getBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==Function getBar==
{{MacroFunction
Gets the value of the specified [[Token:bar|bar]] for the [[Token:Current Token|Current Token]]. The value returned is between 0 and 1 for 0% to 100% respectively.
|name=getBar
|description=Gets the value of the specified [[Token:bar|bar]] for the [[Token:Current Token|Current Token]]. The value returned is between 0 and 1 for 0% to 100% respectively.


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: pct = getBar(name)]
[h: pct = getBar(name)]
</source>
</source>


===Examples===
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[r: healthPct = getBar("health") * 100]
[r: healthPct = getBar("health") * 100]
</source>
</source>
}}
[[Category:Token Find Function]]

Revision as of 02:44, 7 March 2009

getBar() Function

Gets the value of the specified bar for the Current Token. The value returned is between 0 and 1 for 0% to 100% respectively.

Usage

[h: pct = getBar(name)]

Example

[r: healthPct = getBar("health") * 100]