setLayer: Difference between revisions

Revision as of 01:08, 9 May 2024

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:

setLayer(layer)
setLayer(layer, id)
setLayer(layer, id, forceshape)
setLayer(layer, id, forceshape, mapname)

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. Will also work with Token Name

forceshape - If true(1), change the token shape type to TOP_DOWN if the layer is OBJECT, and to a shape reflecting its image if the layer is TOKEN. Defaults to true(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.

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)]

@@ Line 26: / Line 26: @@
 {{param|forceshape|}}If {{true}}, change the token shape type to TOP_DOWN if the layer is {{code|OBJECT}}, and to a shape reflecting its image if the layer is {{code|TOKEN}}. Defaults to {{true}}.
 {{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
-{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than on token has the same name can produce unexpected results.}}
+{{Note|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=