getTokenPortrait

getTokenPortrait() Function

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

Usage

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

Parameters

• size - OPTIONAL: The size the picture 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:getTokenPortrait()]'></img>

</syntaxhighlight>

Version Changes

• 1.5.4 - Added id and mapname parameter options.

Version Notes

In versions before v1.3b51 an attempt to retrieve a portrait image when none was present produced an error. In 1.3b51 and later builds the function returns an empty string if no portrait is associated with the image.