Eat - Revision history

Philmasterplus: Add Template:SeeAlso/Food Management

2021-07-13T14:32:22Z

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

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

2021-07-13T14:16:37Z

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

← Older revision		Revision as of 14:16, 13 July 2021
Line 1:		Line 1:
	{{		<onlyinclude>{{{{{format\|Function2}}}
	~~#vardefine:~~name\|eat}}{{		\|name=eat
	~~#vardefine:return_type~~\|~~boolean~~}}{{		\|function1.return_type=boolean
			\|function1.description=Attempts to eat the {{pspan\|food}} item(s).
			\|function1.param1=food
			\|function1.param1.type=item
			\|function1.param1.description=Item to eat
			\|function1.param2=qty
			\|function1.param2.type=int
			\|function1.param2.description=Amount to eat
			\|function1.param2.optional=yes
			\|function1.param2.default=1
			\|function2.return_type=boolean
			\|function2.description=Attempts to eat {{pspan\|qty}} of {{pspan\|item}}.
			\|function2.param1=qty
			\|function2.param1.type=int
			\|function2.param1.description=Amount to eat
			\|function2.param2=food
			\|function2.param2.type=item
			\|function2.param2.description=Item to eat
			\|description=<p>Attempts to eat {{pspan\|qty}} amount of the {{pspan\|food}} item. Returns <code>true</code> for edible 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 "eat" food helper items (e.g. {{kolwiki\|Ol' Scratch's salad fork}}) to queue them before eating the actual food item. Food helpers can be identified with {{f\|item_type}}, which returns <code>"food helper"</code> for such items. To cancel all queued food helpers, call {{f\|clear_food_helper}}.</p>
	~~name=~~{{~~#var:name~~}}\|

	~~function1={{Function\|~~		<p>If you can use {{kolwiki\|milk of magnesium}} but haven't used one yet, this command will show a warning dialog.</p>
	~~name={{#var:name}}\|~~		\|code1={{CodeSample\|
	~~aggregate={{#var:aggregate}}\|~~		title=Code Sample\|
	~~return_type={{#var:return_type}}\|~~		description=Eats as many olive lo meins as possible.\|
	~~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 eat\|~~		{{!}}
	~~p2desc={{Pspan\|consume}} is the item to eat\|~~		<syntaxhighlight lang="d" line highlight="2">
	~~}}\|~~

	~~function_description=Will attempt to eat~~ {{~~pspan~~\|~~qty}} amount~~ of ~~item {{pspan\|consume~~}}~~. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using~~ this command ~~without Got Milk active, when you are currently capable of acquiring said effect,~~ will ~~issue~~ a warning dialog ~~about eating without Got Milk active~~.\|

	code1={{CodeSample\|
	title=Code Sample\|
	description=~~Eat maximum amount of~~ olive lo meins.\|
	code=
	<syntaxhighlight>
	int amount = (fullness_limit() - my_fullness()) / 3;		int amount = (fullness_limit() - my_fullness()) / 3;
	eat(amount, $item[olive lo mein]);		eat(amount, $item[olive lo mein]);
	</syntaxhighlight>		</syntaxhighlight>
	}}\|		{{!}}
			<syntaxhighlight lang="javascript" line highlight="4">
			const { eat, fullnessLimit, myFullness } = require("kolmafia");

	~~see_also~~={{~~SeeAlso\|can_eat\|eatsilent\|fullness_limit\|my_fullness~~}}\|		const amount = Math.floor((fullnessLimit() - myFullness()) / 4);
	~~cli_equiv=The CLI command "eat" works similarly.\|~~		drink(amount, Item.get('olive lo mein'));
			</syntaxhighlight>
			{{!}}}
	}}		}}
			\|cli_equiv=The CLI command <code>eat</code> works similarly.
			}}
			</onlyinclude>
	[[Category:Item Management]]		[[Category:Item Management]]

Bale at 22:05, 21 May 2010

2010-05-21T22:05:56Z

← Older revision		Revision as of 22:05, 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 "eat" works similarly.\|		cli_equiv=The CLI command "eat" works similarly.\|
	}}		}}

			[[Category:Item Management]]

Heeheehee at 04:26, 9 May 2010

2010-05-09T04:26:28Z

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

	see_also={{SeeAlso\|can_eat\|~~eat_silent~~\|fullness_limit\|my_fullness}}\|		see_also={{SeeAlso\|can_eat\|eatsilent\|fullness_limit\|my_fullness}}\|
	cli_equiv=The CLI command "eat" works similarly.\|		cli_equiv=The CLI command "eat" works similarly.\|
	}}		}}

Bale at 09:55, 10 March 2010

2010-03-10T09:55:02Z

← Older revision		Revision as of 09:55, 10 March 2010
Line 20:		Line 20:
	function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command without Got Milk active, when you are currently capable of acquiring said effect, will issue a warning dialog about eating without Got Milk active.\|		function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command without Got Milk active, when you are currently capable of acquiring said effect, will issue a warning dialog about eating without Got Milk active.\|

	~~needscode~~=~~yes~~\|		code1={{CodeSample\|
			title=Code Sample\|
			description=Eat maximum amount of olive lo meins.\|
			code=
			<syntaxhighlight>
			int amount = (fullness_limit() - my_fullness()) / 3;
			eat(amount, $item[olive lo mein]);
			</syntaxhighlight>
			}}\|

	see_also={{SeeAlso\|can_eat\|eat_silent\|fullness_limit\|my_fullness}}\|		see_also={{SeeAlso\|can_eat\|eat_silent\|fullness_limit\|my_fullness}}\|
	cli_equiv=The CLI command "eat" works similarly.\|		cli_equiv=The CLI command "eat" works similarly.\|
	}}		}}

StDoodle at 21:14, 8 March 2010

2010-03-08T21:14:06Z

← Older revision		Revision as of 21:14, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|eat}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|eat}}{{
			#vardefine:return_type\|boolean}}{{

	{{FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Item Management\|		function_category=Item Management\|

StDoodle at 18:40, 5 March 2010

2010-03-05T18:40:22Z

← Older revision		Revision as of 18:40, 5 March 2010
Line 17:		Line 17:
	}}\|		}}\|

	function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.)\|		function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command without Got Milk active, when you are currently capable of acquiring said effect, will issue a warning dialog about eating without Got Milk active.\|

	needscode=yes\|		needscode=yes\|

	see_also={{SeeAlso\|can_eat\|fullness_limit\|my_fullness}}\|		see_also={{SeeAlso\|can_eat\|eat_silent\|fullness_limit\|my_fullness}}\|
	cli_equiv=The CLI command "eat" works similarly.\|		cli_equiv=The CLI command "eat" works similarly.\|
	}}		}}

StDoodle at 18:33, 5 March 2010

2010-03-05T18:33:53Z

← Older revision		Revision as of 18:33, 5 March 2010
Line 1:		Line 1:
	~~'''[[~~boolean~~]] eat(int quantity, item itemtype)'''~~		{{#vardefine:name\|eat}}
			{{#vardefine:return_type\|boolean}}

	~~Will attempt to eat the number of food specified. The return value only tells you whether the item can be eaten, not if you have enough room for it.~~		{{FunctionPage\|
			name={{#var:name}}\|
			function_category=Item Management\|

	~~So,<br>~~		function1={{Function\|
	~~<code>~~		name={{#var:name}}\|
	~~eat(3,$~~item~~[stinky hi mein]);~~		aggregate={{#var:aggregate}}\|
	~~</code>~~		return_type={{#var:return_type}}\|
	~~<br>~~		return_also={{#var:return_also}}\|
	~~will eat 3 stinky hi meins (depending on fullness) and return true.~~		parameter1={{Param\|int\|qty}}\|
			parameter2={{Param\|item\|consume}}\|
			p1desc={{Pspan\|qty}} is the quantity to eat\|
			p2desc={{Pspan\|consume}} is the item to eat\|
			}}\|

	~~While,~~		function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.)\|
	~~<br>~~
	~~<code>~~
	eat~~(3,$~~item~~[blue pixel]);~~
	~~</code>~~
	~~<br>~~
	~~will tell you~~ that ~~a blue pixel cannot be~~ consumed ~~and return false~~.

	~~This can be adapted for safer consumption by using code such as the following:~~		needscode=yes\|

	~~<code>~~		see_also={{SeeAlso\|can_eat\|fullness_limit\|my_fullness}}\|
	~~boolean eat_hi_mein()~~		cli_equiv=The CLI command "eat" works similarly.\|
	{		}}
	~~if( item_amount( $item[stinky hi mein] ) >= 3 )~~
	{
	~~if( (~~ fullness_limit~~() -~~ my_fullness~~() ) >= 15 )~~
	{
	~~eat( 3 , $item[stinky hi mein] );~~
	~~return true;~~
	}
	~~else~~
	~~print(~~ "~~You are too full to~~ eat ~~all of those~~" );
	}
	~~else~~
	~~print( "You have fewer than three in your inventory" );~~
	~~return false;~~
	}
	~~</code>~~

	~~This code uses [[item_amount()]], [[fullness_limit()]] and [[my_fullness()]] to pre-empt problems that may occur.~~

StDoodle: moved Eat() to Eat

2010-03-02T22:05:51Z

moved Eat() to Eat

← Older revision	Revision as of 22:05, 2 March 2010
(No difference)

Grotfang at 15:08, 22 February 2010

2010-02-22T15:08:25Z

@@ Line 5: / Line 5: @@
 So,<br>
 <code>
-eat(3,$item[stinky hi mein]);
+  eat(3,$item[stinky hi mein]);
 </code>
 <br>
@@ Line 13: / Line 13: @@
 <br>
 <code>
-eat(3,$item[blue pixel]);
+  eat(3,$item[blue pixel]);
 </code>
 <br>
 will tell you that a blue pixel cannot be consumed and return false.

← Older revision		Revision as of 21:14, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|eat}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|eat}}{{
			#vardefine:return_type\|boolean}}{{

	{{FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Item Management\|		function_category=Item Management\|

← Older revision		Revision as of 18:40, 5 March 2010
Line 17:		Line 17:
	}}\|		}}\|

	function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.)\|		function_description=Will attempt to eat {{pspan\|qty}} amount of item {{pspan\|consume}}. Returns true for food items and false for items that are not. (The return value does not reflect whether or not the items were actually consumed.) Using this command without Got Milk active, when you are currently capable of acquiring said effect, will issue a warning dialog about eating without Got Milk active.\|

	needscode=yes\|		needscode=yes\|

	see_also={{SeeAlso\|can_eat\|fullness_limit\|my_fullness}}\|		see_also={{SeeAlso\|can_eat\|eat_silent\|fullness_limit\|my_fullness}}\|
	cli_equiv=The CLI command "eat" works similarly.\|		cli_equiv=The CLI command "eat" works similarly.\|
	}}		}}