getHalo: Difference between revisions

Revision as of 00:21, 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 token's halo.

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

Version Changes

1.3b51 - Added id parameter option.

@@ Line 1: / Line 1: @@
 {{MacroFunction
 |name=getHalo
-|description=Gets the value of the specified [[Token:halo{{!}}halo]] for the [[Token:Current Token{{!}}Current Token]]. The value returned is a string that represents the hexadecimal value of the color of the halo in the format #''RRGGBB'' or "None" if there is no [[Token:halo{{!}}halo]].
+|version=1.3b49
+|description=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 {{code|"#RRGGBB"}} or {{code|"None"}} if the token has no [[Halo]].
 |usage=
 <source lang="mtmacro" line>
-[h: color = getHalo()]
+getHalo()
 </source>
+<source lang="mtmacro" line>
+getHalo(id)
+</source>
+'''Parameter'''
+{{param|id|The token {{code|id}} of the token which has its halo color returned, defaults to the [[Current Token]]}}
 |example=
@@ Line 13: / Line 19: @@
 <span style="color:[r: getHalo()]">Halo Color Text</span>
 </source>
+|changes=
+{{change|1.3b51|Added {{code|id}} parameter option.}}
 }}
 [[Category:Token Function]]