getImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getImage== {{ProposedChange}} Returns the asset id for the image of an Token:image token. ===Usage=== <source lang="mtmacro" line> [h: asset = getImage(name)] </sourc...)
 
No edit summary
 
(26 intermediate revisions by 8 users not shown)
Line 1: Line 1:
==Function getImage==
{{MacroFunction
{{ProposedChange}}
|name=getImage
Returns the [[asset id]] for the image of an [[Token:image token|image token]].  
|version=1.3b48
|description=Returns the [[Asset ID]] for the image of a [[Token]] or [[Image Token]] found on any map in the campaign.  


===Usage===
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: asset = getImage(name)]
getImage(tokenRef)
</source>
getImage(tokenRef, size)
</syntaxhighlight>


===Examples===
'''Parameters'''
To display the image from an [[Token:image token|image token]] called "image:Map" you can do the following
{{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]].}}
<source lang="mtmacro" line>
{{param|size|Image size.}}  Optional.  Specify the size of the image that is called out in the asset string returned.
<img src="[r: getImage('image:Map')]></img>
 
</source>
{{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=
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>
</syntaxhighlight >
 
Alternatively this can be used to retrieve a normal token:
<syntaxhighlight lang="mtmacro" line>
<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)
}}
[[Category:Miscellaneous Function]]

Latest revision as of 18:10, 10 May 2024

getImage() Function

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.

Usage

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.

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)