Difference between revisions of "Equipment"

From Kolmafia
Jump to navigation Jump to search
imported>Alhifar
imported>Bale
(new command: familiar_equipped_equipment)
Line 36: Line 36:
 
<p><strong>item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] )</strong><br />
 
<p><strong>item familiar_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] )</strong><br />
 
Returns the most common piece of equipment that is specially designed for the familiar&#8217;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 ]).</p>
 
Returns the most common piece of equipment that is specially designed for the familiar&#8217;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 ]).</p>
 +
 +
<p><strong>item familiar_equipped_equipment( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] )</strong><br />
 +
Returns returns the current item equipped on a familiar, as opposed to familiar_equipment( familiar ) which returns the special item only this familiar can use.</p>
  
 
<p><strong>boolean have_outfit( string outfit_name )</strong><br />
 
<p><strong>boolean have_outfit( string outfit_name )</strong><br />

Revision as of 08:19, 4 December 2008

Part 3 - Equipment

Time to get dressed!

boolean equip( 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 equip( slot sl, item it )
Puts on the specified item in the specified spot.

item equipped_item( slot sl )
Returns the item currently equipped in the given slot.
Sample:Battlefield_gather

boolean have_equipped( item it )
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).

boolean can_equip( item it )
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).

string weapon_type( item it )
Returns a string indicating the type of weapon which was passed as a parameter.

int weapon_hands( 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:Battlefield_gather

stat weapon_type( item it )
Tells you what stat your weapon bases its hit chance on.

boolean have_familiar( familiar pet )
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).

boolean use_familiar( familiar pet )
Takes the specified familiar out of your Terrarium. Use equip() and unequip() to manage your familiar’s gear.

item familiar_equipment( 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 ]).

item familiar_equipped_equipment( familiar pet )
Returns returns the current item equipped on a familiar, as opposed to familiar_equipment( familiar ) which returns the special item only this familiar can use.

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:Seltzer

boolean outfit( string outfit_name )
Wears the specified outfit.
Sample:Battlefield_gather