setLayer: 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=setLayer | |name=setLayer | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description | |description= | ||
Sets the [[Map | Sets the [[Map Layer]] that a [[Token]] is on. | ||
The [[Map | |||
* TOKEN | The [[Map Layer]] is one of: | ||
* | * {{code|TOKEN}} | ||
* | * {{code|GM}} also known as Hidden | ||
* | * {{code|OBJECT}} | ||
* {{code|BACKGROUND}} | |||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setLayer( | setLayer(layer) | ||
</source> | |||
<source lang="mtmacro" line> | |||
setLayer(layer, id) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|layer|The layer to move the [[Token]] to.}} | |||
{{param|id|The token {{code|id}} of the token which has its layer set, defaults to the [[Current Token]].}} | |||
|also= | |||
[[getLayer|getLayer()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 03:16, 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.
setLayer() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Sets the Map Layer that a Token is on.
The Map Layer is one of:
TOKENGMalso known as HiddenOBJECTBACKGROUND
Usage
setLayer(layer)setLayer(layer, id)Parameters
layer- The layer to move the Token to.id- The tokenidof the token which has its layer set, defaults to the Current Token.
See Also
Version Changes
- 1.3b51 - Added
idparameter option.