setBarVisible: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Add 'See Also' and 'Related Pages' to bar functions.) |
||
| Line 28: | Line 28: | ||
[h: setBarVisible("Health", 0)] | [h: setBarVisible("Health", 0)] | ||
</source> | </source> | ||
|also= | |||
{{func|isBarVisible}}, | |||
{{func|getBar}}, | |||
{{func|setBar}} | |||
|changes= | |changes= | ||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | {{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]] | [[Category:Bar Function]] | ||
Revision as of 03:08, 5 November 2019
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, 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 tokenidof 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.
Examples
Make "health" bar for the Current Token visible.
[h: setBarVisible("Health", 1)]Hide "health" bar for the Current Token.
[h: setBarVisible("Health", 0)]See Also
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.