getTokenImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenImage()
getTokenImage()
getTokenImage(size)
getTokenImage(size)
Line 19: Line 19:
|examples=
|examples=
To display the image for the current [[Token:token|token]].
To display the image for the current [[Token:token|token]].
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
<img src='[r:getTokenImage()]'></img>
<img src='[r:getTokenImage()]'></img>
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 19:36, 14 March 2023

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

Version Changes

  • 1.5.4 - Added id and mapname parameter options.