getTokenShape: Difference between revisions

Latest revision as of 20:43, 14 March 2023

• Introduced in version 1.3b89

Retrieves the token's shape (top-down, circle, square).

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".

Get the token shape for the top down Dragon token.

[r: getTokenShape("Dragon")]

Returns:

TOP_DOWN

1.9.0 - Top Down token shape will be returned as TOP_DOWN with underscore.
1.5.4 - Added mapname parameter option.

@@ Line 1: / Line 1: @@
-{{stub|No examples yet.}}
 {{MacroFunction
 |name=getTokenShape
@@ Line 9: / Line 8: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 getTokenShape()
 getTokenShape(id)
 getTokenShape(id, mapname)
-</source>
+</syntaxhighlight>
 '''Parameters'''
@@ Line 20: / Line 19: @@
 '''Result'''<br />
-The function returns the token's shape as a string value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.
+The function returns the token's shape as a string value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.
 |example=
-This example doesn't really do anything.
+Get the token shape for the top down Dragon token.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: exampleVariable = "a,b,c"]
+[r: getTokenShape("Dragon")]
-[r: exampleFunction(exampleVariable, reverse)]
+</syntaxhighlight>
-</source>
 Returns:
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-c,b,a
+TOP_DOWN
-</source>
+</syntaxhighlight>
 |changes=
+{{change|1.9.0|Top Down token shape will be returned as {{code|TOP_DOWN}} with underscore.}}
 {{change|1.5.4|Added {{code|mapname}} parameter option.}}