getBar: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getBar | |name=getBar | ||
| Line 6: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getBar(name) | getBar(name) | ||
getBar(name, | getBar(name, tokenRef) | ||
getBar(name, | getBar(name, tokenRef, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|name|The name of the bar.}} | {{param|name|The name of the bar.}} | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token. | ||
{{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name 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= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: healthPct = getBar("Health") * 100] | [r: healthPct = getBar("Health") * 100] | ||
</ | </syntaxhighlight> | ||
|also= | |||
{{func|isBarVisible}}, | |||
{{func|setBarVisible}}, | |||
{{func|setBar}} | |||
|changes= | |changes= | ||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | {{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]] | [[Category:Bar Function]] | ||
Latest revision as of 18:13, 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, mapname)Parameters
name- The name of the bar.tokenRef- Either the tokenidor Token Name of the 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.
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]See Also
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.