Runtime Docs

Signals Runtime API

Purpose

Signals are global pub/sub messages between scripts. Emit by signal name and connect listener node methods without direct object references.

Signals Runtime API explains behavior, constraints, and practical usage so implementation decisions stay consistent across scripts and scenes.

Jump to Docs

Signals Featureworkflow view Methodshandler functions

API Source

Functions

signal_connect!signal_emit!signal_disconnect!

Enums

// not documented yet for this module

Constants

emit returns listener count

Types

RuntimeWindowSignalIDNodeIDScriptContext

Usage Pattern

signal_connect!(ctx.run, ctx.id, signal!("player_jumped"), func!("on_alert"));let count = signal_emit!(ctx.run, signal!("player_jumped"), params![ctx.id]);

Key Details

signal_emit! returns the number of triggered listeners.

signal_connect! stores listener node id, signal id, handler function id, and optional connection params.

Connection params append after emitted params.

Physics bodies and areas also emit named collision/overlap signals.