getBar: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
(10 intermediate revisions by 5 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, id) | ||
getBar(name, id, mapname) | |||
</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|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: healthPct = getBar(" | [r: healthPct = getBar("Health") * 100] | ||
</ | </syntaxhighlight> | ||
|also= | |||
{{func|isBarVisible}}, | |||
{{func|setBarVisible}}, | |||
{{func|setBar}} | |||
|changes= | |||
{{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]] |
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 tokenid
of 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
id
andmapname
parameter options.