com.unity.services.cloudsave 3.0.0
Source docsNotes: processedReleased October 3, 2023
Unity Compatibility
Minimum Unity: 2020.3
Package Dependencies
📈 Improvements
- All existing methods have been marked as obsolete. They have mostly been replicated in new namespaces with some additional changes:
- - Methods in the namespace `CloudSaveService.Instance.Files` have been replicated in the namespace `CloudSaveService.Instance.Files.Player` without additional changes.
- - Methods in the namespace `CloudSaveService.Instance.Data` have been replicated in the namespace `CloudSaveService.Instance.Data.Player` with some additional changes:
- - `RetrieveAllKeysAsync` has been renamed to `ListAllKeysAsync` and now returns a `Task>` where `ItemKey` includes additional metadata alongside the key: The write lock value, and modified date-time.
- - `LoadAsync` and `LoadAllAsync` now return a `Task>`, where `Item` includes additional metadata alongside the value: The write lock value, modified date-time, and created date-time.
- - `ForceSaveAsync` has been removed in favour of `SaveAsync(IDictionary data)`, or `SaveAsync(IDictionary data)` without specifying the write lock on the `SaveItem`.
- - `ForceDeleteAsync` has been removed in favour of `DeleteAsync` without specifying the write lock option.
✨ Features
- Support for reading data from custom IDs stored with Game State for Cloud Save Data. This data is read-only from the SDK and the following methods are available from the namespace `CloudSaveService.Instance.Data.Custom.*`
- - `ListAllKeysAsync` will list all keys for a given custom data ID with their metadata
- - `LoadAsync` will load the data for the specified keys for a given custom data ID
- - `LoadAllAsync` will load all the data for a given custom data ID
- Support for reading and enforcing write locks on player data writes:
- - Added `SaveAsync(IDictionary data)` which will fail for the given item if the supplied write lock on the `SaveItem` does not match the server state
- - `SaveAsync` returns a `Dictionary` with the saved keys and their updated write locks
- - Added `DeleteAsync` with an optional `DeleteOptions` parameter which will fail if the specified write lock option does not match the server state