getBarImage: Difference between revisions
Jump to navigation
Jump to search
m (Fix typos (state -> bar)) |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getBarImage(bar) | getBarImage(bar) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getBarImage(bar, size) | getBarImage(bar, size) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getBarImage(bar, size, value) | getBarImage(bar, size, value) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|state}} - The name of the bar which has its image asset returned. | * {{code|state}} - The name of the bar which has its image asset returned. | ||
* {{code|size}} - The size that the bar image will be resized to; this is the height of the final size; this argument is optional, pass a 0 or an empty string to ignore it. | * {{code|size}} - The size that the bar image will be resized to; this is the height of the final size; this argument is optional, pass a 0 or an empty string to ignore it. | ||
* {{code|value}} - The value (0 to 1) on the bar where the image | * {{code|value}} - The value (0 to 1) on the bar where the image asset to be returned is; if a bar only contains a single image, this argument is optional. | ||
|example= | |example= | ||
To display the image for the midway point of a [[Introduction_to_Bars | custom bar]] called "Mana", use | To display the image for the midway point of a [[Introduction_to_Bars | custom bar]] called "Mana", use | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
<img src='[r:getBarImage("Mana", 0, 0.5)]'></img> | <img src='[r:getBarImage("Mana", 0, 0.5)]'></img> | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:Bar Function]] | [[Category:Bar 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.
getBarImage() Function
• Introduced in version unreleased
Gets the asset id for a specific image in a bar. The bar must be one of the image types (single-, double-, or multi-image) for this to work.
Usage
getBarImage(bar)getBarImage(bar, size)getBarImage(bar, size, value)Parameters
state- The name of the bar which has its image asset returned.size- The size that the bar image will be resized to; this is the height of the final size; this argument is optional, pass a 0 or an empty string to ignore it.value- The value (0 to 1) on the bar where the image asset to be returned is; if a bar only contains a single image, this argument is optional.
Example
To display the image for the midway point of a custom bar called "Mana", use
<img src='[r:getBarImage("Mana", 0, 0.5)]'></img>