Difference between revisions of "Equipment"

From Kolmafia
Jump to navigation Jump to search
imported>Fredg1
(→‎Equipment Commands: equipped_amount())
 
(34 intermediate revisions by 15 users not shown)
Line 1: Line 1:
−
[http://roycemotor.com/carpics/cache/eucpmo.html msn love avatars] [http://asie-voyages.com/upload/images/lens/rcpqgx.html movie myspace layouts] [http://www.norcab.com.au/joeavatiforum/templates/cache/nrtulr.html modern day explorers] [http://ankelia-nature.com/catalogues/catalogues/xbougp.html live nba player see they] [http://www.youthfitnesssolutions.com/FTP1/page9/oaiwxm.html investigator meetings] [http://talentmodeles.com/mannequin/images/cache/drotnf.html real estate investors clubs] [http://coastguard.gov.ph/content.old/license/mmkguq.html speech pathology degree programs] [http://tarsierfoundation.org/content/license/wbloin.html wood stapler] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/fxtspp.html nomura research institute] [http://asie-voyages.com/upload/images/lens/vpqelq.html inexpensive new york hotels] [http://panties-pictures.com/free/lib/temp/hsbsdo.html laminate book case] [http://www.norcab.com.au/joeavatiforum/templates/cache/bistkl.html wilkes college pa] [http://roycemotor.com/carpics/cache/elwdro.html jewish volunteer programs] [http://roycemotor.com/carpics/cache/pljgaw.html philippine picture sex storey virgin] [http://panties-pictures.com/free/lib/temp/ldhuto.html renaissance monarchs] [http://asie-voyages.com/upload/images/lens/gwtnes.html auction house england] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/klxooc.html average variable cost formula] [http://www.biblored.org.co/agenda_actividades/programas/images/hppnji.html pavement lyrics] [http://ankelia-nature.com/catalogues/catalogues/iahovp.html protection and computer viruses] [http://tarsierfoundation.org/content/license/ktxnco.html it leading provider services] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/btckia.html nissan skyline reviews] [http://hoosierfishing.com/phpBB/images/avatars/avatar/ufxcrc.html organic synthesis cholesterol] [http://tarsierfoundation.org/content/license/aeswwg.html american man seeking woman] [http://smallbizbohol.com/democatalog/images/baner/npxwmn.html when i am gone 3 doors down lyrics] [http://lumayagrealty.com/catalog/images/pics/fjtxod.html unix diff utility] [http://panties-pictures.com/free/lib/temp/mvnfcp.html anti virus free ware] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/jxkbhq.html xp password] [http://asie-voyages.com/upload/images/lens/osdlpl.html need for speed ii mp3] [http://indianaoutfitters.com/s/info/tmp/pfrfpk.html isos] [http://ankelia-nature.com/catalogues/catalogues/qiqgjv.html american legal reform] [http://roycemotor.com/carpics/cache/sjrpdm.html south australian] [http://asie-voyages.com/upload/images/lens/xdvcin.html news headlines archives] [http://ankelia-nature.com/catalogues/catalogues/cgfkvr.html steaks sale] [http://tch-voyages.com/documents/prague/896/qoxsok.html ro download] [http://xuccco.org/themes/AT-Green3/jdaslk.html university galway ireland] [http://www.norcab.com.au/joeavatiforum/templates/cache/qgaaes.html space fighter game] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/ojvtjm.html 9 11 photograph and pentagon] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/eunopv.html she died with her boots on] [http://coastguard.gov.ph/content.old/license/oeaeek.html japanese car importers canada] [http://cvscaft-tcc.edu.ph/gallery/uploads/cache/fwpvaw.html american woodworking] [http://hoosierfishing.com/phpBB/images/avatars/avatar/vwutvw.html lakeshore and michigan] [http://tarsierfoundation.org/content/license/ruixhp.html memorial dvd from slide show] [http://lumayagrealty.com/catalog/images/pics/tuficd.html ocean food chain diagrams] [http://xuccco.org/themes/AT-Green3/njrdkl.html autistic movies] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/dgcdel.html marriott key west florida] [http://roycemotor.com/carpics/cache/srbdxf.html rotts for sale in houston] [http://hoosierfishing.com/phpBB/images/avatars/avatar/xqrotq.html album song trey] [http://www.biblored.org.co/agenda_actividades/programas/images/iwivnp.html middle school graduation requirements] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/xpmxsf.html previous version] [http://panties-pictures.com/free/lib/temp/ijfmoj.html pattern pants woman] [http://panties-pictures.com/free/lib/temp/rhixwk.html advertising porcelain sign] [http://roycemotor.com/carpics/cache/hetxio.html minimum design loads for buildings and other structures] [http://www.biblored.org.co/agenda_actividades/programas/images/pjvjhs.html sf giants logos] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/tggerg.html lil jon mp3] [http://www.redacademica.edu.co/manejocorreo/Cliente/cache/txnskr.html textbook evaluation criteria] [http://panties-pictures.com/free/lib/temp/satxhs.html rpg maker xp resource] [http://hoosierfishing.com/phpBB/images/avatars/avatar/fkvseq.html mac tool calendar] [http://indianaoutfitters.com/s/info/tmp/jvpcox.html packaged bliss] [http://xuccco.org/themes/AT-Green3/jllfoh.html age discrimination lawsuit won] [http://www.hdac.org/hdfaq/faq/inggda.html secretary of state of south carolina] [http://hoosierfishing.com/phpBB/images/avatars/avatar/nlnahg.html illinois senate district map] [http://ankelia-nature.com/catalogues/catalogues/rpsamt.html artifical neural networks] [http://ankelia-nature.com/catalogues/catalogues/weksng.html the bond market] [http://www.biblored.org.co/agenda_actividades/programas/images/xrtftj.html ocean shores realty] [http://tch-voyages.com/documents/prague/896/eoklga.html usa inflation in 2004] [http://www.lewakins.com/sr/images/rarrxb.html wiring outlet switch] [http://www.norcab.com.au/joeavatiforum/templates/cache/mmemhm.html us news education schools] [http://www.norcab.com.au/joeavatiforum/templates/cache/xnkrnp.html satelliet] [http://xuccco.org/themes/AT-Green3/lelxft.html usage of the internet] [http://roycemotor.com/carpics/cache/mqdiou.html she knows who she is site myspace.com] [http://tch-voyages.com/documents/prague/896/jqoddt.html symptoms of staph skin infection] [http://www.lewakins.com/sr/images/fdaqqi.html pc phone gps] [http://www.youthfitnesssolutions.com/FTP1/page9/rpopcm.html valentine sms texts] [http://indianaoutfitters.com/s/info/tmp/avafai.html picture of bird the kite] [http://tarsierfoundation.org/content/license/oataea.html tardy policies in schools] [http://smallbizbohol.com/democatalog/images/baner/qfwaal.html snowflake airline] [http://smallbizbohol.com/democatalog/images/baner/sosfpq.html wholesale art supplies catalog] [http://tarsierfoundation.org/content/license/ebhteo.html lining of heart chambers] [http://indianaoutfitters.com/s/info/tmp/jmhfek.html rpg freeware game] [http://xuccco.org/themes/AT-Green3/dlqvdc.html in the original arrangement latin] [http://roycemotor.com/carpics/cache/adijht.html savannah sweet] [http://smallbizbohol.com/democatalog/images/baner/drlhee.html australia clear mountain] [http://talentmodeles.com/mannequin/images/cache/owvnax.html enter car] [http://www.youthfitnesssolutions.com/FTP1/page9/ujxams.html ocean city webcams] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/ffojto.html true colors tabs] [http://tarsierfoundation.org/content/license/dukqen.html lecister square london] [http://tch-voyages.com/documents/prague/896/cckotb.html picture frame craft project] [http://bluespringsbmx.com/4IMAGES/data/media/10/tmp/wqeepe.html extended laptop battery life] [http://smallbizbohol.com/democatalog/images/baner/dmedjk.html africa africa get in involved relief work] [http://www.lewakins.com/sr/images/cunwvk.html krome] [http://www.biblored.org.co/agenda_actividades/programas/images/ntdbdj.html used computers for sale vancouver] [http://talentmodeles.com/mannequin/images/cache/hvjshm.html i could never leave your beautiful eyes] [http://smallbizbohol.com/democatalog/images/baner/dhxgih.html adult as minors trying] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/fcuuha.html now baby just let me out] [http://xuccco.org/themes/AT-Green3/lhsffu.html atp i tennis tour] [http://tch-voyages.com/documents/prague/896/fobaql.html aquaculture career opportunity] [http://hoosierfishing.com/phpBB/images/avatars/avatar/wlrnoe.html in nature pattern] [http://www.sedbogota.edu.co/FINANCIERA/temp/tmp/grchkq.html inuyasha music i am] [http://roycemotor.com/carpics/cache/hjmktk.html you dont love me no more] [http://coastguard.gov.ph/content.old/license/meknnr.html service software version 4.0]
+
{{TOCright}}
−
== Part 3 - Equipment ==
+
==Equipment Commands==
−
<p><em>Time to get dressed!</em></p>
+
{{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.}}
  
−
<p><strong>boolean equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
+
==Outfit Commands==
−
Puts on the specified item in the &#8220;natural&#8221; slot.  For example, it won&#8217;t equip a weapon to the off-hand and it will only put a accessory into an empty slot.</p>
+
{{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.}}
  
−
<p><strong>boolean unequip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
+
[[Category:Scripting]]
−
Takes off one of the specified item.</p>
 
−
 
 
−
<p><strong>boolean equip_slot( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]], [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )<br />
 
−
boolean unequip_slot( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] )</strong><br />
 
−
Equipment management that targets a specific slot.</p>
 
−
 
 
−
<p><strong>item current_equipment( [[%28ASHRM%29_Datatype_Constants#.24slot.5Bconstant.5D|slot sl]] )</strong><br />
 
−
Returns the item currently equipped in the given slot.<br />
 
−
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]</p>
 
−
 
 
−
<p><strong>boolean have_equipped( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
 
−
Tells you if the specified item is currently equipped (as it would not otherwise show up in item_amount()).</p>
 
−
 
 
−
<p><strong>boolean can_equip( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
 
−
Tells you if you meet the requirements to equip the given item (regardless of whether you own it).</p>
 
−
 
 
−
<p><strong>string weapon_type( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
 
−
Returns a string indicating the type of weapon which was passed as a parameter.</p>
 
−
 
 
−
<p><strong>int weapon_hands( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|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.<br />
 
−
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]</p>
 
−
 
 
−
<p><strong>boolean ranged_weapon( [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item it]] )</strong><br />
 
−
Tells you if a weapon&#8217;s chance of hitting the opponent is based on your Moxie instead of your Muscle.</p>
 
−
 
 
−
<p><strong>boolean have_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] )</strong><br />
 
−
Tells you if you have placed the specified familiar in your Terrarium (or have it equipped now).</p>
 
−
 
 
−
<p><strong>boolean use_familiar( [[%28ASHRM%29_Datatype_Constants#.24familiar.5Bconstant.5D|familiar pet]] )</strong><br />
 
−
Takes the specified familiar out of your Terrarium.  Use equip() and unequip() to manage your familiar&#8217;s gear.</p>
 
−
 
 
−
<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 current_equipment( $slot[ familiar ]).</p>
 
−
 
 
−
<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.<br />
 
−
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_1:_Seltzer|Seltzer]]</p>
 
−
 
 
−
<p><strong>boolean outfit( string outfit_name )</strong><br />
 
−
Wears the specified outfit.<br />
 
−
<em>Sample</em>:[[%28ASHRM%29_Code_Samples#Sample_2:_Battlefield_gather|Battlefield_gather]]</p>
 

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"