My fullness: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Zarqon
added example
imported>StDoodle
No edit summary
Line 1: Line 1:
[[int]] [[my_fullness()]]
{{#vardefine:name|my_fullness}}
{{#vardefine:return_type|int}}


Returns the logged-in character's current fullness as an [[int]].  This can be used in tandem with [[fullness_limit()]] to eat as much of something as possible:
{{FunctionPage|
name={{#var:name}}|
function_category=CATEGORY|


<code>
function1={{Function|
  if ([[my_fullness()]] < ([[fullness_limit()]]-2))
name={{#var:name}}|
    [[eat()|eat]]([[floor()|floor]](([[fullness_limit()]]-[[my_fullness()]]) / 3), $[[item]][peach pie]);
aggregate={{#var:aggregate}}|
</code>
return_type={{#var:return_type}}|
[[Category:Your Character | My fullness()]]
return_also={{#var:return_also}}|
[[Category:Ash Functions | My fullness()]]
}}|


When not logged in, this function returns 0.
function_description=Returns the current fullness of the logged-in character.|
 
code1={{CodeSample|
title=Code Sample|
description=To eat as many peach pies as possible:|
code=
<syntaxhighlight>
if (my_fullness() < (fullness_limit() - 2))
  eat(floor(((fullness_limit() - my_fullness()) / 3) , $item[peach pie]);
</syntaxhighlight>}}|
 
see_also={{SeeAlso|fullness_limit}}|
special=When not logged in, this function returns 0.
}}

Revision as of 20:26, 28 February 2010



Function Syntax

int my_fullness()

Returns the current fullness of the logged-in character.

Code Sample

To eat as many peach pies as possible:

if (my_fullness() < (fullness_limit() - 2))
   eat(floor(((fullness_limit() - my_fullness()) / 3) , $item[peach pie]);

See Also

fullness_limit()

Special

When not logged in, this function returns 0.