setTokenLayoutProps: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
|name=setTokenLayoutProps | |name=setTokenLayoutProps | ||
|version=1.6.1 | |version=1.6.1 | ||
|description= Set the | |description= Set the Token Layout {{code|scale}}, {{code|xOffset}}, and {{code|yOffset}} values. These values will be reflected in the positioning and size of the token image within the Layout portion of the Config tab in the Edit Token Dialog as well as on the map. | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 12: | Line 13: | ||
'''Parameters''' | '''Parameters''' | ||
{{param|scale|The scale of the token layout. If an empty string, the scale is not changed.}} | {{param|scale|The scale of the token layout. If an empty string, the scale is not changed.}} | ||
{{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. Negative values shift the image left.}} | ||
{{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. Negative values shift the image up.}} | ||
{{param|id|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.}} | ||
The {{code|xOffset}} and {{code|yOffset}} values must be integers. | |||
|example= | |||
Set the layout properties of the Frog token to make it 50% larger and moved up 24 pixels, leaving the xOffset as it is. Then read them back. | |||
<source lang="mtmacro" line> | |||
[h: setTokenLayoutProps(1.5,"",-24,"Frog")] | |||
[r: getTokenLayourProps("json","Frog")] | |||
</source> | |||
'''Returns:''' | |||
<source lang="javascript"> | |||
{"scale":1.5,"xOffset":4.0,"yOffset":-24.0} | |||
</source> | |||
|also= | |also= | ||
{{func|getTokenLayoutProps}} | {{func|getTokenLayoutProps}} | ||
Revision as of 23:12, 22 March 2020
setTokenLayoutProps() Function
• Introduced in version 1.6.1
Set the Token Layout
scale, xOffset, and yOffset values. These values will be reflected in the positioning and size of the token image within the Layout portion of the Config tab in the Edit Token Dialog as well as on the map.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. Negative values shift the image left.yOffset- The yOffset of the token layout. If an empty string, the yOffset is not changed. Negative values shift the image up.id- The tokenidof 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.
The xOffset and yOffset values must be integers.
Example
Set the layout properties of the Frog token to make it 50% larger and moved up 24 pixels, leaving the xOffset as it is. Then read them back.
[h: setTokenLayoutProps(1.5,"",-24,"Frog")]
[r: getTokenLayourProps("json","Frog")]Returns:
{"scale":1.5,"xOffset":4.0,"yOffset":-24.0}