SceneTreeTimer
One-shot timer.
SceneTreeTimer.swift:23class SceneTreeTimer
A one-shot timer managed by the scene tree, which emits [signal timeout] on completion. See also createTimer(timeSec:processAlways:processInPhysics:ignoreTimeScale:)
.
As opposed to Timer
, it does not require the instantiation of a node. Commonly used to create a one-shot delay timer as in the following example:
The timer will be dereferenced after its time elapses. To preserve the timer, you can keep a reference to it. See RefCounted
.
This object emits the following signals:
Superclasses
class RefCounted
Base class for reference-counted objects.
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 exampleGString
,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.
Type members
Instance members
var timeLeft: Double
The time remaining (in seconds).
var timeout: SimpleSignal
Emitted when the timer reaches 0.