setLayer

Contents 1 setLayer() Function 1.1 Usage 1.2 Examples 1.3 See Also 1.4 Version Changes

setLayer() Function

Sets the Map Layer that a Token is on.

The Map Layer is one of:

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

Usage

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.

Toggle a token between the Hidden and Token layers.

See Also

getLayer()

Version Changes

• 1.3b51 - Added id parameter option.

Token: A visual marker representing a character, monster, or NPCTrusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.State: A binary (i.e., it has two possible values, 1 or 0) variable that is set for a given token, frequently used for conditions or statuses that affect a particular character in a game.