imported>StDoodle |
imported>StDoodle |
| Line 1: |
Line 1: |
| − | {{Flink|int|my_meat|desc=Returns the amount of meat you have on hand.}} | + | {{ |
| − | {{Flink|int|my_closet_meat|desc=Returns the amount of meat you have in your Colossal Closet.}}
| + | #vardefine:name|shop_amount}}{{ |
| − | {{Flink|int|pulls_remaining|desc=Returns the number of pulls you can make from storage, or 0 if not applicable.}}
| + | #vardefine:return_type|int}}{{ |
| − | {{Flink|boolean|have_chef|desc=Returns true if you have a chef-boxen at your campground.}}
| |
| − | {{Flink|boolean|have_bartender|desc=Returns true if you have a bartender-boxen at your campground.}}
| |
| − | {{Flink|int [item]|get_campground|desc=Returns a map of your campground items.}}
| |
| − | {{Flink|boolean|have_mushroom_plot|desc=Returns true if and only if you've purchased a mushroom plot this run.}}
| |
| − | {{Flink|int|stills_available|desc=Returns the number of Nash Crosby's Still uses left for the day (0 if not accessible).}}
| |
| − | {{Flink|int|item_amount|item}}
| |
| − | {{Flink|int|closet_amount|item}}
| |
| − | {{Flink|int|equipped_amount|item}}
| |
| − | {{Flink|int|display_amount|item}}
| |
| − | {{Flink|int|shop_amount|item}}
| |
| − | {{Flink|int|storage_amount|item}}
| |
| − | {{Flink|int|stash_amount|item|desc=Returns the total number available of a given item in the respective section of your inventory.}}
| |
| − | {{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.}}
| |
| − | {{Flink|boolean|take_storage|int|item}}
| |
| − | {{Flink|boolean|take_closet|int|item}}
| |
| − | {{Flink|boolean|take_stash|int|item}} | |
| − | {{Flink|boolean|take_display|int|item}}
| |
| − | {{Flink|boolean|put_coset|int|item}} | |
| − | {{Flink|boolean|put_stash|int|item}}
| |
| − | {{Flink|boolean|put_display|int|item|desc=Attempts to take or put the specified item in the appropriate section of your inventory, and returns its success.}}
| |
| − | {{Flink|boolean|take_closet|int|desc=Attempts to move meat from your closet to on-hand and reports success.}}
| |
| − | {{Flink|boolean|put_closet|int|desc=Attempts to move meat from on-hand to your closet and reports success.}}
| |
| − | {{Flink|boolean|put_shop|int|int|item|}}
| |
| − | {{Flink|boolean|put_shop|int|int|int|item|desc=Puts items in your store (see page for details).}}
| |
| | | | |
| − | '''boolean [[put_shop()|put_shop( int price, int limit, item it )]]''' - places all of the associated [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] into your mall store at the desired price and with the associated limit on purchases per day, if possible. If the price is set to 0, then the current price will remain unchanged if you already have that item in your store. If you do not already have that item in your store and if the price is set to 0, then the price set will be 999,999,999 meat.
| + | FunctionPage| |
| | + | name={{#var:name}}| |
| | + | function_category=Item Management| |
| | | | |
| − | '''boolean [[put_shop()|put_shop( int price, int limit, int qty, item it )]]''' - Places qty of the item in the mall store, similar to the above.
| + | function1={{Function| |
| | + | name={{#var:name}}| |
| | + | aggregate={{#var:aggregate}}| |
| | + | return_type={{#var:return_type}}| |
| | + | return_also={{#var:return_also}}| |
| | + | parameter1={{Param|item|it}}| |
| | + | p1desc={{Pspan|it}} is the item to check| |
| | + | }}| |
| | | | |
| − | '''boolean [[buy()|buy( int quantity, item it )]]''' - tries to buy the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]]. First preference is given to NPC stores that you have access to and then, if possible, will buy the cheapest available items from the mall. When passing 0 or a negative number to the buy function, KoLmafia does nothing and automatically returns true.<br />
| + | function_description=Returns the amount of a given item that are currently for sale in your mall store.| |
| − | '''int [[buy()|buy( int quantity, item it, int price_limit )]]''' - tries to buy the specified number of [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]] at or below the specified price. Returns the number of items successfully purchased, which may be 0 if your limit is too low.
| + | needscode=yes| |
| − | | + | see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|item_amount|stash_amount|storage_amount}}| |
| − | '''boolean [[autosell()|autosell( int quantity, item it )]]''' - autosells the given [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]].
| + | }} |
| − | | |
| − | '''int [[autosell_price()|autosell_price( item it )]]''' - returns the autosell price of the [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]]. Non-discardable items return a negative value.
| |
| − | | |
| − | '''boolean [[mall_price()|mall_price( item it )]]''' - returns the current mall price of the given [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]].
| |
| − | | |
| − | '''boolean [[retrieve_item()|retrieve_item( int quantity, item it )]]''' - uses KoLmafia internal logic to gather the [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]] in the least destructive manner. See the “acquire” documentation in [http://kolmafia.sourceforge.net/scripting.html the CLI manual] for more details.
| |
| − | | |
| − | '''boolean [[hermit()|hermit( int quantity, item it )]]'''<br />
| |
| − | Buys the appropriate number of the given [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] from the Hermit, buying hermit permits and adventuring in the sewer for more worthless items if necessary.
| |
| − | | |
| − | '''boolean [[use()|use( int quantity, item it )]]'''<br />
| |
| − | '''boolean [[eat()|eat( int quantity, item it )]]'''<br />
| |
| − | '''boolean [[drink()|drink( int quantity, item it )]]'''<br />
| |
| − | Consumes the given [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]]. These are not interchangeable - food must be consumed with eat(), booze with drink(), and non-foods with use().
| |
| − | | |
| − | '''boolean [[create()|create( int quantity, item it )]]''' - attempts to create the specified [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|items]]. Depending on your in-game settings and conditions, this may involve buying ingredients for the items or servants to create the items for you.
| |
| − | | |
| − | '''int [[creatable_amount()|creatable_amount( item it )]]''' - returns the amount of the [[%28ASHRM%29_Datatype_Constants#.24item.5Bconstant.5D|item]] that you are capable of creating with your current inventory and skills.
| |
| − | | |
| − | '''int [item] [[get_ingredients()|get_ingredients( item it )]]''' - returns a map where each item key is a known ingredient and each int value is the number of that ingredient required. If you do not have the relevant skill to create the item from the ingredients, returns an empty map.
| |
| − | | |
| − | '''int [item] [[get_related|get_related( item it , string type )]]''' - type can be either "zap" or "fold". "zap" returns the zap group that the item is part of. The integer values in the map are meaningless in this case, and the item itself isn't included. "fold" returns the fold group that the item is part of. The integer is the position in the fold sequence (1..N), and the item itself IS included, so you can determine its position. Retrieves some variable-length internal data that isn't readily readable via file_to_map().
| |
| − | | |
| − | '''void [[refresh_stash()]]''' - takes a new look at the contents of your clan stash. Crucial if your clanmates have been manipulating the contents during your session.
| |
| − | | |
| − | '''boolean [[is_tradeable|is_tradeable( item it )]]''' - returns true if the item can be placed in the mall
| |
| − | | |
| − | '''boolean [[is_giftable|is_giftable( item it )]]''' - returns true for tradeable items and gift items like stuffies
| |
| − | | |
| − | '''boolean [[is_displayable|is_displayable( item it )]]''' - returns true for all items that can be put in a display case (all items but quest items)
| |
| − | | |
| − | '''boolean [[is_npc_item|is_npc_item( item it )]]''' - returns true for all items that can be bought from an NPC store
| |