getBar: Difference between revisions

Latest revision as of 18:33, 14 March 2023

• Introduced in version 1.3b42

Gets the value of the specified bar for the Current Token. The value returned is between 0 and 1 for 0% to 100% respectively.

getBar(name)
getBar(name, id)
getBar(name, id, mapname)

Parameters

name - The name of the bar.
id - The token id of the token to get the bar value from, 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.

[r: healthPct = getBar("Health") * 100]

@@ Line 1: / Line 1: @@
 {{MacroFunction
 |name=getBar
-|description=Gets the value of the specified [[Token:bar|bar]] for the [[Token:Current Token|Current Token]]. The value returned is between 0 and 1 for 0% to 100% respectively.
+|version=1.3b42
+|description=Gets the value of the specified [[Token:bar|bar]] for the [[Current Token]]. The value returned is between 0 and 1 for 0% to 100% respectively.
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: pct = getBar(name)]
+getBar(name)
-</source>
+getBar(name, id)
+getBar(name, id, mapname)
+</syntaxhighlight>
+'''Parameters'''
+{{param|name|The name of the bar.}}
+{{param|id|The token {{code|id}} of the token to get the bar value from, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |example=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[r: healthPct = getBar("health") * 100]
+[r: healthPct = getBar("Health") * 100]
-</source>
+</syntaxhighlight>
+|also=
+{{func|isBarVisible}},
+{{func|setBarVisible}},
+{{func|setBar}}
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
 }}
-[[Category:Token Bar Function]]
+==Related Pages==
+* [[HP and Health Bars]]
+* [[bar.name|The <code>bar.name</code> special variable]]
+[[Category:Bar Function]]