setHalo

setHalo() Function

• Introduced in version 1.3b49

Sets the Halo color of a Token.

Usage

setHalo(color)

setHalo(color, id)

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.

[h: setHalo("None")]

To set the Halo for the Current Token to red.

[h: setHalo("Red")]

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

[h: setHalo("#33AAFF")]

See Also

Halo, getHalo()

Version Changes

• 1.3b51 - Added id parameter option.