getTokenLayoutProps

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

<syntaxhighlight lang="mtmacro" line> getTokenLayoutProps() getTokenLayoutProps(delim) getTokenLayoutProps(delim, id) getTokenLayoutProps(delim, id, mapName) </source>

Parameters

• delim - The delimiter of the String Property List. If set to json, the function will instead return a Json Object. Defaults to ,.
• 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.

Example

Get the Token layout properties of the impersonated or current token.

<syntaxhighlight lang="mtmacro" line> [h: props = getTokenLayoutProps()] Layout: [r: props] </source> Returns: <syntaxhighlight lang="javascript"> Layout: scale=1.3000000000000003,xOffset=4,yOffset=-24 </source>

Get the Token layout properties of the impersonated or current token separated by a semi-colon. <syntaxhighlight lang="mtmacro" line> [h: props = getTokenLayoutProps(";")] Layout: [r: props] </source> Returns: <syntaxhighlight lang="javascript"> Layout: scale=1.3000000000000003;xOffset=4;yOffset=-24 </source>

Get the Token layout properties of the specified token as a JSON object. <syntaxhighlight lang="mtmacro" line> [h: props = getTokenLayoutProps("json", "Frog")] Layout: [r: props] </source> Returns: <syntaxhighlight lang="javascript"> Layout: {"scale":1.3000000000000003,"xOffset":4,"yOffset":-24}

</source>

See Also

setTokenLayoutProps()