setTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Modified usage) |
No edit summary |
||
| Line 6: | Line 6: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
This function sets the token's shape (top | This function sets the token's shape (top down, circle, square). | ||
|usage= | |usage= | ||
| Line 15: | Line 15: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|shape|String value: {{code|"TOP | {{param|shape|String value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.}} | ||
{{param|id|The token id of the token to set to a new shape, defaults to the [[Current Token]].}}{{TrustedParameter}} | {{param|id|The token id of the token to set to a new shape, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
'''Result'''<br /> | '''Result'''<br /> | ||
The function returns the token's shape as a string value: {{code|"TOP | 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 09:15, 7 July 2014
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