Store API
Core Store types, transactions, reads, patches, and subscriptions.
calmui::CalmUiStore is the engine-neutral owner of typed gameplay state. The
project schema supplies stable field IDs, paths, value types, scope, and keyed
array metadata.
| Area | Public API |
|---|---|
| Transactions | BeginUpdate, Commit, Rollback, CalmUiStoreTransaction |
| Scalar writes | SetNull, SetBool, SetInt, SetFloat, SetString |
| Structured writes | SetObject, SetObjectField, ReplaceArray |
| Keyed arrays | InsertKeyedArrayItem, UpdateKeyedArrayItem, RemoveKeyedArrayItem, MoveKeyedArrayItem |
| Reads | Read, typed Read* methods |
| Changes | LastPatch, Subscribe, SubscribeAll, scoped subscription variants |
| Schema lifecycle | Schema, Reconfigure, StoreSchemaChange |
Writes performed inside one transaction notify subscribers as one committed patch batch. A failed or abandoned RAII transaction rolls back. Use scoped subscriptions where ownership should automatically unsubscribe.
Fields use PerLocalPlayer or Global scope. The Unreal local-player subsystem
routes global fields to the engine subsystem; Store replication across the
network remains gameplay code's responsibility.
See the Store guide, C++ Store, and
Blueprint Store. The exact C++ declaration lives in
core/CalmUiCore/include/calmui/Store.h; the project source schema is
store.schema.json.