getBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
(Add 'See Also' and 'Related Pages' to bar functions.)
Line 22: Line 22:
[r: healthPct = getBar("Health") * 100]
[r: healthPct = getBar("Health") * 100]
</source>
</source>
|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]]

Revision as of 03:08, 5 November 2019

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

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