Inheritance #

ProgressBar
Table of contents

ProgressBar #

is_instantiable, Node, core, not_builtin_classes

A control used for visual representation of a percentage.

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

Members #

var editor_preview_indeterminate: bool#

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

var fill_mode: int = 0#

The fill direction. See FillMode for possible values.

var indeterminate: bool = false#

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 show_percentage: bool = true#

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

Methods #

Annotations #

Constants #

const FILL_BEGIN_TO_END = 0 enum FillMode#

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.

const FILL_END_TO_BEGIN = 1 enum FillMode#

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.

const FILL_TOP_TO_BOTTOM = 2 enum FillMode#

The progress fills from top to bottom.

const FILL_BOTTOM_TO_TOP = 3 enum FillMode#

The progress fills from bottom to top.

Constructors #

Enums #

FillMode#

enum FillMode { FILL_BEGIN_TO_END = 0, FILL_END_TO_BEGIN = 1, FILL_TOP_TO_BOTTOM = 2, FILL_BOTTOM_TO_TOP = 3, }

Operators #

Signals #

Theme Items #

self["theme_override_colors/font_color"] = Color(0.95, 0.95, 0.95, 1) as Color#

The color of the text.

self["theme_override_colors/font_outline_color"] = Color(0, 0, 0, 1) as Color#

The tint of text outline of the ProgressBar.

self["theme_override_constants/outline_size"] = 0 as int#

The size of the text outline.

Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.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.

self["theme_override_fonts/font"] = font as Font#

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

self["theme_override_font_sizes/font_size"] = font_size as int#

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

self["theme_override_styles/background"] = style as StyleBox#

The style of the background.

self["theme_override_styles/fill"] = style as StyleBox#

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

Tutorials #