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