getImage

From RPTools Wiki
Jump to navigationJump to search

getImage() Function

Introduced in version 1.3b48
Returns the asset id for the image of a Token or Image Token found on any map in the campaign.

Usage

getImage(name)
getImage(name, size)

Parameters

  • name - Token name. Note: Token ID cannot be used.
  • size - Image size. Optional. Specify the size of the image that is called out in the asset string returned.

If identical token names appear on multiple maps, it may be difficult (or impossible) to select a specific token image using this function.

Example

To display the image from an image token called image:Map you can do the following:
<img src="[r: getImage('image:Map')]"></img>

Alternatively this can be used to retrieve a normal token:

<img src="[r: getImage('Dragon')]"></img>

To display the image in chat with a max dimension of 100:

<img src="[r: getImage('Hero',100)]"></img>

See Also

getTokenImage (which you can give the size as parameter)