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: @@
-{{stub}}
 {{MacroFunction
 |name=getBar
@@ Line 6: / Line 5: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 getBar(name)
-getBar(name, id)
+getBar(name, tokenRef)
-getBar(name, id, mapname)
+getBar(name, tokenRef, mapRef)
-</source>
+</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|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token.
-{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
+ {{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]
-</source>
+</syntaxhighlight>
+|also=
+{{func|isBarVisible}},
+{{func|setBarVisible}},
+{{func|setBar}}
 |changes=
-{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter option.}}
+{{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]]