getTokenImage

From RPTools Wiki
Revision as of 22:17, 9 February 2023 by Conversion script (talk | contribs) (Conversion script moved page getTokenImage to GetTokenImage without leaving a redirect: Converting page title to first-letter uppercase)
Jump to navigation Jump to search

getTokenImage() Function

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

Usage

getTokenImage()
getTokenImage(size)
getTokenImage(size, id)
getTokenImage(size, id, mapname)

Parameters

  • size - OPTIONAL: The size in pixels 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 image, defaults to the Current Token.
  • mapname - OPTIONAL: The name of the map to find the token. Defaults to the current map.

Examples

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

To get the image of any token using its id and the token roll option. 

[h, token(tokenId): imgAsset = getTokenImage()]

See Also

getImage, getTokenHandout, getTokenPortrait

Version Changes

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