Posted on

Cloud Saving Service – Cross Platform Native Plugins: Essential Kit

Download

Documentation: https://assetstore.essentialkit.voxelbusters.com/

0:00 Welcome to Cloud Saving with CPNP2
0:30 Overview
1:27 Setup
2:30 iOS
2:57 Android
3:30 Usage Code
12:40 Unity Demo
15:10 Testing

In this lesson on how to use the Cross Platform Native Plugin in Unity, I will show you how to implement the Cloud Service to save player data. Having the ability to save player data to the cloud is important because it makes it so the player game quickly change devices and keep their data. The Cloud Service even allows you to save the player’s purchases whenever then buy an IAP from your store.

IG_CloudSaving.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using VoxelBusters.EssentialKit;
using VoxelBusters.CoreLibrary;


public class IG_CloudSaving : MonoBehaviour
{
    public static IG_CloudSaving instance;

    public IG_CloudData myCloudData;
    public string cloudDataKey;




    private void OnEnable()
    {
        // register for events
        CloudServices.OnUserChange += OnUserChange;
        CloudServices.OnSavedDataChange += OnSavedDataChange;
        CloudServices.OnSynchronizeComplete += OnSynchronizeComplete;
    }

    private void OnDisable()
    {
        // unregister from events
        CloudServices.OnUserChange -= OnUserChange;
        CloudServices.OnSavedDataChange -= OnSavedDataChange;
        CloudServices.OnSynchronizeComplete -= OnSynchronizeComplete;
    }

    // Start is called before the first frame update
    void Start()
    {
        instance = this;
        DontDestroyOnLoad(gameObject);
        if(CloudServices.IsAvailable())
        {
            CloudServices.Synchronize(); // First call to syncronize triggers google play services login prompt if required - on Android.
        }
        
    }

    private void OnSynchronizeComplete(CloudServicesSynchronizeResult result)
    {
        Debug.Log("Received synchronize finish callback.");
        Debug.Log("Status: " + result.Success);
        // By this time, you have the latest data from cloud and you can start reading.
        myCloudData = GetCloudData(cloudDataKey);
    }


    public void SaveCloudData(string key, IG_CloudData data)
    {
        string json = JsonUtility.ToJson(data);                                                                  // Please mention the limitations of JsonUtility and they have option to use their own serializer here for complex data where JsonUtility has limitations.

        CloudServices.SetString(key, json);
    }

    public IG_CloudData GetCloudData(string key)
    {
        string json = CloudServices.GetString(key);

        return JsonUtility.FromJson<IG_CloudData>(json);
    }


    private void OnUserChange(CloudServicesUserChangeResult result, Error error)
    {
        Debug.Log(result.User);
    }

    //This gets triggered if the data changed externally on another device while playing on this device.
    private void OnSavedDataChange(CloudServicesSavedDataChangeResult result)
    {

        for (int i = 0; i < result.ChangedKeys.Length; i++)
        {
            if (result.ChangedKeys[i] == cloudDataKey)
            {
                // Here GetCloudData returns the data that is recently available on server. So, we always need to maintain a runtime memory copy incase if current device has new data.
                // Here you are already maintaining the copy in myCloudData. So let me show you how to handle this conflict...

                IG_CloudData serverCopy = GetCloudData(cloudDataKey);

                if(serverCopy.highScore > myCloudData.highScore) //This means if server has better highscore, we want to retain it.
                {
                    myCloudData.highScore = serverCopy.highScore;
                }

                if(serverCopy.hasRemoveAds || myCloudData.hasRemoveAds) // This means we are making sure if remove ads value is true any where on external device or this device
                {
                    myCloudData.hasRemoveAds = true;
                }

                //Now as we made changes, we push the conflict resolved data to the cloud again by setting the latest data.
                SaveCloudData(cloudDataKey, myCloudData);

                // Lines 127-140 can be skipped if you are fine overwriting your local device data with the external changed data. But its good to consider whats the best value to safeguard the users progress.

                // On next sync, the recent data set above will be automatically pushed to cloud.
            }
        }

    }
}

public class IG_CloudData
{
    public int highScore;
    public bool hasRemoveAds;
    //Add whatever variable you wish to save to the cloud
}