Difference between revisions of "Familiar"
imported>MagiNinjA m (pilot type) |
imported>MagiNinjA (additions. still need to tune up.) |
||
| Line 3: | Line 3: | ||
This will contain ASH functions and constants for familiars. | This will contain ASH functions and constants for familiars. | ||
| − | <code>familiar my_familiar()</code> | + | <code>familiar my_familiar()</code> <br /> |
Returns the familiar you currently have equipped as <code>$familiar[familiar]</code>. | Returns the familiar you currently have equipped as <code>$familiar[familiar]</code>. | ||
| + | <code>int familiar_weight( familiar pet )</code> <br /> | ||
| + | Returns the raw, unbuffed weight of the familiar <code>pet</code>. | ||
| + | <code>int familiar_weight( familiar pet )</code> <br /> | ||
| + | Returns the difference between the unbuffed and buffed weights of your currently equipped familiar. | ||
| − | * | + | <code>boolean have_familiar( familiar pet )</code> <br /> |
| − | * | + | Returns true or false depending on if you have the familiar <code>pet</code> in your terrarium or equipped on you. |
| + | |||
| + | <code>boolean equip_familiar( familiar pet )</code> <br /> | ||
| + | Returns true or false depending on if the <code>equip_familiar</code> succeeded in equipping the familiar <code>pet</code> as your current familiar. | ||
| + | |||
| + | <code>item familiar_equipment( familiar pet )</code> <br /> | ||
| + | Returns the item that is most common to <code>pet</code>. e.g. This function will return <code>$item[Meat detector]</code> if pet is <code>$familiar[Leprechaun]</code>. | ||
| + | |||
| + | boolean train_familiar( int nGoal, string sGoal ) <br /> | ||
| + | Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles. | ||
| + | |||
| + | == Datatype Conversions == | ||
| + | string familiar_to_string( familiar pet ) <br /> | ||
| + | familiar string_to_familiar( string str ) <br /> | ||
| + | int familiar_to_int ( familiar pet ) # used for building raw URLs <br /> | ||
| + | familiar int_to_familiar ( int nFamiliar ) # converts an ASH object into a KoL number? not what we're looking for, apparently. <br /> | ||
| + | |||
| + | == $familiar[constant] == | ||
| + | * Angry Goat | ||
| + | * Astral Badger | ||
| + | * Attention-Deficit Demon | ||
| + | * Baby Gravy Fairy | ||
| + | * Baby Yeti | ||
| + | * Barrrnacle | ||
| + | * Blood-Faced Volleyball | ||
| + | * Cheshire Bat | ||
| + | * Clockwork Grapefruit | ||
| + | * Cocoabo | ||
| + | * Coffee Pixie | ||
| + | * Comma Chameleon | ||
| + | * Crimbo Elf | ||
| + | * Cymbal-Playing Monkey | ||
| + | * Doppelshifter | ||
| + | * Emo Squid | ||
| + | * Feather Boa Constrictor | ||
| + | * Flaming Gravy Fairy | ||
| + | * Frozen Gravy Fairy | ||
| + | * Fuzzy Dice | ||
| + | * Ghost Pickle on a Stick | ||
| + | * Ghuol Whelp | ||
| + | * Grue | ||
| + | * Hand Turkey | ||
| + | * Hanukkimbo Dreidl | ||
| + | * Hovering Sombrero | ||
| + | * Howling Balloon Monkey | ||
| + | * Inflatable Dodecapede | ||
| + | * Jill-O-Lantern | ||
| + | * Killer Bee | ||
| + | * Leprechaun | ||
| + | * Levitating Potato | ||
| + | * MagiMechTech MicroMechaMech | ||
| + | * Mosquito | ||
| + | * Ninja Pirate Zombie Robot | ||
| + | * Personal Raincloud | ||
| + | * Pet Rock | ||
| + | * Pygmy Bugbear Shaman | ||
| + | * Sabre-Toothed Lime | ||
| + | * Sleazy Gravy Fairy | ||
| + | * Snowy Owl | ||
| + | * Spirit Hobo | ||
| + | * Spooky Gravy Fairy | ||
| + | * Spooky Pirate Skeleton | ||
| + | * Stab Bat | ||
| + | * Star Starfish | ||
| + | * Stinky Gravy Fairy | ||
| + | * Sweet Nutcracker | ||
| + | * Teddy Bear | ||
| + | * Temporal Riftlet | ||
| + | * Whirling Maple Leaf | ||
| + | * Wild Hare | ||
| + | * Wind-up Chattering Teeth | ||
Revision as of 03:59, 9 May 2007
CURRENTLY A TEST PAGE...MY BAD IF NO ONE LIKES IT. :)
This will contain ASH functions and constants for familiars.
familiar my_familiar()
Returns the familiar you currently have equipped as $familiar[familiar].
int familiar_weight( familiar pet )
Returns the raw, unbuffed weight of the familiar pet.
int familiar_weight( familiar pet )
Returns the difference between the unbuffed and buffed weights of your currently equipped familiar.
boolean have_familiar( familiar pet )
Returns true or false depending on if you have the familiar pet in your terrarium or equipped on you.
boolean equip_familiar( familiar pet )
Returns true or false depending on if the equip_familiar succeeded in equipping the familiar pet as your current familiar.
item familiar_equipment( familiar pet )
Returns the item that is most common to pet. e.g. This function will return $item[Meat detector] if pet is $familiar[Leprechaun].
boolean train_familiar( int nGoal, string sGoal )
Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles.
Datatype Conversions
string familiar_to_string( familiar pet )
familiar string_to_familiar( string str )
int familiar_to_int ( familiar pet ) # used for building raw URLs
familiar int_to_familiar ( int nFamiliar ) # converts an ASH object into a KoL number? not what we're looking for, apparently.
$familiar[constant]
* Angry Goat * Astral Badger * Attention-Deficit Demon * Baby Gravy Fairy * Baby Yeti * Barrrnacle * Blood-Faced Volleyball * Cheshire Bat * Clockwork Grapefruit * Cocoabo * Coffee Pixie * Comma Chameleon * Crimbo Elf * Cymbal-Playing Monkey * Doppelshifter * Emo Squid * Feather Boa Constrictor * Flaming Gravy Fairy * Frozen Gravy Fairy * Fuzzy Dice * Ghost Pickle on a Stick * Ghuol Whelp * Grue * Hand Turkey * Hanukkimbo Dreidl * Hovering Sombrero * Howling Balloon Monkey * Inflatable Dodecapede * Jill-O-Lantern * Killer Bee * Leprechaun * Levitating Potato * MagiMechTech MicroMechaMech * Mosquito * Ninja Pirate Zombie Robot * Personal Raincloud * Pet Rock * Pygmy Bugbear Shaman * Sabre-Toothed Lime * Sleazy Gravy Fairy * Snowy Owl * Spirit Hobo * Spooky Gravy Fairy * Spooky Pirate Skeleton * Stab Bat * Star Starfish * Stinky Gravy Fairy * Sweet Nutcracker * Teddy Bear * Temporal Riftlet * Whirling Maple Leaf * Wild Hare * Wind-up Chattering Teeth