Classmigueldeicaza.swiftgodot 0.45.0SwiftGodot

Signal1

Signal support.

class Signal1

Mangled symbol

s10SwiftGodot5RangeC7Signal1CWhat are these?

FNV24: [37DHQ]

Use the connect(flags:_:) method to connect to the signal on the container object, and disconnect(_:) to drop the connection.

You can also await the emitted property for waiting for a single emission of the signal.

Other members in extension

View members

This section is hidden by default because it contains too many (17) members.

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]).

Citizens in SwiftGodot

Instance members

var emitted: Void
You can await this property to wait for the signal to be emitted once
func connect(flags: Object.ConnectFlags, @escaping (_ value: Double) -> ()) -> Object
Connects the signal to the specified callback
func disconnect(Object)
Disconnects a signal that was previously connected, the return value from calling connect(flags:_:)