PlayMaker
Store and sync key-value data across devices using platform cloud storage.
Actions (14)
Write/read:
CloudServicesSetValue,CloudServicesGetValue(supports Bool/Int/Float/String)Snapshot helper:
CloudServicesGetSnapshot(reads full snapshot as JSON)Existence:
CloudServicesHasKey(checks current snapshot)Sync:
CloudServicesSynchronize(firessuccessEvent/failureEvent)Change listener:
CloudServicesOnSavedDataChange(persistent; firesdataChangedEvent)Change helper:
CloudServicesGetChangedKeys(reads all cached changed keys as string array)Conflict helper:
CloudServicesGetCloudAndLocalCacheValues(reads both cloud + local cache value for a key)User listener:
CloudServicesOnUserChange(persistent; fires account status events)User helper:
CloudServicesGetUserInfo(reads cached user id/status)Delete:
CloudServicesRemoveKey,CloudServicesRemoveAllKeysEasy Save 3 sync (requires
ENABLE_VOXELBUSTERS_ESSENTIAL_KIT_EASY_SAVE_SUPPORT):ES3EssentialKitCloudServicesSyncRawBytesES3EssentialKitCloudServicesSyncKeyValues
Key patterns
SetValue/GetValue are synchronous. Use
CloudServicesSynchronizewhen you want to push/pull changes and get a completion event.Listener actions should stay active:
CloudServicesOnSavedDataChangereceives remote changes and provideschangedKeys+changeReason.CloudServicesOnUserChangereports account availability (signed in/out/restricted).
Common flows
Save:
SetValue(one or more keys) →SynchronizeLoad with defaults:
HasKey→GetValue(else keep local default)Multi-device: keep
OnSavedDataChangeactive → ondataChangedEvent, loop keys andGetValueReset:
RemoveKey/RemoveAllKeys→Synchronize
Use cases
Start here: use-cases/README.md
Last updated