getBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetBar to getBar: Converting page titles to lowercase)
No edit summary
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getBar(name)
getBar(name)
getBar(name, id)
getBar(name, id)
getBar(name, id, mapname)
getBar(name, id, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
Line 18: Line 18:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: healthPct = getBar("Health") * 100]
[r: healthPct = getBar("Health") * 100]
</source>
</syntaxhighlight>


|also=
|also=

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 token id 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 and mapname parameter options.

Related Pages