getLayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
|name=getLayer | |||
|version=1.3b48 | |||
|description= | |||
Returns the [[Introduction to Mapping#introduction to Mapping|Map Layer]] that a [[Token]] is on. | |||
The [[Introduction to Mapping#introduction to Mapping|Map Layer]] will be one of: | |||
* {{code|TOKEN}} | |||
* TOKEN | * {{code|GM}} also known as Hidden | ||
* | * {{code|OBJECT}} | ||
* | * {{code|BACKGROUND}} | ||
* | | ||
|usage= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
getLayer() | |||
</ | getLayer(tokenRef) | ||
getLayer(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its [[Introduction to Mapping#introduction to Mapping|Map Layer]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|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.}} | |||
|also= | |||
[[setLayer|setLayer()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Token Function]] | |||
Latest revision as of 23:59, 13 May 2024
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(tokenRef)
getLayer(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor 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.
mapRef- The Name or ID 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
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.