getTokenLayoutProps: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
No edit summary
 
Line 8: Line 8:
getTokenLayoutProps()
getTokenLayoutProps()
getTokenLayoutProps(delim)
getTokenLayoutProps(delim)
getTokenLayoutProps(delim, id)
getTokenLayoutProps(delim, tokenRef)
getTokenLayoutProps(delim, id, mapName)
getTokenLayoutProps(delim, tokenRef, mapName)
</syntaxhighlight>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|delim|The delimiter of the String Property List. If set to {{code|json}}, the function will instead return a Json Object. Defaults to {{code|,}}.}}
{{param|delim|The delimiter of the String Property List. If set to {{code|json}}, the function will instead return a Json Object. Defaults to {{code|,}}.}}
{{param|id|The token {{code|id}} of the token to name, defaults to the [[Current Token]]. {{TrustedParameter}}}}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


|example=
|example=

Latest revision as of 19:20, 11 May 2024

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, tokenRef)
getTokenLayoutProps(delim, tokenRef, mapName)

Parameters

  • delim - The delimiter of the String Property List. If set to json, the function will instead return a Json Object. Defaults to ,.
  • tokenRef - Either the token id or Token Name 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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}

See Also