getImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (specify that images are retrieved from tokens on any map, not just the current one)
m (Tweaking page layout and asking clarification)
Line 5: Line 5:


|usage=
|usage=
{{Clarify|There's no real parameter description.<br />
Error handling on duplicates should be pointed out.}}
<source lang="mtmacro" line>
<source lang="mtmacro" line>
getImage(name)
getImage(name)
</source>
</source>


Note that token images can be retrieved from ANY map (so they do NOT have to be on the current map).  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:
Line 19: Line 22:
<img src="[r: getImage('Dragon')]"></img>
<img src="[r: getImage('Dragon')]"></img>
</source>
</source>
Note that token images can be retrieved from ANY map (so they do NOT have to be on the current map).  If identical token names appear on multiple maps, it may be difficult (or impossible) to select a specific token image using this function.
|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]]

Revision as of 05:58, 14 December 2012

getImage() Function

Introduced in version 1.3b48
Returns the asset id for the image of a Token or Image Token.

Usage

Needs Clarification:
There's no real parameter description.
Error handling on duplicates should be pointed out.

getImage(name)

Note that token images can be retrieved from ANY map (so they do NOT have to be on the current map). 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>

See Also

getTokenImage (which you can give the size as parameter)