getBar: Difference between revisions

Latest revision as of 23:59, 10 May 2024

getBar() Function

• 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.

Usage

getBar(name)
getBar(name, tokenRef)
getBar(name, tokenRef, mapRef)

Parameters

name - The name of the bar.
tokenRef - Either the token id or Token Name of the token.

Note: This parameter can only be used in a Trusted Macro.

mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

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

Version Changes

1.5.7 - Added id and mapname parameter options.

Related Pages

@@ 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, tokenRef)
+getBar(name, tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{param|name|The name of the bar.}}
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token.
+ {{TrustedParameter}} }}
+{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
+{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
 |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 Find Function]]
+==Related Pages==
+* [[HP and Health Bars]]
+* [[bar.name|The <code>bar.name</code> special variable]]
+[[Category:Bar Function]]