Total free rests

From Kolmafia
Revision as of 22:10, 26 November 2014 by imported>Bale (add category, seealso and formatting help)
Jump to navigation Jump to search


Function Syntax

int total_free_rests()

This function will the total number of free rests available to your character. These rests can come from multiple sources, such as skills or familiars.

This can be compared against the preference timesRested to see how many free rests you have remaining.

Code Sample

Show how many free rests you have remaining.

int rests_used=get_property("timesRested").to_int();
int rests_left=total_free_rests()-rests_used;
print("You have "+rests_left+" remaining.");

See Also

my_adventures() | have_skill()