> For the complete documentation index, see [llms.txt](https://wiki.playgama.com/playgama/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.playgama.com/playgama/bridge-sdk-v1/bridge-sdk/api/storage.md).
# Storage
The Storage module persists player data: progress, settings, currency, level state. **This is required for almost every game.** Without it, players lose progress between sessions.
## Two storage types
| Type | Persistence | Cross-device | Use when |
| ------------------- | --------------------------- | ------------ | --------------------------------------------------- |
| `local_storage` | Browser/device localStorage | No | Default for offline, single-device progress |
| `platform_internal` | Platform cloud servers | Yes | Player is authorized and you want cross-device save |
`bridge.storage.defaultType` returns the storage type preferred by the current platform. Use it by default; pass an explicit `storageType` only when you need to control where the data is stored.
## Implementation order
1. **Required** — On game start, call [`storage.get(...)`](#load-data) for the keys you need (`level`, `coins`, `settings`, etc.). Restore the player's state before showing gameplay.
2. **Required** — On meaningful state change (level complete, purchase, settings change), [`storage.set(...)`](#save-data) to persist. Avoid saving every frame.
## Current Storage Type
Read the default storage type before saving data. It tells you whether Bridge will use local browser storage or platform cloud storage.
{% tabs %}
{% tab title="Plain JS" %}
```javascript
bridge.storage.defaultType
```
{% endtab %}
{% tab title="Unity" %}
```java
Bridge.storage.defaultType
```
{% endtab %}
{% tab title="Construct 3" %}
```javascript
PlaygamaBridge.DefaultStorageType
```
{% endtab %}
{% tab title="GDevelop" %}
```javascript
PlaygamaBridge::DefaultStorageType()
```
{% endtab %}
{% tab title="Godot" %}
```gdscript
Bridge.storage.default_type
```
{% endtab %}
{% tab title="GameMaker" %}
```javascript
playgama_bridge_storage_default_type()
```
{% endtab %}
{% tab title="Defold" %}
```lua
bridge.storage.default_type()
```
{% endtab %}
{% tab title="Cocos Creator" %}
```javascript
bridge.storage.defaultType
```
{% endtab %}
{% tab title="Scratch" %}
{% endtab %}
{% endtabs %}
Possible values: `local_storage`, `platform_internal`.
Platform support · all 28 platforms (local) · 20 of 28 platforms (cloud)
**`local_storage` supports:** `absolute_games`, `bitquest`, `crazy_games`, `discord`, `dlightek`, `facebook`, `game_distribution`, `gamepush`, `gamesnacks`, `huawei`, `jio_games`, `lagged`, `microsoft_store`, `msn`, `ok`, `playdeck`, `playgama`, `poki`, `portal`, `reddit`, `samsung`, `telegram`, `tiktok`, `vk`, `xiaomi`, `y8`, `yandex`, `youtube`
**`platform_internal` supports:** `absolute_games`, `bitquest`, `crazy_games`, `facebook`, `gamesnacks`, `huawei`, `microsoft_store`, `msn`, `ok`, `playdeck`, `playgama`, `portal`, `reddit`, `samsung`, `telegram`, `tiktok`, `vk`, `y8`, `yandex`, `youtube`
**`platform_internal` does not support:** `discord`, `dlightek`, `game_distribution`, `gamepush`, `jio_games`, `lagged`, `poki`, `xiaomi`
## Availability Check
Check whether a storage type is available before forcing it explicitly. Availability can depend on platform support and player authorization.
{% tabs %}
{% tab title="Plain JS" %}
```javascript
bridge.storage.isAvailable(storageType)
```
{% endtab %}
{% tab title="Unity" %}
```java
Bridge.storage.IsAvailable(StorageType.LocalStorage)
Bridge.storage.IsAvailable(StorageType.PlatformInternal)
```
{% endtab %}
{% tab title="Construct 3" %}
Copy This Example
```
{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"is-storage-available","objectClass":"PlaygamaBridge","parameters":{"storage-type":"local-storage"}}],"actions":[{"type":"comment","text":"local storage available"}]},{"eventType":"block","conditions":[{"id":"is-storage-available","objectClass":"PlaygamaBridge","parameters":{"storage-type":"platform-internal"}}],"actions":[{"type":"comment","text":"platform internal available"}]}]}
```
{% endtab %}
{% tab title="GDevelop" %}
Copy This Example
```
{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsStorageAvailable"},"parameters":["","\"platform_internal\"",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"Platform internal storage available\"","\"info\"",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsStorageAvailable"},"parameters":["","\"local_storage\"",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"Local storage available\"","\"info\"",""]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[{"type":{"value":"PlaygamaBridge::IsStorageSupported"},"parameters":["","\"local_storage\"",""]}],"conditionsCount":1}}
```
{% endtab %}
{% tab title="Godot" %}
```gdscript
Bridge.storage.is_available("local_storage")
Bridge.storage.is_available("platform_internal")
# To use constants for convenience:
Bridge.storage.is_available(Bridge.StorageType.LOCAL_STORAGE)
Bridge.storage.is_available(Bridge.StorageType.PLATFORM_INTERNAL)
```
{% endtab %}
{% tab title="GameMaker" %}
```javascript
playgama_bridge_storage_is_available("platform_internal")
```
{% endtab %}
{% tab title="Defold" %}
```lua
bridge.storage.is_available("local_storage")
bridge.storage.is_available("platform_internal")
```
{% endtab %}
{% tab title="Cocos Creator" %}
```javascript
bridge.storage.isAvailable(STORAGE_TYPE.PLATFORM_INTERNAL)
bridge.storage.isAvailable(STORAGE_TYPE.LOCAL_STORAGE)
```
{% endtab %}
{% tab title="Scratch" %}
{% endtab %}
{% endtabs %}
## Load Data
Load one key or several keys before gameplay starts. Missing keys return `null`, so always provide defaults in your game state.
{% tabs %}
{% tab title="Plain JS" %}
```javascript
// Load data by key
bridge.storage.get('key')
.then(data => {
// Data loaded and you can work with it
// data = null if there is no data for the given key
console.log('Data: ', data)
})
.catch(error => {
// Error, something went wrong
})
// Load data by multiple keys
bridge.storage.get(['key_1', 'key_2'])
.then(data => {
// Data loaded and you can work with it
// data[n] = null if there is no data for the given key
console.log('Data: ', data)
})
.catch(error => {
// Error, something went wrong
})
```
{% endtab %}
{% tab title="Unity" %}
```csharp
// Get data by key
private void Start()
{
Bridge.storage.Get("level", OnStorageGetCompleted);
}
private void OnStorageGetCompleted(bool success, string data)
{
// Loading succeeded
if (success)
{
if (data != null)
{
Debug.Log(data);
}
else
{
// No data for the key 'level'
}
}
else
{
// Error, something went wrong
}
}
// Get data by multiple keys
private void Start()
{
Bridge.storage.Get(new List() { "level", "coins" }, OnStorageGetCompleted);
}
private void OnStorageGetCompleted(bool success, List data)
{
// Loading succeeded
if (success)
{
if (data[0] != null)
{
Debug.Log($"Level: {data[0]}");
}
else
{
// No data for the key 'level'
}
if (data[1] != null)
{
Debug.Log($"Coins: {data[1]}");
}
else
{
// No data for the key 'coins'
}
}
else
{
// Error, something went wrong
}
}
// Get data from a specific storage type
private void Start()
{
Bridge.storage.Get("level", OnStorageGetCompleted, StorageType.LocalStorage);
}
private void OnStorageGetCompleted(bool success, string data)
{
// Loading succeeded
if (success)
{
if (data != null)
{
Debug.Log(data);
}
else
{
// No data for the key 'level'
}
}
else
{
// Error, something went wrong
}
}
```
{% endtab %}
{% tab title="Construct 3" %}
{% hint style="info" %}
If you need data in JSON format, use the `PlaygamaBridge.StorageDataAsJSON("key_1")` expression.
{% endhint %}
Copy This Example
```
{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"append-storage-data-get-request","objectClass":"PlaygamaBridge","parameters":{"key":"\"key_1\""}},{"id":"append-storage-data-get-request","objectClass":"PlaygamaBridge","parameters":{"key":"\"key_2\""}},{"id":"send-storage-data-get-request","objectClass":"PlaygamaBridge","parameters":{"storage-type":"default"}}]},{"eventType":"block","conditions":[{"id":"on-storage-data-get-request-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"has-storage-data","objectClass":"PlaygamaBridge","parameters":{"key":"\"key_1\""}}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.StorageData(\"key_1\")"}}]},{"eventType":"block","conditions":[{"id":"has-storage-data","objectClass":"PlaygamaBridge","parameters":{"key":"\"key_2\""}}],"actions":[{"id":"log","objectClass":"Browser","parameters":{"type":"log","message":"PlaygamaBridge.StorageData(\"key_2\")"}}]}]}]}
```
{% endtab %}
{% tab title="GDevelop" %}
{% hint style="info" %}
If you need data in JSON format, use the `PlaygamaBridge::StorageDataKeyAsJSON("key_1")` expression.
{% endhint %}
Copy This Example
```
{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::AppendStorageDataGetRequest"},"parameters":["","\"key_1\"",""]},{"type":{"value":"PlaygamaBridge::AppendStorageDataGetRequest"},"parameters":["","\"key_2\"",""]},{"type":{"value":"PlaygamaBridge::SendStorageDataGetRequest"},"parameters":["","\"default\"",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnStorageDataGetRequestCompleted"},"parameters":["",""]}],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::HasStorageData"},"parameters":["","\"key_1\"",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["PlaygamaBridge::StorageDataKey(\"key_1\")","\"info\"",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::HasStorageData"},"parameters":["","\"key_2\"",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["PlaygamaBridge::StorageDataKey(\"key_2\")","\"info\"",""]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}
```
{% endtab %}
{% tab title="Godot" %}
{% tabs %}
{% tab title="Godot 3.x" %}
```gdscript
# Load data by key
func _ready():
Bridge.storage.get("level", funcref(self, "_on_storage_get_completed"))
func _on_storage_get_completed(success, data):
if success:
if data != null:
print(data)
else:
# No data for the key 'level'
print("Data is null")
# Load data by multiple keys
func _ready():
Bridge.storage.get(["level", "coins"], funcref(self, "_on_storage_get_completed"))
func _on_storage_get_completed(success, data):
if success:
if data[0] != null:
print("Level: ", data[0])
else:
# No data for the key 'level'
print("Level is null")
if data[1] != null:
print("Coins: ", data[1])
else:
# No data for the key 'coins'
print("Coins is null")
# Load data from a specific storage type
Bridge.storage.get("level", funcref(self, "_on_storage_get_completed"), Bridge.StorageType.LOCAL_STORAGE)
```
{% endtab %}
{% tab title="Godot 4.x" %}
```gdscript
# Load data by key
func _ready():
Bridge.storage.get("level", Callable(self, "_on_storage_get_completed"))
func _on_storage_get_completed(success, data):
if success:
if data != null:
print(data)
else:
# No data for the key 'level'
print("Data is null")
# Load data by multiple keys
func _ready():
Bridge.storage.get(["level", "coins"], Callable(self, "_on_storage_get_completed"))
func _on_storage_get_completed(success, data):
if success:
if data[0] != null:
print("Level: ", data[0])
else:
# No data for the key 'level'
print("Level is null")
if data[1] != null:
print("Coins: ", data[1])
else:
# No data for the key 'coins'
print("Coins is null")
# Load data from a specific storage type
Bridge.storage.get("level", Callable(self, "_on_storage_get_completed"), Bridge.StorageType.LOCAL_STORAGE)
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="GameMaker" %}
```javascript
// Load data by key
var keys = ["coins", "level"]
playgama_bridge_storage_get(json_stringify(keys))
// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_storage_get_callback" {
if async_load[? "success"] {
var values = json_parse(async_load[? "data"])
var coins = values[0]
var level = values[1]
if is_undefined(coins) {
// there is no stored data for key "coins"
}
if is_undefined(level) {
// there is no stored data for key "level"
}
}
}
```
{% endtab %}
{% tab title="Defold" %}
```lua
local bridge = require("bridge.bridge")
function init(self)
bridge.storage.get(
{ "coins", "level" },
function (_, data)
if data.coins then
print("Coins: ", data.coins)
end
if data.level then
print("Level: ", data.level)
end
end,
function ()
-- error
end
)
end
```
{% endtab %}
{% tab title="Cocos Creator" %}
```javascript
// Load data by key
bridge.storage.get('key')
.then(data => {
// Data loaded and you can work with it
// data = null if there is no data for the given key
console.log('Data: ', data)
})
.catch(error => {
// Error, something went wrong
})
// Load data by multiple keys
bridge.storage.get(['key_1', 'key_2'])
.then(data => {
// Data loaded and you can work with it
// data[n] = null if there is no data for the given key
console.log('Data: ', data)
})
.catch(error => {
// Error, something went wrong
})
```
{% endtab %}
{% tab title="Scratch" %}
{% endtab %}
{% endtabs %}
## Save Data
Save one key or several keys after meaningful progress changes, such as level completion, purchase, currency change, or settings update.
{% tabs %}
{% tab title="Plain JS" %}
```javascript
// Save data by key
bridge.storage.set('key', 'value')
.then(() => {
// Data successfully saved
})
.catch(error => {
// Error, something went wrong
})
// Save data by multiple keys
bridge.storage.set(['key_1', 'key_2'], ['value_1', 'value_2'])
.then(() => {
// Data successfully saved
})
.catch(error => {
// Error, something went wrong
})
```
{% endtab %}
{% tab title="Unity" %}
```csharp
// Save data by key
private void Start()
{
Bridge.storage.Set("level", "dungeon_123", OnStorageSetCompleted);
}
private void OnStorageSetCompleted(bool success)
{
Debug.Log($"OnStorageSetCompleted, success: {success}");
}
// Save data by multiple keys
private void Start()
{
var keys = new List() { "level", "is_tutorial_completed", "coins" };
var data = new List