Difference between revisions of "Equipment"

From Kolmafia
Jump to navigation Jump to search
imported>Raeith
(Copy/Paste with HTML formatting. Links removed.)
imported>Raeith
(Gotta love Sample Links)
Line 16: Line 16:
  
 
<p><strong>item current_equipment( slot sl )</strong><br />
 
<p><strong>item current_equipment( slot sl )</strong><br />
Returns the item currently equipped in the given slot.</p>
+
Returns the item currently equipped in the given slot.<br />
 +
<em>Sample</em>:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]</p>
  
 
<p><strong>boolean have_equipped( item it )</strong><br />
 
<p><strong>boolean have_equipped( item it )</strong><br />
Line 28: Line 29:
  
 
<p><strong>int weapon_hands( item it )</strong><br />
 
<p><strong>int weapon_hands( item it )</strong><br />
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.</p>
+
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.<br />
 +
<em>Sample</em>:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]</p>
  
 
<p><strong>boolean ranged_weapon( item it )</strong><br />
 
<p><strong>boolean ranged_weapon( item it )</strong><br />
Line 43: Line 45:
  
 
<p><strong>boolean have_outfit( string outfit_name )</strong><br />
 
<p><strong>boolean have_outfit( string outfit_name )</strong><br />
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.</p>
+
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.<br />
 +
<em>Sample</em>:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_1:_Seltzer Seltzer]</p>
  
 
<p><strong>boolean outfit( string outfit_name )</strong><br />
 
<p><strong>boolean outfit( string outfit_name )</strong><br />
Wears the specified outfit.</p>
+
Wears the specified outfit.<br />
 +
<em>Sample</em>:[http://www.wiki.kolmafia.us/index.php/%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather Battlefield_gather]</p>

Revision as of 04:39, 9 January 2007

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 unequip( item it )
Takes off one of the specified item.

boolean equip_slot( slot sl, item it )
boolean unequip_slot( slot sl )

Equipment management that targets a specific slot.

slot item_to_slot( item it )
Returns the natural slot for the item, if it is equippable.

item current_equipment( 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 )
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

boolean ranged_weapon( item it )
Tells you if a weapon’s chance of hitting the opponent is based on your Moxie instead of your Muscle.

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

boolean equip_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 current_equipment( $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:Seltzer

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