https://wiki.kolmafia.us/api.php?action=feedcontributions&feedformat=atom&user=88.160.37.38 Kolmafia - User contributions [en] 2026-04-24T21:19:07Z User contributions MediaWiki 1.44.0 https://wiki.kolmafia.us/index.php?title=Item_type&diff=4951 Item type 2010-07-07T12:48:20Z <p>88.160.37.38: changed category</p> <hr /> <div>{{<br /> #vardefine:name|item_type}}{{<br /> #vardefine:return_type|string}}{{<br /> <br /> FunctionPage|<br /> name={{#var:name}}|<br /> <br /> function1={{Function|<br /> name={{#var:name}}|<br /> aggregate={{#var:aggregate}}|<br /> return_type={{#var:return_type}}|<br /> return_also={{#var:return_also}}|<br /> parameter1={{Param|item|check_me}}|<br /> p1desc={{Pspan|check_me}} is the equipment to check|<br /> }}|<br /> <br /> function_description=Returns the type of equipment that {{pspan|check_me}} is categorized as. Possible values are hat, [http://kol.coldfront.net/thekolwiki/index.php/Category:Weapons (various weapon types)], shield, offhand, pants, accessory, familiar equipment, shirt, container, hp restore, mp restore, hp+mp restore, food, booze, drink helper, food helper, and familiar larva.|<br /> <br /> code1={{CodeSample|<br /> title=Simple Example|<br /> description=A universal consume function.|<br /> code=<br /> &lt;syntaxhighlight&gt;<br /> if(item_type(it)==&quot;food&quot;) eat(qty,it);<br /> else if(item_type(it)==&quot;booze&quot;) drink(qty,it);<br /> else use(qty,it);<br /> // Note: this example doesn't check your drunkenness, so it isn't practical for normal use.<br /> &lt;/syntaxhighlight&gt;}}<br /> <br /> {{SeeAlso|weapon_hands|weapon_type}}|<br /> special= For non-equipment, this function returns an empty string.|<br /> }}<br /> <br /> [[Category:Item Management]]</div> 88.160.37.38 https://wiki.kolmafia.us/index.php?title=Equipment&diff=804 Equipment 2010-07-07T12:47:49Z <p>88.160.37.38: removed item_type()</p> <hr /> <div>{{Flink|boolean|equip|{{opt|slot}}|item|desc=Equips the specified item and reports success.}}<br /> {{Flink|item|equipped_item|slot|desc=Returns the item equipped in the specified slot.}}<br /> {{Flink|boolean|have_equipped|item|desc=Reports if the specified item is currently equipped by your character.}}<br /> {{Flink|boolean|can_equip|item|desc=Tells if you meet the requirements for equipping the given item (regardless of its availability).}}<br /> {{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.}}<br /> {{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].}}<br /> {{Flink|boolean|have_familiar|familiar|desc=Reports on whether you have the specified familiar either in your Terrarium or equipped.}}<br /> {{Flink|boolean|use_familiar|familiar|desc=Attempts to make the specified familiar your currently used one and reports success.}}<br /> {{Flink|item|familiar_equipment|familiar|desc=Reports the most commonly associated familiar equipment for the specified familiar.}}<br /> {{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).}}<br /> {{Flink|boolean|enthrone|familiar|desc=Enthrones the specified familiar.}}<br /> {{Flink|familiar|my_enthroned_familiar|desc=Returns the familiar currently enthroned.}}<br /> {{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 &amp; inventory availability of all outfit pieces.}}<br /> {{Flink|boolean|outfit|string|desc=Attempts to wear the specified outfit and reports success.}}<br /> [[Category:ASH Scripting]]</div> 88.160.37.38 https://wiki.kolmafia.us/index.php?title=Item_Management&diff=4213 Item Management 2010-07-07T12:47:42Z <p>88.160.37.38: added item_type()</p> <hr /> <div>{{TOCright}}<br /> ==Informational==<br /> {{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}}<br /> {{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}<br /> {{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}<br /> {{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}<br /> {{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}<br /> {{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}<br /> {{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}<br /> {{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}<br /> {{Flink|int|item_amount|item}}<br /> {{Flink|string|item_type|item|desc=Returns the type of item specified.}}<br /> {{Flink|int|closet_amount|item}}<br /> {{Flink|int|display_amount|item}}<br /> {{Flink|int|equipped_amount|item}}<br /> {{Flink|int|shop_amount|item}}<br /> {{Flink|int|stash_amount|item|}}<br /> {{Flink|int|storage_amount|item|desc=These 7 functions return the total number available of a given item in the respective section of your inventory.}}<br /> {{Flink|int|available_amount|item|desc=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions.}}<br /> {{Flink|int|creatable_amount|item|desc=Returns the amount of the item that you are capable of creating given your current inventory and skills.}}<br /> {{Flink|int [item]|get_ingredients|item|desc=Returns a map where each key is one of the required ingredients, with the integer value the number required. If you don't have the skills needed to make the item, it will return an empty map.}}<br /> {{Flink|int [item]|get_inventory|desc=Returns a map where each key is an item in your inventory, with the integer value its quantity.}}<br /> {{Flink|int [item]|get_related|item|string|desc=Returns associated items in a zap or fold group (see page for details).}}<br /> [[File:Item category.png|frame|You can categorize items in KoL using [[is tradeable|is_tradeable()]], [[is giftable|is_giftable()]], and [[is displayable|is_displayable()]].]]<br /> {{Flink|boolean|is_tradeable|item|desc=Returns whether the item can be placed in the mall.}}<br /> {{Flink|boolean|is_giftable|item|desc=Returns whether the item can be traded in a gift package.}}<br /> {{Flink|boolean|is_displayable|item|desc=Returns whether the item can be put in a display case (true for all but quest items).}}<br /> {{Flink|boolean|have_shop|desc=Returns whether you have a mall store.}}<br /> {{Flink|boolean|have_display|desc=Returns whether you have a display case.}}<br /> {{Flink|boolean|is_npc_item|item|desc=Returns whether the item can be bought from an NPC store.}}<br /> {{Flink|void|refresh_stash|desc=Takes a new look at the contents of your clan stash, as that section of inventory cannot be internally tracked due to access by others.}}<br /> {{Flink|boolean|mall_price|item|desc=Returns the current (lowest) mall price of the given item.}}<br /> {{Flink|int|historical_price|item|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}<br /> {{Flink|float|historical_age|item|desc=Returns the age of the most recently checked price for an item in days. This allows you to decide if you want to use historical_price() or mall_price().}}<br /> {{Flink|int|autosell_price|item|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}<br /> {{Flink|int|get_power|item|desc=Returns the power of the item (0 for items that don't have a power).}}<br /> {{Flink|string|to_plural|item|desc=Returns the plural of an item as a string.}}<br /> {{Flink|int|meat_drop|{{opt|monster}}|desc=Returns a certain monster's base meat drop.}}<br /> {{Flink|int [item]|item_drops|{{opt|monster}}|desc=Returns an array of a certain monster's base item drops, keying item to drop rate. Has certain limitations detailed on individual page.}}<br /> {{Flink|record [int]|item_drops_array|{{opt|monster}}|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}<br /> <br /> ==Moving Items Around==<br /> {{Flink|boolean|put_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|put_display|int|item}}<br /> {{Flink|boolean|put_stash|int|item}}<br /> {{Flink|boolean|take_closet|int|{{opt|item}}}}<br /> {{Flink|boolean|take_display|int|item}}<br /> {{Flink|boolean|take_stash|int|item}}<br /> {{Flink|boolean|take_storage|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success.&lt;br /&gt;If the item parameter is omitted from put_closet() or take_closet(), meat is transferred instead of an item.}}<br /> {{Flink|boolean|put_shop|int|int|{{opt|int}}|item|desc=Puts items in your store (see page for details).}}<br /> <br /> ==Acquiring &amp; Using Items==<br /> {{Flink|boolean|retrieve_item|int|item|desc=Uses KoLmafia internal logic to gather items (see page for details).}}<br /> {{Flink|boolean|hermit|int|item|desc=Trades worthless items (adventuring in the sewer if needed) to the hermit for specified items (see page for details).}}<br /> {{Flink|boolean|use|int|item|desc=Attempts to use items as specified and reports success.}}<br /> {{Flink|boolean|eatsilent|int|item}}<br /> {{Flink|boolean|eat|int|item|desc=Attempts to eat items as specified and reports success.}}<br /> {{Flink|boolean|overdrink|int|item}}<br /> {{Flink|boolean|drink|int|item|desc=Attempts to drink items as specified and reports success.}}<br /> {{Flink|boolean|create|int|item|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients &amp; require boxen.}}<br /> {{Flink|boolean|buy|int|item}}<br /> {{Flink|int|buy|int|item|int|desc=Tries to purchase the specified items (see page for details).}}<br /> {{Flink|boolean|autosell|int|item|desc=Attempts to autosell the given items and reports success.}}<br /> {{Flink|int|craft|string|int|item|item|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}<br /> [[Category:ASH Scripting]]</div> 88.160.37.38