getBar: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getBar(name) | getBar(name) | ||
getBar(name, id) | getBar(name, id) | ||
getBar(name, id, mapname) | getBar(name, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 18: | Line 18: | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: healthPct = getBar("Health") * 100] | [r: healthPct = getBar("Health") * 100] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 18:33, 14 March 2023
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, id)
getBar(name, id, mapname)Parameters
name- The name of the bar.id- The tokenidof 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.
Example
[r: healthPct = getBar("Health") * 100]See Also
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.