getLayer: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==Function getLayer==
{{MacroFunction
|name=getLayer
|description=Returns the [[Map:map layer{{!}}map layer]] that the [[Token:Current Token{{!}}Current Token]] is on.


Returns the [[Map:map layer|map layer]] that the [[Token:Current Token|Current Token]] is on.
The [[Map:map layer{{!}}map layer]] is one of:
The [[Map:map layer|map layer]] is one of:
* TOKEN
* TOKEN
* BACKGROUND
* BACKGROUND
Line 8: Line 9:
* OBJECT
* OBJECT


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: layerName = getLayer()]
[h: layerName = getLayer()]
</source>
</source>
}}
[[Category:Token Function]]

Revision as of 03:48, 7 March 2009

getLayer() Function

Returns the map layer that the Current Token is on.

The map layer is one of:

  • TOKEN
  • BACKGROUND
  • GM
  • OBJECT

Usage

[h: layerName = getLayer()]