Class StatusBar

A Frame representing a variable-length bar.

This frame has three main properties: a minimum value, a maximum value, and a current value that must be contained between the minimum and maximum values. The frame will render a textured bar that will either be full, empty, or anything in between depending on the current value.

This can be used to display health bars, or progress bars.

Events. Hard-coded events available to all StatusBars, in addition to those from Frame:

  • OnValueChanged: Triggered whenever the value represented by the status bar changes. This is triggered by StatusBar:set_value. This can also be triggered by StatusBar:set_min_max_values if the previous value would not satisfy the new constraints.

Inherits all methods from: Region, Frame.

Child classes: none.

Methods

statusbar:get_min_max_values()
statusbar:get_orientation()
statusbar:get_status_bar_color()
statusbar:get_status_bar_texture()
statusbar:get_value()
statusbar:is_reversed()
statusbar:set_min_max_values()
statusbar:set_orientation()
statusbar:set_status_bar_color()
statusbar:set_status_bar_texture()
statusbar:set_value()
statusbar:set_reversed()


Methods

statusbar:get_min_max_values()
statusbar:get_orientation()
statusbar:get_status_bar_color()
statusbar:get_status_bar_texture()
statusbar:get_value()
statusbar:is_reversed()
statusbar:set_min_max_values()
statusbar:set_orientation()
statusbar:set_status_bar_color()
statusbar:set_status_bar_texture()
statusbar:set_value()
statusbar:set_reversed()
generated by LDoc 1.5.0 Last updated 2023-10-08 09:07:54