setBarVisible: Difference between revisions

Latest revision as of 23:59, 23 May 2024

setBarVisible() Function

• 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.

Usage

setBarVisible(name, value)
setBarVisible(name, value, tokenRef)
setBarVisible(name, value, tokenRef, mapRef)

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.
tokenRef - Either the token id or Token Name 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.
mapRef - The Name or ID 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.

Examples

Make "health" bar for the Current Token visible.

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

Hide "health" bar for the Current Token.

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

Version Changes

1.5.7 - Added id and mapname parameter options.

Related Pages

@@ Line 3: / Line 3: @@
 |version=1.3b46
 |description=
-Sets if the specified [[Token:bar|bar]] for the [[Token:Current Token|Current Token]] is visible or not. If the value is non zero then the [[Token:bar|bar]] is visible, if it is 0 it is not visible.
+Sets if the specified [[Token:bar|bar]] for the [[Current Token]] is visible or not. If the value is non zero then the [[Token:bar|bar]] is visible, if it is 0 it is not visible.
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
 setBarVisible(name, value)
-</source>
+setBarVisible(name, value, tokenRef)
+setBarVisible(name, value, tokenRef, mapRef)
+</syntaxhighlight>
+'''Parameters'''
+{{param|bar|A string that contains the name of the bar that has its visibility set.}}
+{{param|value|The visibility value of the bar, either 0 or 1.}}
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its bar visibility set, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|mapRef|The Name or ID 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.}}
 |examples=
-Make "health" [[Token:bar|bar]] for the [[Token:Current Token|Current Token]] visible.
+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]].
+<syntaxhighlight lang="mtmacro" line>
+[h: setBarVisible("Health", 0)]
+</syntaxhighlight>
+|also=
+{{func|isBarVisible}},
+{{func|getBar}},
+{{func|setBar}}
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
-Hide "health" [[Token:bar|bar]] for the [[Token:Current Token|Current Token]].
-<source lang="mtmacro" line>
-[h: setBarVisible("health", 0)]
-</source>
 }}
+==Related Pages==
+* [[HP and Health Bars]]
+* [[bar.name|The <code>bar.name</code> special variable]]
 [[Category:Bar Function]]