Fullness limit: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m More concise & accurate. Also more documentation.
imported>StDoodle
m cleanup of code comments
Line 23: Line 23:
if(my_fullness() + 5 <= fullness_limit()) {
if(my_fullness() + 5 <= fullness_limit()) {
   eat(floor( fullness_limit() / 5 ) , $item[hot hi mein]);
   eat(floor( fullness_limit() / 5 ) , $item[hot hi mein]);
   // We're using the floor function here because if fullness_limit()/5 returns, say, 2.2, we only want it to consume 2. Also, eat() takes an integer, not a float, as a parameter.
   // We're using the floor function here because if fullness_limit()/5 returns, say, 2.2, we only want it to consume 2.
  // Also, eat() takes an integer, not a float, as a parameter.
}
}
// Note: This script
</syntaxhighlight>
</syntaxhighlight>
}}|
}}|

Revision as of 16:51, 17 March 2010

Function Syntax

int fullness_limit()

Returns the logged-in character's maximum fullness level as an int. For most characters, the returned value will be 15. On the Feast of Boris this number is raised by 15. The number is also raised by 5 for characters with Stomach of Steel.

Code Samples

This example calculates how many hot hi meins it can eat and then eats them.

if(my_fullness() + 5 <= fullness_limit()) {
   eat(floor( fullness_limit() / 5 ) , $item[hot hi mein]);
   // We're using the floor function here because if fullness_limit()/5 returns, say, 2.2, we only want it to consume 2.
   // Also, eat() takes an integer, not a float, as a parameter.
}

See Also

my_fullness() | eat()

Special

When not logged in, this function returns 15.