getImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
|name=getImage
|name=getImage
|version=1.3b48
|version=1.3b48
|description=Returns the [[asset id]] for the image of an [[Token]] or [[Image Token]].  
|description=Returns the [[asset id]] for the image of a [[Token]] or [[Image Token]].  


|usage=
|usage=
Line 14: Line 14:
<img src="[r: getImage('image:Map')]"></img>
<img src="[r: getImage('image:Map')]"></img>
</source>
</source>
}}
 
Note that an "image:token" can be retrieved from ANY map (so it does NOT have to be on the current map.
Note that an "image:token" can be retrieved from ANY map (so it does NOT have to be on the current map.


Line 22: Line 22:
</source>
</source>
}}
}}


see also: [[getTokenImage]] (which you can give the size as parameter)  
see also: [[getTokenImage]] (which you can give the size as parameter)  
[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]

Revision as of 20:26, 2 September 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>

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, which MUST be on the same map:

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


see also: getTokenImage (which you can give the size as parameter)