setTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Modified usage)
(Modified usage)
Line 1: Line 1:
{{stub|Confirm the shape strings that can be used.<br />
{{stub|No examples yet.}}
No examples yet.}}
{{MacroFunction
{{MacroFunction
|name=setTokenShape
|name=setTokenShape
Line 20: Line 19:


'''Result'''<br />
'''Result'''<br />
The token's shape as a string value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.|example=
The function returns the token's shape as a string value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.|example=
This example doesn't really do anything.
This example doesn't really do anything.
<source lang="mtmacro" line>
<source lang="mtmacro" line>

Revision as of 07:55, 9 April 2013

 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).

Usage

setTokenShape()
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 function returns 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