Familiar: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Zarqon
ran a foreach to list all familiars recognized by mafia 1/29/09; used wiki list formatting
imported>Zarqon
No edit summary
Line 1: Line 1:
This page has ASH functions and constants related to familiars.
This page has ASH functions and constants related to familiars.


<code>'''familiar my_familiar()'''</code> <br />
'''familiar [[my_familiar()]]''' - returns the familiar you currently have equipped.
Returns the familiar you currently have equipped as <code>$familiar[familiar]</code>.


<code>'''boolean have_familiar( familiar pet )'''</code> <br />
'''boolean [[have_familiar()|have_familiar( familiar pet )]]''' - returns ''true'' if you have the specified familiar in your Terrarium (or "equipped").  Otherwise, returns ''false''.
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 />
'''boolean [[use_familiar()|use_familiar( familiar pet )]]''' - equips the specified familiar.
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>'''int familiar_weight( familiar pet )'''</code> <br />
'''int [[familiar_weight()|familiar_weight( familiar pet )]]''' - returns the raw, unbuffed weight of the specified familiar.
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 train_familiar( int nGoal, string sGoal )'''</code> <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. Returns success value.
 
<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>.


'''item [[familiar_equipment()|familiar_equipment( familiar pet )]]''' - returns the item that is most common to <tt>pet</tt>.




== Datatype Conversions ==
== Datatype Conversions ==
<code>'''string familiar_to_string( familiar pet )'''</code> <br />
'''string [[to_string()|to_string( familiar pet )]]''' - returns the string name of <tt>pet</tt>.
Returns the string name of <code>pet</code>.
 
<code>'''familiar string_to_familiar( string str )'''</code> <br />
Returns <code>$familiar[str]</code> from the string given.


<code>'''int familiar_to_int ( familiar pet )'''</code> <br />
'''familiar [[to_familiar()|to_familiar( string str )]]''' - returns <code>$familiar[str]</code> from the string given.
Returns the KoL number of familiar <code>pet</code> for raw URL building.


<code>'''familiar int_to_familiar ( int nFamiliar )'''</code> <br />
'''int [[to_int()|to_int( familiar pet )]]''' - returns the KoL number of familiar <tt>pet</tt> for raw URL building.
Returns <code>$familiar[pet]</code> from the KoL number of the familiar.


'''familiar [[to_familiar()|to_familiar( int nFamiliar )]]''' - returns <code>$familiar[pet]</code> from the KoL number of the familiar.





Revision as of 08:39, 29 January 2009

This page has ASH functions and constants related to familiars.

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