getTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTokenShape to getTokenShape: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenShape()
getTokenShape()
getTokenShape(id)
getTokenShape(id)
Line 22: Line 22:
|example=
|example=
Get the token shape for the top down Dragon token.
Get the token shape for the top down Dragon token.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: getTokenShape("Dragon")]
[r: getTokenShape("Dragon")]
</source>
</source>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
TOP_DOWN
TOP_DOWN
</source>
</source>

Revision as of 20:30, 14 March 2023

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.