getTokenHandout: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetTokenHandout to getTokenHandout: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenHandout()
getTokenHandout()
getTokenHandout(size)
getTokenHandout(size)
Line 19: Line 19:
|example=
|example=
To display the image for the current [[Token]].
To display the image for the current [[Token]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
<img src='[r:getTokenHandout()]'></img>
<img src='[r:getTokenHandout()]'></img>
</source>
</source>

Revision as of 20:23, 14 March 2023

getTokenHandout() Function

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

Usage

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

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.

<syntaxhighlight lang="mtmacro" line> <img src='[r:getTokenHandout()]'></img>

</source>


Version Changes

  • 1.5.4 - Added id and mapname parameter options.