Restore mp - Revision history

Fronobulax at 21:40, 17 December 2011

2011-12-17T21:40:44Z

← Older revision		Revision as of 21:40, 17 December 2011
Line 17:		Line 17:

	function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan\|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan\|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible.</p>		function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan\|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan\|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible.</p>
	<p>If {{pspan\|target}} is zero then it will restore MP according to KoLmafia's recovery settings.</p>		<p>If {{pspan\|target}} is zero then it will restore MP according to KoLmafia's recovery settings. Note that the definition of "current recovery settings" may be different if a {{pspan\|recoveryScript}} is specified.</p>
	<p>~~This~~ function ~~will do nothing~~ and ~~return false if you have not checked any restore items. Otherwise,~~ this function returns ~~true if your MP~~ is ~~at or equal to {{pspan\|target}} when finished~~. If ~~{{pspan\|target}}~~ is ~~set above~~ your ~~current max MP, this function will attempt to restore~~ to that amount ~~and report its success based on that goal,~~ not ~~the number used for {{pspan\|target}}~~.\|		<p>If a recoveryScript is present and returns TRUE then this function returns TRUE. If a recoveryScript is present and returns FALSE then this function returns the results of mafia's internal restoration attempt. If no recoveryScript is specified then the results of mafia's internal restoration attempt will be returned.

			If you use a recoveryScript and call restore_mp then it is your responsibility to deal with the possibility that restore_mp will return TRUE but the desired amount of MP will not have been reached.
			\|

	code1={{CodeSample\|		code1={{CodeSample\|

StDoodle at 17:22, 17 December 2011

2011-12-17T17:22:31Z

← Older revision		Revision as of 17:22, 17 December 2011
Line 33:		Line 33:
	see_also={{SeeAlso\|my_hp\|my_mp\|my_maxhp\|my_maxmp\|restore_hp}}\|		see_also={{SeeAlso\|my_hp\|my_mp\|my_maxhp\|my_maxmp\|restore_hp}}\|
	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]]		[[Category:Skills and Effects]]

Bale at 22:15, 21 May 2010

2010-05-21T22:15:27Z

← Older revision		Revision as of 22:15, 21 May 2010
Line 6:		Line 6:

	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Skills and Effects\|~~

	function1={{Function\|		function1={{Function\|
Line 35:		Line 34:
	cli_equiv=The CLI command "restore" has similar functionality.\|		cli_equiv=The CLI command "restore" has similar functionality.\|
	}}		}}

			[[Category:Skills and Effects]]

Bale: target 0

2010-05-03T08:00:51Z

target 0

← Older revision		Revision as of 08:00, 3 May 2010
Line 17:		Line 17:
	}}\|		}}\|

	function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan\|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan\|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible. This function will do nothing and return false if you have not checked any restore items. Otherwise, this function returns true if your MP is at or equal to {{pspan\|target}} when finished. If {{pspan\|target}} is set above your current max MP, this function will attempt to restore to that amount and report its success based on that goal, not the number used for {{pspan\|target}}.\|		function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan\|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan\|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible.</p>
			<p>If {{pspan\|target}} is zero then it will restore MP according to KoLmafia's recovery settings.</p>
			<p>This function will do nothing and return false if you have not checked any restore items. Otherwise, this function returns true if your MP is at or equal to {{pspan\|target}} when finished. If {{pspan\|target}} is set above your current max MP, this function will attempt to restore to that amount and report its success based on that goal, not the number used for {{pspan\|target}}.\|

	code1={{CodeSample\|		code1={{CodeSample\|

Grotfang at 20:31, 8 March 2010

2010-03-08T20:31:23Z

← Older revision		Revision as of 20:31, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|restore_mp}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|restore_mp}}{{
			#vardefine:return_type\|boolean}}{{

			FunctionPage\|

	~~{{FunctionPage\|~~
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Skills and Effects\|		function_category=Skills and Effects\|
Line 25:		Line 27:
	restore_mp(my_maxmp());		restore_mp(my_maxmp());
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>
			}}\|

	see_also={{SeeAlso\|my_hp\|my_mp\|my_maxhp\|my_maxmp\|restore_hp}}\|		see_also={{SeeAlso\|my_hp\|my_mp\|my_maxhp\|my_maxmp\|restore_hp}}\|
	cli_equiv=The CLI command "restore" has similar functionality.\|		cli_equiv=The CLI command "restore" has similar functionality.\|
	}}		}}

StDoodle at 17:09, 2 March 2010

2010-03-02T17:09:21Z

← Older revision		Revision as of 17:09, 2 March 2010
Line 22:		Line 22:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	if (my_mp() < ~~my_max_mp~~()) {		if (my_mp() < my_maxmp()) {
	restore_mp(~~my_max_mp~~());		restore_mp(my_maxmp());
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

	see_also={{SeeAlso\|my_hp\|my_mp\|~~my_max_hp~~\|~~my_max_mp~~\|restore_hp}}\|		see_also={{SeeAlso\|my_hp\|my_mp\|my_maxhp\|my_maxmp\|restore_hp}}\|
	cli_equiv=The CLI command "restore" has similar functionality.\|		cli_equiv=The CLI command "restore" has similar functionality.\|
	}}		}}

StDoodle: Created page with '{{#vardefine:name|restore_mp}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Skills and Effects| function1={{Function| name={{#var:na…'

2010-03-02T17:08:10Z

Created page with '{{#vardefine:name|restore_mp}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Skills and Effects| function1={{Function| name={{#var:na…'

New page

{{#vardefine:name|restore_mp}}
{{#vardefine:return_type|boolean}}

{{FunctionPage|
name={{#var:name}}|
function_category=Skills and Effects|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|target}}|
p1desc={{pspan|target}} is the minimum MP desired after the function is run.|
}}|

function_description=Restores your MP, following your current recovery settings as closely as possible. This function only attempts to surpass {{pspan|target}}, not to arrive as closely as possible to it. If your current KoLmafia recovery settings are lower than your current MP (or off), this function will restore the bare minimum necessary to reach {{pspan|target}} using the restores you have checked. If, however, you have your recovery setting set to "Try to recover up to 100% mana," this function will follow that preference if possible. This function will do nothing and return false if you have not checked any restore items. Otherwise, this function returns true if your MP is at or equal to {{pspan|target}} when finished. If {{pspan|target}} is set above your current max MP, this function will attempt to restore to that amount and report its success based on that goal, not the number used for {{pspan|target}}.|

code1={{CodeSample|
title=Code Sample|
description=This sample attempts to restore your MP to full.|
code=
<syntaxhighlight>
if (my_mp() < my_max_mp()) {
restore_mp(my_max_mp());
}
</syntaxhighlight>}}|

see_also={{SeeAlso|my_hp|my_mp|my_max_hp|my_max_mp|restore_hp}}|
cli_equiv=The CLI command "restore" has similar functionality.|
}}