TextureProgress

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

    TextureProgress works like , 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

    get_stretch_margin ( margin ) const

    void

    set_stretch_margin ( margin, int value )

    Enumerations

    enum FillMode:

    • FILL_LEFT_TO_RIGHT = 0 —- The texture_progress fills from left to right.

    • FILL_TOP_TO_BOTTOM = 2 —- The fills from top to bottom.

    • FILL_BOTTOM_TO_TOP = 3 —- The texture_progress fills from bottom to top.

    • FILL_COUNTER_CLOCKWISE = 5 —- Turns the node into a radial bar. The fills counterclockwise. See radial_center_offset, and radial_fill_degrees to control the way the bar fills up.

    • FILL_BILINEAR_LEFT_AND_RIGHT = 6 —- The fills from the center, expanding both towards the left and the right.

    • FILL_BILINEAR_TOP_AND_BOTTOM = 7 —- The texture_progress fills from the center, expanding both towards the top and the bottom.

    • FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE = 8 —- Turns the node into a radial bar. The fills radially from the center, expanding both clockwise and counterclockwise. See radial_center_offset, and radial_fill_degrees to control the way the bar fills up.

    Default

    Setter

    set_fill_mode(value)

    Getter

    get_fill_mode()

    The fill direction. See for possible values.

    • bool nine_patch_stretch

    Default

    false

    Setter

    set_nine_patch_stretch(value)

    Getter

    get_nine_patch_stretch()

    If true, Godot treats the bar’s textures like in . Use the stretch_margin_* properties like stretch_margin_bottom to set up the nine patch’s 3×3 grid. When using a radial , this setting will enable stretching.

    Default

    Vector2( 0, 0 )

    Setter

    set_radial_center_offset(value)

    Getter

    get_radial_center_offset()

    Offsets if fill_mode is or FILL_COUNTER_CLOCKWISE.

    • radial_fill_degrees

    Default

    360.0

    Setter

    set_fill_degrees(value)

    Getter

    get_fill_degrees()

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

    See Range.value, .

    • float radial_initial_angle

    Starting angle for the fill of if fill_mode is 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 .

    • int stretch_margin_bottom

    Default

    0

    Setter

    set_stretch_margin(value)

    Getter

    get_stretch_margin()

    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.

    Default

    0

    Setter

    set_stretch_margin(value)

    Getter

    get_stretch_margin()

    • stretch_margin_right

    Default

    Setter

    set_stretch_margin(value)

    Getter

    get_stretch_margin()

    The width of the 9-patch’s right column.

    • int stretch_margin_top

    Default

    0

    Setter

    set_stretch_margin(value)

    Getter

    get_stretch_margin()

    The height of the 9-patch’s top row.

    • texture_over

    Setter

    set_over_texture(value)

    Getter

    get_over_texture()

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

    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 . See Range.value, , Range.max_value.

    • texture_progress_offset

    Default

    Vector2( 0, 0 )

    Setter

    set_texture_progress_offset(value)

    Getter

    get_texture_progress_offset()

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

    • texture_under

    Setter

    set_under_texture(value)

    Getter

    get_under_texture()

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

    • tint_over

    Default

    Color( 1, 1, 1, 1 )

    Setter

    set_tint_over(value)

    Getter

    get_tint_over()

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

    • tint_progress

    Default

    Color( 1, 1, 1, 1 )

    Setter

    set_tint_progress(value)

    Getter

    get_tint_progress()

    Multiplies the color of the bar’s texture_progress texture.

    Default

    Setter

    set_tint_under(value)

    Getter

    Multiplies the color of the bar’s texture_under texture.

    Method Descriptions

    • int get_stretch_margin ( margin ) const