getTokenShape

From RPTools Wiki
Revision as of 16:36, 14 May 2024 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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.