sendToBack

From RPTools Wiki
Revision as of 08:34, 12 February 2023 by Taustin (talk | contribs)
Jump to navigation Jump to search

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

Version Changes

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