getTokenPortrait: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Unifying Current Token red link.)
No edit summary
Line 1: Line 1:
{{MacroFunction
{{MacroFunction
|name=getTokenPortrait
|name=getTokenPortrait
|proposed=true
|version=1.3b77
|description=
|description=
Returns the [[Asset ID|asset id]] of the portrait image for the for the [[Current Token]].
Returns the [[Asset ID|asset id]] of the portrait image for the for the [[Current Token]].

Revision as of 07:49, 19 November 2010

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

getTokenPortrait() Function

Introduced in version 1.3b77
Returns the asset id of the portrait image for the for the Current Token.

Usage

[h: assetId = getTokenPortrait()]

Examples

To display the image for the current Token.
<img src='[r:getTokenPortrait()]'></img>

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.