Familiar: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older edit
VisualWikitext
imported>MagiNinjA
m tune up of my pretty page ;)
imported>Aventuristo
Add to Data Types category; add proxy record boilerplate
 
(8 intermediate revisions by 3 users not shown)
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] ==
    * 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

Latest revision as of 00:42, 30 September 2017


This data type represents any familiar available in KoL.

The full range, besides $familiar[ none ], is too much to list and keep up with here: please see the Wiki Familiars page for more information.

Related Functions

boolean bjornify_familiar( familiar )

boolean enthrone_familiar( familiar )

boolean equip_all_familiars()

item familiar_equipment( familiar )

item familiar_equipped_equipment( familiar )

int familiar_weight( familiar )

boolean [familiar] favorite_familiars()

boolean have_familiar( familiar )

boolean is_familiar_equipment_locked()

boolean is_trendy( item/familiar/skill/string )

boolean is_unrestricted( item/familiar/skill/string )

void lock_familiar_equipment( boolean )

familiar my_bjorned_familiar()

familiar my_effective_familiar()

familiar my_enthroned_familiar()

familiar my_familiar()

float numeric_modifier( familiar, string, int, item )

familiar to_familiar( int )

familiar to_familiar( strict_string )

boolean use_familiar( familiar )


Proxy Record Fields

Here are the proxy record fields for familiars. Proxy records are discussed in more detail here.

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
Retrieved from "https://wiki.kolmafia.us/index.php?title=Familiar&oldid=2043"