getImage

From RPTools Wiki
Revision as of 16:46, 21 August 2021 by Phergus (talk | contribs)
Jump to navigation Jump 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)

Parameters

  • name - Token name. Note: Token ID is not allowed.

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>

See Also

getTokenImage (which you can give the size as parameter)