Familiar

This page has ASH functions and constants related to familiars.

familiar my_familiar()
Returns the familiar you currently have equipped as $familiar[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.

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 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. Returns success value.

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].

Datatype Conversions

string familiar_to_string( familiar pet )
Returns the string name of pet.

familiar string_to_familiar( string str )
Returns $familiar[str] from the string given.

int familiar_to_int ( familiar pet )
Returns the KoL number of familiar pet for raw URL building.

familiar int_to_familiar ( int nFamiliar )
Returns $familiar[pet] from the KoL number of the familiar.

$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