getImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Tweaking page layout and typography)
m (specify that images are retrieved from tokens on any map, not just the current one)
Line 15: Line 15:
</source>
</source>


Note that an [[Image Token]] can be retrieved from ANY map (so it does NOT have to be on the current map).
Alternatively this can be used to retrieve a normal token:
 
Alternatively this can be used to retrieve a normal token, which MUST be on the same map:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
<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 18:55, 13 December 2012

getImage() Function

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

Usage

getImage(name)

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>
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.

See Also

getTokenImage (which you can give the size as parameter)