Total free rests: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Fluxxdog
Creation
 
imported>Bale
Huh. Those lines actually matter?
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{
{{
#vardefine:name|total_free_rests}}{{
#vardefine:name|total_free_rests}}{{
#vardefine:return_type|int}}
#vardefine:return_type|int}}{{FunctionPage|
name={{#var:name}}|


==Function Syntax==
function1={{Function|
{{Function|
name={{#var:name}}|
name=total_free_rests|
aggregate={{#var:aggregate}}|
return_type=int|
return_type={{#var:return_type}}|
}}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.<br>
return_also={{#var:return_also}}|
This can be compared against the preference ''timesRested'' to see how many free rests you have remaining.|
}}|


{{CodeSample|
function_description=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.</p>
<p>This can be compared against the preference <code> timesRested </code> to see how many free rests you have remaining.|
 
code1={{CodeSample|
title=Code Sample|
title=Code Sample|
description=Show how many free rests you have remaining.|
description=Show how many free rests you have remaining.|
Line 17: Line 21:
int rests_used=get_property("timesRested").to_int();
int rests_used=get_property("timesRested").to_int();
int rests_left=total_free_rests()-rests_used;
int rests_left=total_free_rests()-rests_used;
print("You have "+rests_left+" remaining");
print("You have "+rests_left+" remaining.");
</syntaxhighlight>
</syntaxhighlight>}}|
 
see_also={{SeeAlso|my_adventures|have_skill}}|
}}
}}
[[Category:Your Character]]

Latest revision as of 22:15, 26 November 2014

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()