Familiar

From Kolmafia
Revision as of 08:40, 29 January 2009 by imported>Zarqon
Jump to navigation Jump to search

This page has ASH functions and constants related to familiars.

Basic Familiar Functions

familiar my_familiar() - returns the familiar you currently have equipped.

boolean have_familiar( familiar pet ) - returns true if you have the specified familiar in your Terrarium (or "equipped"). Otherwise, returns false.

boolean use_familiar( familiar pet ) - equips the specified familiar.

int familiar_weight( familiar pet ) - returns the raw, unbuffed weight of the specified familiar.

item familiar_equipment( familiar pet ) - returns the item that is most common to pet.


Datatype Conversions

string to_string( familiar pet ) - returns the string name of pet.

familiar to_familiar( string str ) - returns $familiar[str] from the string given.

int to_int( familiar pet ) - returns the KoL number of familiar pet for raw URL building.

familiar to_familiar( int nFamiliar ) - returns $familiar[pet] from the KoL number of the familiar.


$familiar[constant]

  • Mosquito
  • Leprechaun
  • Levitating Potato
  • Angry Goat
  • Sabre-Toothed Lime
  • Fuzzy Dice
  • Spooky Pirate Skeleton
  • Barrrnacle
  • Howling Balloon Monkey
  • Stab Bat
  • Grue
  • Blood-Faced Volleyball
  • none
  • Ghuol Whelp
  • Baby Gravy Fairy
  • Cocoabo
  • Star Starfish
  • Hovering Sombrero
  • Ghost Pickle on a Stick
  • Killer Bee
  • Whirling Maple Leaf
  • Coffee Pixie
  • Cheshire Bat
  • Jill-O-Lantern
  • Hand Turkey
  • Crimbo Elf
  • Hanukkimbo Dreidl
  • Baby Yeti
  • Feather Boa Constrictor
  • Emo Squid
  • Personal Raincloud
  • Clockwork Grapefruit
  • MagiMechTech MicroMechaMech
  • Flaming Gravy Fairy
  • Frozen Gravy Fairy
  • Stinky Gravy Fairy
  • Spooky Gravy Fairy
  • Inflatable Dodecapede
  • Pygmy Bugbear Shaman
  • Doppelshifter
  • Attention-Deficit Demon
  • Cymbal-Playing Monkey
  • Temporal Riftlet
  • Sweet Nutcracker
  • Pet Rock
  • Snowy Owl
  • Teddy Bear
  • Ninja Pirate Zombie Robot
  • Sleazy Gravy Fairy
  • Wild Hare
  • Wind-up Chattering Teeth
  • Spirit Hobo
  • Astral Badger
  • Comma Chameleon
  • Misshapen Animal Skeleton
  • Scary Death Orb
  • Jitterbug
  • Nervous Tick
  • Reassembled Blackbird
  • Origami Towel Crane
  • Ninja Snowflake
  • Evil Teddy Bear
  • Toothsome Rock
  • none
  • Ancient Yuletide Troll
  • Dandy Lion
  • O.A.F.
  • Penguin Goodfella
  • Jumpsuited Hound Dog
  • Green Pixie
  • Ragamuffin Imp
  • Exotic Parrot
  • Wizard Action Figure
  • Gluttonous Green Ghost
  • Casagnova Gnome
  • Hunchbacked Minion
  • Crimbo P. R. E. S. S. I. E.
  • Bulky Buddy Box
  • Teddy Borg
  • RoboGoose
  • El Vibrato Megadrone
  • Mad Hatrack