getTokenPortrait: Difference between revisions

Latest revision as of 21:11, 14 March 2023

getTokenPortrait() Function

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

Usage

getTokenPortrait()
getTokenPortrait(size)
getTokenPortrait(size, id)
getTokenPortrait(size, id, mapname)

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.

<img src='[r:getTokenPortrait()]'></img>

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.

@@ Line 1: / Line 1: @@
-==Function getTokenPortrait==
+{{MacroFunction
+|name=getTokenPortrait
+|description=
+Returns the [[Asset ID|asset id]] of the portrait image for the for the [[Current Token]].
-Returns the [[asset id]] of the portrait image for the for the [[Token:Current Token|Current Token]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getTokenPortrait()
+getTokenPortrait(size)
+getTokenPortrait(size, id)
+getTokenPortrait(size, id, mapname)
+</syntaxhighlight>
-===Usage===
+'''Parameters'''
-<source lang="mtmacro" line>
+{{param|size|OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}}
-[h: assetId = getTokenPortrait()]
+{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the token image, defaults to the [[Current Token]]. }}
-</source>
+{{param|mapname|OPTIONAL: The name of the map to find the token.  Defaults to the current map.}}
+|examples=
-===Examples===
+To display the image for the current [[Token]].
-To display the image for the current [[Token:token|token]].
+<syntaxhighlight lang="mtmacro" line>
-<source lang="mtmacro" line>
 <img src='[r:getTokenPortrait()]'></img>
-</source>
+</syntaxhighlight>
+|changes={{change|1.5.4|Added {{code|id}} and {{code|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.
+[[Category:Token Function]]