setBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by 6 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>
<syntaxhighlight lang="mtmacro" line>
[h: setBar(name, pct/100)]
setBar(name, pct/100)
</source>
setBar(name, pct/100, tokenRef)
setBar(name, pct/100, TokenRef, mapname)
</syntaxhighlight>


===Examples===
'''Parameters'''
<source lang="mtmacro" line>
{{param|name|The name of the bar.}}
[h: setBar("health", HP/MaxHP)]
{{param|value|The value of the bar. Should be between 0 and 1.}}
</source>
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}
 
 
|example=
<syntaxhighlight lang="mtmacro" line>
[h: setBar("Health", HP/MaxHP)]
</syntaxhighlight>
 
|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]]

Latest revision as of 20:42, 10 May 2024

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, tokenRef)
setBar(name, pct/100, TokenRef, mapname)

Parameters

  • name - The name of the bar.
  • value - The value of the bar. Should be between 0 and 1.
  • tokenRef - Either the token id or Token Name of the token, 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

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

See Also

Version Changes

  • 1.5.7 - Added id and mapname parameter options.

Related Pages