setTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(Adding description, usage, link to other functions)
No edit summary
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{stub|Confirm the function acts on current token as default id.<br />
{{stub|No examples yet.}}
What are all the shape strings that can be used?<br />
No examples yet.}}
{{MacroFunction
{{MacroFunction
|name=setTokenShape
|name=setTokenShape
|proposed=false
|proposed=false
|trusted=true
|trusted=false
|version=1.3b89
|version=1.3b89
|description=
|description=
This function sets the token's shape (top-down, circle, etc.).
Sets the token's shape (top down, circle, square, figure).


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setTokenShape(shape)
setTokenShape(shape)
setTokenShape(shape, id)
setTokenShape(shape, id)
</source>
setTokenShape(shape, id, mapRef)
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|shape|'''To be defined.'''}}
{{param|shape|String value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}.}}
{{param|id|The token id of the token to check for the state, defaults to the Current Token.}}
{{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 />
The function returns the token's shape as a string value: {{code|"TOP_DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}.
 
|example=
|example=
This example doesn't really do anything.
On current token.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[h: newShape = "CIRCLE"]
[r: exampleFunction(exampleVariable, reverse)]
[r: setTokenShape(newShape)]
</source>
</syntaxhighlight>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
c,b,a
Circle
</source>
</syntaxhighlight>
With Token ID.
<syntaxhighlight lang="mtmacro" line>
[h: newShape = "TOP_DOWN"]
[h: tokenName = "Some Token"]
[r: setTokenShape(newShape,tokenName)]
</syntaxhighlight>
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: 

Circle

With Token ID. 

[h: newShape = "TOP_DOWN"]
[h: tokenName = "Some Token"]
[r: setTokenShape(newShape,tokenName)]

Returns: 

Top down

See Also

getTokenShape()

Version Changes

  • 1.9.0 - Shape parameter TOP_DOWN works with or without underscore character.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=setTokenShape&oldid=35756"