Actions API
Typed UI-to-game action registration, dispatch, context, and results.
calmui::CalmUiActionDispatcher is the engine-neutral bridge from UI intent to
gameplay handlers. An action schema defines each stable action ID, name, and
required payload fields.
| API | Purpose |
|---|---|
Register(ActionId, Handler) | Attach a handler and receive a registration ID. |
Unregister(ActionRegistrationId) | Remove the exact registration. |
Dispatch(ActionId, Value, view, componentInstance) | Validate and deliver an action with context. |
Log() | Inspect the bounded diagnostic history. |
Schema() | Read the active action contract. |
Dispatch returns Handled, InvalidPayload, MissingHandler, or
HandlerRejected. ActionContext identifies the local player, view, and
component instance that produced the intent.
Generated TypeScript exposes named action functions. Unreal C++ registers handlers, while Blueprint uses action references and the detailed action event. Gameplay changes should be written back through Store updates.
See the Actions guide, C++ handlers, and
Blueprint handlers. The exact C++ declaration lives
in core/CalmUiCore/include/calmui/Actions.h.