setBar

From RPTools Wiki
Revision as of 13:53, 10 October 2019 by Phergus (talk | contribs) (Mapname parameter requires Token ID.)
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.

setBar() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b42
Sets the value of the specified bar for the Current Token. The value to set is between 0 and 1 for 0% to 100% respectively.

Usage

setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, id, mapname)

Parameters

  • name - The name of the bar.
  • value - The value of the bar. Should be between 0 and 1.
  • id - The token id of the token which has its bar set, 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

[h: setBar("Health", HP/MaxHP)]


Version Changes

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