getHalo

getHalo() Function

• Introduced in version 1.3b49

Gets the color value of a token's Halo. The value returned is a string that represents the hexadecimal value of the color of the Halo in the format "#RRGGBB" or "None" if the token has no Halo.

Usage

getHalo()

getHalo(tokenRef)

Parameter

• tokenRef - getHalo which has its halo color returned, defaults to the Current Token.

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

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

The following example will display the text "Halo Color Text" in the color of the Current Token's Halo.

<span style="color:[r: getHalo()]">Halo Color Text</span>

See Also

Halo, setHalo()

Version Changes

• 1.3b51 - Added id parameter option.