getLayer: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetLayer to getLayer: Converting page titles to lowercase)
No edit summary
Line 4: Line 4:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns the [[Map Layer]] that a [[Token]] is on.
Returns the [[Introduction to Mapping#introduction to Mapping|Map Layer]] that a [[Token]] is on.


The [[Map Layer]] will be one of:
The [[Introduction to Mapping#introduction to Mapping|Map Layer]] will be one of:
* {{code|TOKEN}}
* {{code|TOKEN}}
* {{code|GM}} also known as Hidden
* {{code|GM}} also known as Hidden
Line 20: Line 20:
</source>
</source>
'''Parameter'''
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its [[Map Layer]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token which has its [[Introduction to Mapping#introduction to Mapping|Map Layer]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}



Revision as of 08:34, 12 February 2023

 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(id)
getLayer(id, mapname)

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.