getTokenShape: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 12: | Line 12: | ||
getTokenShape(id) | getTokenShape(id) | ||
getTokenShape(id, mapname) | getTokenShape(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 24: | Line 24: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
[r: getTokenShape("Dragon")] | [r: getTokenShape("Dragon")] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
TOP_DOWN | TOP_DOWN | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Revision as of 20:43, 14 March 2023
getTokenShape() Function
• Introduced in version 1.3b89
Retrieves the token's shape (top-down, circle, square).
Usage
getTokenShape()
getTokenShape(id)
getTokenShape(id, mapname)Parameters
id- The token id of the token to check for the shape, 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.
Result
The function returns the token's shape as a string value: "TOP_DOWN", "CIRCLE", "SQUARE".
Example
Get the token shape for the top down Dragon token.
[r: getTokenShape("Dragon")]Returns:
TOP_DOWNSee Also
Version Changes
- 1.9.0 - Top Down token shape will be returned as
TOP_DOWNwith underscore. - 1.5.4 - Added
mapnameparameter option.