getLayer: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getLayer moved to getLayer) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getLayer | |name=getLayer | ||
|description=Returns the [[Map | |version=1.3b48 | ||
|description= | |||
Returns the [[Introduction to Mapping#introduction to Mapping|Map Layer]] that a [[Token]] is on. | |||
The [[Map | The [[Introduction to Mapping#introduction to Mapping|Map Layer]] will be one of: | ||
* TOKEN | * {{code|TOKEN}} | ||
* | * {{code|GM}} also known as Hidden | ||
* | * {{code|OBJECT}} | ||
* | * {{code|BACKGROUND}} | ||
| |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getLayer() | |||
</ | getLayer(id) | ||
getLayer(id, mapname) | |||
</syntaxhighlight> | |||
'''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|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|also= | |||
[[setLayer|setLayer()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
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.