sendToBack

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. 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

sendToBack()
sendToBack(id)
sendToBack(id, mapname)

Parameter

• id - The token id or 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.

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

bringToFront()

Version Changes

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