getTokenHandout: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Conversion script moved page getTokenHandout to GetTokenHandout without leaving a redirect: Converting page title to first-letter uppercase)
(No difference)

Revision as of 22:23, 9 February 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.