getTokenPortrait: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Applied Template:MacroFunction)
Line 1: Line 1:
==Function getTokenPortrait==
{{MacroFunction
|name=getTokenPortrait
|description=
Returns the [[Asset ID|asset id]] of the portrait image for the for the [[Token:Current Token|Current Token]].


Returns the [[asset id]] of the portrait image for the for the [[Token:Current Token|Current Token]].
|usage=
 
===Usage===
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: assetId = getTokenPortrait()]
[h: assetId = getTokenPortrait()]
</source>
</source>


 
|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>
<source lang="mtmacro" line>
<img src='[r:getTokenPortrait()]'></img>
<img src='[r:getTokenPortrait()]'></img>
</source>
</source>
 
}}
===Version Notes===
===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.
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.
[[Category:Token Function]]

Revision as of 04:11, 8 March 2009

getTokenPortrait() Function

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.