Difference between revisions of "Eat"
Jump to navigation
Jump to search
imported>StDoodle m |
imported>Bale |
||
| 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.| | ||
| − | + | 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.| | ||
}} | }} | ||
Revision as of 09:55, 10 March 2010
Function Syntax
boolean eat(int qty ,item consume )
- qty is the quantity to eat
- consume is the item to eat
Will attempt to eat qty amount of item 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.
Code Sample
Eat maximum amount of olive lo meins.
int amount = (fullness_limit() - my_fullness()) / 3;
eat(amount, $item[olive lo mein]);CLI Equivalent
The CLI command "eat" works similarly.
See Also