setHalo: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function setHalo== Sets the Token:Halo color of the Token:Current Token. The valid values for this function are * Black * Green * Yellow * Orange * Red * Cyan * Magenta * White...)
 
m (Applied Template:MacroFunction)
Line 1: Line 1:
==Function setHalo==
{{MacroFunction
|name=setHalo
|description=
Sets the [[Token:Halo|Halo]] color of the [[Token:Current Token|Current Token]]. The valid values for this function are
Sets the [[Token:Halo|Halo]] color of the [[Token:Current Token|Current Token]]. The valid values for this function are
* Black
* Black
Line 12: Line 14:
* None
* None


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setHalo(color)]
[h: setHalo(color)]
</source>
</source>


===Examples===
|examples=
To remove the [[Token:Halo|Halo]] from the [[Token:Current Token|Current Token]].
To remove the [[Token:Halo|Halo]] from the [[Token:Current Token|Current Token]].
<source lang="mtmacro" line>
<source lang="mtmacro" line>
Line 32: Line 34:
[h: setHalo("#33AAFF")]
[h: setHalo("#33AAFF")]
</source>
</source>
}}
[[Category:Token Function]]

Revision as of 03:54, 9 March 2009

setHalo() Function

Sets the Halo color of the Current Token. The valid values for this function are
  • Black
  • Green
  • Yellow
  • Orange
  • Red
  • Cyan
  • Magenta
  • White
  • A hexadecimal string in the format #rrggbb.
  • None

Usage

[h: setHalo(color)]

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")]