Table of Contents

Class ProgressBar

A control used for visual representation of a percentage.

Inheritance
ProgressBar

Remarks

A control used for visual representation of a percentage. Shows fill percentage from right to left.

Properties

editor_preview_indeterminate

If false, the indeterminate animation will be paused in the editor.

var editor_preview_indeterminate : bool

Property Value

bool

Remarks

  • void set_editor_preview_indeterminate(bool value)
  • bool is_editor_preview_indeterminate_enabled

fill_mode

The fill direction. See FillMode for possible values.

var fill_mode : int = 0

Property Value

int

Remarks

  • void set_fill_mode(int value)
  • int get_fill_mode

indeterminate

When set to true, the progress bar indicates that something is happening with an animation, but does not show the fill percentage or value.

var indeterminate : bool = false

Property Value

bool

Remarks

  • void set_indeterminate(bool value)
  • bool is_indeterminate

show_percentage

If true, the fill percentage is displayed on the bar.

var show_percentage : bool = true

Property Value

bool

Remarks

  • void set_show_percentage(bool value)
  • bool is_percentage_shown

font_color

Theme Property

The color of the text.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

font_outline_color

Theme Property

The tint of text outline of the ProgressBar.

 = ``Color(0, 0, 0, 1)``

Property Value

Color

outline_size

Theme Property

The size of the text outline.

Note: If using a font with multichannel_signed_distance_field enabled, its msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

 = ``0``

Property Value

int

font

Theme Property

Font used to draw the fill percentage if show_percentage is true.

Font font

Property Value

Font

font_size

Theme Property

Font size used to draw the fill percentage if show_percentage is true.

int font_size

Property Value

int

background

Theme Property

The style of the background.

StyleBox background

Property Value

StyleBox

fill

Theme Property

The style of the progress (i.e. the part that fills the bar).

StyleBox fill

Property Value

StyleBox