getTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Adding description, usage, link to other functions) |
(Modified trusted usage and result) |
||
| Line 1: | Line 1: | ||
{{stub| | {{stub|What are all the shape strings that can be used?<br /> | ||
What are all the shape strings that can be used?<br /> | |||
No examples yet.}} | No examples yet.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenShape | |name=getTokenShape | ||
|proposed=false | |proposed=false | ||
|trusted= | |trusted=false | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
| Line 16: | Line 15: | ||
'''Parameters''' | '''Parameters''' | ||
{{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}} | ||
'''Result'''<br /> | '''Result'''<br /> | ||
The token's shape as a string value. | The token's shape as a string value: "TOP-DOWN", "CIRCLE", SQUARE". | ||
|example= | |example= | ||
This example doesn't really do anything. | This example doesn't really do anything. | ||
Revision as of 12:45, 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: What are all the shape strings that can be used?
No examples yet.
getTokenShape() Function
• Introduced in version 1.3b89
This function retrieves the token's shape (top-down, circle, etc.).
Usage
getTokenShape(id)Parameters
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