getHalo: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==Function getHalo==
{{MacroFunction
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|].
|name=getHalo
===Usage===
|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]].
 
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: color = getHalo()]
[h: color = getHalo()]
</source>
</source>


===Examples===
|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 [[Token:halo{{!}}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>
</source>
</source>
}}
[[Category:Token Function]]

Revision as of 03:21, 7 March 2009

getHalo() Function

Gets the value of the specified halo for the 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 halo.

Usage

[h: color = getHalo()]

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>