Difference between revisions of "Equipment"

From Kolmafia
Jump to navigation Jump to search
imported>Fredg1
(→‎Equipment Commands: equipped_amount())
 
(29 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
[http://avelinabranum.ifrance.com/topic/march-music.html march music festivals] [http://avelinabranum.ifrance.com/topic/mike-in-brasil.html mike in brasil] [http://aftermida.freehostia.com/content/application-computer.html application computer supported telephony] [http://my-rss.freehostia.com/web/collin-county.html collin county appraisal district] [http://danyelmcmann.ifrance.com/resources/mohawk-carpet.htm mohawk carpet] [http://mipafford.ifrance.com/lib/women-having-orgasm.html women having orgasm] [http://avelinabranum.ifrance.com/topic/avi-mpeg-to-dvd.html avi mpeg to dvd convertor] [http://balthrop.ifrance.com/description/northrup-grumman.html northrup grumman] [http://my-rss.freehostia.com/web/phone-sex-directory.html phone sex directory] [http://balthrop.ifrance.com/description/spooky.html spooky] [http://dahliacomerford.ifrance.com/lib/naughty-toons.html naughty toons] [http://serega-baranka.jino-net.ru/dragonballz-porn.html dragonballz porn] [http://mariamgetz.ifrance.com/hillary-duff-sex.html hillary duff sex] [http://danyelmcmann.ifrance.com/resources/shoes-speed-training.htm shoes speed training] [http://tata-tjan.freehostia.com/nikon-d70s-review.htm nikon d70s review] [http://bel4onok-spb.jino-net.ru/library/sexfarsi.html sexfarsi] [http://lana-lapusya.freehostia.com/high-fructose-corn.html high fructose corn syrup] [http://sybilcasiano.ifrance.com/view/amateur-sex-blogs.html amateur sex blogs] [http://dahliacomerford.ifrance.com/lib/one-night-in-paris.html one night in paris hilton] [http://gladygendreau.ifrance.com/description/sexy-photography.htm sexy photography] [http://balthrop.ifrance.com/description/bareback-men.html bareback men] [http://gladygendreau.ifrance.com/description/virginia-hardwoods.htm virginia hardwoods] [http://dahliacomerford.ifrance.com/lib/clitoral-piercing.html clitoral piercing] [http://aftermida.freehostia.com/content/kiss-the-band.html kiss the band] [http://my-rss.freehostia.com/web/volleyball-tshirts.html volleyball tshirts] [http://bel4onok-spb.jino-net.ru/library/breaking-benjamin.html breaking benjamin] [http://lana-lapusya.freehostia.com/retro-jordan.html retro jordan] [http://sunshine-queen.freehostia.com/view/winmix.html winmix] [http://danyelmcmann.ifrance.com/resources/atlantic-city-best.htm atlantic city best western] [http://mariamgetz.ifrance.com/quotes-and-poems.html quotes and poems] [http://mipafford.ifrance.com/lib/boardshorts.html boardshorts] [http://balthrop.ifrance.com/description/negotiate-a-loan.html negotiate a loan] [http://sunshine-queen.freehostia.com/view/trophy.html trophy] [http://serega-baranka.jino-net.ru/armoire.html armoire] [http://aesher.freehostia.com/manual.html manual] [http://serega-baranka.jino-net.ru/hair-cuts.html hair cuts] [http://lana-lapusya.freehostia.com/knife-making-supplies.html knife making supplies] [http://dahliacomerford.ifrance.com/lib/osu-cowboys.html osu cowboys baseball jerseys] [http://nat-z.freehostia.com/small/very-hot-asians.html very hot asians] [http://aftermida.freehostia.com/content/lesbian-erotic.html lesbian erotic stories] [http://therapia90.ifrance.com/reseller-terms.html reseller terms and conditions] [http://mipafford.ifrance.com/lib/brittany-spears.html brittany spears pussy] [http://lana-lapusya.freehostia.com/tink.html tink] [http://aftermida.freehostia.com/content/kid-porno.html kid porno] [http://therapia90.ifrance.com/infant-rash.html infant rash after fever] [http://lana-lapusya.freehostia.com/male-celebrities.html male celebrities] [http://nat-z.freehostia.com/small/who-wrote-the.html who wrote the gospel of mark] [http://balthrop.ifrance.com/description/inflammation.html inflammation and heart health] [http://my-rss.freehostia.com/web/chloe-anderson.html chloe anderson] [http://sybilcasiano.ifrance.com/view/authorial.html authorial] [http://veronikac.jino-net.ru/small/hertz-rental-cars.html hertz rental cars] [http://danyelmcmann.ifrance.com/resources/pleated-shades.htm pleated shades] [http://mariamgetz.ifrance.com/still-waiting.html still waiting] [http://tata-tjan.freehostia.com/e815.htm e815] [http://gladygendreau.ifrance.com/description/hard-sex-gallery.htm hard sex gallery] [http://bel4onok-spb.jino-net.ru/library/mature-titty-fucking.html mature titty fucking] [http://mcjonath.freehostia.com/lib/cuckold.htm cuckold] [http://balthrop.ifrance.com/description/kitchen-waste-can.html kitchen waste can] [http://sybilcasiano.ifrance.com/view/free-nude-preteens.html free nude preteens] [http://lana-lapusya.freehostia.com/carrie-wescott.html carrie wescott] [http://aftermida.freehostia.com/content/mother-son-hot.html mother son hot sex] [http://nat-z.freehostia.com/small/hummus-recipe.html hummus recipe] [http://aesher.freehostia.com/learn-spanish.html learn spanish] [http://danyelmcmann.ifrance.com/resources/miniature-schnauzers.htm miniature schnauzers] [http://sunshine-queen.freehostia.com/view/outdoor-grill.html outdoor grill] [http://tata-tjan.freehostia.com/example-reference.htm example reference letters] [http://bulatovmz.freehostia.com/data/car-problems.html car problems] [http://gladygendreau.ifrance.com/description/carseats.htm carseats] [http://my-rss.freehostia.com/web/little-blonde.html little blonde] [http://aesher.freehostia.com/mansions.html mansions] [http://tata-tjan.freehostia.com/free-amature-sex.htm free amature sex] [http://aesher.freehostia.com/crimes.html crimes] [http://mipafford.ifrance.com/lib/gourmet-food-store.html gourmet food store los angeles] [http://mcjonath.freehostia.com/lib/celtic-tattoo.htm celtic tattoo art] [http://mcjonath.freehostia.com/lib/male-strip-poker.htm male strip poker] [http://sunshine-queen.freehostia.com/view/lrg-clothing.html lrg clothing] [http://aftermida.freehostia.com/content/swingset.html swingset] [http://dahliacomerford.ifrance.com/lib/reviews-of-external.html reviews of external hard drives] [http://bel4onok-spb.jino-net.ru/library/wedding-party.html wedding party supplies] [http://tata-tjan.freehostia.com/dibujos.htm dibujos] [http://aesher.freehostia.com/brittany-spaniel.html brittany spaniel] [http://mipafford.ifrance.com/lib/california-department.html california department of motor vehicles] [http://mcjonath.freehostia.com/lib/right-food-combination.htm right food combination to eat] [http://mipafford.ifrance.com/lib/tongue-fetish.html tongue fetish] [http://danyelmcmann.ifrance.com/resources/conspiracies.htm conspiracies] [http://danyelmcmann.ifrance.com/resources/lauren-nude.htm lauren nude] [http://mipafford.ifrance.com/lib/aroma-bead-wholesale.html aroma bead wholesale distributors] [http://sybilcasiano.ifrance.com/view/inflatable-boat.html inflatable boat] [http://tata-tjan.freehostia.com/new-york-state.htm new york state mock trial competition] [http://avelinabranum.ifrance.com/topic/compare-term-life.html compare term life insurance quote] [http://avelinabranum.ifrance.com/topic/bonaire.html bonaire] [http://gladygendreau.ifrance.com/description/christian-books.htm christian books] [http://mariamgetz.ifrance.com/picture-of-police.html picture of police dog] [http://mipafford.ifrance.com/lib/shoko-goto.html shoko goto] [http://veronikac.jino-net.ru/small/hypnosex.html hypnosex] [http://nat-z.freehostia.com/small/prelolita-bbs.html prelolita bbs] [http://mipafford.ifrance.com/lib/tux.html tux] [http://balthrop.ifrance.com/description/airport-shuttles.html airport shuttles chicago il] [http://mcjonath.freehostia.com/lib/fossil-watches.htm fossil watches] [http://nat-z.freehostia.com/small/adobe-acroread.html adobe acroread mac os x]
+
{{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"