Difference between revisions of "Familiar"
imported>Zarqon (oops, forgot a few) |
imported>Aventuristo (Add to Data Types category; add proxy record boilerplate) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{DISPLAYTITLE:familiar}} | |
− | + | {{TOCright}} | |
− | |||
− | + | 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 {{kolwiki|Familiars}} page for more information. | ||
− | + | ==Related Functions== | |
− | + | {{Flink|boolean|bjornify_familiar|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}} | ||
+ | ==Proxy Record Fields== | ||
− | + | Here are the proxy record fields for familiars. Proxy records are discussed in more | |
− | + | 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]] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
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 |