setHalo: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=setHalo
|name=setHalo
|version=1.3b49
|description=
|description=
Sets the [[Token:Halo|Halo]] color of the [[Token:Current Token|Current Token]]. The valid values for this function are
Sets the [[Halo]] color of a [[Token]].
* Black
* Green
* Yellow
* Orange
* Red
* Cyan
* Magenta
* White
* A hexadecimal string in the format #''rrggbb''.
* None


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setHalo(color)]
setHalo(color)
</source>
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
setHalo(color, id)
</syntaxhighlight>
'''Parameters'''
{{param|color|The color to set the [[Halo]] to, valid values are:
** {{code|"Black"}}
** {{code|"Green"}}
** {{code|"Yellow"}}
** {{code|"Orange"}}
** {{code|"Red"}}
** {{code|"Cyan"}}
** {{code|"Magenta"}}
** {{code|"White"}}
** A hexadecimal color value in the format {{code|"#RRGGBB"}}
** {{code|"None"}} }}
{{param|id|The token {{code|id}} of the token that has its [[Halo]] set by this function. {{TrustedParameter}} }}


|examples=
|examples=
To remove the [[Token:Halo|Halo]] from the [[Token:Current Token|Current Token]].
To remove the [[Halo]] from the [[Current Token]].
<source lang="mtmacro" line>
<syntaxhighlight  lang="mtmacro" line>
[h: setHalo("None")]
[h: setHalo("None")]
</source>
</syntaxhighlight>


To set the [[Token:Halo|Halo]] for the [[Token:Current Token|Current Token]] to red.
To set the [[Halo]] for the [[Current Token]] to red.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setHalo("Red")]
[h: setHalo("Red")]
</source>
</syntaxhighlight>


To set the [[Token:Halo|Halo]] from the [[Token:Current Token|Current Token]] to a custom color
To set the [[Halo]] from the [[Current Token]] to a custom color
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setHalo("#33AAFF")]
[h: setHalo("#33AAFF")]
</source>
</syntaxhighlight>
 
|also=
[[Halo]],
[[getHalo|getHalo()]]
 
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 23:59, 14 March 2023

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.
Retrieved from "https://wiki.rptools.info/index.php?title=setHalo&oldid=35699"