TextureProgress¶
Inherits: Range < Control < CanvasItem < Node < Object
Category: Core
Brief Description¶
Texture-based progress bar. Useful for loading screens and life or stamina bars.
Member Variables¶
- int fill_mode - The fill direction. Uses FILL_* constants.
- bool nine_patch_stretch - If
true
Godot treats the bar’s textures like NinePatchRect. Usestretch_margin_*
, like stretch_margin_bottom, to set up the nine patch’s 3x3 grid. Default value:false
. - Vector2 radial_center_offset - Offsets texture_progress if fill_mode is
FILL_CLOCKWISE
orFILL_COUNTER_CLOCKWISE
. - float radial_fill_degrees - Upper limit for the fill of texture_progress if fill_mode is
FILL_CLOCKWISE
orFILL_COUNTER_CLOCKWISE
. When the node’svalue
is equal to itsmax_value
, the texture fills up to this angle.
See Range.value, Range.max_value.
- float radial_initial_angle - Starting angle for the fill of texture_progress if fill_mode is
FILL_CLOCKWISE
orFILL_COUNTER_CLOCKWISE
. When the node’svalue
is equal to itsmin_value
, the texture doesn’t show up at all. When thevalue
increases, the texture fills and tends towards radial_fill_degrees. - int stretch_margin_bottom - The height of the 9-patch’s bottom row. A margin of 16 means the 9-slice’s bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
- int stretch_margin_left - The width of the 9-patch’s left column.
- int stretch_margin_right - The width of the 9-patch’s right column.
- int stretch_margin_top - The height of the 9-patch’s top row.
- Texture texture_over - Texture that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of texture_progress.
- Texture texture_progress - Texture that clips based on the node’s
value
and fill_mode. Asvalue
increased, the texture fills up. It shows entirely whenvalue
reachesmax_value
. It doesn’t show at all ifvalue
is equal tomin_value
.
The value
property comes from Range. See Range.value, Range.min_value, Range.max_value.
Enums¶
enum FillMode
- FILL_LEFT_TO_RIGHT = 0 — The texture_progress fills from left to right.
- FILL_RIGHT_TO_LEFT = 1 — The texture_progress fills from right to left.
- FILL_TOP_TO_BOTTOM = 2 — The texture_progress fills from top to bototm.
- FILL_BOTTOM_TO_TOP = 3 — The texture_progress fills from bottom to top.
- FILL_CLOCKWISE = 4 — Turns the node into a radial bar. The texture_progress fills clockwise. See radial_center_offset, radial_initial_angle and radial_fill_degrees to refine its behavior.
- FILL_COUNTER_CLOCKWISE = 5 — Turns the node into a radial bar. The texture_progress fills counter-clockwise. See radial_center_offset, radial_initial_angle and radial_fill_degrees to refine its behavior.
Description¶
TextureProgress works like ProgressBar but it uses up to 3 textures instead of Godot’s Theme resource. Works horizontally, vertically, and radially.