setLayer: Difference between revisions

Latest revision as of 20:56, 14 March 2023

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

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 4: / Line 4: @@
 |version=1.3b48
 |description=
-Sets the [[Map Layer]] that a [[Token]] is on.
+Sets the [[Introduction to Mapping#introduction to Mapping|Map Layer]] that a [[Token]] is on.
-The [[Map Layer]] is one of:
+The [[Introduction to Mapping#introduction to Mapping|Map Layer]] is one of:
 * {{code|TOKEN}}
 * {{code|GM}} also known as Hidden
@@ Line 14: / Line 14: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setLayer(layer)
 setLayer(layer, id)
 setLayer(layer, id, forceshape)
 setLayer(layer, id, forceshape, mapname)
-</source>
+</syntaxhighlight>
 '''Parameters'''
 {{param|layer|The layer to move the [[Token]] to.}}
@@ Line 28: / Line 28: @@
 |examples=
 When an NPC token is dead, send it to the Object layer, otherwise leave it where it is.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [h: layerName = getLayer()]
 [h: layerName = if(state.Dead&&isNPC(), "OBJECT", layerName)]
 [h: setLayer(layerName)]
-</source>
+</syntaxhighlight>
 Toggle a token between the Hidden and Token layers.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 [h: layerName = getLayer()]
 [h: layerName = if(layerName=="GM", "TOKEN", "GM")]
 [h: setLayer(layerName)]
-</source>
+</syntaxhighlight>
 |also=