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. Use stretch_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 or FILL_COUNTER_CLOCKWISE.
  • float radial_fill_degrees - Upper limit for the fill of texture_progress if fill_mode is FILL_CLOCKWISE or FILL_COUNTER_CLOCKWISE. When the node’s value is equal to its max_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 or FILL_COUNTER_CLOCKWISE. When the node’s value is equal to its min_value, the texture doesn’t show up at all. When the value 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. As value increased, the texture fills up. It shows entirely when value reaches max_value. It doesn’t show at all if value is equal to min_value.

The value property comes from Range. See Range.value, Range.min_value, Range.max_value.

  • Texture texture_under - Texture that draws under the progress bar. The bar’s background.

Numeric Constants

Description

TextureProgress works like ProgressBar but it uses up to 3 textures instead of Godot’s Theme resource. Works horizontally, vertically, and radially.