Skip to content
Hengo Hengo

Event actions

15 actions in the Event category. Each block mirrors how the action appears in the editor's sidebar.

Emit Signal

Every Frame
Emit Signal Event
''

Emits one of this script signals, reaching everything connected to it. The signal must be declared in this script first.

Input Type Default Description
Signal String '' Name of the signal to emit, matching one declared in this script.

Phases StartEvery FramePhysicsEnd

On Animation Finished

Every Frame
On Animation Finished Event
Emitter not set | Store Name not set | → Received

Runs when an AnimationPlayer finishes playing its current clip.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Name Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Any Button Pressed

Every Frame
On Any Button Pressed Event
Container not set | Store Index not set | → Received

Watches every child button of a container at once and reports which one was pressed by its index. It replaces one listener and one state per button with a single action.

Input Type Default Description
Container Container - The node whose buttons are watched. Leave it empty to watch the children of this node.
Store Index int - Variable that receives the child index that was pressed. Optional.
Branch Goes to
Received Where to go when any child button is pressed.

Phases Every FramePhysics

On Area Entered

Every Frame
On Area Entered Event
Emitter not set | Store Area not set | → Received

Runs when another Area2D overlaps this Area2D.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Area Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Area Exited

Every Frame
On Area Exited Event
Emitter not set | Store Area not set | → Received

Runs when another Area2D stops overlapping this Area2D.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Area Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Body Entered

Every Frame
On Body Entered Event
Emitter not set | Store Body not set | → Received

Runs when a physics body enters this Area2D or RigidBody2D.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Body Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Body Exited

Every Frame
On Body Exited Event
Emitter not set | Store Body not set | → Received

Runs when a physics body leaves this Area2D or RigidBody2D.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Body Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Button Pressed

Every Frame
On Button Pressed Event
not set | → Received

Runs when a Button is pressed by mouse or keyboard.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Mouse Entered

Every Frame
On Mouse Entered Event
not set | → Received

Runs when the mouse moves over a node, such as a Control or an Area with mouse detection on.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Mouse Exited

Every Frame
On Mouse Exited Event
not set | → Received

Runs when the mouse leaves a node, such as a Control or an Area with mouse detection on.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Signal

Every Frame
On Signal Event
Emitter not set | Signal 'body_entered' | Sends 'nothing' | Store Value not set | → Received

Reacts to a signal coming from a node while this state runs. The connection is made when the state starts and dropped when it ends, so it only fires here.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Signal String 'body_entered' Name of the signal to listen for, like body_entered or pressed.
Sends String 'nothing' Whether the signal also carries a value to capture.
Store Value Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Text Submitted

Every Frame
On Text Submitted Event
Emitter not set | Store Text not set | → Received

Runs when Enter is pressed in a LineEdit. The submitted text is sent to Store Text.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Text Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Timer Timeout

Every Frame
On Timer Timeout Event
not set | → Received

Runs when a Timer node reaches the end of its countdown.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Toggled

Every Frame
On Toggled Event
Emitter not set | Store On not set | → Received

Runs when a toggle button such as a CheckBox flips on or off. The new state is sent to Store On.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store On Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics

On Value Changed

Every Frame
On Value Changed Event
Emitter not set | Store Value not set | → Received

Runs when a Range node such as a Slider or SpinBox changes. The new value is sent to Store Value.

Input Type Default Description
Emitter Node - The node that emits the signal, such as an Area2D or a Button.
Store Value Variant - Variable that receives the value the signal sends. Optional.
Branch Goes to
Received Where to go when the signal is received.

Phases Every FramePhysics