getImage: Difference between revisions

Latest revision as of 23:59, 10 May 2024

• Introduced in version 1.3b48

Returns the Asset ID for the image of a Token or Image Token found on any map in the campaign.

getImage(tokenRef)
getImage(tokenRef, size)

Parameters

tokenRef - Either the token id or Token Name of the token for which you want to retrieve the token image, defaults to the Current Token.
size - Image size. Optional. Specify the size of the image that is called out in the asset string returned.

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 from an image token called image:Map you can do the following:

<img src="[r: getImage('image:Map')]"></img>

Alternatively this can be used to retrieve a normal token:

<img src="[r: getImage('Dragon')]"></img>

To display the image in chat with a max dimension of 100:

<img src="[r: getImage('Hero',100)]"></img>

@@ Line 6: / Line 6: @@
 |usage=
 <syntaxhighlight lang="mtmacro" line>
-getImage(name)
+getImage(tokenRef)
-getImage(name, size)
+getImage(tokenRef, size)
 </syntaxhighlight>
 '''Parameters'''
-{{param|name|Token name.}}  '''Note:''' Token ID cannot be used.
+{{param|tokenRef|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|size|Image size.}}  Optional.  Specify the size of the image that is called out in the asset string returned.
-If identical token names appear on multiple maps, it may be difficult (or impossible) to select a specific token image using this function.
+{{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.}}
 |example=