getTokenImage: Difference between revisions

Revision as of 04:07, 15 August 2019

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

getTokenImage()
getTokenImage(size)
getTokenImage(size, id)
getTokenImage(size, id, mapname)

Parameters Template:size

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.

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()]

@@ Line 8: / Line 8: @@
 getTokenImage()
 getTokenImage(size)
+getTokenImage(size, id)
+getTokenImage(size, id, mapname)
 </source>
+'''Parameters'''
+{{size|value|OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}}
+{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the token image, defaults to the [[Current Token]]. }}
+{{param|mapname|OPTIONAL: The name of the map to find the token.  Defaults to the current map.}}
 |examples=
@@ Line 16: / Line 23: @@
 </source>
-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>
 [h, token(tokenId): imgAsset = getTokenImage()]
 </source>
+|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
 |also=
 [[getImage|getImage]]
 }}
 [[Category:Token Function]]