getBarImage: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetBarImage to getBarImage: Converting page titles to lowercase)
m (Text replacement - "<source" to "<syntaxhighlight")
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getBarImage(bar)
getBarImage(bar)
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getBarImage(bar, size)
getBarImage(bar, size)
</source>
</syntaxhighlight>
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getBarImage(bar, size, value)
getBarImage(bar, size, value)
</source>
</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.
Line 23: Line 23:
|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
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
<img src='[r:getBarImage("Mana", 0, 0.5)]'></img>
<img src='[r:getBarImage("Mana", 0, 0.5)]'></img>
</source>
</syntaxhighlight>


}}
}}
[[Category:Bar Function]]
[[Category:Bar Function]]

Latest revision as of 18:06, 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>