setTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setTokenShape()
setTokenShape(shape)
setTokenShape(shape)
setTokenShape(shape, id)
setTokenShape(shape, id)

Revision as of 15:17, 9 September 2018

 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
This function sets the token's shape (top down, circle, square, figure).

Usage

setTokenShape(shape)
setTokenShape(shape, id)

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

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