getBarImage: Difference between revisions
Jump to navigation
Jump to search
m (Fix typos (state -> bar)) |
m (Remove direct address of reader) |
||
Line 19: | Line 19: | ||
* {{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= |
Revision as of 14:55, 20 February 2021
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>