setBar: Difference between revisions

Revision as of 03:08, 5 November 2019

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

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.

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.

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

@@ Line 25: / Line 25: @@
 [h: setBar("Health", HP/MaxHP)]
 </source>
+|also=
+{{func|isBarVisible}},
+{{func|setBarVisible}},
+{{func|getBar}}
 |changes=
@@ Line 30: / Line 35: @@
 }}
+==Related Pages==
+* [[HP and Health Bars]]
+* [[bar.name|The <code>bar.name</code> special variable]]
 [[Category:Bar Function]]