getHalo: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
|||
| Line 7: | Line 7: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getHalo() | getHalo() | ||
</ | </syntaxhighlight> | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getHalo(id) | getHalo(id) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|id|The token {{code|id}} of the token which has its halo color returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its halo color returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
| Line 18: | Line 18: | ||
<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> | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 18:24, 14 March 2023
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
<source lang="mtmacro" line> getHalo() </syntaxhighlight> <source lang="mtmacro" line> getHalo(id) </syntaxhighlight> Parameter
id- The tokenidof the token which has its halo color returned, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
Example
The following example will display the text "Halo Color Text" in the color of the Current Token's Halo.
<source lang="mtmacro" line> Halo Color Text
</syntaxhighlight>See Also
Version Changes
- 1.3b51 - Added
idparameter option.