setHalo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setHalo(color) | setHalo(color) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setHalo(color, id) | setHalo(color, id) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|color|The color to set the [[Halo]] to, valid values are: | {{param|color|The color to set the [[Halo]] to, valid values are: | ||
| Line 28: | Line 28: | ||
|examples= | |examples= | ||
To remove the [[Halo]] from the [[Current Token]]. | To remove the [[Halo]] from the [[Current Token]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setHalo("None")] | [h: setHalo("None")] | ||
</ | </syntaxhighlight> | ||
To set the [[Halo]] for the [[Current Token]] to red. | To set the [[Halo]] for the [[Current Token]] to red. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setHalo("Red")] | [h: setHalo("Red")] | ||
</ | </syntaxhighlight> | ||
To set the [[Halo]] from the [[Current Token]] to a custom color | To set the [[Halo]] from the [[Current Token]] to a custom color | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setHalo("#33AAFF")] | [h: setHalo("#33AAFF")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 21:02, 14 March 2023
setHalo() Function
• Introduced in version 1.3b49
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 tokenidof 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
Version Changes
- 1.3b51 - Added
idparameter option.