getTokenShape: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
getTokenShape() | getTokenShape() | ||
getTokenShape(id) | getTokenShape(id) | ||
getTokenShape(id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{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}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
'''Result'''<br /> | '''Result'''<br /> | ||
The function returns 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"}}. | ||
| Line 28: | Line 31: | ||
c,b,a | c,b,a | ||
</source> | </source> | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
Revision as of 20:56, 15 August 2019
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
Retrieves the token's shape (top-down, circle, square).
Usage
getTokenShape()
getTokenShape(id)
getTokenShape(id, mapname)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.
mapname- The name of the map to find the token. Defaults to the current map.
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,aSee Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.