setTokenShape: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
setTokenShape(shape) | setTokenShape(shape) | ||
setTokenShape(shape, id) | setTokenShape(shape, id) | ||
setTokenShape(shape, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|shape|String value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}.}} | {{param|shape|String value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}.}} | ||
{{param|id|The token id of the token to set to a new shape, defaults to the [[Current Token]].}}{{TrustedParameter}} | {{param|id|The token id of the token to set to a new 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 /> | ||
| Line 40: | Line 43: | ||
Top down | Top down | ||
</source> | </source> | ||
|changes= | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
Revision as of 20:57, 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.
setTokenShape() Function
• Introduced in version 1.3b89
Sets the token's shape (top down, circle, square, figure).
Usage
setTokenShape(shape)
setTokenShape(shape, id)
setTokenShape(shape, id, mapname)Parameters
shape- String value:"TOP DOWN","CIRCLE","SQUARE","FIGURE".id- The token id of the token to set to a new 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", "FIGURE".
Example
On current token.
[h: newShape = "CIRCLE"]
[r: setTokenShape(newShape)]Returns:
CircleWith Token ID.
[h: newShape = "TOP DOWN"]
[h: tokenName = "Some Token"]
[r: setTokenShape(newShape,tokenName)]Returns:
Top downSee Also
Version Changes
- 1.5.4 - Added
mapnameparameter option.