setBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Function setBar==
{{MacroFunction
Sets the value of the specified [[Token:bar|bar]] for the [[Token:Current Token|Current Token]]. The value to set is between 0 and 1 for 0% to 100% respectively.
|name=setBar
|trusted=true
|version=1.3b42
|description=
Sets the value of the specified [[Token:bar|bar]] for the [[Current Token]] and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.


===Usage===
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setBar(name, pct/100)]
setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, id, mapname)
</source>
</source>


===Examples===
'''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 bar set, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 
 
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setBar("health", HP/MaxHP)]
[h: setBar("Health", HP/MaxHP)]
</source>
</source>
|also=
{{func|isBarVisible}},
{{func|setBarVisible}},
{{func|getBar}}
|changes=
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
==Related Pages==
* [[HP and Health Bars]]
* [[bar.name|The <code>bar.name</code> special variable]]
[[Category:Bar Function]]

Revision as of 14:25, 5 November 2019

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 and makes the bar visible. 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, id, 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 bar 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)]

See Also

Version Changes

  • 1.5.7 - Added id and mapname parameter options.

Related Pages