getTokenOpacity: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro"> | ||
getTokenOpacity( | getTokenOpacity() | ||
</ | getTokenOpacity(id) | ||
getTokenOpacity(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the opacity, defaults to the [[Current Token]].}}{{TrustedParameter}} | {{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the opacity, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
{{param|mapname|OPTIONAL: The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
The opacity for the Dragon token is: [r: getTokenOpacity("Dragon")] | The opacity for the Dragon token is: [r: getTokenOpacity("Dragon")] | ||
[h, token("Dragon"): opacity = getTokenOpacity()] | [h, token("Dragon"): opacity = getTokenOpacity()] | ||
</ | </syntaxhighlight> | ||
|changes={{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category: | [[Category:Token Function]] | ||
Latest revision as of 21:10, 14 March 2023
getTokenOpacity() Function
• Introduced in version 1.4.2.0
Returns the opacity value of the corresponding token.
Usage
getTokenOpacity()
getTokenOpacity(id)
getTokenOpacity(id, mapname)Parameters
id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map.
Example
The opacity for the Dragon token is: [r: getTokenOpacity("Dragon")]
[h, token("Dragon"): opacity = getTokenOpacity()]
Version Changes
- 1.5.4 - Added
mapnameparameter option.