getHalo

Contents 1 getHalo() Function 1.1 Usage 1.2 Example 1.3 See Also 1.4 Version Changes

getHalo() Function

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

Parameter

• id - The token id of the token which has its halo color returned, defaults to the Current Token.  Note: This parameter can only be used in a Trusted Macro. 

Example

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

See Also

Halo, setHalo()

Version Changes

• 1.3b51 - Added id parameter option.

Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.Halo: A colored border that appears around a token on the map.Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.