getLayer: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version.) |
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getLayer | |name=getLayer | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns the [[Map | |description= | ||
Returns the [[Map Layer]] that a [[Token]] is on. | |||
The [[Map | The [[Map Layer]] is one of: | ||
* TOKEN | * {{code|TOKEN}} | ||
* BACKGROUND | * {{code|BACKGROUND}} | ||
* GM | * {{code|GM}} also known as Hidden | ||
* OBJECT | * {{code|OBJECT}} | ||
|usage= | |usage= | ||
| Line 14: | Line 16: | ||
getLayer() | getLayer() | ||
</source> | </source> | ||
<source lang="mtmacro" line> | |||
getLayer(id) | |||
</source> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token which has its [[Map Layer]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|also= | |||
[[setLayer|setLayer()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 03:10, 31 March 2009
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 is one of:
TOKENBACKGROUNDGMalso known as HiddenOBJECT
Usage
getLayer()getLayer(id)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.
See Also
Version Changes
- 1.3b51 - Added
idparameter option.