setBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Unifying Current Token red link.)
No edit summary
Line 10: Line 10:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setBar(name, pct/100)
setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, mapname)
</source>
</source>
'''Parameters'''
{{param|name|The name of the bar.}}
{{param|value|The value of the bar. Should be between 0 and 1.}}
{{param|id|The token {{code|id}} of the token which has its property set, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|example=
|example=
Line 16: Line 25:
[h: setBar("health", HP/MaxHP)]
[h: setBar("health", HP/MaxHP)]
</source>
</source>
|changes=
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter option.}}
}}
}}
[[Category:Bar Function]]
[[Category:Bar Function]]

Revision as of 18:15, 9 October 2019

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

setBar() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b42
Sets the value of the specified bar for the Current Token. The value to set is between 0 and 1 for 0% to 100% respectively.

Usage

setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, mapname)

Parameters

  • name - The name of the bar.
  • value - The value of the bar. Should be between 0 and 1.
  • id - The token id of the token which has its property set, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - The name of the map to find the token. Defaults to the current map.

Example

[h: setBar("health", HP/MaxHP)]


Version Changes

  • 1.5.7 - Added id and mapname parameter option.