class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS Signal
A built-in type representing a signal of an Object.

Signal is a built-in Variant type that represents a signal of an Object instance. Like all Variant types, it can be stored in variables and passed to functions. Signals allow all connected Callables (and by extension their respective objects) to listen and react to events, without directly referencing one another. This keeps the code flexible and easier to manage. You can check whether an Object has a given signal name using Object.has_signal().

In GDScript, signals can be declared with the signal keyword. In C#, you may use the [Signal] attribute on a delegate.

signal attacked # Additional arguments may be declared. # These arguments must be passed when the signal is emitted. signal item_dropped(item_name, amount)
Signal Signal<>():Signal

Constructs an empty Signal with no object nor signal name bound.

 Signal Signal<>( Signal from=, from:Signal=, ):Signal

Constructs a Signal as a copy of the given Signal.

 Signal Signal<>( Object object=, object:Object=, StringName signal=, signal:StringName=, ):Signal

Creates a Signal object referencing a signal named signal in the specified object.

 bool operator !=<>( Signal right=, right:Signal=, ):bool

Returns true if the signals do not share the same object and name.

 bool operator ==<>( Signal right=, right:Signal=, ):bool

Returns true if both signals share the same object and name.

 int connect<>( Callable callable=, callable:Callable=, int flags=0, flags:int=0, ):int

Connects this signal to the specified callable. Optional flags can be also added to configure the connection's behavior (see ConnectFlags constants). You can provide additional arguments to the connected callable by using Callable.bind().

A signal can only be connected once to the same Callable. If the signal is already connected, returns @GlobalScope.ERR_INVALID_PARAMETER and pushes an error message, unless the signal is connected with Object.CONNECT_REFERENCE_COUNTED. To prevent this, use is_connected() first to check for existing connections.

for button in $Buttons.get_children(): button.pressed.connect(_on_pressed.bind(button)) func _on_pressed(button): print(button.name, " was pressed")
void disconnect<>( Callable callable=, callable:Callable=, ):void

Disconnects this signal from the specified Callable. If the connection does not exist, generates an error. Use is_connected() to make sure that the connection exists.

 void emit<>( ... params=, params:...=, ):void

Emits this signal. All Callables connected to this signal will be triggered. This method supports a variable number of arguments, so parameters can be passed as a comma separated list.

 Array get_connections<>():Array

Returns an Array of connections for this signal. Each connection is represented as a Dictionary that contains three entries:

  • signal is a reference to this signal;

  • callable is a reference to the connected Callable;

  • flags is a combination of ConnectFlags.

 StringName get_name<>():StringName

Returns the name of this signal.

 Object get_object<>():Object

Returns the object emitting this signal.

 int get_object_id<>():int

Returns the ID of the object emitting this signal (see Object.get_instance_id()).

 bool has_connections<>():bool

Returns true if any Callable is connected to this signal.

 bool is_connected<>( Callable callable=, callable:Callable=, ):bool

Returns true if the specified Callable is connected to this signal.

 bool is_null<>():bool

Returns true if this Signal has no object and the signal name is empty. Equivalent to signal == Signal().


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...