setBar

 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 and makes the bar visible. 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)]

See Also

isBarVisible(),

setBarVisible(),

getBar()

Version Changes

• 1.5.7 - Added id and mapname parameter options.

Related Pages

• HP and Health Bars
• The bar.name special variable