setTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Correcting parameter description) |
No edit summary |
||
| (11 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub| | {{stub|No examples yet.}} | ||
No examples yet.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=setTokenShape | |name=setTokenShape | ||
| Line 7: | Line 6: | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
Sets the token's shape (top down, circle, square, figure). | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setTokenShape(shape) | setTokenShape(shape) | ||
setTokenShape(shape, id) | setTokenShape(shape, id) | ||
</ | setTokenShape(shape, id, mapRef) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|shape|String value: {{code|" | {{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|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
'''Result'''<br /> | '''Result'''<br /> | ||
The token's shape as a string value: {{code|" | The function returns the token's shape as a string value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}. | ||
< | |example= | ||
[h: | On current token. | ||
[r: | <syntaxhighlight lang="mtmacro" line> | ||
</ | [h: newShape = "CIRCLE"] | ||
[r: setTokenShape(newShape)] | |||
</syntaxhighlight> | |||
Returns: | |||
<syntaxhighlight lang="mtmacro" line> | |||
Circle | |||
</syntaxhighlight> | |||
With Token ID. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: newShape = "TOP_DOWN"] | |||
[h: tokenName = "Some Token"] | |||
[r: setTokenShape(newShape,tokenName)] | |||
</syntaxhighlight> | |||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
Top down | |||
</ | </syntaxhighlight> | ||
|changes= | |||
{{change|1.9.0|Shape parameter {{code|TOP_DOWN}} works with or without underscore character.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
Latest revision as of 23:59, 14 March 2023
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, mapRef)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.
mapRef- The Name or ID 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.9.0 - Shape parameter
TOP_DOWNworks with or without underscore character. - 1.5.4 - Added
mapnameparameter option.