setLayer
(Redirected from SetLayer)
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 HiddenOBJECT
BACKGROUND
Usage
setLayer(layer)
setLayer(layer, tokenRef)
setLayer(layer, tokenRef, forceshape)
setLayer(layer, tokenRef, forceshape, mapname)
Parameters
layer
- The layer to move the Token to.tokenRef
- Either the tokenid
or Token Name of the token.
forceshape
- Iftrue
(1
), change the token shape type to TOP_DOWN if the layer isOBJECT
, and to a shape reflecting its image if the layer isTOKEN
. Defaults totrue
(1
).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
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. - 1.5.4 - Added
mapname
parameter option.