getTokenHandout: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
m (Text replacement - "source>" to "syntaxhighlight>")
Line 10: Line 10:
getTokenHandout(size, id)
getTokenHandout(size, id)
getTokenHandout(size, id, mapname)
getTokenHandout(size, id, mapname)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
Line 21: Line 21:
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
<img src='[r:getTokenHandout()]'></img>
<img src='[r:getTokenHandout()]'></img>
</source>
</syntaxhighlight>
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 20:48, 14 March 2023

getTokenHandout() Function

Returns the asset id of the handout image for the for the Current Token.

Usage

getTokenHandout()
getTokenHandout(size)
getTokenHandout(size, id)
getTokenHandout(size, id, mapname)

Parameters

  • size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".
  • id - OPTIONAL: The token id of the token for which you want to retrieve the token handout image, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

Example

To display the image for the current Token.
<img src='[r:getTokenHandout()]'></img>


Version Changes

  • 1.5.4 - Added id and mapname parameter options.