Difference between revisions of "To slot"

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m (Erm, meant the code sample comment to be here. :P)
imported>Bale
(alternate)
Line 17: Line 17:
 
}}|
 
}}|
  
function_description=This function will return the slot that any item is equipped to.</p>
+
function2={{Function|
 +
name={{#var:name}}|
 +
aggregate={{#var:aggregate}}|
 +
return_type={{#var:return_type}}|
 +
return_also={{#var:return_also}}|
 +
parameter1={{Param|string|slot}}|
 +
p1desc={{pspan|slot}} is the name of a slot that you want converted to the slot datatype.
 +
}}|
 +
 
 +
function_description=This function will return the slot to which any item would be equipped. Alternatively it will convert the name of a slot to the correct datatype.</p>
 
<p>Note:
 
<p>Note:
 
* Non-equipment items return $slot[none].
 
* Non-equipment items return $slot[none].

Revision as of 08:15, 3 May 2010

Function Syntax

slot to_slot(item equip )

  • equip is any item where you want to know which slot it is equipped to.

slot to_slot(string slot )

  • slot is the name of a slot that you want converted to the slot datatype.

This function will return the slot to which any item would be equipped. Alternatively it will convert the name of a slot to the correct datatype.

Note:

  • Non-equipment items return $slot[none].
  • Ranged and melee weapons return $slot[weapon], even if you have double fisted skull-smashing.
  • All accessories return $slot[acc1].

 

Code Samples

This code will equip a star sword if the slot it goes in is empty.

if(have_equipped(to_slot($item[star sword]) == $item[none]) {
   equip($item[star sword]);
}