setHalo

Contents 1 setHalo() Function 1.1 Usage 1.2 Examples 1.3 See Also 1.4 Version Changes

setHalo() Function

Sets the Halo color of a Token.

Usage

Parameters

• color - The color to set the Halo to, valid values are:
  • "Black"
  • "Green"
  • "Yellow"
  • "Orange"
  • "Red"
  • "Cyan"
  • "Magenta"
  • "White"
  • A hexadecimal color value in the format "#RRGGBB"
  • "None"
• id - The token id of the token that has its Halo set by this function.  Note: This parameter can only be used in a Trusted Macro. 

Examples

To remove the Halo from the Current Token.

To set the Halo for the Current Token to red.

To set the Halo from the Current Token to a custom color

See Also

Halo, getHalo()

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.