getTokenHandout

From RPTools Wiki
(Redirected from GetTokenHandout)
Jump to navigation Jump to search

getTokenHandout() Function

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

Usage

getTokenHandout()
getTokenHandout(size)
getTokenHandout(size, tokenRef)
getTokenHandout(size, tokenRef, mapRef)

Parameters

  • size - OPTIONAL: The size the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".
  • tokenRef - OPTIONAL: Either the token id or Token Name of the token for which you want to retrieve the token handout image, defaults to the Current Token.
  • mapRef - OPTIONAL: The Name or ID 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

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


Version Changes

  • 1.5.4 - Added id and mapname parameter options.
Retrieved from "https://wiki.rptools.info/index.php?title=getTokenHandout&oldid=35076"