Item Management - Revision history

Philmasterplus: /* Acquiring & Using Items */ Add clear_booze_helper(), clear_food_helper()

2021-07-13T14:26:51Z

Acquiring & Using Items: Add clear_booze_helper(), clear_food_helper()

← Older revision		Revision as of 14:26, 13 July 2021
Line 70:		Line 70:
	{{Flink\|boolean\|buy_using_storage\|int\|item}}		{{Flink\|boolean\|buy_using_storage\|int\|item}}
	{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}		{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}
			{{FunctionEmbed\|clear_booze_helper\|desc=yes}}
			{{FunctionEmbed\|clear_food_helper\|desc=yes}}
	{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}		{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
	{{FunctionEmbed\|drink\|desc=yes}}		{{FunctionEmbed\|drink\|desc=yes}}

Philmasterplus: Use Template:FunctionEmbed for drink(), eat()

2021-07-13T14:19:07Z

Use Template:FunctionEmbed for drink(), eat()

← Older revision		Revision as of 14:19, 13 July 2021
Line 71:		Line 71:
	{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}		{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}
	{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}		{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
	{{~~Flink\|boolean~~\|drink~~\|int\|item~~\|desc=~~Attempts to drink items as specified and reports success.~~}}		{{FunctionEmbed\|drink\|desc=yes}}
	{{~~Flink\|boolean~~\|eat~~\|int\|item~~\|desc=~~Attempts to eat items as specified and reports success.~~}}		{{FunctionEmbed\|eat\|desc=yes}}
	{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}		{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}
	{{Flink\|boolean\|chew\|int\|item\|desc=Attempts to chew spleen items as specified and reports success.}}		{{Flink\|boolean\|chew\|int\|item\|desc=Attempts to chew spleen items as specified and reports success.}}

Philmasterplus: /* Mall Prices */ Use Template:FunctionEmbed for historical_age(), historical_price(), mall_price()

2020-12-31T15:27:33Z

Mall Prices: Use Template:FunctionEmbed for historical_age(), historical_price(), mall_price()

← Older revision		Revision as of 15:27, 31 December 2020
Line 47:		Line 47:

	===Mall Prices===		===Mall Prices===
	{{~~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().~~}}		{{FunctionEmbed\|historical_age\|desc=yes}}
	{{~~Flink\|int~~\|historical_price~~\|item~~\|desc=~~Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().~~}}		{{FunctionEmbed\|historical_price\|desc=yes}}
	{{~~Flink\|int~~\|mall_price~~\|item~~\|desc=~~Returns the current (lowest) mall price of the given item.~~}}		{{FunctionEmbed\|mall_price\|desc=yes}}
	{{FunctionEmbed\|mall_prices\|desc=yes}}		{{FunctionEmbed\|mall_prices\|desc=yes}}

Philmasterplus: Add Mall Prices section, add mall_prices()

2020-12-31T13:50:17Z

Add Mall Prices section, add mall_prices()

← Older revision		Revision as of 13:50, 31 December 2020
Line 38:		Line 38:
	{{Flink\|void\|refresh_shop\|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}		{{Flink\|void\|refresh_shop\|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}
	{{Flink\|int\|shop_price\|item\|desc=Returns the current price for the given item if it is present in your mall store.}}		{{Flink\|int\|shop_price\|item\|desc=Returns the current price for the given item if it is present in your mall store.}}
	~~{{Flink\|int\|mall_price\|item\|desc=Returns the current (lowest) mall price of the given item.}}~~
	{{Flink\|int\|npc_price\|item\|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}		{{Flink\|int\|npc_price\|item\|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
	~~{{Flink\|int\|historical_price\|item\|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}~~
	~~{{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().}}~~
	{{Flink\|int\|autosell_price\|item\|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}		{{Flink\|int\|autosell_price\|item\|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
	{{Flink\|int\|get_power\|item\|desc=Returns the power of the item (0 for items that don't have a power).}}		{{Flink\|int\|get_power\|item\|desc=Returns the power of the item (0 for items that don't have a power).}}
Line 48:		Line 45:
	{{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.}}		{{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.}}
	{{Flink\|record [int]\|item_drops_array\|{{opt\|monster}}\|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}		{{Flink\|record [int]\|item_drops_array\|{{opt\|monster}}\|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

			===Mall Prices===
			{{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().}}
			{{Flink\|int\|historical_price\|item\|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
			{{Flink\|int\|mall_price\|item\|desc=Returns the current (lowest) mall price of the given item.}}
			{{FunctionEmbed\|mall_prices\|desc=yes}}

	==Moving Items Around==		==Moving Items Around==

Philmasterplus: /* Acquiring & Using Items */ Update overdrink()

2020-12-23T13:19:28Z

Acquiring & Using Items: Update overdrink()

← Older revision		Revision as of 13:19, 23 December 2020
Line 74:		Line 74:
	{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}		{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
	{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}		{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}
	{{~~Flink\|boolean~~\|overdrink\|~~int~~\|~~item~~}}		{{FunctionEmbed\|overdrink\|format=signature\|desc=yes}}
	{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}		{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
	{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}		{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}

Bale: All Sweet Synthesis skills as of r17644

2017-01-08T22:12:35Z

All Sweet Synthesis skills as of r17644

← Older revision		Revision as of 22:12, 8 January 2017
Line 96:		Line 96:
	{{Flink\|boolean\|buy\|coinmaster\|int\|item\|desc=Buys an item from a coinmaster.}}		{{Flink\|boolean\|buy\|coinmaster\|int\|item\|desc=Buys an item from a coinmaster.}}
	{{Flink\|boolean\|sell\|coinmaster\|int\|item\|desc=Sells an item to a coinmaster.}}		{{Flink\|boolean\|sell\|coinmaster\|int\|item\|desc=Sells an item to a coinmaster.}}

			===Sweet Synthesis===
			{{Flink\|item [int]\|candy_for_tier\|int\|{{opt\|int}}\|desc=Returns all the candy to create a given tier of effect.}}
			{{Flink\|item [int]\|sweet_synthesis_pairing\|effect\|item\|{{opt\|int}}\|desc=Find a second candy to synthesize.}}
			{{Flink\|item [int]\|sweet_synthesis_pair\|effect\|{{opt\|int}}\|desc=Picks a pair of candies to synthesize for an effect.}}
			{{Flink\|effect\|sweet_synthesis_result\|item\|item\|desc=Show result of synthesis.}}
			{{Flink\|boolean\|sweet_synthesis\|item\|item\|desc=Synthesize specified candies.}}
			{{Flink\|boolean\|sweet_synthesis\|effect\|{{opt\|int}}\|desc=Picks a pair of candies and synthesizes them for the effect.}}


	[[Category:Scripting]]		[[Category:Scripting]]

Bale: added get_clan_lounge() in r17077

2016-08-01T17:22:01Z

added get_clan_lounge() in r17077

← Older revision		Revision as of 17:22, 1 August 2016
Line 8:		Line 8:
	{{Flink\|boolean\|have_bartender\|desc=Returns true if you have a bartender-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\|int [item]\|get_campground\|desc=Returns a map of your campground items.}}
			{{Flink\|int [item]\|get_clan_lounge\|desc=Returns a map of your Clan VIP Lounge items.}}
	{{Flink\|item\|get_dwelling\|desc=Returns the item corresponding with your dwelling.}}		{{Flink\|item\|get_dwelling\|desc=Returns the item corresponding with your dwelling.}}
	{{Flink\|boolean\|have_mushroom_plot\|desc=Returns true if and only if you've purchased a mushroom plot this run.}}		{{Flink\|boolean\|have_mushroom_plot\|desc=Returns true if and only if you've purchased a mushroom plot this run.}}

Theo: /* Acquiring & Using Items */

2016-05-29T11:02:29Z

Acquiring & Using Items

← Older revision		Revision as of 11:02, 29 May 2016
Line 70:		Line 70:
	{{Flink\|boolean\|eat\|int\|item\|desc=Attempts to eat items as specified and reports success.}}		{{Flink\|boolean\|eat\|int\|item\|desc=Attempts to eat items as specified and reports success.}}
	{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}		{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}
			{{Flink\|boolean\|chew\|int\|item\|desc=Attempts to chew spleen items as specified and reports success.}}
	{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}		{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
	{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}		{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}

Bale: is_discardable

2014-11-10T10:44:44Z

is_discardable

← Older revision		Revision as of 10:44, 10 November 2014
Line 30:		Line 30:
	{{Flink\|boolean\|is_giftable\|item\|desc=Returns whether the item can be traded in a gift package.}}		{{Flink\|boolean\|is_giftable\|item\|desc=Returns whether the item can be traded in a gift package.}}
	{{Flink\|boolean\|is_displayable\|item\|desc=Returns whether the item can be put in a display case (true for all but quest items).}}		{{Flink\|boolean\|is_displayable\|item\|desc=Returns whether the item can be put in a display case (true for all but quest items).}}
			{{Flink\|boolean\|is_discardable\|item\|desc=Returns whether the item can be discarded or autosold.}}
	{{Flink\|boolean\|have_shop\|desc=Returns whether you have a mall store.}}		{{Flink\|boolean\|have_shop\|desc=Returns whether you have a mall store.}}
	{{Flink\|boolean\|have_display\|desc=Returns whether you have a display case.}}		{{Flink\|boolean\|have_display\|desc=Returns whether you have a display case.}}

Bale: buy_using_storage

2014-11-06T08:21:49Z

buy_using_storage

← Older revision		Revision as of 08:21, 6 November 2014
Line 61:		Line 61:
	==Acquiring & Using Items==		==Acquiring & Using Items==
	{{Flink\|boolean\|autosell\|int\|item\|desc=Attempts to autosell the given items and reports success.}}		{{Flink\|boolean\|autosell\|int\|item\|desc=Attempts to autosell the given items and reports success.}}
	{{Flink\|boolean\|buy\|int\|item}}		{{Flink\|boolean\|buy\|{{opt\|coinmaster}}\|int\|item}}
			{{Flink\|int\|buy\|int\|item\|int\|desc=Tries to purchase the specified items.}}
			{{Flink\|boolean\|buy_using_storage\|int\|item}}
			{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}
	{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}		{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
	{{Flink\|boolean\|drink\|int\|item\|desc=Attempts to drink items as specified and reports success.}}		{{Flink\|boolean\|drink\|int\|item\|desc=Attempts to drink items as specified and reports success.}}
Line 70:		Line 73:
	{{Flink\|boolean\|overdrink\|int\|item}}		{{Flink\|boolean\|overdrink\|int\|item}}
	{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}		{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
	~~{{Flink\|int\|buy\|int\|item\|int\|desc=Tries to purchase the specified items (see page for details).}}~~
	{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}		{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}
	{{Flink\|string\|last_item_message\|desc=Returns message that KoL reports in the event of error.}}		{{Flink\|string\|last_item_message\|desc=Returns message that KoL reports in the event of error.}}

← Older revision		Revision as of 14:26, 13 July 2021
Line 70:		Line 70:
	{{Flink\|boolean\|buy_using_storage\|int\|item}}		{{Flink\|boolean\|buy_using_storage\|int\|item}}
	{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}		{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}
			{{FunctionEmbed\|clear_booze_helper\|desc=yes}}
			{{FunctionEmbed\|clear_food_helper\|desc=yes}}
	{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}		{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
	{{FunctionEmbed\|drink\|desc=yes}}		{{FunctionEmbed\|drink\|desc=yes}}

← Older revision		Revision as of 14:19, 13 July 2021
Line 71:		Line 71:
	{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}		{{Flink\|int\|buy_using_storage\|int\|item\|int\|desc=Tries to purchase the specified items using meat in Hangks.}}
	{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}		{{Flink\|boolean\|create\|int\|item\|desc=Attempts to create the specified items, following your KoLmafia settings regarding purchases to gather ingredients & require boxen.}}
	{{~~Flink\|boolean~~\|drink~~\|int\|item~~\|desc=~~Attempts to drink items as specified and reports success.~~}}		{{FunctionEmbed\|drink\|desc=yes}}
	{{~~Flink\|boolean~~\|eat~~\|int\|item~~\|desc=~~Attempts to eat items as specified and reports success.~~}}		{{FunctionEmbed\|eat\|desc=yes}}
	{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}		{{Flink\|boolean\|eatsilent\|int\|item\|desc=Attempts to eat items as specified.}}
	{{Flink\|boolean\|chew\|int\|item\|desc=Attempts to chew spleen items as specified and reports success.}}		{{Flink\|boolean\|chew\|int\|item\|desc=Attempts to chew spleen items as specified and reports success.}}

← Older revision		Revision as of 15:27, 31 December 2020
Line 47:		Line 47:

	===Mall Prices===		===Mall Prices===
	{{~~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().~~}}		{{FunctionEmbed\|historical_age\|desc=yes}}
	{{~~Flink\|int~~\|historical_price~~\|item~~\|desc=~~Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().~~}}		{{FunctionEmbed\|historical_price\|desc=yes}}
	{{~~Flink\|int~~\|mall_price~~\|item~~\|desc=~~Returns the current (lowest) mall price of the given item.~~}}		{{FunctionEmbed\|mall_price\|desc=yes}}
	{{FunctionEmbed\|mall_prices\|desc=yes}}		{{FunctionEmbed\|mall_prices\|desc=yes}}

← Older revision		Revision as of 13:50, 31 December 2020
Line 38:		Line 38:
	{{Flink\|void\|refresh_shop\|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}		{{Flink\|void\|refresh_shop\|desc=Takes a new look at the contents of your mall store, as that section of inventory cannot be internally tracked due to access by others.}}
	{{Flink\|int\|shop_price\|item\|desc=Returns the current price for the given item if it is present in your mall store.}}		{{Flink\|int\|shop_price\|item\|desc=Returns the current price for the given item if it is present in your mall store.}}
	~~{{Flink\|int\|mall_price\|item\|desc=Returns the current (lowest) mall price of the given item.}}~~
	{{Flink\|int\|npc_price\|item\|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}		{{Flink\|int\|npc_price\|item\|desc=Returns the current price of the given item if it can currently be bought from an NPC store.}}
	~~{{Flink\|int\|historical_price\|item\|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}~~
	~~{{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().}}~~
	{{Flink\|int\|autosell_price\|item\|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}		{{Flink\|int\|autosell_price\|item\|desc=Returns the autosell price of the item (0 for items that cannot be autosold).}}
	{{Flink\|int\|get_power\|item\|desc=Returns the power of the item (0 for items that don't have a power).}}		{{Flink\|int\|get_power\|item\|desc=Returns the power of the item (0 for items that don't have a power).}}
Line 48:		Line 45:
	{{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.}}		{{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.}}
	{{Flink\|record [int]\|item_drops_array\|{{opt\|monster}}\|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}		{{Flink\|record [int]\|item_drops_array\|{{opt\|monster}}\|desc=Returns an array of records holding information regarding a certain monster's base item drops.}}

			===Mall Prices===
			{{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().}}
			{{Flink\|int\|historical_price\|item\|desc=Returns the most recently checked price for an item. This will never hit the server, unlike mall_price().}}
			{{Flink\|int\|mall_price\|item\|desc=Returns the current (lowest) mall price of the given item.}}
			{{FunctionEmbed\|mall_prices\|desc=yes}}

	==Moving Items Around==		==Moving Items Around==

← Older revision		Revision as of 13:19, 23 December 2020
Line 74:		Line 74:
	{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}		{{Flink\|boolean\|hermit\|int\|item\|desc=Trades worthless items (buying and using chewing gum if needed) to the hermit for specified items (see page for details).}}
	{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}		{{Flink\|boolean\|use\|int\|item\|desc=Attempts to use items as specified and reports success.}}
	{{~~Flink\|boolean~~\|overdrink\|~~int~~\|~~item~~}}		{{FunctionEmbed\|overdrink\|format=signature\|desc=yes}}
	{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}		{{Flink\|boolean\|retrieve_item\|int\|item\|desc=Uses KoLmafia internal logic to gather items (see page for details).}}
	{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}		{{Flink\|int\|craft\|string\|int\|item\|item\|desc=Raw crafting that obeys KoLmafia settings (see page for details).}}