getLayer

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples of usage.

getLayer() Function

• Introduced in version 1.3b48

Returns the Map Layer that a Token is on.

The Map Layer will be one of:

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

 

Usage

getLayer()
getLayer(tokenRef)
getLayer(tokenRef, mapname)

Parameter

• tokenRef - Either the token id or Token Name of the token which has its Map Layer returned, defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

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

See Also

setLayer()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.4 - Added mapname parameter option.