Eat: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
No edit summary
imported>StDoodle
mNo edit summary
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.|
}}
}}

Revision as of 18:40, 5 March 2010



needs(code_samples);

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.

CLI Equivalent

The CLI command "eat" works similarly.

See Also

can_eat() | eat_silent() | fullness_limit() | my_fullness()