class Godot::BoundSignal

• Godot::BoundSignal
• Reference
• Object

Overview

Represents a signal bound to a specific Godot object instance. Enables first-class signal handling, inspection, connection, emission, and non-blocking #await.

Examples:

await(enemy.died)
await(enemy.died, timeout_sec: 2.0)
enemy.died.await
enemy.health_changed.connect { |cur, max| puts "Health: #{cur}/#{max}" }

Direct Known Subclasses

• Godot::TypedSignal(*T)

Defined in:

Constructors

• .new(target : Godot::Object, name : String)

Instance Method Summary

• #alive? : Bool

  Returns true if the bound object is still alive in ObjectDB

• #await(timeout_sec : Float64 | Nil = nil) : Array(Variant)

  Cooperatively awaits this signal without blocking the engine main loop.

• #await(timeout_sec : Number) : Array(Variant)

  Cooperatively awaits this signal with timeout in seconds

• #connect(flags : ConnectFlags = ConnectFlags::None, callback : Proc(Array(Variant), Void) | Nil = nil) : SignalSubscription

  Connects a callback proc to this signal

• #connect(flags : ConnectFlags = ConnectFlags::None, &block : Array(Variant) -> Void) : SignalSubscription

  Connects a callback block to this signal

• #connect(listener_target : Godot::Object, method_name : Symbol, flags : ConnectFlags = ConnectFlags::None) : SignalSubscription

  Connects this signal to a method call on a target object by symbol name

• #connect_one_shot(&block : Array(Variant) -> Void) : SignalSubscription

  Backwards-compatibility helper redirecting to ConnectFlags::OneShot

• #disconnect : Void

  Disconnects all active subscriptions for this signal on the target

• #emit(*args) : Void

  Emits this signal on the target object

• #name : String
• #target : Godot::Object
• #target_id : UInt64

  Returns the target's 64-bit instance ID (or Crystal object_id for unparented Crystal nodes)

• #to_s(io : IO) : Void

  Appends a short String representation of this object which includes its class name and its object address.

Constructor Detail

Instance Method Detail

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).to_s # => #<Person:0x10a199f20>