ProgressBar

Inherits: Range < Control < CanvasItem < Node < Object

General-purpose progress bar.

Description

General-purpose progress bar. Shows fill percentage from right to left.

Properties

int

fill_mode

0

bool

percent_visible

true

Theme Properties

Color

font_color

Color(0.95, 0.95, 0.95, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_shadow_color

Color(0, 0, 0, 1)

int

outline_size

0

Font

font

int

font_size

StyleBox

bg

StyleBox

fg

Enumerations

enum FillMode:

  • FILL_BEGIN_TO_END = 0 --- The progress bar fills from begin to end horizontally, according to the language direction. If Control.is_layout_rtl returns false, it fills from left to right, and if it returns true, it fills from right to left.

  • FILL_END_TO_BEGIN = 1 --- The progress bar fills from end to begin horizontally, according to the language direction. If Control.is_layout_rtl returns false, it fills from right to left, and if it returns true, it fills from left to right.

  • FILL_TOP_TO_BOTTOM = 2 --- The progress fills from top to bottom.

  • FILL_BOTTOM_TO_TOP = 3 --- The progress fills from bottom to top.

Property Descriptions

  • int fill_mode

Default

0

Setter

set_fill_mode(value)

Getter

get_fill_mode()

The fill direction. See FillMode for possible values.


  • bool percent_visible

Default

true

Setter

set_percent_visible(value)

Getter

is_percent_visible()

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

Theme Property Descriptions

Default

Color(0.95, 0.95, 0.95, 1)

The color of the text.


  • Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the ProgressBar.


  • Color font_shadow_color

Default

Color(0, 0, 0, 1)

The color of the text's shadow.


  • int outline_size

Default

0

The size of the text outline.


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


  • int font_size

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


The style of the background.


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