Open Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

Range

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

class Range

Mangled symbol

s10SwiftGodot5RangeCWhat are these?

FNV24: [5ID96]

Range is an abstract base class for controls that represent a number within a range, using a configured step and page size. See e.g. ScrollBar and Slider for examples of higher-level nodes using Range.

This object emits the following signals:

valueChanged
changed

Superclasses

class Control
Base class for all GUI controls. Adapts its position and size based on its parent control.

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

class Signal1
Signal support.

Type members

class var godotClassName: StringName

Instance members

var allowGreater: Bool
If true, value may be greater than maxValue.
var allowLesser: Bool
If true, value may be less than minValue.
var changed: SimpleSignal
Emitted when minValue, maxValue, page, or step change.
var expEdit: Bool
If true, and minValue is greater than 0, value will be represented exponentially rather than linearly.
var maxValue: Double
Maximum value. Range is clamped if value is greater than maxValue.
var minValue: Double
Minimum value. Range is clamped if value is less than minValue.
var page: Double
Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by page over the difference between minValue and maxValue.
var ratio: Double
The value mapped between 0 and 1.
var rounded: Bool
If true, value will always be rounded to the nearest integer.
var step: Double
If greater than 0, value will always be rounded to a multiple of this property’s value. If rounded is also true, value will first be rounded to a multiple of this property’s value, then rounded to the nearest integer.
var value: Double
Range’s current value. Changing this property (even via code) will trigger [signal value_changed] signal. Use setValueNoSignal(value:) if you want to avoid it.
var valueChanged: Signal1
Emitted when value changes. When used on a Slider, this is called continuously while dragging (potentially every frame). If you are performing an expensive operation in a function connected to [signal value_changed], consider using a debouncing Timer to call the function less often.
func setValueNoSignal(value: Double)
Sets the Range’s current value to the specified value, without emitting the [signal value_changed] signal.
func share(with: Node?)
Binds two Ranges together along with any ranges previously grouped with either of them. When any of range’s member variables change, it will share the new value with all other ranges in its group.
func unshare()
Stops the Range from sharing its member variables with any other.

Show implementation details (1)

func _valueChanged(newValue: Double)
Called when the Range’s value is changed (following the same conditions as [signal value_changed]).

Subclasses

class EditorSpinSlider
Godot editor’s control for editing numeric values.
class ProgressBar
A control used for visual representation of a percentage.
class ScrollBar
Abstract base class for scrollbars.
class Slider
Abstract base class for sliders.
class SpinBox
An input field for numbers.
class TextureProgressBar
Texture-based progress bar. Useful for loading screens and life or stamina bars.