setBar: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function setBar== Sets the value of the specified bar for the Current Token. The value to set is between 0 and 1 for 0% to 100% respectively. ===Us...) |
No edit summary |
||
(15 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
= | {{MacroFunction | ||
Sets the value of the specified [[Token:bar|bar]] for the [[ | |name=setBar | ||
|trusted=true | |||
|version=1.3b42 | |||
|description= | |||
Sets the value of the specified [[Token:bar|bar]] for the [[Current Token]] and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively. | |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
setBar(name, pct/100) | |||
</ | setBar(name, pct/100, id) | ||
setBar(name, pct/100, id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
< | {{param|name|The name of the bar.}} | ||
[ | {{param|value|The value of the bar. Should be between 0 and 1.}} | ||
</ | {{param|id|The token {{code|id}} of the token which has its bar set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: setBar("Health", HP/MaxHP)] | |||
</syntaxhighlight> | |||
|also= | |||
{{func|isBarVisible}}, | |||
{{func|setBarVisible}}, | |||
{{func|getBar}} | |||
|changes= | |||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | |||
==Related Pages== | |||
* [[HP and Health Bars]] | |||
* [[bar.name|The <code>bar.name</code> special variable]] | |||
[[Category:Bar Function]] |
Latest revision as of 21:08, 14 March 2023
setBar() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b42
Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.
Usage
setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, id, mapname)
Parameters
name
- The name of the bar.value
- The value of the bar. Should be between 0 and 1.id
- The tokenid
of the token which has its bar set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname
- The name of the map to find the token. Defaults to the current map.
Example
[h: setBar("Health", HP/MaxHP)]
See Also
Version Changes
- 1.5.7 - Added
id
andmapname
parameter options.