bringToFront: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (16 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=bringToFront | |||
|version=1.3b48 | |||
|description= | |||
Adjust the z order (or draw order) of the [[Token]] so that is is drawn after all other [[Token]]s on the same [[Introduction to Mapping#introduction to Mapping|Map Layer]], this has the effect of making the [[Token]] appear to be in front of the other [[Token]]s as it will obscure other [[Token]]s on the same [[Introduction to Mapping#introduction to Mapping|Map Layer]] in the same location. | |||
== | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
bringToFront() | |||
bringToFront(tokenRef) | |||
bringToFront(tokenRef, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token 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.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|examples= | |||
<syntaxhighlight lang="mtmacro" line> | |||
<!-- Make sure that we are visible above all other tokens on the same layer --> | |||
[h: bringToFront()] | [h: bringToFront()] | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
<!-- The Hero of the piece should always stand out --> | |||
[h: bringToFront("Hero")] | |||
</syntaxhighlight> | |||
|also= | |||
[[sendToBack|sendToBack()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Token Function]] | |||
Latest revision as of 20:33, 12 May 2024
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.
Usage
bringToFront()
bringToFront(tokenRef)
bringToFront(tokenRef, mapname)Parameter
tokenRef- Either the tokenidor Token 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
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.