setBar: Difference between revisions

Latest revision as of 21:08, 14 March 2023

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.

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 token id 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.

[h: setBar("Health", HP/MaxHP)]

@@ Line 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=setBar
@@ Line 5: / Line 4: @@
 |version=1.3b42
 |description=
-Sets the value of the specified [[Token:bar|bar]] for the [[Current Token]]. The value to set is between 0 and 1 for 0% to 100% respectively.
+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=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setBar(name, pct/100)
 setBar(name, pct/100, id)
 setBar(name, pct/100, id, mapname)
-</source>
+</syntaxhighlight>
 '''Parameters'''
@@ Line 22: / Line 21: @@
 |example=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [h: setBar("Health", HP/MaxHP)]
-</source>
+</syntaxhighlight>
 |also=