setTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
|version=1.3b89
|version=1.3b89
|description=
|description=
This function sets the token's shape (top down, circle, square).
This function sets the token's shape (top down, circle, square, figure).


|usage=
|usage=
Line 15: Line 15:
</source>
</source>
'''Parameters'''
'''Parameters'''
{{param|shape|String value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.}}
{{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}}


'''Result'''<br />
'''Result'''<br />
The function returns the token's shape as a string value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}.|example=
The function returns the token's shape as a string value: {{code|"TOP DOWN"}}, {{code|"CIRCLE"}}, {{code|"SQUARE"}}, {{code|"FIGURE"}}.
This example doesn't really do anything.
 
|example=
On current token.
<source lang="mtmacro" line>
[h: newShape = "CIRCLE"]
[r: setTokenShape(newShape)]
</source>
Returns:
<source lang="mtmacro" line>
Circle
</source>
With Token ID.
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: exampleVariable = "a,b,c"]
[h: newShape = "TOP DOWN"]
[r: exampleFunction(exampleVariable, reverse)]
[h: tokenName = "Some Token"]
[r: setTokenShape(newShape,tokenName)]
</source>
</source>
Returns:
Returns:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
c,b,a
Top down
</source>
</source>



Revision as of 15:16, 9 September 2018

 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
This function sets the token's shape (top down, circle, square, figure).

Usage

setTokenShape()
setTokenShape(shape)
setTokenShape(shape, id)

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

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