Difference between revisions of "Equipment"

From Kolmafia
Jump to navigation Jump to search
imported>Zarqon
(consistent wiki formatting, more compact layout)
imported>Fredg1
(→‎Equipment Commands: equipped_amount())
 
(20 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
== Part 3 - Equipment ==
+
{{TOCright}}
−
<em>Time to get dressed!</em>
+
==Equipment Commands==
 +
{{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.}}
 +
{{Flink|boolean|have_equipped|item|desc=Reports if the specified item is currently equipped by your character.}}
 +
{{Flink|int|equipped_amount|item|desc=Returns the amount of a given item currently equipped on your character.}}
 +
{{Flink|boolean|can_equip|item|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}
 +
{{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.}}
 +
{{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|use_familiar|familiar|desc=Attempts to make the specified familiar your currently used one and reports success.}}
 +
{{Flink|item|familiar_equipment|familiar|desc=Reports the most commonly associated familiar equipment for the specified familiar.}}
 +
{{Flink|item|familiar_equipped_equipment|familiar|desc=Returns the item currently equipped on the specified familiar (or $item[none] if you don't have that familiar).}}
 +
{{Flink|boolean|enthrone_familiar|familiar|desc=Enthrones the specified familiar.}}
 +
{{Flink|familiar|my_enthroned_familiar|desc=Returns the familiar currently enthroned.}}
 +
{{Flink|boolean|bjornify_familiar|familiar|desc=Bjornifies the specified familiar.}}
 +
{{Flink|familiar|my_bjorned_familiar|desc=Returns the familiar currently in the Buddy Bjorn.}}
 +
{{Flink|boolean|maximize|string|boolean}}
 +
{{Flink|boolean|maximize|string|int|int|boolean|desc=Checks for and optionally equips the optimal gear for any given parameters.}}
  
−
'''boolean [[equip()|equip( item it )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] in the &#8220;natural&#8221; slot.  Only equips accessories in empty slots.
+
==Outfit Commands==
 +
{{Flink|boolean|have_outfit|string|desc=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.}}
 +
{{Flink|boolean|outfit|string|desc=Attempts to wear the specified outfit and reports success.}}
 +
{{Flink|item [int]|outfit_pieces|string|desc=Returns an array of the items which compose an outfit.}}
 +
{{Flink|boolean|is_wearing_outfit|string|desc=Reports on whether or not you're wearing the specified (in-game or custom) outfit.}}
 +
{{Flink|string [int]|get_outfits|desc=This function returns a  list of all KoL outfits that the character currently owns and can wear.}}
 +
{{Flink|string [int]|get_custom_outfits|desc=This function returns a list of all currently defined custom outfits.}}
  
−
'''boolean [[equip()|equip( slot sl, item it )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] in the specified [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot]].
+
[[Category:Scripting]]
−
 
 
−
'''item [[equipped_item()|equipped_item( slot sl )]]''' - returns the item currently equipped in the given slot. (<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])
 
−
 
 
−
'''boolean [[have_equipped()|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()|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()|weapon_type( item it )]]''' - returns a string indicating the type of weapon which was passed as a parameter.
 
−
 
 
−
'''int [[weapon_hands()|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. (<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])
 
−
 
 
−
'''stat [[weapon_type()|weapon_type( item it )]]''' - tells you what stat your weapon bases its hit chance on.
 
−
 
 
−
'''boolean [[have_familiar()|have_familiar( familiar pet )]]''' - tells you if you have placed the specified [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]] in your Terrarium (or have it equipped now).
 
−
 
 
−
'''boolean [[use_familiar()|use_familiar( familiar pet )]]''' - equips the specified [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]].  Use [[equip()]] to change your familiar&#8217;s gear.
 
−
 
 
−
'''item [[familiar_equipment()|familiar_equipment( familiar pet )]]''' - returns the most common piece of equipment that is specially designed for the familiar&#8217;s type.
 
−
 
 
−
'''item [[familiar_equipped_equipment()|familiar_equipped_equipment( familiar pet )]]''' - returns the current item equipped on a [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar]], as opposed to familiar_equipment( familiar ) which returns the special item only the familiar can use.
 
−
 
 
−
'''boolean [[have_outfit()|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. (<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]])
 
−
 
 
−
'''boolean [[outfit()|outfit( string outfit_name )]]''' - wears the specified outfit. (<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]])
 

Latest revision as of 21:37, 31 July 2020

Equipment Commands

boolean equip( [slot], item )

Equips the specified item and reports success.

item equipped_item( slot )

Returns the item equipped in the specified slot.

boolean have_equipped( item )

Reports if the specified item is currently equipped by your character.

int equipped_amount( item )

Returns the amount of a given item currently equipped on your character.

boolean can_equip( item )

Tells if you meet the requirements for equipping the given item (regardless of its availability).

int weapon_hands( item )

Reports how many weapon-hand slots are required for a given item (0 - 2). Off-hand items return 0.

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 enthrone_familiar( familiar )

Enthrones the specified familiar.

familiar my_enthroned_familiar()

Returns the familiar currently enthroned.

boolean bjornify_familiar( familiar )

Bjornifies the specified familiar.

familiar my_bjorned_familiar()

Returns the familiar currently in the Buddy Bjorn.

boolean maximize( string, boolean )

boolean maximize( string, int, int, boolean )

Checks for and optionally equips the optimal gear for any given parameters.


Outfit Commands

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.

item [int] outfit_pieces( string )

Returns an array of the items which compose an outfit.

boolean is_wearing_outfit( string )

Reports on whether or not you're wearing the specified (in-game or custom) outfit.

string [int] get_outfits()

This function returns a list of all KoL outfits that the character currently owns and can wear.

string [int] get_custom_outfits()

This function returns a list of all currently defined custom outfits.
Retrieved from "https://wiki.kolmafia.us/index.php?title=Equipment&oldid=814"