getLayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (4 intermediate revisions by 2 users not shown) | |||
| 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 14: | Line 14: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getLayer() | getLayer() | ||
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 [[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.}} | ||
Latest revision as of 19:36, 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
getLayer()
getLayer(id)
getLayer(id, mapname)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.