Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
ProgressBar¶
Inherits: Range < Control < CanvasItem < Node < Object
A control used for visual representation of a percentage.
Description¶
A control used for visual representation of a percentage. Shows fill percentage from right to left.
Properties¶
|
||
|
Theme Properties¶
|
||
|
||
|
||
Enumerations¶
enum FillMode:
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.
FillMode 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.
FillMode FILL_TOP_TO_BOTTOM = 2
The progress fills from top to bottom.
FillMode FILL_BOTTOM_TO_TOP = 3
The progress fills from bottom to top.
Property Descriptions¶
int fill_mode = 0
The fill direction. See FillMode for possible values.
bool show_percentage = true
If true, the fill percentage is displayed on the bar.
Theme Property Descriptions¶
Color font_color = Color(0.95, 0.95, 0.95, 1)
The color of the text.
Color font_outline_color = Color(1, 1, 1, 1)
The tint of text outline of the ProgressBar.
int outline_size = 0
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.
Font font
Font used to draw the fill percentage if show_percentage is true.
int font_size
Font size used to draw the fill percentage if show_percentage is true.
StyleBox background
The style of the background.
StyleBox fill
The style of the progress (i.e. the part that fills the bar).