getBar: Difference between revisions

Revision as of 18:14, 9 October 2019

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

• 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 which has its property 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.

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

@@ Line 8: / Line 8: @@
 <source lang="mtmacro" line>
 getBar(name)
+getBar(name, id)
+getBar(name, id, mapname)
 </source>
+'''Parameters'''
+{{param|name|The name of the bar.}}
+{{param|id|The token {{code|id}} of the token which has its property set, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |example=
@@ Line 14: / Line 22: @@
 [r: healthPct = getBar("health") * 100]
 </source>
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter option.}}
 }}
 [[Category:Bar Function]]