Talk:Equipment

2008-03-30T23:30:02Z

69.91.82.28:

ranged_weapon function does not seem to be available any more.

Equipment

2008-03-30T23:29:22Z

69.91.82.28:

== Part 3 - Equipment ==
Time to get dressed!

boolean equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Puts on the specified item in the “natural” slot. For example, it won’t equip a weapon to the off-hand and it will only put a accessory into an empty slot.

boolean unequip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Takes off one of the specified item.

boolean equip_slot( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
boolean unequip_slot( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Equipment management that targets a specific slot.

item equipped_item( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] ) 
Returns the item currently equipped in the given slot. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean have_equipped( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) 
Tells you if a weapon will keep you from using your off-hand slot. Even if a weapon is described as being 3-handed, this function will return 2. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

boolean ranged_weapon( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] ) Function no longer available. Someone who knows better, please show a workaround here.
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

boolean have_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] ) 
Returns the most common piece of equipment that is specially designed for the familiar’s type. If you want to find out what item is being equipped by your familiar of a specific species, then you would need to take that familiar out of the Terrarium with equip_familiar() and then check equipped_item( $slot[ familiar ]).

boolean have_outfit( string outfit_name ) 
Lets you know if you could wear a specified outfit right now, either an in-game or a custom outfit. A false result means either that you are missing one or more pieces of the outfit or that your stats are not high enough to equip all of the pieces. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]

boolean outfit( string outfit_name ) 
Wears the specified outfit. 
Sample:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]

Kolmafia - User contributions [en]

Talk:Equipment

Equipment