setTokenShape

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: No examples yet.

setTokenShape() Function

• Introduced in version 1.3b89

Sets the token's shape (top down, circle, square, figure).

Usage

setTokenShape(shape)
setTokenShape(shape, id)
setTokenShape(shape, id, mapRef)

Parameters

• shape - String value: "TOP_DOWN", "CIRCLE", "SQUARE", "FIGURE".
• id - The token id of the token to set to a new shape, defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID 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", "FIGURE".

Example

On current token.

[h: newShape = "CIRCLE"]
[r: setTokenShape(newShape)]

Returns:

Circle

With Token ID.

[h: newShape = "TOP_DOWN"]
[h: tokenName = "Some Token"]
[r: setTokenShape(newShape,tokenName)]

Returns:

Top down

See Also

getTokenShape()

Version Changes

• 1.9.0 - Shape parameter TOP_DOWN works with or without underscore character.
• 1.5.4 - Added mapname parameter option.