Merge pull request #102 from TaloDev/develop

Release 0.25.0

Author: tudddorrr

README.md

@@ -32,7 +32,8 @@ channels](https://trytalo.com/channels): Send real-time messages between players
 - 🔒 Authentication: a registration/login/account management flow, showing how to create player accounts and authenticate them.
 - 🎮 Playground: a text-based playground allowing you to test identifying, events, stats and leaderboards.
 - 🕹️ Leaderboards: a basic leaderboard UI, allowing you to add and update entries.
-- 💾 Stateful buttons: showing how to save and load game state.
+- 💾 Multi-scene saves: a small game showing how to persist save data across multiple scenes.
+- 💾 Stateful buttons: a simple demo showing how to save and load game state.
 - 💬 Chat: showing how to send messages between channels in a chat room.
 
 ## Documentation

addons/talo/apis/saves_api.gd

@@ -68,8 +68,6 @@ func get_saves() -> Array[TaloGameSave]:
 ## Set the chosen save and optionally (default true) load it.
 func choose_save(save: TaloGameSave, load_save = true) -> void:
 	_saves_manager.set_chosen_save(save, load_save)
-	if load_save:
-		save_chosen.emit(save)
 
 ## Unload the current save.
 func unload_current_save() -> void:
@@ -78,8 +76,6 @@ func unload_current_save() -> void:
 ## Create a new save with the given name and content.
 func create_save(save_name: String, content: Dictionary = {}) -> TaloGameSave:
 	var save: TaloGameSave
-
-	_saves_manager.register_fields_for_saved_objects()
 	var save_content := content if not content.is_empty() else _saves_manager.get_save_content()
 
 	if await Talo.is_offline():
@@ -108,12 +104,6 @@ func create_save(save_name: String, content: Dictionary = {}) -> TaloGameSave:
 func register(loadable: TaloLoadable) -> void:
 	_saves_manager.register(loadable)
 
-## Mark an object as loaded.
-func set_object_loaded(id: String) -> void:
-	_saves_manager.push_loaded_object(id)
-	if _saves_manager.is_loading_completed():
-		save_loading_completed.emit()
-
 ## Update the currently loaded save using the current state of the game and with the given name.
 func update_current_save(new_name: String = "") -> TaloGameSave:
 	return await update_save(_saves_manager.current_save, new_name)
@@ -161,3 +151,7 @@ func delete_save(save: TaloGameSave) -> void:
 
 	if _saves_manager.current_save and _saves_manager.current_save.id == save.id:
 		unload_current_save()
+
+## Get the format version for the current save.
+func get_format_version() -> String:
+	return _saves_manager.get_format_version()

addons/talo/entities/loadable.gd

@@ -8,43 +8,31 @@ class_name TaloLoadable extends Node
 ## The unique identifier for this loadable.
 @export var id: String
 
-var _saved_fields: Dictionary
+var _saved_fields: Dictionary[String, Variant]
 
 func _ready() -> void:
-	Talo.saves.save_chosen.connect(_load_data)
 	Talo.saves.register(self)
 
-func _load_data(save: TaloGameSave) -> void:
-	if not save:
-		return
+func _convert_serialised_data(item: Dictionary) -> Variant:
+	match Talo.saves.get_format_version():
+		"godot.v1": return type_convert(item.value, int(item.type))
+		_: return str_to_var(item.value)
 
+## Update this loadable with the latest data.
+func hydrate(data: Array[Dictionary]) -> void:
 	var fields := {}
-
-	var filtered := save.content.objects.filter(func (obj: Dictionary): return obj.id == id) as Array
-	if filtered.is_empty():
-		push_warning("Loadable with id '%s' not found in save '%s'" % [id, save.name])
-		return
-
-	var saved_object = filtered.front()
-
-	for item in saved_object.data:
-		fields[item.key] = type_convert(item.value, int(item.type))
+	for item in data:
+		fields[item.key] = _convert_serialised_data(item)
 
 	on_loaded(fields)
 
-	Talo.saves.set_object_loaded(id)
-
-## Clear all the saved data for this loadable.
-func clear_saved_fields() -> void:
-	_saved_fields.clear()
-
-## Register all the fields that should be saved and loaded. This must be implemented by the child class.
+## Register all the fields that should be saved and loaded.
 func register_fields() -> void:
-	assert(false, "register_fields() must be implemented")
+	pass
 
 ## Register the given key with a value. When this object is saved, the value will be saved and loaded.
 func register_field(key: String, value: Variant) -> void:
-	_saved_fields[key] = value
+	_saved_fields.set(key, value)
 
 ## Handle the loaded data. This must be implemented by the child class.
 func on_loaded(data: Dictionary) -> void:
@@ -58,10 +46,18 @@ func handle_destroyed(data: Dictionary) -> bool:
 
 	return destroyed
 
-## Serialise the saved fields.
-func get_saved_object_data() -> Array:
-	return _saved_fields.keys().map(
-	func (key: String):
-		var value = _saved_fields[key]
-		return {key = key, value = str(value), type = str(typeof(value))}
-	)
+## Ensure the data is up-to-date and return the serialised saved fields.
+func get_latest_data() -> Array[Dictionary]:
+	register_fields()
+
+	var data: Array[Dictionary] = []
+	data.assign(_saved_fields.keys().map(
+		func (key: String):
+			var value = _saved_fields[key]
+			return {
+				key = key,
+				value = var_to_str(value),
+				type = str(typeof(value))
+			}
+	))
+	return data

addons/talo/entities/player_stat_snapshot.gd

@@ -10,5 +10,5 @@ func _init(data: Dictionary):
 	player_alias = TaloPlayerAlias.new(data.playerAlias)
 	change = data.change
 	value = data.value
-	global_value = data.globalValue
+	global_value = data.get("globalValue", 0.0)
 	created_at = data.createdAt

addons/talo/entities/saved_object.gd

@@ -1,27 +1,59 @@
 class_name TaloSavedObject extends RefCounted
 
+var loadable: TaloLoadable
 var id: String
 var name: String
-var loadable: TaloLoadable
+var _cached_data: Array[Dictionary] = []
+var _root_path: String
+
+func _init(saved_object: Dictionary) -> void:
+	id = saved_object.id
+	name = saved_object.get("name", "unknown")
+	_cached_data.assign(saved_object.data)
 
-func _init(loadable: TaloLoadable) -> void:
-	id = loadable.id
-	name = loadable.get_path()
+# Match a loadable with a saved object to hydrate the loadable with the latest data.
+func register_loadable(loadable: TaloLoadable, hydrate = true) -> void:
 	self.loadable = loadable
+	_root_path = loadable.get_tree().current_scene.get_path()
+	if hydrate:
+		loadable.hydrate(_cached_data)
 
-## Register the fields that should be saved and loaded for this object.
-func register_loadable_fields():
-	if is_instance_valid(loadable):
-		loadable.clear_saved_fields()
-		loadable.register_fields()
+func _get_latest_data() -> Array[Dictionary]:
+	_cached_data.assign(loadable.get_latest_data())
+	return _cached_data
 
-func to_dictionary() -> Dictionary:
-	register_loadable_fields()
+func _is_loadable_valid() -> bool:
+	return is_instance_valid(loadable) and not loadable.is_queued_for_deletion()
+
+func _current_scene_matches_name() -> bool:
+	# if the root path hasn't been set, it may not have been registered yet
+	# in that case, we should only return cached data
+	return _root_path and name.begins_with(_root_path)
 
-	var destroyed_data := [{ key = "meta.destroyed", value = str(true), type = str(TYPE_BOOL) }]
+func _serialise_data() -> Array[Dictionary]:
+	var valid := _is_loadable_valid()
 
+	# doesn't exist but isn't part of the scene, don't modify it
+	if not valid and not _current_scene_matches_name():
+		return _cached_data
+
+	#  exists and is part of the scene, serialise it
+	if valid:
+		return _get_latest_data()
+
+	# doesn't exist and is part of the scene, mark it as destroyed
+	_cached_data.push_back({
+		key = "meta.destroyed",
+		value = str(true),
+		type = str(TYPE_BOOL)
+	})
+
+	return _cached_data
+
+# Serialise the saved object so that it can be saved.
+func to_dictionary() -> Dictionary:
 	return {
 		id = id,
 		name = name,
-		data = destroyed_data if not is_instance_valid(loadable) else loadable.get_saved_object_data() 
+		data = _serialise_data()
 	}

addons/talo/plugin.cfg

@@ -3,5 +3,5 @@
 name="Talo Game Services"
 description="Talo (https://trytalo.com) is an open-source game backend with services designed to help you build games faster. You can currently:\n\n- Identify and authenticate players\n- Store persistent data across players\n- Track events (levelling up, finding loot, etc)\n- Display high scores with leaderboards\n- Store and load player saves\n- Load game config options and flags from the cloud\n- Get feedback directly from your players\n- Keep your data in-sync even when players are offline\n- Send channel messages between players\n- See if players are online and set custom statuses"
 author="trytalo"
-version="0.24.0"
+version="0.25.0"
 script="talo_autoload.gd"

addons/talo/samples/multiscene_saves/scenes/blue_zone.tscn

@@ -0,0 +1,44 @@
+[gd_scene load_steps=4 format=3 uid="uid://c4doqk5ectldu"]
+
+[ext_resource type="PackedScene" uid="uid://ci52f1pjsppv3" path="res://addons/talo/samples/multiscene_saves/scenes/star.tscn" id="1_h5eft"]
+[ext_resource type="PackedScene" uid="uid://b0jdoni6crl0s" path="res://addons/talo/samples/multiscene_saves/scenes/portal.tscn" id="2_yfx2i"]
+[ext_resource type="PackedScene" uid="uid://b3b4ek8meeflf" path="res://addons/talo/samples/multiscene_saves/scenes/player.tscn" id="3_v3fgw"]
+
+[node name="BlueZone" type="Node2D"]
+
+[node name="Map" type="Polygon2D" parent="."]
+color = Color(0.277352, 0.505327, 0.795826, 1)
+polygon = PackedVector2Array(86, -140, 240, -128, 430, -135, 488, 81, 227, 319, 8.73462, 225.248, -107, 285, -378, 217, -315, -2, -359, -186, -175, -303, 2, -263)
+
+[node name="Star1" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(350, -80)
+id = "blue_zone_star1"
+
+[node name="Star2" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(-250, -51)
+id = "blue_zone_star2"
+
+[node name="Star3" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(-222, 165)
+id = "blue_zone_star3"
+
+[node name="Star4" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(216, 245)
+id = "blue_zone_star4"
+
+[node name="Star5" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(221, 49)
+id = "blue_zone_star5"
+
+[node name="Star6" parent="." instance=ExtResource("1_h5eft")]
+position = Vector2(-99, -178)
+id = "blue_zone_star6"
+
+[node name="Portal" parent="." instance=ExtResource("2_yfx2i")]
+position = Vector2(-233, -237)
+rotation = 1.00356
+to_level = "green_zone"
+spawn_point = Vector2(225, 166)
+
+[node name="Player" parent="." instance=ExtResource("3_v3fgw")]
+position = Vector2(-192, -175)

addons/talo/samples/multiscene_saves/scenes/green_zone.tscn

@@ -0,0 +1,42 @@
+[gd_scene load_steps=4 format=3 uid="uid://bucpvtjej40ju"]
+
+[ext_resource type="PackedScene" uid="uid://b3b4ek8meeflf" path="res://addons/talo/samples/multiscene_saves/scenes/player.tscn" id="1_mdugq"]
+[ext_resource type="PackedScene" uid="uid://ci52f1pjsppv3" path="res://addons/talo/samples/multiscene_saves/scenes/star.tscn" id="2_4im17"]
+[ext_resource type="PackedScene" uid="uid://b0jdoni6crl0s" path="res://addons/talo/samples/multiscene_saves/scenes/portal.tscn" id="3_vv7xr"]
+
+[node name="GreenZone" type="Node2D"]
+
+[node name="Map" type="Polygon2D" parent="."]
+color = Color(0.160784, 0.588235, 0.360784, 1)
+polygon = PackedVector2Array(100, -186, 347, -261, 416, -21, 364, 185, 227, 319, -235, 344, -395, 38, -314, -337, 0, -287)
+
+[node name="Star1" parent="." instance=ExtResource("2_4im17")]
+position = Vector2(76, 63)
+id = "green_zone_star1"
+
+[node name="Star2" parent="." instance=ExtResource("2_4im17")]
+position = Vector2(-147, 227)
+id = "green_zone_star2"
+
+[node name="Star3" parent="." instance=ExtResource("2_4im17")]
+position = Vector2(-130, -141)
+id = "green_zone_star3"
+
+[node name="Star4" parent="." instance=ExtResource("2_4im17")]
+position = Vector2(281, 61)
+id = "green_zone_star4"
+
+[node name="PortalBlueZone" parent="." instance=ExtResource("3_vv7xr")]
+position = Vector2(288, 225)
+rotation = 0.794125
+to_level = "blue_zone"
+spawn_point = Vector2(-192, -175)
+
+[node name="PortalStartingZone" parent="." instance=ExtResource("3_vv7xr")]
+position = Vector2(-329, -151)
+rotation = 0.214676
+to_level = "starting_zone"
+spawn_point = Vector2(68, -106)
+
+[node name="Player" parent="." instance=ExtResource("1_mdugq")]
+position = Vector2(-262, -136)

addons/talo/samples/multiscene_saves/scenes/player.tscn

@@ -0,0 +1,43 @@
+[gd_scene load_steps=5 format=3 uid="uid://b3b4ek8meeflf"]
+
+[ext_resource type="Texture2D" uid="uid://b3naludt1ank2" path="res://icon.png" id="1_rswej"]
+[ext_resource type="Script" uid="uid://pjwribovgraj" path="res://addons/talo/samples/multiscene_saves/scripts/loadable_player.gd" id="1_t5o6r"]
+[ext_resource type="Script" uid="uid://cbm1re05xae6k" path="res://addons/talo/samples/multiscene_saves/scripts/player_controller.gd" id="2_bg0gd"]
+
+[sub_resource type="CircleShape2D" id="CircleShape2D_mdugq"]
+radius = 450.0
+
+[node name="Player" type="CharacterBody2D"]
+scale = Vector2(0.05, 0.05)
+script = ExtResource("2_bg0gd")
+
+[node name="Loadable" type="Node2D" parent="."]
+script = ExtResource("1_t5o6r")
+username = "saves_demo_player"
+
+[node name="CollisionShape2D" type="CollisionShape2D" parent="."]
+shape = SubResource("CircleShape2D_mdugq")
+
+[node name="Sprite2D" type="Sprite2D" parent="."]
+texture = ExtResource("1_rswej")
+
+[node name="Camera" type="Camera2D" parent="."]
+unique_name_in_owner = true
+zoom = Vector2(1.5, 1.5)
+
+[node name="Stars" type="Label" parent="."]
+unique_name_in_owner = true
+anchors_preset = 7
+anchor_left = 0.5
+anchor_top = 1.0
+anchor_right = 0.5
+anchor_bottom = 1.0
+offset_left = -1000.0
+offset_top = 464.0
+offset_right = 1000.0
+offset_bottom = 1010.0
+grow_horizontal = 2
+grow_vertical = 0
+theme_override_font_sizes/font_size = 350
+text = "0 stars"
+horizontal_alignment = 1

addons/talo/samples/multiscene_saves/scenes/portal.tscn

@@ -0,0 +1,21 @@
+[gd_scene load_steps=4 format=3 uid="uid://b0jdoni6crl0s"]
+
+[ext_resource type="Script" uid="uid://bnkfuweqaugsr" path="res://addons/talo/samples/multiscene_saves/scripts/portal.gd" id="1_dmas5"]
+
+[sub_resource type="CanvasTexture" id="CanvasTexture_mdugq"]
+
+[sub_resource type="RectangleShape2D" id="RectangleShape2D_4im17"]
+size = Vector2(45, 45)
+
+[node name="Portal" type="Area2D"]
+script = ExtResource("1_dmas5")
+
+[node name="Sprite2D" type="Sprite2D" parent="."]
+modulate = Color(0.299775, 0.228743, 0.432167, 1)
+scale = Vector2(50, 50)
+texture = SubResource("CanvasTexture_mdugq")
+
+[node name="CollisionShape2D" type="CollisionShape2D" parent="."]
+shape = SubResource("RectangleShape2D_4im17")
+
+[connection signal="body_entered" from="." to="." method="_on_body_entered"]