setLayer: Difference between revisions

Revision as of 19:42, 15 August 2019

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, 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.
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 16: / Line 16: @@
 <source lang="mtmacro" line>
 setLayer(layer)
-</source>
-<source lang="mtmacro" line>
 setLayer(layer, id)
+setLayer(layer, id, mapname)
 </source>
 '''Parameters'''
 {{param|layer|The layer to move the [[Token]] to.}}
 {{param|id|The token {{code|id}} of the token which has its layer set, defaults to the [[Current Token]].}}
+{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |examples=
@@ Line 44: / Line 44: @@
 |changes=
 {{change|1.3b51|Added {{code|id}} parameter option.}}
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 }}
 [[Category:Token Function]]