setTokenLayoutProps: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 14: Line 14:
{{param|xOffset|The xOffset of the token layout. If an empty string, the xOffset is not changed.}}
{{param|xOffset|The xOffset of the token layout. If an empty string, the xOffset is not changed.}}
{{param|yOffset|The yOffset of the token layout. If an empty string, the yOffset is not changed.}}
{{param|yOffset|The yOffset of the token layout. If an empty string, the yOffset is not changed.}}
{{param|tokenID|The token {{code|id}} of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}}}}
{{param|id|The token {{code|id}} of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}}}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}



Revision as of 17:52, 22 March 2020

setTokenLayoutProps() Function

Introduced in version 1.6.1
Set the token layout scale, xOffset, and yOffset.

Usage

setTokenLayoutProps(scale, xOffset, yOffset)
setTokenLayoutProps(scale, xOffset, yOffset, id)
setTokenLayoutProps(scale, xOffset, yOffset, id, mapName)

Parameters

  • scale - The scale of the token layout. If an empty string, the scale is not changed.
  • xOffset - The xOffset of the token layout. If an empty string, the xOffset is not changed.
  • yOffset - The yOffset of the token layout. If an empty string, the yOffset is not changed.
  • id - The token id of the token to name, 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.


See Also