Equipment

From Kolmafia
Revision as of 00:24, 2 March 2010 by imported>Alhifar (→‎Part 3 - Equipment)
Jump to navigation Jump to search

Part 3 - Equipment

Time to get dressed!

boolean equip( item it ) - equips the specified item in the “natural” slot. Only equips accessories in empty slots.

boolean equip( slot sl, item it ) - equips the specified item in the specified slot.

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 item_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 ) - equips the specified familiar. Use equip to change 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.

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

boolean have_outfit( string outfit_name ) - returns true 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)