getTokenLayoutProps: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<source" to "<syntaxhighlight") |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| Line 10: | Line 10: | ||
getTokenLayoutProps(delim, id) | getTokenLayoutProps(delim, id) | ||
getTokenLayoutProps(delim, id, mapName) | getTokenLayoutProps(delim, id, mapName) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 22: | Line 22: | ||
[h: props = getTokenLayoutProps()] | [h: props = getTokenLayoutProps()] | ||
Layout: [r: props] | Layout: [r: props] | ||
</ | </syntaxhighlight> | ||
'''Returns:''' | '''Returns:''' | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
Layout: scale=1.3000000000000003,xOffset=4,yOffset=-24 | Layout: scale=1.3000000000000003,xOffset=4,yOffset=-24 | ||
</ | </syntaxhighlight> | ||
Get the Token layout properties of the impersonated or current token separated by a semi-colon. | Get the Token layout properties of the impersonated or current token separated by a semi-colon. | ||
| Line 32: | Line 32: | ||
[h: props = getTokenLayoutProps(";")] | [h: props = getTokenLayoutProps(";")] | ||
Layout: [r: props] | Layout: [r: props] | ||
</ | </syntaxhighlight> | ||
'''Returns:''' | '''Returns:''' | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
Layout: scale=1.3000000000000003;xOffset=4;yOffset=-24 | Layout: scale=1.3000000000000003;xOffset=4;yOffset=-24 | ||
</ | </syntaxhighlight> | ||
Get the Token layout properties of the specified token as a JSON object. | Get the Token layout properties of the specified token as a JSON object. | ||
| Line 42: | Line 42: | ||
[h: props = getTokenLayoutProps("json", "Frog")] | [h: props = getTokenLayoutProps("json", "Frog")] | ||
Layout: [r: props] | Layout: [r: props] | ||
</ | </syntaxhighlight> | ||
'''Returns:''' | '''Returns:''' | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
Layout: {"scale":1.3000000000000003,"xOffset":4,"yOffset":-24} | Layout: {"scale":1.3000000000000003,"xOffset":4,"yOffset":-24} | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 20:32, 14 March 2023
getTokenLayoutProps() Function
• Introduced in version 1.6.1
Return the Token Layout
scale, xOffset, and yOffset values in either a JSON Object or String Property List. These values represent the positioning of the token image within the Layout portion of the Config tab in the Edit Token Dialog.Usage
getTokenLayoutProps()
getTokenLayoutProps(delim)
getTokenLayoutProps(delim, id)
getTokenLayoutProps(delim, id, mapName)Parameters
delim- The delimiter of the String Property List. If set tojson, the function will instead return a Json Object. Defaults to,.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.
Example
Get the Token layout properties of the impersonated or current token.
[h: props = getTokenLayoutProps()]
Layout: [r: props]Returns:
Layout: scale=1.3000000000000003,xOffset=4,yOffset=-24
Get the Token layout properties of the impersonated or current token separated by a semi-colon.
[h: props = getTokenLayoutProps(";")]
Layout: [r: props]Returns:
Layout: scale=1.3000000000000003;xOffset=4;yOffset=-24
Get the Token layout properties of the specified token as a JSON object.
[h: props = getTokenLayoutProps("json", "Frog")]
Layout: [r: props]Returns:
Layout: {"scale":1.3000000000000003,"xOffset":4,"yOffset":-24}