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)
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenShape()
getTokenShape()
getTokenShape(id)
getTokenShape(tokenRef)
getTokenShape(id, mapname)
getTokenShape(tokenRef, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|The token id of the token to check for the shape, defaults to the [[Current Token]].}}{{TrustedParameter}}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for the shape, defaults to the [[Current Token]].}}{{TrustedParameter}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


'''Result'''<br />
'''Result'''<br />
Line 22: Line 23:
|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>
</syntaxhighlight>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
TOP_DOWN
TOP_DOWN
</source>
</syntaxhighlight>


|changes=
|changes=

Latest revision as of 16:36, 14 May 2024

getTokenShape() Function

Introduced in version 1.3b89
Retrieves the token's shape (top-down, circle, square).

Usage

getTokenShape()
getTokenShape(tokenRef)
getTokenShape(tokenRef, mapname)

Parameters

  • tokenRef - Either the token id or Token Name 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


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_DOWN

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.