getTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Modified usage) |
(Updated description, usage) |
||
| Line 1: | Line 1: | ||
{{stub| | {{stub|No examples yet.}} | ||
No examples yet.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenShape | |name=getTokenShape | ||
| Line 7: | Line 6: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
This function retrieves the token's shape (top-down, circle, | This function retrieves the token's shape (top-down, circle, square). | ||
|usage= | |usage= | ||
| Line 18: | Line 17: | ||
{{param|id|The token id of the token to check for the shape, defaults to the [[Current Token]].}}{{TrustedParameter}} | {{param|id|The token id of the token to check for the shape, defaults to the [[Current Token]].}}{{TrustedParameter}} | ||
'''Result'''<br /> | '''Result'''<br /> | ||
The token's shape as a string value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}. | The function returns the token's shape as a string value: {{code|"TOP-DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}. | ||
|example= | |example= | ||
This example doesn't really do anything. | This example doesn't really do anything. | ||
Revision as of 07:54, 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.
getTokenShape() Function
• Introduced in version 1.3b89
This function retrieves the token's shape (top-down, circle, square).
Usage
getTokenShape()
getTokenShape(id)Parameters
id- The token id of the token to check for the 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