getTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Created empty) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (12 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenShape | |name=getTokenShape | ||
|proposed=false | |proposed=false | ||
|trusted= | |trusted=false | ||
|version=1.3b89 | |version=1.3b89 | ||
|description= | |description= | ||
Retrieves the token's shape (top-down, circle, square). | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getTokenShape() | |||
</ | getTokenShape(id) | ||
getTokenShape(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{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 /> | |||
The function returns the token's shape as a string value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}. | |||
|example= | |example= | ||
Get the token shape for the top down Dragon token. | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
[ | [r: getTokenShape("Dragon")] | ||
</syntaxhighlight> | |||
</ | |||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
TOP_DOWN | |||
</ | </syntaxhighlight> | ||
|changes= | |||
{{change|1.9.0|Top Down token shape will be returned as {{code|TOP_DOWN}} with underscore.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
|also= | |also= | ||
{{func|setTokenShape}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 20:43, 14 March 2023
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
Get the token shape for the top down Dragon token.
[r: getTokenShape("Dragon")]Returns:
TOP_DOWNSee Also
Version Changes
- 1.9.0 - Top Down token shape will be returned as
TOP_DOWNwith underscore. - 1.5.4 - Added
mapnameparameter option.