Total free rests

Function Syntax

int total_free_rests()

This function will the total number of free rests available to your character. These rest can come from multiple sourses, 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");