API Reference
Review draft. This source page has not completed website editorial and release-specific verification.
The stable runtime API lives in the SignalBusRuntime module. Editor-only integrations live in SignalBusEditor; runtime code does not depend on that module.
| API | Purpose |
|---|---|
FSignalBusMessageId |
Names a typed SignalBus message. |
FSignalBusSubscriptionHandle |
Identifies a subscription for explicit removal and state checks. |
USignalBusWorldSubsystem |
Routes World-scoped subscriptions and messages. |
USignalBusGameInstanceSubsystem |
Routes Game Instance-scoped subscriptions and messages. |
FSignalBusPublishContext |
Provides a reflected publish payload for Blueprint listeners. |
FSignalBusDispatchResult |
Reports immediate publish outcome and subscriber counts. |
FSignalBusQueueResult |
Reports queued publish outcome and queue identity. |
FSignalBusDiagnosticEvent |
Immutable snapshot of one observed runtime event. |
FSignalBusWarning |
Retained warning-analysis result. |
Payloads are reflected structs, and subscription callbacks must use the same exact payload type used to publish. SignalBus APIs are game-thread-only. A subscription belongs to one subsystem scope and its lifetime owner; removing a handle affects that subscription only.
See C++ Usage and Blueprint Usage for signatures and examples. See Architecture for delivery ordering, reentrancy, and subsystem lifetimes.