You are viewing an older version of the site. Click here to view
the latest version of this page. (This may be a dead link, if so, try the root page of the docs
here.)
== create_bar ==
[[../objects/ms.lang.CastException|ms.lang.CastException]]
[[../objects/ms.lang.FormatException|ms.lang.FormatException]]
[[../objects/ms.lang.RangeException|ms.lang.RangeException]]
[[../objects/ms.lang.Exception|ms.lang.Exception]] |- ! scope="row" | Since | 3.3.2 |- ! scope="row" | Restricted |
Creates a new boss bar with a reference id. An optional array can be given with the keys: title, color, style, visible, percent. Title displays above the boss bar. Color can be one of PINK, BLUE, RED, GREEN, YELLOW, PURPLE, or WHITE. Style can be one of SOLID, SEGMENTED_6, SEGMENTED_10, SEGMENTED_12, or SEGMENTED_20. Visible is a boolean for whether the bar is visible or not. Percent is a double from 0.0 to 1.0 representing the how much the bar is filled from left to right. Defaults to an empty title with a WHITE, SOLID, visible, full bar.
Once the bar is created, it can be shown to specified players with {{function|bar_add_player}} and the display can be modified with {{function|update_bar}}
=== Vital Info ===
{| style="width: 40%;" cellspacing="1" cellpadding="1" border="1" class="wikitable"
|-
! scope="col" width="20%" |
! scope="col" width="80%" |
|-
! scope="row" | Name
| create_bar
|-
! scope="row" | Returns
| void
|-
! scope="row" | Usages
| id, [optionsArray]
|-
! scope="row" | Throws
| [[../objects/ms.lang.IllegalArgumentException|ms.lang.IllegalArgumentException]][[../objects/ms.lang.CastException|ms.lang.CastException]]
[[../objects/ms.lang.FormatException|ms.lang.FormatException]]
[[../objects/ms.lang.RangeException|ms.lang.RangeException]]
[[../objects/ms.lang.Exception|ms.lang.Exception]] |- ! scope="row" | Since | 3.3.2 |- ! scope="row" | Restricted |
Yes
|-
! scope="row" | Optimizations
| None
|}
=== Usages ===
create_bar(id, [optionsArray])=== Examples === Sorry, there are no examples for this function! :(
Find a bug in this page? Edit this page yourself, then submit a pull request. (Note this page is automatically generated from the documentation in the source code.)
