Difference between revisions of "Familiar"

Field	Data type	Default value
hatchling	item	none
image	string	"debug.gif"
name	string	""
charges	int	0
drop_name	string	""
drop_item	item	none
drops_today	int	0
drops_limit	int	0
combat	boolean	false
physical_damage	boolean	false
elemental_damage	boolean	false
block	boolean	false
delevel	boolean	false
hp_during_combat	boolean	false
mp_during_combat	boolean	false
other_action_during_combat	boolean	false
hp_after_combat	boolean	false
mp_after_combat	boolean	false
other_action_after_combat	boolean	false
passive	boolean	false
variable	boolean	false

Difference between revisions of "Familiar"

Latest revision as of 00:42, 30 September 2017

Contents

Related Functions

Proxy Record Fields

Navigation menu

Search

@@ Line 1: / Line 1: @@
-This page has ASH functions and constants related to familiars.
+{{DISPLAYTITLE:familiar}}
-<code>'''familiar my_familiar()'''</code> <br />
+{{TOCright}}
-Returns the familiar you currently have equipped as <code>$familiar[familiar]</code>.
-<code>'''boolean have_familiar( familiar pet )'''</code> <br />
+This data type represents any familiar available in KoL.
-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 />
+The full range, besides $familiar[ none ], is too much to list and keep up
-Returns true or false depending on if the <code>equip_familiar</code> succeeded in equipping the familiar <code>pet</code> as your current familiar.
+with here: please see the Wiki {{kolwiki|Familiars}} page for more information.
-<code>'''int familiar_weight( familiar pet )'''</code> <br />
+==Related Functions==
-Returns the raw, unbuffed weight of the familiar <code>pet</code>.
-<code>'''int familiar_weight( familiar pet )'''</code> <br />
+{{Flink|boolean|bjornify_familiar|familiar}}
-Returns the difference between the unbuffed and buffed weights of your currently equipped familiar.
+{{Flink|boolean|enthrone_familiar|familiar}}
+{{Flink|boolean|equip_all_familiars}}
+{{Flink|item|familiar_equipment|familiar}}
+{{Flink|item|familiar_equipped_equipment|familiar}}
+{{Flink|int|familiar_weight|familiar}}
+{{Flink|boolean [familiar]|favorite_familiars|}}
+{{Flink|boolean|have_familiar|familiar}}
+{{Flink|boolean|is_familiar_equipment_locked}}
+{{Flink|boolean|is_trendy|item/familiar/skill/string}}
+{{Flink|boolean|is_unrestricted|item/familiar/skill/string}}
+{{Flink|void|lock_familiar_equipment|boolean}}
+{{Flink|familiar|my_bjorned_familiar}}
+{{Flink|familiar|my_effective_familiar}}
+{{Flink|familiar|my_enthroned_familiar}}
+{{Flink|familiar|my_familiar}}
+{{Flink|float|numeric_modifier|familiar|string|int|item}}
+{{Flink|familiar|to_familiar|int}}
+{{Flink|familiar|to_familiar|strict_string}}
+{{Flink|boolean|use_familiar|familiar}}
-<code>'''boolean train_familiar( int nGoal, string sGoal )'''</code> <br />
+==Proxy Record Fields==
-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 />
+Here are the proxy record fields for familiars.  Proxy records are discussed in more
-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>.
+detail [[Proxy Records|here]].
+{| cellpadding="3" cellspacing="0" border="1px" class="sortable"
+|- | style="background-color: #F2F2F2"
+|-
+! Field
+! Data type
+! Default value
+! ASH Accessor Function / Notes
+|-
+| hatchling
+| item
+| none
+|
+|-
+| image
+| string
+| "debug.gif"
+|
+|-
+| name
+| string
+| ""
+|
+|-
+| charges
+| int
+| 0
+|
+|-
+| drop_name
+| string
+| ""
+|
+|-
+| drop_item
+| item
+| none
+|
+|-
+| drops_today
+| int
+| 0
+|
+|-
+| drops_limit
+| int
+| 0
+|
+|-
+| combat
+| boolean
+| false
+|
+|-
+| physical_damage
+| boolean
+| false
+|
+|-
+| elemental_damage
+| boolean
+| false
+|
+|-
+| block
+| boolean
+| false
+|
+|-
+| delevel
+| boolean
+| false
+|
+|-
+| hp_during_combat
+| boolean
+| false
+|
+|-
+| mp_during_combat
+| boolean
+| false
+|
+|-
+| other_action_during_combat
+| boolean
+| false
+|
+|-
+| hp_after_combat
+| boolean
+| false
+|
+|-
+| mp_after_combat
+| boolean
+| false
+|
+|-
+| other_action_after_combat
+| boolean
+| false
+|
+|-
+| passive
+| boolean
+| false
+|
+|-
+| variable
+| boolean
+| false
+|
+|}
+[[Category:Scripting]] [[Category:Data Types]]
-== Datatype Conversions ==
-<code>'''string familiar_to_string( familiar pet )'''</code> <br />
-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 />
-Returns the KoL number of familiar <code>pet</code> for raw URL building.
-<code>'''familiar int_to_familiar ( int nFamiliar )'''</code> <br />
-Returns <code>$familiar[pet]</code> 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