getBar

From RPTools Wiki
Revision as of 18:17, 9 October 2019 by Merudo (talk | contribs)
Jump to navigation Jump to search

 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]


Version Changes

  • 1.5.7 - Added id and mapname parameter option.
Retrieved from "https://rptools.hyperbooks.com/index.php?title=getBar&oldid=7725"