Equipment: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
No edit summary
imported>Fredg1
→‎Equipment Commands: equipped_amount()
 
(38 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[http://princebuster.behav.info/ prince buster] [http://mp3dawsonscreek.etotest.info/ mp3 dawson s creek] [http://stampantihplaserjet.alient.info/ stampanti hp laserjet 6l] [http://autonoleggioanzio.wedged.info/ auto noleggio anzio] [http://giornaleporta.demogen.info/ giornale porta portese] [http://faitebricolage.wedged.info/ fai te bricolage] [http://lawu.skains.info/ lawu] [http://iesololido.alient.info/ iesolo lido] [http://albergopermeeting.demogen.info/ albergo per meeting e conventions rimini] [http://thermaltakearmor.alient.info/ thermaltake armor silver] [http://passatswdiesel.behav.info/ passat sw diesel] [http://yankeeprogdvb.etotest.info/ yankee progdvb] [http://videoporrno.skains.info/ video porrno] [http://volkswagenpolohighline.alient.info/ volkswagen polo highline 2001] [http://hotelmadagascar.alient.info/ hotel madagascar] [http://wwwmediait.alient.info/ www media it] [http://gliastronomi.behav.info/ gli astronomi] [http://advanracing.etotest.info/ advan racing] [http://linkmagnat.etotest.info/ link magnat] [http://canonmv700i.alient.info/ canon mv 700i] [http://curanaturale.behav.info/ cura naturale] [http://pim.wedged.info/ pim] [http://joystickplaystation.demogen.info/ joystick playstation 2] [http://kateryanlapro.behav.info/ kate ryan la pro] [http://bubblinblue.skains.info/ bubblin blue] [http://hildegardofbingen.enlard.info/ hildegard of bingen] [http://batteriecanon.etotest.info/ batterie canon nb 1lh] [http://profumischon.alient.info/ profumi schon] [http://ifidanzatidella.demogen.info/ i fidanzati della morte] [http://microfonofrequenza.enlard.info/ microfono frequenza] [http://anellicondiamanti.etotest.info/ anelli con diamanti] [http://anubi.etotest.info/ anubi] [http://wwwdonneperverse.skains.info/ www donne perverse it] [http://dockingstation.alient.info/ docking station serie m] [http://prezzimacchine.skains.info/ prezzi macchine digitali] [http://scontivolopraga.wedged.info/ sconti volo praga] [http://mfe.alient.info/ mfe] [http://puffdaddycome.enlard.info/ puff daddy come with me] [http://mistral.demogen.info/ mistral] [http://autonoleggiogrosseto.etotest.info/ auto noleggio grosseto] [http://musicistipiano.skains.info/ musicisti piano bar messina] [http://ftvkylie.skains.info/ ftv kylie] [http://figueiradafoz.enlard.info/ figueira da foz] [http://keenenivorywayans.skains.info/ keenen ivory wayans] [http://pokornit.behav.info/ pokorn it] [http://quadricavalli.behav.info/ quadri cavalli] [http://etotest.info/index3_1000.html index] [http://ploiesteanu.wedged.info/ ploiesteanu] [http://giochidipasqua.etotest.info/ giochi di pasqua] [http://ruda.alient.info/ ruda] [http://comoli.etotest.info/ comoli] [http://levacomandi.wedged.info/ leva comandi] [http://riassuntomalavoglia.skains.info/ riassunto malavoglia di verga] [http://krawczykibartosiewicz.skains.info/ krawczyk i bartosiewicz] [http://wwwsuperit.skains.info/ www super it] [http://cassaintegrazione.alient.info/ cassa integrazione regolamento] [http://giochixpc.skains.info/ giochi x pc] [http://newall.etotest.info/ newall] [http://bennatomediterraneo.wedged.info/ bennato mediterraneo] [http://toplessonthe.demogen.info/ topless on the beach 2007] [http://wwwcorpoforestale.skains.info/ www corpo forestale it] [http://z300samsungtim.wedged.info/ z300 samsung tim] [http://canon430.behav.info/ canon 430] [http://castlecatadventures.enlard.info/ castle cat adventures] [http://frankiehinrg.enlard.info/ frankie hinrg] [http://skains.info/index0_1000.html home] [http://tavolettegrafiche.enlard.info/ tavolette grafiche] [http://mariah.enlard.info/ mariah] [http://trucetastuces.behav.info/ truc et astuces] [http://ire.behav.info/ ire] [http://chabnasro.etotest.info/ chab nasro] [http://aristonscaldabagni.demogen.info/ ariston scaldabagni 80] [http://hooveroctopus.behav.info/ hoover octopus 2000] [http://bigliettoaereo.wedged.info/ biglietto aereo napoli palermo] [http://clikkaepunta.demogen.info/ clikka e punta] [http://zeligoffnuovi.alient.info/ zelig off nuovi comici] [http://wedged.info/index2_500.html url] [http://spille.demogen.info/ spille] [http://volkswagenpolo.alient.info/ volkswagen polo 1 4 tdi] [http://inpdapgovit.alient.info/ inpdap gov it] [http://concorsodirettivo.behav.info/ concorso direttivo] [http://imospa.wedged.info/ imo spa] [http://garyjules.enlard.info/ gary jules] [http://lisoladeidimenticati.wedged.info/ lisola dei dimenticati] [http://snoopgogg.alient.info/ snoop gogg] [http://wwweduissit.etotest.info/ www edu iss it] [http://coppia21.alient.info/ coppia 21] [http://teensexwithold.etotest.info/ teen sex with old men] [http://pornofiga.behav.info/ porno figa] [http://headtis6.enlard.info/ head ti s6] [http://alienattack.alient.info/ alien attack] [http://kara.behav.info/ kara] [http://laspeziaprovincia.skains.info/ la spezia provincia] [http://vanninolago.enlard.info/ vannino lago-] [http://caseproduzionecinematografica.wedged.info/ case produzione cinematografica] [http://okiml3410.behav.info/ oki ml3410] [http://marinterior.etotest.info/ mar interior] [http://alient.info/index1_500.html map] [http://marcomasiniit.wedged.info/ marcomasini it] [http://umorgif.alient.info/ umor gif]
{{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; slotFor 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.