setTokenOpacity: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page SetTokenOpacity to setTokenOpacity: Converting page titles to lowercase) |
No edit summary |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro"> | ||
setTokenOpacity(value) | setTokenOpacity(value) | ||
setTokenOpacity(value, id) | setTokenOpacity(value, id) | ||
setTokenOpacity(value, id, | setTokenOpacity(value, id, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|value|The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.}} | {{param|value|The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.}} | ||
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the opacity, defaults to the [[Current Token]]. }} | {{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the opacity, defaults to the [[Current Token]]. }} | ||
{{param| | {{param|mapRef|OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.}} | ||
'''Returns''' | '''Returns''' | ||
The opacity value that was set. | The opacity value that was set. | ||
'''Note''' | |||
If opacity is below about 20%, it becomes increasingly difficult to see the token. At 0%, it is completely invisible, even to the Gamemaster. If you can't find it, use the Map Explorer panel. | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setTokenOpacity(0.5, "Dragon")] | [h: setTokenOpacity(0.5, "Dragon")] | ||
[h, token("Dragon"): setTokenOpacity(0.75)] | [h, token("Dragon"): setTokenOpacity(0.75)] | ||
</ | </syntaxhighlight> | ||
|changes={{change|1.5.4|Added {{code|mapname}} parameter option.}} | |changes={{change|1.5.4|Added {{code|mapname}} parameter option.}} | ||
}} | }} | ||
[[Category:VBL Function]] | [[Category:VBL Function]] | ||
Latest revision as of 23:59, 19 September 2023
setTokenOpacity() Function
• Introduced in version 1.4.2.0
Sets the opacity value of the corresponding token.
Usage
setTokenOpacity(value)
setTokenOpacity(value, id)
setTokenOpacity(value, id, mapRef)Parameters
value- The value of the opacity to set, ranging from 0.0 (completely transparent) to 1.0 (completely opaque). This must be a floating point value with leading zero if less than 1.0.id- OPTIONAL: The tokenidof the token for which you want to retrieve the opacity, defaults to the Current Token.mapRef- OPTIONAL: The Name or ID of the map to find the token. Defaults to the current map.
Returns The opacity value that was set.
Note If opacity is below about 20%, it becomes increasingly difficult to see the token. At 0%, it is completely invisible, even to the Gamemaster. If you can't find it, use the Map Explorer panel.
Example
[h: setTokenOpacity(0.5, "Dragon")]
[h, token("Dragon"): setTokenOpacity(0.75)]
Version Changes
- 1.5.4 - Added
mapnameparameter option.