getBarImage: Difference between revisions

Revision as of 14:53, 20 February 2021

This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

• 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.

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 you want is; if a bar only contains a single image, this argument is optional.

To display the image for the midway point of a custom bar called "Mana", use

<img src='[r:getBarImage("Mana", 0, 0.5)]'></img>

@@ Line 4: / Line 4: @@
 |version=unreleased
 |description=
-Gets the [[Asset ID|asset id]] for the image of a bar, the state must be one of the image types (single-, double-, or multi-image) for this to work.
+Gets the [[Asset ID|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=
@@ Line 17: / Line 17: @@
 </source>
 '''Parameters'''
-* {{code|state}} - The name of the state 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 state 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 you want is; if a bar only contains a single image, this argument is optional.