setBarVisible: Difference between revisions

Latest revision as of 21:08, 14 March 2023

• Introduced in version 1.3b46

Sets if the specified bar for the Current Token is visible or not. If the value is non zero then the bar is visible, if it is 0 it is not visible.

setBarVisible(name, value)
setBarVisible(name, value, id)
setBarVisible(name, value, id, mapname)

Parameters

bar - A string that contains the name of the bar that has its visibility set.
value - The visibility value of the bar, either 0 or 1.
id - The token id of the token which has its bar visibility 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.

Make "health" bar for the Current Token visible.

[h: setBarVisible("Health", 1)]

Hide "health" bar for the Current Token.

[h: setBarVisible("Health", 0)]

@@ Line 6: / Line 6: @@
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setBarVisible(name, value)
-</source>
+setBarVisible(name, value, id)
+setBarVisible(name, value, id, mapname)
+</syntaxhighlight>
 '''Parameters'''
@@ Line 18: / Line 20: @@
 |examples=
 Make "health" [[Token:bar|bar]] for the [[Current Token]] visible.
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: setBarVisible("health", 1)]
+[h: setBarVisible("Health", 1)]
-</source>
+</syntaxhighlight>
 Hide "health" [[Token:bar|bar]] for the [[Current Token]].
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: setBarVisible("health", 0)]
+[h: setBarVisible("Health", 0)]
-</source>
+</syntaxhighlight>
+|also=
+{{func|isBarVisible}},
+{{func|getBar}},
+{{func|setBar}}
 |changes=
-{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter option.}}
+{{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]]