Table of Contents

Class TextureProgressBar

Texture-based progress bar. Useful for loading screens and life or stamina bars.

Inheritance
TextureProgressBar

Remarks

TextureProgressBar works like ProgressBar, but uses up to 3 textures instead of Godot's Theme resource. It can be used to create horizontal, vertical and radial progress bars.

Properties

fill_mode

The fill direction. See FillMode for possible values.

var fill_mode : int = 0

Property Value

int

Remarks

  • void set_fill_mode(int value)
  • int get_fill_mode

nine_patch_stretch

If true, Godot treats the bar's textures like in NinePatchRect. Use the stretch_margin_* properties like stretch_margin_bottom to set up the nine patch's 3×3 grid. When using a radial fill_mode, this setting will only enable stretching for texture_progress, while texture_under and texture_over will be treated like in NinePatchRect.

var nine_patch_stretch : bool = false

Property Value

bool

Remarks

  • void set_nine_patch_stretch(bool value)
  • bool get_nine_patch_stretch

radial_center_offset

Offsets texture_progress if fill_mode is TextureProgressBar.FILL_CLOCKWISE, TextureProgressBar.FILL_COUNTER_CLOCKWISE, or TextureProgressBar.FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE.

Note: The effective radial center always stays within the texture_progress bounds. If you need to move it outside the texture's bounds, modify the texture_progress to contain additional empty space where needed.

var radial_center_offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

  • void set_radial_center_offset(Vector2 value)
  • Vector2 get_radial_center_offset

radial_fill_degrees

Upper limit for the fill of texture_progress if fill_mode is TextureProgressBar.FILL_CLOCKWISE, TextureProgressBar.FILL_COUNTER_CLOCKWISE, or TextureProgressBar.FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE. When the node's value is equal to its max_value, the texture fills up to this angle.

See value, max_value.

var radial_fill_degrees : float = 360.0

Property Value

float

Remarks

  • void set_fill_degrees(float value)
  • float get_fill_degrees

radial_initial_angle

Starting angle for the fill of texture_progress if fill_mode is TextureProgressBar.FILL_CLOCKWISE, TextureProgressBar.FILL_COUNTER_CLOCKWISE, or TextureProgressBar.FILL_CLOCKWISE_AND_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.

Note: radial_initial_angle is wrapped between 0 and 360 degrees (inclusive).

var radial_initial_angle : float = 0.0

Property Value

float

Remarks

  • void set_radial_initial_angle(float value)
  • float get_radial_initial_angle

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. Only effective if nine_patch_stretch is true.

var stretch_margin_bottom : int = 0

Property Value

int

Remarks

  • void set_stretch_margin(int margin, int value)
  • int get_stretch_margin(int margin)

stretch_margin_left

The width of the 9-patch's left column. Only effective if nine_patch_stretch is true.

var stretch_margin_left : int = 0

Property Value

int

Remarks

  • void set_stretch_margin(int margin, int value)
  • int get_stretch_margin(int margin)

stretch_margin_right

The width of the 9-patch's right column. Only effective if nine_patch_stretch is true.

var stretch_margin_right : int = 0

Property Value

int

Remarks

  • void set_stretch_margin(int margin, int value)
  • int get_stretch_margin(int margin)

stretch_margin_top

The height of the 9-patch's top row. Only effective if nine_patch_stretch is true.

var stretch_margin_top : int = 0

Property Value

int

Remarks

  • void set_stretch_margin(int margin, int value)
  • int get_stretch_margin(int margin)

texture_over

Texture2D that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of texture_progress.

var texture_over : Texture2D

Property Value

Texture2D

Remarks

texture_progress

Texture2D 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 value, min_value, max_value.

var texture_progress : Texture2D

Property Value

Texture2D

Remarks

texture_progress_offset

The offset of texture_progress. Useful for texture_over and texture_under with fancy borders, to avoid transparent margins in your progress texture.

var texture_progress_offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

  • void set_texture_progress_offset(Vector2 value)
  • Vector2 get_texture_progress_offset

texture_under

Texture2D that draws under the progress bar. The bar's background.

var texture_under : Texture2D

Property Value

Texture2D

Remarks

tint_over

Multiplies the color of the bar's texture_over texture. The effect is similar to modulate, except it only affects this specific texture instead of the entire node.

var tint_over : Color = Color(1, 1, 1, 1)

Property Value

Color

Remarks

  • void set_tint_over(Color value)
  • Color get_tint_over

tint_progress

Multiplies the color of the bar's texture_progress texture.

var tint_progress : Color = Color(1, 1, 1, 1)

Property Value

Color

Remarks

  • void set_tint_progress(Color value)
  • Color get_tint_progress

tint_under

Multiplies the color of the bar's texture_under texture.

var tint_under : Color = Color(1, 1, 1, 1)

Property Value

Color

Remarks

  • void set_tint_under(Color value)
  • Color get_tint_under

Methods

get_stretch_margin(int)

Qualifiers: const

Returns the stretch margin with the specified index. See stretch_margin_bottom and related properties.

int get_stretch_margin(int margin)

Parameters

margin int

set_stretch_margin(int, int)

Sets the stretch margin with the specified index. See stretch_margin_bottom and related properties.

void set_stretch_margin(int margin, int value)

Parameters

margin int
value int