Equipment: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle mNo edit summary |
imported>StDoodle mNo edit summary |
||
Line 1: | Line 1: | ||
{{Flink|boolean|equip|{{opt|slot}}|item|desc=Equips the specified item and reports success.}} | {{Flink|boolean|equip|{{opt|slot}}|item|desc=Equips the specified item and reports success.}} | ||
{{Flink|item|equipped_item|slot|desc=Returns the item equipped in the specified slot. (''Sample'': [[ | {{Flink|item|equipped_item|slot|desc=Returns the item equipped in the specified slot. (''Sample'': [[Code Samples#Battlefield Gather|Battlefield Gather]])}} | ||
{{Flink|boolean|have_equipped|item|desc=Reports if the specified item is currently equipped by your character.}} | {{Flink|boolean|have_equipped|item|desc=Reports if the specified item is currently equipped by your character.}} | ||
{{Flink|boolean|can_equip|item|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}} | {{Flink|boolean|can_equip|item|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}} | ||
{{Flink|string|item_type|item|desc=Returns the type of item specified.}} | {{Flink|string|item_type|item|desc=Returns the type of item specified.}} | ||
{{Flink|int|weapon_hands|item|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0. (''Sample'': [[ | {{Flink|int|weapon_hands|item|desc=Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0. (''Sample'': [[Code Samples#Battlefield Gather|Battlefield Gather]])}} | ||
{{Flink|stat|weapon_type|item|desc=Returns the equip requirement stat for the specified item. If it is not a weapon, this function returns $stat[none].}} | {{Flink|stat|weapon_type|item|desc=Returns the equip requirement stat for the specified item. If it is not a weapon, this function returns $stat[none].}} | ||
{{Flink|boolean|have_familiar|familiar|desc=Reports on whether you have the specified familiar either in your Terrarium or equipped.}} | {{Flink|boolean|have_familiar|familiar|desc=Reports on whether you have the specified familiar either in your Terrarium or equipped.}} |
Revision as of 15:24, 9 March 2010
boolean equip( [slot], item )
Equips the specified item and reports success.
Returns the item equipped in the specified slot. (Sample: Battlefield Gather)
boolean have_equipped( item )
Reports if the specified item is currently equipped by your character.
boolean can_equip( item )
Tells if you meet the requirements for equipping the given item (regardless of its availability).
string item_type( item )
Returns the type of item specified.
Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0. (Sample: Battlefield Gather)
stat weapon_type( item )
Returns the equip requirement stat for the specified item. If it is not a weapon, this function returns $stat[none].
boolean have_familiar( familiar )
Reports on whether you have the specified familiar either in your Terrarium or equipped.
boolean use_familiar( familiar )
Attempts to make the specified familiar your currently used one and reports success.
item familiar_equipment( familiar )
Reports the most commonly associated familiar equipment for the specified familiar.
item familiar_equipped_equipment( familiar )
Returns the item currently equipped on the specified familiar (or $item[none] if you don't have that familiar).
boolean have_outfit( string )
Reports on whether or not you're currently capable of equipping the specified (in-game or custom) outfit, based on your stats & inventory availability of all outfit pieces.
boolean outfit( string )
Attempts to wear the specified outfit and reports success.