getBar

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, tokenRef)
getBar(name, tokenRef, mapRef)

Parameters

• name - The name of the bar.
• tokenRef - Either the token id or Token Name of the token.

 Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

[r: healthPct = getBar("Health") * 100]

See Also

isBarVisible(),

setBarVisible(),

setBar()

Version Changes

• 1.5.7 - Added id and mapname parameter options.

Related Pages

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