Game State

P00LS Games SDK can save arbitrary chunks of JSON data, aka saves, so that the user's progress is saved across devices

The underlying storage is based on Firestore, as such, the SDK will use its implicit conversion, if any.

Unity Bridge relies on Unity Serialization package to serialize data.

User Data

Save

                        internal class UserData
                        {
                            public float hiscore;
                        }

                        public void Save(UserData userData)
                        {
                            p00lsGamesSdk.SaveUserData(userData);
                        }

                    

                        await sdk.data.saveUserData({
                          myTestKey: 'myTestValue',
                        });
                    

Get

If no data have been saved yet, those methods will yield undefined or null. There is no type enforcement on the SDK side. For instance, if you introduce a new field, you should apply some migration logic at load time.

                        p00lsGamesSdk.GetUserData<UserData>(v =>
                        {
                            // do something with the data

                            gameState.Start();
                        });
                    

await sdk.data.getUserData();

Parts

Sometimes, saving every time a big chunk of data can be wasteful. For instance, things like user preferences (sound on/off, etc), don't change so much, and including them each time would just yield heavier network calls.

For that purpose, you can use parts. Parts work pretty much like user data, only you can specify a key to store them into.

Save

                        private void SavePartData(string docKey, UserData userData)
                        {
                            sdk.SavePartData(docKey, userData);
                        }
                    

                        await sdk.data.savePartData('aKey', {
                            myTestPartKey1: 'myTestPartValue1',
                            myTestPartKey2: 'myTestPartValue2',
                        });
                    

Get

sdk.ReadPartData<UserData>(docKey, data => // do something with data);

                        const savedPart = await sdk.data.readPartData('aKey');
                        // do something with saved part
                    

Last modified: 18 November 2024