setTokenShape: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created empty)
 
(Adding description, usage, link to other functions)
Line 1: Line 1:
{{stub|Empty article at the moment.}}
{{stub|Confirm the function acts on current token as default id.<br />
What are all the shape strings that can be used?<br />
No examples yet.}}
{{MacroFunction
{{MacroFunction
|name=setTokenShape
|name=setTokenShape
Line 6: Line 8:
|version=1.3b89
|version=1.3b89
|description=
|description=
This is an example function. It doesn't actually exist as a function in MapTool.
This function sets the token's shape (top-down, circle, etc.).


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
exampleFunction(param1, param2)
setTokenShape(shape)
setTokenShape(shape, id)
</source>
</source>
 
'''Parameters'''
{{param|shape|'''To be defined.'''}}
{{param|id|The token id of the token to check for the state, defaults to the Current Token.}}
|example=
|example=
This example doesn't really do anything.
This example doesn't really do anything.
Line 25: Line 30:


|also=
|also=
[[linkToRelatedArticle|Display Name of Related Article]]
{{func|getTokenShape}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 12:25, 8 April 2013

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Confirm the function acts on current token as default id.
What are all the shape strings that can be used?
No examples yet.

setTokenShape() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b89
This function sets the token's shape (top-down, circle, etc.).

Usage

setTokenShape(shape)
setTokenShape(shape, id)

Parameters

  • shape - To be defined.
  • id - The token id of the token to check for the state, defaults to the Current Token.

Example

This example doesn't really do anything.
[h: exampleVariable = "a,b,c"]
[r: exampleFunction(exampleVariable, reverse)]

Returns:

c,b,a

See Also