getStateImage: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page getStateImage to GetStateImage without leaving a redirect: Converting page title to first-letter uppercase) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getStateImage(state) | getStateImage(state) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getStateImage(state, size) | getStateImage(state, size) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|state}} - The name of the state which has its image asset returned. | * {{code|state}} - The name of the state which has its image asset returned. | ||
Line 19: | Line 19: | ||
|example= | |example= | ||
To display the image for the "Dead" [[Token:state | token state]] use. | To display the image for the "Dead" [[Token:state | token state]] use. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src='[r:getStateImage("Dead")]'></img> | <img src='[r:getStateImage("Dead")]'></img> | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:State Function]] | [[Category:State Function]] |
Latest revision as of 23:59, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getStateImage() Function
• Introduced in version 1.3b40
Gets the asset id for the image of a state, the state must be one of the image types for this to work.
Usage
getStateImage(state)
getStateImage(state, size)
Parameters
state
- The name of the state which has its image asset returned.size
- The size that the state image will be resized to; this is the height of the final size.
Example
To display the image for the "Dead" token state use.
<img src='[r:getStateImage("Dead")]'></img>