getLayer: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
Verisimilar (talk | contribs) m (Reorderd layers to match UI.) |
||
| Line 6: | Line 6: | ||
Returns the [[Map Layer]] that a [[Token]] is on. | Returns the [[Map Layer]] that a [[Token]] is on. | ||
The [[Map Layer]] | The [[Map Layer]] will be one of: | ||
* {{code|TOKEN}} | * {{code|TOKEN}} | ||
* {{code|GM}} also known as Hidden | * {{code|GM}} also known as Hidden | ||
* {{code|OBJECT}} | * {{code|OBJECT}} | ||
* {{code|BACKGROUND}} | |||
|usage= | |usage= | ||
Revision as of 03:11, 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 will be one of:
TOKENGMalso known as HiddenOBJECTBACKGROUND
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.