getLayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 18: | Line 18: | ||
getLayer(id) | getLayer(id) | ||
getLayer(id, mapname) | getLayer(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{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|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}} }} | ||
Revision as of 18:12, 14 March 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:
TOKENGMalso known as HiddenOBJECTBACKGROUND
Usage
<source lang="mtmacro" line> getLayer() getLayer(id) getLayer(id, mapname) </syntaxhighlight> Parameter
id- The tokenidof 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.