getLayer

From RPTools Wiki
Revision as of 18:12, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

 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

<source lang="mtmacro" line> getLayer() getLayer(id) getLayer(id, mapname) </syntaxhighlight> Parameter

  • id - The token id 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.


See Also

Version Changes

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