bringToFront

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 token id or 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

sendToBack()

Version Changes

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