getTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Created empty) |
(Adding description, usage, link to other functions) |
||
| Line 1: | Line 1: | ||
{{stub| | {{stub|Confirm the function acts on current token as default id.<br /> | ||
What are all the shape strings that can be used?<br /> | |||
No examples yet.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenShape | |name=getTokenShape | ||
| Line 6: | Line 8: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
This | This function retrieves the token's shape (top-down, circle, etc.). | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getTokenShape(id) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|id|The token id of the token to check for the state, defaults to the Current Token.}} | |||
'''Result'''<br /> | |||
The token's shape as a string value. | |||
|example= | |example= | ||
This example doesn't really do anything. | This example doesn't really do anything. | ||
| Line 25: | Line 31: | ||
|also= | |also= | ||
{{func|setTokenShape}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 12:10, 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 function acts on current token as default id.
What are all the shape strings that can be used?
No examples yet.
getTokenShape() Function
Note: This function can only be used in a Trusted Macro
• 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.
Result
The token's shape as a string value.
Example
This example doesn't really do anything.
[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]Returns:
c,b,a