getTokenPortrait: Difference between revisions
Jump to navigation
Jump to search
True Hitoare (talk | contribs) (Size of the image available as a parameter, reformatted usage to conform to more standard design) |
No edit summary |
||
| Line 8: | Line 8: | ||
getTokenPortrait() | getTokenPortrait() | ||
getTokenPortrait(size) | getTokenPortrait(size) | ||
getTokenPortrait(size, id) | |||
getTokenPortrait(size, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | |||
{{param|size|OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".}} | |||
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to retrieve the token image, defaults to the [[Current Token]]. }} | |||
{{param|mapname|OPTIONAL: The name of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
| Line 15: | Line 22: | ||
<img src='[r:getTokenPortrait()]'></img> | <img src='[r:getTokenPortrait()]'></img> | ||
</source> | </source> | ||
|changes={{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | }} | ||
===Version Notes=== | ===Version Notes=== | ||
In versions before v1.3b51 an attempt to retrieve a portrait image when none was present produced an error. In 1.3b51 and later builds the function returns an empty string if no portrait is associated with the image. | In versions before v1.3b51 an attempt to retrieve a portrait image when none was present produced an error. In 1.3b51 and later builds the function returns an empty string if no portrait is associated with the image. | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 04:10, 15 August 2019
getTokenPortrait() Function
Returns the asset id of the portrait image for the for the Current Token.
Usage
getTokenPortrait()
getTokenPortrait(size)
getTokenPortrait(size, id)
getTokenPortrait(size, id, mapname)Parameters
size- OPTIONAL: The size the picture should be returned as. If a blank string "", no size adjustment is done. Defaults to "".id- OPTIONAL: The tokenidof the token for which you want to retrieve the token image, defaults to the Current Token.mapname- OPTIONAL: The name of the map to find the token. Defaults to the current map.
Examples
To display the image for the current Token.
<img src='[r:getTokenPortrait()]'></img>Version Changes
- 1.5.4 - Added
idandmapnameparameter options.
Version Notes
In versions before v1.3b51 an attempt to retrieve a portrait image when none was present produced an error. In 1.3b51 and later builds the function returns an empty string if no portrait is associated with the image.