getTokenImage

From RPTools Wiki
Revision as of 19:36, 14 March 2023 by Taustin (talk | contribs) (Text replacement - "source>" to "syntaxhighlight>")
Jump to navigation Jump to search

getTokenImage() Function

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

Usage

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

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.

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

To get the image of any token using its id and the token roll option. <source lang="mtmacro" line> [h, token(tokenId): imgAsset = getTokenImage()]

</syntaxhighlight>

See Also

getImage, getTokenHandout, getTokenPortrait

Version Changes

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