bringToFront: Difference between revisions
Jump to navigation
Jump to search
m (Added note about current bug in 1.3.b63) |
No edit summary |
||
| Line 10: | Line 10: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
bringToFront() | bringToFront() | ||
bringToFront(id) | bringToFront(id) | ||
bringToFront(id, mapname) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|id|The token {{code|id}} or name of the token to effect, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} or name of the token to effect, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
| Line 34: | Line 35: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 20:36, 15 August 2019
bringToFront() Function
• Introduced in version 1.3b48
Adjust the z order (or draw order) of the Token so that is is drawn after all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in front of the other Tokens as it will obscure other Tokens on the same Map Layer in the same location.
As of 1.3.b63 there appears to be a bug in which token states are not rendered properly after calling sendToBack or bringToFront. As a work-around, macros should change the token ordering first, then turn states on or off.
Usage
bringToFront()
bringToFront(id)
bringToFront(id, mapname)Parameter
id- The tokenidor name of the token to effect, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.
Examples
<!-- Make sure that we are visible above all other tokens on the same layer -->
[h: bringToFront()]
<!-- The Hero of the piece should always stand out -->
[h: bringToFront("Hero")]See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.