imported>Relyk |
|
Line 1: |
Line 1: |
− | Proxy records are special records associated with the special [[Data Types|data types]] available to scripters. These records are always available for the special datatypes. The fields in a proxy record are referenced in the same manner as a [[Data_Structures#Records|record]].
| + | <includeonly>{{#ifexist:{{{1|}}} |
| + | |{{#if:{{data|{{{1}}}|function1.return_type}} |
| + | |{{FunctionDeclaration|name={{{1}}}|func=1|format=signature}}{{ |
| + | #if:{{data|{{{1}}}|function1.short_description}} |
| + | |:{{data|{{{1}}}|function1.short_description}} |
| + | }} |
| + | }}{{#if:{{data|{{{1}}}|function2.return_type}} |
| + | |;{{FunctionDeclaration|name={{{1}}}|func=2|format=signature}}{{ |
| + | #if:{{data|{{{1}}}|function2.short_description}} |
| + | |:{{data|{{{1}}}|function2.short_description}} |
| + | }} |
| + | }}{{#if:{{data|{{{1}}}|function3.return_type}} |
| + | |;{{FunctionDeclaration|name={{{1}}}|func=3|format=signature}}{{ |
| + | #if:{{data|{{{1}}}|function3.short_description}} |
| + | |:{{data|{{{1}}}|function3.short_description}} |
| + | }} |
| + | }}{{#if:{{data|{{{1}}}|function4.return_type}} |
| + | |;{{FunctionDeclaration|name={{{1}}}|func=4|format=signature}}{{ |
| + | #if:{{data|{{{1}}}|function4.short_description}} |
| + | |:{{data|{{{1}}}|function4.short_description}} |
| + | }} |
| + | }}{{#if:{{data|{{{1}}}|function5.return_type}} |
| + | |;{{FunctionDeclaration|name={{{1}}}|func=5|format=signature}}{{ |
| + | #if:{{data|{{{1}}}|function5.short_description}} |
| + | |:{{data|{{{1}}}|function5.short_description}} |
| + | }} |
| + | }} |
| + | |{{error|Cannot find page "{{{1|}}}" for Template:FunctionEmbed}}}}</includeonly><noinclude> |
| | | |
− | ==Special Datatypes==
| + | <templatedata> |
| + | { |
| + | "description": "Generates a brief description of a function's signature(s). Used to embed function signatures in function list pages.", |
| + | "params": { |
| + | "1": { |
| + | "label": "Function page name", |
| + | "description": "Must be a new-style function page", |
| + | "type": "wiki-page-name" |
| + | } |
| + | } |
| + | } |
| + | </templatedata> |
| | | |
− | ===bounty=== | + | ==Examples== |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable" | + | <pre>{{FunctionEmbed|visit_url}}</pre> |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | plural
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | type
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | kol_internal_type
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | number
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | monster
| |
− | | monster
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | location
| |
− | | location
| |
− | | none
| |
− | |
| |
− | |}
| |
| | | |
− | ===class===
| + | {{FunctionEmbed|visit_url}} |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable" | + | </noinclude> |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | primestat
| |
− | | stat
| |
− | | Muscle
| |
− | |
| |
− | |}
| |
− | | |
− | ===coinmaster===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | token
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | item
| |
− | | item
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | property
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | available_tokens
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | buys
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | sells
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |}
| |
− | | |
− | ===effect===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | default
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | note
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | all
| |
− | | aggregate
| |
− | boolean [string] =>
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | "/images/debug.gif"
| |
− | |
| |
− | |-
| |
− | | descid
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |}
| |
− | | |
− | ===element===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | "circle.gif"
| |
− | |
| |
− | |}
| |
− | | |
− | ===familiar===
| |
− | {| 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
| |
− | |
| |
− | |}
| |
− | ===item===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | plural
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | descid
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | smallimage
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | levelreq
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | quality
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | adventures
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | muscle
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | mysticality
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | moxie
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | fullness
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | inebriety
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | spleen
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | minhp
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | maxhp
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | minmp
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | maxmp
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | dailyusesleft
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | notes
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | quest
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | gift
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | tradeable
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | discardable
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | combat
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | combat_reusable
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | usable
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | reusable
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | multi
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | fancy
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | candy
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | seller
| |
− | | coinmaster
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | buyer
| |
− | | coinmaster
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | name_length
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |}
| |
− | | |
− | ===location===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | nocombats
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | zone
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | parent
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | parentdesc
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | environment
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | bounty
| |
− | | bounty
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | combat_queue
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | noncombat_queue
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | turns_spent
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | kisses
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | recommended_stat
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | water_level
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |}
| |
− | | |
− | ===monster===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | id
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | base_hp
| |
− | | int
| |
− | | 0
| |
− | | {{f|monster_hp}} (includes modifiers)
| |
− | |-
| |
− | | base_attack
| |
− | | int
| |
− | | 0
| |
− | | {{f|monster_attack}} (includes modifiers)
| |
− | |-
| |
− | | base_defense
| |
− | | int
| |
− | | 0
| |
− | | {{f|monster_defense}} (includes modifiers)
| |
− | |-
| |
− | | raw_hp
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | raw_attack
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | raw_defense
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | base_initiative
| |
− | | int
| |
− | | 0
| |
− | | {{f|monster_initiative}} (includes modifiers)
| |
− | |-
| |
− | | raw_initiative
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | element attack_element
| |
− | | element
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | element defense_element
| |
− | | element
| |
− | | none
| |
− | | {{f|monster_element}}
| |
− | |-
| |
− | | physical_resistance
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | min_meat
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | max_meat
| |
− | | int
| |
− | | 0
| |
− | | (excludes modifiers)
| |
− | |-
| |
− | | base_mainstat_exp
| |
− | | foat
| |
− | | 0.0
| |
− | | (includes bonus stats from +ML, but not from +stat effects)
| |
− | |-
| |
− | | phylum
| |
− | | phylum
| |
− | | none
| |
− | | {{f|monster_phylum}}
| |
− | |-
| |
− | | poison
| |
− | | effect
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | boss
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | dummy
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | images
| |
− | | aggregate boolean [string]
| |
− | |
| |
− | |
| |
− | |-
| |
− | | attributes
| |
− | | string
| |
− | | ""
| |
− | | A compilation of attack, defense, initiative, element, meat drop, and phylum
| |
− | |-
| |
− | | random_attributes
| |
− | | aggregate boolean [string]
| |
− | |
| |
− | | The monster's random modifiers - like those generated in the One Crazy Random Summer path
| |
− | |-
| |
− | | manuel_name
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |}
| |
− | | |
− | ===phylum===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | none
| |
− | |
| |
− | |}
| |
− | | |
− | ===skill===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | level
| |
− | | int
| |
− | | -1
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | traincost
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | class
| |
− | | class
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | libram
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | passive
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | buff
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | combat
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | song
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | expression
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | summon
| |
− | | boolean
| |
− | | false
| |
− | |
| |
− | |-
| |
− | | permable
| |
− | | boolean
| |
− | | true
| |
− | |
| |
− | |-
| |
− | | dailylimit
| |
− | | int
| |
− | | -1
| |
− | |
| |
− | |-
| |
− | | timescast
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |}
| |
− | | |
− | === slot ===
| |
− | Slot does not have any fields.
| |
− | | |
− | ===stat===
| |
− | Stat does not have any fields.
| |
− | | |
− | ===thrall===
| |
− | {| cellpadding="3" cellspacing="0" border="1px" class="sortable"
| |
− | |- | style="background-color: #F2F2F2"
| |
− | |-
| |
− | ! Field
| |
− | ! Data type
| |
− | ! Default value
| |
− | ! ASH Accessor Function / Notes
| |
− | |-
| |
− | | id
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | name
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | level
| |
− | | int
| |
− | | 0
| |
− | |
| |
− | |-
| |
− | | image
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | tinyimage
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |-
| |
− | | skill
| |
− | | skill
| |
− | | none
| |
− | |
| |
− | |-
| |
− | | current_modifiers
| |
− | | string
| |
− | | ""
| |
− | |
| |
− | |}
| |