getTokenShape: Difference between revisions
Jump to navigation
Jump to search
(Updated description, usage) |
No edit summary |
||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenShape | |name=getTokenShape | ||
| Line 6: | Line 5: | ||
|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() | ||
getTokenShape( | getTokenShape(tokenRef) | ||
</ | getTokenShape(tokenRef, mapRef) | ||
</syntaxhighlight> | |||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for the 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.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
'''Result'''<br /> | '''Result'''<br /> | ||
The function returns 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"}}. | ||
|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= | ||
Latest revision as of 23:59, 14 May 2024
getTokenShape() Function
• Introduced in version 1.3b89
Retrieves the token's shape (top-down, circle, square).
Usage
getTokenShape()
getTokenShape(tokenRef)
getTokenShape(tokenRef, mapRef)Parameters
tokenRef- Either the tokenidor Token Name of the token to check for the 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
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.