getImage: Difference between revisions
Jump to navigation
Jump to search
m (specify that images are retrieved from tokens on any map, not just the current one) |
No edit summary |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
|name=getImage | |name=getImage | ||
|version=1.3b48 | |version=1.3b48 | ||
|description=Returns the [[ | |description=Returns the [[Asset ID]] for the image of a [[Token]] or [[Image Token]] found on any map in the campaign. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getImage(name) | getImage(name) | ||
</ | getImage(name, size) | ||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|name|Token name.}} '''Note:''' Token ID cannot be used. | |||
{{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. | |||
|example= | |example= | ||
To display the image from an [[Token:image token{{!}}image token]] called {{code|image:Map}} you can do the following: | To display the image from an [[Token:image token{{!}}image token]] called {{code|image:Map}} you can do the following: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src="[r: getImage('image:Map')]"></img> | <img src="[r: getImage('image:Map')]"></img> | ||
</ | </syntaxhighlight > | ||
Alternatively this can be used to retrieve a normal token: | Alternatively this can be used to retrieve a normal token: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src="[r: getImage('Dragon')]"></img> | <img src="[r: getImage('Dragon')]"></img> | ||
</ | </syntaxhighlight> | ||
To display the image in chat with a max dimension of 100: | |||
<syntaxhighlight lang="mtmacro" line> | |||
<img src="[r: getImage('Hero',100)]"></img> | |||
</syntaxhighlight > | |||
|also=[[getTokenImage]] (which you can give the size as parameter) | |also=[[getTokenImage]] (which you can give the size as parameter) | ||
}} | }} | ||
[[Category:Miscellaneous Function]] | [[Category:Miscellaneous Function]] | ||
Latest revision as of 01:48, 21 April 2023
getImage() Function
• Introduced in version 1.3b48
Usage
getImage(name)
getImage(name, size)Parameters
name- Token name. Note: Token ID cannot be used.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.
Example
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>See Also
getTokenImage (which you can give the size as parameter)