sendToBack: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Bug fixed in Nerps and 1.5.0)
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Adjust the z-order (or draw order) of the [[Token]] so that it is drawn before all other [[Token]]s on the same [[Map Layer]], this has the effect of making the Token appear to be in back of the other [[Token]]s as it will be obscured by other [[Token]]s on the same [[Map Layer]] in the same location.
Adjust the z-order (or draw order) of the [[Token]] so that it is drawn before 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 back of the other [[Token]]s as it will be obscured by other [[Token]]s on the same [[Introduction to Mapping#introduction to Mapping|Map Layer]] in the same location.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
sendToBack()
sendToBack()
sendToBack(id)
sendToBack(tokenRef)
sendToBack(id, mapname)
sendToBack(tokenRef, mapname)
</source>
</syntaxhighlight>
'''Parameter'''
'''Parameter'''
{{param|id|The token {{code|id}} or name of the token that has its z-order changed, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that has its z-order changed, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{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=
|examples=
Sends the [[Current Token]] to the lowest z-order.
Sends the [[Current Token]] to the lowest z-order.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: sendToBack()]
[h: sendToBack()]
</source>
</syntaxhighlight>


Sends all of the selected tokens to the lowest z-order.
Sends all of the selected tokens to the lowest z-order.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: tokens = getSelected()]
[h: tokens = getSelected()]
[h, foreach(id, tokens, ""), code:
[h, foreach(id, tokens, ""), code:
Line 29: Line 29:
     [h: sendToBack(id)]
     [h: sendToBack(id)]
}]
}]
</source>
</syntaxhighlight>


|also=
|also=

Latest revision as of 17:03, 23 May 2024

sendToBack() Function

Introduced in version 1.3b48
Adjust the z-order (or draw order) of the Token so that it is drawn before all other Tokens on the same Map Layer, this has the effect of making the Token appear to be in back of the other Tokens as it will be obscured by other Tokens on the same Map Layer in the same location.

Usage

sendToBack()
sendToBack(tokenRef)
sendToBack(tokenRef, mapname)

Parameter

  • tokenRef - Either the token id or Token Name of the token that has its z-order changed, 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

Sends the Current Token to the lowest z-order.
[h: sendToBack()]

Sends all of the selected tokens to the lowest z-order.

[h: tokens = getSelected()]
[h, foreach(id, tokens, ""), code:
{
    [h: sendToBack(id)]
}]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.