getTokenShape: Difference between revisions

Revision as of 23:31, 9 February 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.

Revision as of 22:29, 9 February 2023 (view source) Conversion script (talk \| contribs) m (Conversion script moved page getTokenShape to GetTokenShape without leaving a redirect: Converting page title to first-letter uppercase) ← Older edit	Revision as of 23:31, 9 February 2023 (view source) Conversion script (talk \| contribs) m (Conversion script moved page GetTokenShape to getTokenShape: Converting page titles to lowercase) Newer edit →
(No difference)