setTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Adding description, usage, link to other functions) |
(Modified trusted usage, parameters and result) |
||
| Line 1: | Line 1: | ||
{{stub|Confirm | {{stub|Confirm the shape strings that can be used.<br /> | ||
No examples yet.}} | No examples yet.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=setTokenShape | |name=setTokenShape | ||
|proposed=false | |proposed=false | ||
|trusted= | |trusted=false | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
This function sets the token's shape (top-down, circle, | This function sets the token's shape (top-down, circle, square). | ||
|usage= | |usage= | ||
| Line 16: | Line 15: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|shape| | {{param|shape|String value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.}} | ||
{{param|id|The token id of the token to check for the state, defaults to the Current Token.}} | {{param|id|The token id of the token to check for the state, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
|example= | |||
'''Result'''<br /> | |||
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 12:55, 8 April 2013
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 check for the state, 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