getTokenShape
getTokenShape() Function
• Introduced in version 1.3b89
Retrieves the token's shape (top-down, circle, square).
Usage
<syntaxhighlight lang="mtmacro" line> getTokenShape() getTokenShape(id) getTokenShape(id, mapname) </source>
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.
<syntaxhighlight lang="mtmacro" line> [r: getTokenShape("Dragon")] </source> Returns: <syntaxhighlight lang="mtmacro" line> TOP_DOWN
</source>See Also
Version Changes
- 1.9.0 - Top Down token shape will be returned as
TOP_DOWN
with underscore. - 1.5.4 - Added
mapname
parameter option.