getHalo: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Updated with recent version changes.)
mNo edit summary
Line 15: Line 15:


|example=
|example=
The following example will display the text "Halo Color Text" in the color of the [[Token:halo{{!}}token's halo]].
The following example will display the text "Halo Color Text" in the color of the [[Current Token]]'s [[Halo]].
<source lang="mtmacro" line>
<source lang="mtmacro" line>
<span style="color:[r: getHalo()]">Halo Color Text</span>
<span style="color:[r: getHalo()]">Halo Color Text</span>

Revision as of 00:23, 31 March 2009

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(id)

Parameter

  • id - The token id of the token which has its halo color returned, defaults to the Current Token

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>


Version Changes

  • 1.3b51 - Added id parameter option.