Skip to content

3.0.0

Choose a tag to compare

@Needle-Mirror-Bot Needle-Mirror-Bot released this 03 Oct 14:12

[3.0.0] - 2023-07-25

Changed

  • 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<List<ItemKey>> where ItemKey includes additional metadata alongside the key: The write lock value, and modified date-time.
      • LoadAsync and LoadAllAsync now return a Task<Dictionary<string, Item>>, 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<string, object> data), or SaveAsync(IDictionary<string, SaveItem> data) without specifying the write lock on the SaveItem.
      • ForceDeleteAsync has been removed in favour of DeleteAsync without specifying the write lock option.

Added

  • 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<string, SaveItem> 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<string, string> 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