Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

TextureProgressBar

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

class TextureProgressBar

Mangled symbol

s10SwiftGodot18TextureProgressBarCWhat are these?

FNV24: [31RUC]

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.

Superclasses

class Range
Abstract base class for controls that represent a number within a range.

Citizens in SwiftGodot

Conformances

protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

enum FillMode

Type members

class var godotClassName: StringName

Instance members

var fillMode: Int32
The fill direction. See FillMode for possible values.
var ninePatchStretch: Bool
If true, Godot treats the bar’s textures like in NinePatchRect. Use the stretch_margin_* properties like stretchMarginBottom to set up the nine patch’s 3×3 grid. When using a radial fillMode, this setting will enable stretching.
var radialCenterOffset: Vector2
Offsets textureProgress if fillMode is .fillClockwise or .fillCounterClockwise.
var radialFillDegrees: Double
Upper limit for the fill of textureProgress if fillMode is .fillClockwise or .fillCounterClockwise. When the node’s value is equal to its max_value, the texture fills up to this angle.
var radialInitialAngle: Double
Starting angle for the fill of textureProgress if fillMode is .fillClockwise or .fillCounterClockwise. 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 radialFillDegrees.
var stretchMarginBottom: Int32
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.
var stretchMarginLeft: Int32
The width of the 9-patch’s left column.
var stretchMarginRight: Int32
The width of the 9-patch’s right column.
var stretchMarginTop: Int32
The height of the 9-patch’s top row.
var textureOver: Texture2D?
Texture2D that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of textureProgress.
var textureProgress: Texture2D?
Texture2D that clips based on the node’s value and fillMode. 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.
var textureProgressOffset: Vector2
The offset of textureProgress. Useful for textureOver and textureUnder with fancy borders, to avoid transparent margins in your progress texture.
var textureUnder: Texture2D?
Texture2D that draws under the progress bar. The bar’s background.
var tintOver: Color
Multiplies the color of the bar’s textureOver texture. The effect is similar to modulate, except it only affects this specific texture instead of the entire node.
var tintProgress: Color
Multiplies the color of the bar’s textureProgress texture.
var tintUnder: Color
Multiplies the color of the bar’s textureUnder texture.