getTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(Modified trusted usage and result)
m (Text replacement - "source>" to "syntaxhighlight>")
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{stub|What are all the shape strings that can be used?<br />
No examples yet.}}
{{MacroFunction
{{MacroFunction
|name=getTokenShape
|name=getTokenShape
Line 7: Line 5:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function retrieves the token's shape (top-down, circle, etc.).
Retrieves the token's shape (top-down, circle, square).


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenShape()
getTokenShape(id)
getTokenShape(id)
</source>
getTokenShape(id, mapname)
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|The token id of the token to check for the state, 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 token's shape as a string value: "TOP-DOWN", "CIRCLE", SQUARE".
The function returns the token's shape as a string value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.
|example=
|example=
This example doesn't really do anything.
Get the token shape for the top down Dragon token.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[r: getTokenShape("Dragon")]
[r: exampleFunction(exampleVariable, reverse)]
</syntaxhighlight>
</source>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
c,b,a
TOP_DOWN
</source>
</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 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_DOWN

See Also

setTokenShape()

Version Changes

  • 1.9.0 - Top Down token shape will be returned as TOP_DOWN with underscore.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getTokenShape&oldid=16051"