Drink - Revision history

Philmasterplus: Add Template:SeeAlso/Booze Management

2021-07-13T14:33:30Z

← Older revision		Revision as of 14:33, 13 July 2021
Line 45:		Line 45:
	}}		}}
	\|cli_equiv=The CLI command <code>drink</code> works similarly.		\|cli_equiv=The CLI command <code>drink</code> works similarly.
			\|see_also={{SeeAlso/Booze Management}}
	}}		}}
	</onlyinclude>		</onlyinclude>
	[[Category:Item Management]]		[[Category:Item Management]]

Philmasterplus: Add missing parameter type information

2021-07-13T14:11:17Z

Add missing parameter type information

← Older revision		Revision as of 14:11, 13 July 2021
Line 4:		Line 4:
	\|function1.description=Attempts to drink the {{pspan\|booze}} item(s).		\|function1.description=Attempts to drink the {{pspan\|booze}} item(s).
	\|function1.param1=booze		\|function1.param1=booze
			\|function1.param1.type=item
	\|function1.param1.description=Item to drink		\|function1.param1.description=Item to drink
	\|function1.param2=qty		\|function1.param2=qty
			\|function1.param2.type=int
	\|function1.param2.description=Amount to drink		\|function1.param2.description=Amount to drink
	\|function1.param2.optional=yes		\|function1.param2.optional=yes
Line 12:		Line 14:
	\|function2.description=Attempts to drink {{pspan\|qty}} of {{pspan\|booze}}.		\|function2.description=Attempts to drink {{pspan\|qty}} of {{pspan\|booze}}.
	\|function2.param1=qty		\|function2.param1=qty
			\|function2.param1.type=int
	\|function2.param1.description=Amount to drink		\|function2.param1.description=Amount to drink
	\|function2.param2=booze		\|function2.param2=booze
			\|function2.param2.type=item
	\|function2.param2.description=Item to drink		\|function2.param2.description=Item to drink
	\|description=<p>Attempts to drink {{pspan\|qty}} amount of the {{pspan\|booze}} item. Returns <code>true</code> for drinkable items and <code>false</code> for items that are not. (The return value does not reflect whether or not the items were actually consumed.)</p>		\|description=<p>Attempts to drink {{pspan\|qty}} amount of the {{pspan\|booze}} item. Returns <code>true</code> for drinkable items and <code>false</code> for items that are not. (The return value does not reflect whether or not the items were actually consumed.)</p>

Philmasterplus: Fix template error

2021-07-13T14:06:30Z

Fix template error

← Older revision		Revision as of 14:06, 13 July 2021
Line 39:		Line 39:
	</syntaxhighlight>		</syntaxhighlight>
	{{!}}}		{{!}}}
			}}
	\|cli_equiv=The CLI command <code>drink</code> works similarly.		\|cli_equiv=The CLI command <code>drink</code> works similarly.
	}}		}}
	</onlyinclude>		</onlyinclude>
	[[Category:Item Management]]		[[Category:Item Management]]

Philmasterplus: Rewrite page to use Template:Function2. Also add info on clear_booze_helper().

2021-07-13T14:05:24Z

Rewrite page to use Template:Function2. Also add info on clear_booze_helper().

← Older revision		Revision as of 14:05, 13 July 2021
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:~~name\|drink}}{{		\|name=drink
	~~#vardefine:return_type~~\|~~boolean~~}}{{		\|function1.return_type=boolean
			\|function1.description=Attempts to drink the {{pspan\|booze}} item(s).
			\|function1.param1=booze
			\|function1.param1.description=Item to drink
			\|function1.param2=qty
			\|function1.param2.description=Amount to drink
			\|function1.param2.optional=yes
			\|function1.param2.default=1
			\|function2.return_type=boolean
			\|function2.description=Attempts to drink {{pspan\|qty}} of {{pspan\|booze}}.
			\|function2.param1=qty
			\|function2.param1.description=Amount to drink
			\|function2.param2=booze
			\|function2.param2.description=Item to drink
			\|description=<p>Attempts to drink {{pspan\|qty}} amount of the {{pspan\|booze}} item. Returns <code>true</code> for drinkable items and <code>false</code> for items that are not. (The return value does not reflect whether or not the items were actually consumed.)</p>

	~~FunctionPage~~\|		<p>You can also "drink" drink helper items (e.g. {{kolwiki\|divine champagne flute}}) to queue them before drinking the actual booze item. Drink helpers can be identified with {{f\|item_type}}, which returns <code>"drink helper"</code> for such items. To cancel all queued drink helpers, call {{f\|clear_booze_helper}}.</p>
	~~name=~~{{~~#var:name~~}}\|

	~~function1={{Function\|~~		<p>If this command will cause you to overdrink, KoLmafia will show a warning dialog. Using this command without Ode to Booze active will also show a warning, if you have the skill and the MP required to cast it.</p>
	~~name={{#var:name}}\|~~		\|code1={{CodeSample\|
	~~aggregate={{#var:aggregate}}\|~~		title=Code Sample\|
	~~return_type={{#var:return_type}}\|~~		description=Drinks as many tangaritas as possible without getting drunk.\|
	~~return_also={{#var:return_also}}\|~~		code={{{!}} class="wikitable" style="margin: auto"
	~~parameter1={{Param\|int\|qty}}\|~~		! ASH !! JavaScript
	~~parameter2={{Param\|item\|consume}}\|~~		{{!}}-
	~~p1desc={{Pspan\|qty}} is the quantity to drink\|~~		{{!}}
	~~p2desc={{Pspan\|consume}} is the item to drink\|~~		<syntaxhighlight lang="d" line highlight="2">
	~~}}\|~~

	function_description=Will attempt to drink {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for drinkable items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) If this command will cause you to overdrink, a warning dialog ~~will be given~~. Using this command without Ode to Booze active, ~~when~~ you have the skill & required MP to cast it~~, will give a warning about drinking without Ode~~.\|

	code1={{CodeSample\|
	title=Code Sample\|
	description=Drinks ~~maximum amount of~~ tangaritas without getting drunk.\|
	code=
	<syntaxhighlight>
	int amount = floor((inebriety_limit() - my_inebriety()) / 4);		int amount = floor((inebriety_limit() - my_inebriety()) / 4);
	drink(amount, $item[tangarita]);		drink(amount, $item[tangarita]);
	</syntaxhighlight>		</syntaxhighlight>
	}}\|		{{!}}
			<syntaxhighlight lang="javascript" line highlight="4">
			const { drink, inebrietyLimit, myInebriety } = require("kolmafia");

	~~see_also~~={{~~SeeAlso\|can_drink\|overdrink\|inebriety_limit\|my_inebriety~~}}\|		const amount = Math.floor((inebrietyLimit() - myInebriety()) / 4);
	cli_equiv=The CLI command "drink" works similarly.\|		drink(amount, Item.get('tangarita'));
			</syntaxhighlight>
			{{!}}}
			\|cli_equiv=The CLI command <code>drink</code> works similarly.
	}}		}}
			</onlyinclude>
	[[Category:Item Management]]		[[Category:Item Management]]

Bale at 22:06, 21 May 2010

2010-05-21T22:06:13Z

← Older revision		Revision as of 22:06, 21 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Item Management\|~~

	function1={{Function\|		function1={{Function\|
Line 33:		Line 32:
	cli_equiv=The CLI command "drink" works similarly.\|		cli_equiv=The CLI command "drink" works similarly.\|
	}}		}}

			[[Category:Item Management]]

Bale: heh

2010-05-09T05:32:39Z

heh

← Older revision		Revision as of 05:32, 9 May 2010
Line 30:		Line 30:
	}}\|		}}\|

	see_also={{SeeAlso\|can_drink\|~~drink_silent~~\|inebriety_limit\|my_inebriety}}\|		see_also={{SeeAlso\|can_drink\|overdrink\|inebriety_limit\|my_inebriety}}\|
	cli_equiv=The CLI command "drink" works similarly.\|		cli_equiv=The CLI command "drink" works similarly.\|
	}}		}}

Heeheehee: Eliminated possibility of rounding up (and drinking one too many, eh?) in the code sample.

2010-03-31T23:41:05Z

Eliminated possibility of rounding up (and drinking one too many, eh?) in the code sample.

← Older revision		Revision as of 23:41, 31 March 2010
Line 25:		Line 25:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	int amount = (inebriety_limit() - my_inebriety()) / 4;		int amount = floor((inebriety_limit() - my_inebriety()) / 4);
	drink(amount, $item[tangarita]);		drink(amount, $item[tangarita]);
	</syntaxhighlight>		</syntaxhighlight>

Slyz: right, nevermind =)

2010-03-31T18:23:28Z

right, nevermind =)

← Older revision		Revision as of 18:23, 31 March 2010
Line 25:		Line 25:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	int amount = (inebriety_limit() ~~- 1~~ - my_inebriety()) / 4;		int amount = (inebriety_limit() - my_inebriety()) / 4;
	drink(amount, $item[tangarita]);		drink(amount, $item[tangarita]);
	</syntaxhighlight>		</syntaxhighlight>

Slyz at 18:21, 31 March 2010

2010-03-31T18:21:25Z

← Older revision		Revision as of 18:21, 31 March 2010
Line 25:		Line 25:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	int amount = (inebriety_limit() - my_inebriety()) / 4;		int amount = (inebriety_limit() - 1 - my_inebriety()) / 4;
	drink(amount, $item[tangarita]);		drink(amount, $item[tangarita]);
	</syntaxhighlight>		</syntaxhighlight>

Bale: added code sample

2010-03-10T09:52:16Z

added code sample

← Older revision		Revision as of 09:52, 10 March 2010
Line 20:		Line 20:
	function_description=Will attempt to drink {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for drinkable items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) If this command will cause you to overdrink, a warning dialog will be given. Using this command without Ode to Booze active, when you have the skill & required MP to cast it, will give a warning about drinking without Ode.\|		function_description=Will attempt to drink {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for drinkable items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) If this command will cause you to overdrink, a warning dialog will be given. Using this command without Ode to Booze active, when you have the skill & required MP to cast it, will give a warning about drinking without Ode.\|

	~~needscode~~=~~yes~~\|		code1={{CodeSample\|
			title=Code Sample\|
			description=Drinks maximum amount of tangaritas without getting drunk.\|
			code=
			<syntaxhighlight>
			int amount = (inebriety_limit() - my_inebriety()) / 4;
			drink(amount, $item[tangarita]);
			</syntaxhighlight>
			}}\|

	see_also={{SeeAlso\|can_drink\|drink_silent\|inebriety_limit\|my_inebriety}}\|		see_also={{SeeAlso\|can_drink\|drink_silent\|inebriety_limit\|my_inebriety}}\|
	cli_equiv=The CLI command "drink" works similarly.\|		cli_equiv=The CLI command "drink" works similarly.\|
	}}		}}