setLayer

From RPTools Wiki
Revision as of 01:56, 28 April 2009 by Palmer (talk | contribs) (Added examples of use, removed Stub note)
Jump to navigation Jump to search

setLayer() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
Sets the Map Layer that a Token is on.

The Map Layer is one of:

  • TOKEN
  • GM also known as Hidden
  • OBJECT
  • BACKGROUND

Usage

setLayer(layer)
setLayer(layer, id)

Parameters

  • layer - The layer to move the Token to.
  • id - The token id of the token which has its layer set, defaults to the Current Token.

Examples

When an NPC token is dead, send it to the Object layer, otherwise leave it where it is.
[h: layerName = getLayer()]
[h: layerName = if(state.Dead&&isNPC(), "OBJECT", layerName)]
[h: setLayer(layerName)]

Toggle a token between the Hidden and Token layers.

[h: layerName = getLayer()]
[h: layerName = if(layerName=="GM", "TOKEN", "GM")]
[h: setLayer(layerName)]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.