getTokenImage

getTokenImage() Function

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

Usage

getTokenImage()
getTokenImage(size)
getTokenImage(size, tokenRef)
getTokenImage(size, tokenRef, mapRef)

Parameters

• size - OPTIONAL: The size in pixels 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 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.

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.