SceneTreeTimer

Documentation

Overview

Package SceneTreeTimer provides methods for working with SceneTreeTimer object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsSceneTreeTimer() Instance
  • func (self Instance) OnTimeout(cb func())
  • func (self Instance) SetTimeLeft(value Float.X)
  • func (self Instance) TimeLeft() Float.X
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsSceneTreeTimer() Instance
}

type Instance

type Instance [1]gdclass.SceneTreeTimer

A one-shot timer managed by the scene tree, which emits [signal timeout] on completion. See also [method SceneTree.create_timer]. 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: [codeblocks] [gdscript] func some_function():

print("Timer started.")
await get_tree().create_timer(1.0).timeout
print("Timer ended.")

[/gdscript] [csharp] public async Task SomeFunction()

{
    GD.Print("Timer started.");
    await ToSignal(GetTree().CreateTimer(1.0f), SceneTreeTimer.SignalName.Timeout);
    GD.Print("Timer ended.");
}

[/csharp] [/codeblocks] The timer will be dereferenced after its time elapses. To preserve the timer, you can keep a reference to it. See [RefCounted]. [b]Note:[/b] The timer is processed after all of the nodes in the current frame, i.e. node's [method Node._process] method would be called before the timer (or [method Node._physics_process] if [code]process_in_physics[/code] in [method SceneTree.create_timer] has been set to [code]true[/code]).

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsSceneTreeTimer

func (self Instance) AsSceneTreeTimer() Instance

func (Instance) OnTimeout

func (self Instance) OnTimeout(cb func())

func (Instance) SetTimeLeft

func (self Instance) SetTimeLeft(value Float.X)

func (Instance) TimeLeft

func (self Instance) TimeLeft() Float.X

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value