getTokenNativeWidth: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTokenNativeWidth to getTokenNativeWidth: Converting page titles to lowercase)
m (Text replacement - "source>" to "syntaxhighlight>")
Line 12: Line 12:
getTokenNativeWidth(id)
getTokenNativeWidth(id)
getTokenNativeWidth(id, mapname)
getTokenNativeWidth(id, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
Line 25: Line 25:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r: getTokenWidth("Dragon")]
[r: getTokenWidth("Dragon")]
</source>
</syntaxhighlight>
returns:
returns:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
120
120
</source>
</syntaxhighlight>


|changes=
|changes=

Revision as of 19:36, 14 March 2023

getTokenWidth() Function

Introduced in version 1.5.1
Retrieves the token's native image width in pixels (native size).

Usage

<source lang="mtmacro" line> getTokenNativeWidth() getTokenNativeWidth(id) getTokenNativeWidth(id, mapname) </syntaxhighlight>

Parameters

  • id - The token id of the token to check for its width, 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.


Result
The token's native (image) width in pixels.

Example

Assuming a token called "Dragon", with 120px native image width, medium size, on a 50px square grid , then:

<source lang="mtmacro" line> [r: getTokenWidth("Dragon")] </syntaxhighlight> returns: <source lang="mtmacro" line> 120

</syntaxhighlight>

See Also

Version Changes

  • 1.5.4 - Added mapname parameter option.