Restore hp: Difference between revisions
imported>Bale target 0 |
imported>StDoodle No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 6: | Line 6: | ||
name={{#var:name}}| | name={{#var:name}}| | ||
function1={{Function| | function1={{Function| | ||
| Line 34: | Line 33: | ||
see_also={{SeeAlso|my_hp|my_mp|my_maxhp|my_maxmp|restore_mp}}| | see_also={{SeeAlso|my_hp|my_mp|my_maxhp|my_maxmp|restore_mp}}| | ||
cli_equiv=The CLI command "restore" has similar functionality.| | cli_equiv=The CLI command "restore" has similar functionality.| | ||
special=Note: the return value can be over-ridden by a [[Miscellaneous_ASH_Features#Recovery_.28recoveryScript.29|recoveryScript]] if in use. If your script's behavior changes based on the return value of this function, it is recommended that you explicitly state which, if any, recoveryScripts it can support when publicly releasing your script. | |||
}} | }} | ||
[[Category:Skills and Effects]] | |||
Latest revision as of 17:23, 17 December 2011
Function Syntax
boolean restore_hp(int target )
- target is the minimum HP desired after the function is run.
Restores your HP, following your current recovery settings as closely as possible. This function only attempts to surpass target, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current HP (or off), this function will restore the bare minimum necessary to reach target using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% health," this function will follow that preference if possible.
If target is zero then it will restore HP according to KoLmafia's recovery settings.
This function will do nothing and return false if you have not checked any restore items. Otherwise, this function returns true if your HP is at or equal to target when finished. If target is set above your current max HP, this function will attempt to restore to that amount and report its success based on that goal, not the number used for target.
Code Sample
This sample attempts to restore your HP to full.
if (my_hp() < my_maxhp()) {
restore_hp(my_maxhp());
}CLI Equivalent
The CLI command "restore" has similar functionality.
See Also
my_hp() | my_mp() | my_maxhp() | my_maxmp() | restore_mp()
Special
Note: the return value can be over-ridden by a recoveryScript if in use. If your script's behavior changes based on the return value of this function, it is recommended that you explicitly state which, if any, recoveryScripts it can support when publicly releasing your script.