setTokenShape

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

setTokenShape() Function

• Introduced in version 1.3b89

This function sets the token's shape (top-down, circle, square).

Usage

setTokenShape(shape)
setTokenShape(shape, id)

Parameters

• shape - String value: "TOP-DOWN", "CIRCLE", "SQUARE".
• 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. 

Result
The token's shape as a string value: "TOP-DOWN", "CIRCLE", "SQUARE".

Example

This example doesn't really do anything.

[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]

Returns:

c,b,a

See Also

getTokenShape()