getTokenImage: Difference between revisions

Revision as of 21:45, 9 May 2024

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

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

Parameters

size - OPTIONAL: The size in pixels the image should be returned as. If a blank string "", no size adjustment is done. Defaults to "".
TokenID - OPTIONAL: Either the token id or Token Name 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.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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, TokenID)
 getTokenImage(size, id, mapname)
 </syntaxhighlight>
@@ Line 14: / Line 14: @@
 '''Parameters'''
 {{param|size|OPTIONAL: The size in pixels the image 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]]. Will also work with [[getTokenName|Token Name]] }}
+{{param|TokenID|OPTIONAL: Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}}
 {{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}