Merge pull request #88 from TaloDev/develop

Release 0.22.0

Author: tudddorrr

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on: push
+
+jobs:
+  build-check:
+    strategy:
+      matrix:
+        platform: ['Windows Desktop', 'macOS', 'Linux', 'Web']
+    runs-on: ${{ matrix.platform == 'macOS' && 'macos-latest' || 'ubuntu-latest' }}
+
+    steps:
+      - uses: actions/checkout@v4
+        name: Checkout
+        with:
+          lfs: true
+
+      - uses: chickensoft-games/setup-godot@v1
+        name: Set up Godot
+        with:
+          version: 4.3.0
+          use-dotnet: false
+          include-templates: true
+
+      - name: Build
+        run: |
+          output=$(godot --headless --export-release '${{ matrix.platform }}' 2>&1)
+          if echo "$output" | grep -q "SCRIPT ERROR"; then
+            exit 1
+          fi

.gitignore

@@ -4,7 +4,6 @@
 # Godot-specific ignores
 .import/
 export.cfg
-export_presets.cfg
 
 # Imported translations (automatically generated from CSV files)
 *.translation

README.md

@@ -25,7 +25,7 @@ channels](https://trytalo.com/channels): Send real-time messages between players
 - 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration): Hook into Steamworks for authentication and ownership checks.
 - 🗣️ [Game feedback](https://trytalo.com/feedback): Collect and manage feedback from your players.
 - 🛡️ [Continuity](https://trytalo.com/continuity): Keep your data in-sync even when your players are offline.
-- 🔔 [Player presence](https://trytalo.com/player#presence): See if players are online and set custom statuses.
+- 🔔 [Player presence](https://trytalo.com/players#presence): See if players are online and set custom statuses.
 
 ## Samples included with the plugin
 

addons/talo/apis/channels_api.gd

@@ -7,14 +7,32 @@ class_name ChannelsAPI extends TaloAPI
 
 ## Emitted when a message is received from a channel.
 signal message_received(channel: TaloChannel, player_alias: TaloPlayerAlias, message: String)
+## Emitted when a player is joined to a channel.
+signal player_joined(channel: TaloChannel, player_alias: TaloPlayerAlias)
+## Emitted when a player is left from a channel.
+signal player_left(channel: TaloChannel, player_alias: TaloPlayerAlias)
+## Emitted when a channel's ownership transferred.
+signal channel_ownership_transferred(channel: TaloChannel, new_owner_player_alias: TaloPlayerAlias)
+## Emitted when a channel is deleted.
+signal channel_deleted(channel: TaloChannel)
 
-func _ready():
+
+func _ready() -> void:
 	await Talo.init_completed
 	Talo.socket.message_received.connect(_on_message_received)
 
 func _on_message_received(res: String, data: Dictionary) -> void:
-	if res == "v1.channels.message":
-		message_received.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias), data.message)
+	match res:
+		"v1.channels.message":
+			message_received.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias), data.message)
+		"v1.channels.player-joined":
+			player_joined.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias))
+		"v1.channels.player-left":
+			player_left.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias))
+		"v1.channels.ownership-transferred":
+			player_left.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.newOwner))
+		"v1.channels.deleted":
+			channel_deleted.emit(TaloChannel.new(data.channel))
 
 ## Get a channel by its ID.
 func find(channel_id: int) -> TaloChannel:
@@ -27,16 +45,16 @@ func find(channel_id: int) -> TaloChannel:
 			return null
 
 ## Get a list of channels that players can join.
-func get_channels(page: int) -> Array:
+func get_channels(page: int) -> ChannelPage:
 	var res = await client.make_request(HTTPClient.METHOD_GET, "?page=%s" % page)
 
 	match (res.status):
 		200:
 			var channels: Array[TaloChannel] = []
 			channels.assign(res.body.channels.map(func (channel: Dictionary): return TaloChannel.new(channel)))
-			return [channels, res.body.count, res.body.isLastPage]
+			return ChannelPage.new(channels, res.body.count, res.body.isLastPage)
 		_:
-			return []
+			return null
 
 ## Get a list of channels that the current player is subscribed to.
 func get_subscribed_channels() -> Array[TaloChannel]:
@@ -138,3 +156,14 @@ func send_message(channel_id: int, message: String) -> void:
 		},
 		message = message
 	})
+
+# Structs
+class ChannelPage:
+	var channels: Array[TaloChannel]
+	var count: int
+	var is_last_page: bool
+
+	func _init(channels: Array[TaloChannel], count: int, is_last_page: bool) -> void:
+		self.channels = channels
+		self.count = count
+		self.is_last_page = is_last_page

addons/talo/apis/events_api.gd

@@ -46,7 +46,7 @@ func track(name: String, props: Dictionary = {}) -> void:
 	_queue.push_back({
 		name = name,
 		props = final_props.map(func (prop: TaloProp): return prop.to_dictionary()),
-		timestamp = TimeUtils.get_timestamp_msec()
+		timestamp = TaloTimeUtils.get_timestamp_msec()
 	})
 
 	if _queue.size() >= _min_queue_size:

addons/talo/apis/game_config_api.gd

@@ -20,9 +20,12 @@ func _on_message_received(res: String, data: Dictionary) -> void:
 		live_config_updated.emit(TaloLiveConfig.new(data.config))
 
 ## Get the live config for your game.
-func get_live_config() -> void:
+func get_live_config() -> TaloLiveConfig:
 	var res = await client.make_request(HTTPClient.METHOD_GET, "/")
 	match (res.status):
 		200:
 			Talo.live_config = TaloLiveConfig.new(res.body.config)
 			live_config_loaded.emit(Talo.live_config)
+			return Talo.live_config
+		_:
+			return null

addons/talo/apis/leaderboards_api.gd

@@ -22,13 +22,13 @@ func get_cached_entries_for_current_player(internal_name: String) -> Array:
 	)
 
 ## Get a list of entries for a leaderboard. The page parameter is used for pagination.
-func get_entries(internal_name: String, page: int, alias_id = -1, include_archived = false) -> Array:
+func get_entries(internal_name: String, page: int, alias_id = -1, include_archived = false) -> EntriesPage:
 	var url = "/%s/entries?page=%s"
 	var url_data = [internal_name, page]
 
 	if alias_id != -1:
 		url += "&aliasId=%s"
-		url_data += alias_id
+		url_data.append(alias_id)
 
 	if include_archived:
 		url += "&withDeleted=1"
@@ -37,32 +37,32 @@ func get_entries(internal_name: String, page: int, alias_id = -1, include_archiv
 
 	match (res.status):
 		200:
-			var entries: Array = res.body.entries.map(
-				func (data: Dictionary):
+			var entries: Array[TaloLeaderboardEntry] = Array(res.body.entries.map(
+				func(data: Dictionary):
 					var entry = TaloLeaderboardEntry.new(data)
 					_entries_manager.upsert_entry(internal_name, entry)
 
 					return entry
-			)
-			return [entries, res.body.count, res.body.isLastPage]
+			), TYPE_OBJECT, (TaloLeaderboardEntry as Script).get_instance_base_type(), TaloLeaderboardEntry)
+			return EntriesPage.new(entries, res.body.count, res.body.isLastPage)
 		_:
-			return []
+			return null
 
 ## Get a list of entries for a leaderboard for the current player. The page parameter is used for pagination.
-func get_entries_for_current_player(internal_name: String, page: int, include_archived = false) -> Array:
+func get_entries_for_current_player(internal_name: String, page: int, include_archived = false) -> EntriesPage:
 	if Talo.identity_check() != OK:
-		return []
+		return null
 
 	return await get_entries(internal_name, page, Talo.current_alias.id, include_archived)
 
 ## Add an entry to a leaderboard. The props (key-value pairs) parameter is used to store additional data with the entry.
-func add_entry(internal_name: String, score: float, props: Dictionary = {}) -> Array:
+func add_entry(internal_name: String, score: float, props: Dictionary = {}) -> AddEntryResult:
 	if Talo.identity_check() != OK:
-		return []
+		return null
 
-	var props_to_send = props.keys().map(func (key: String): return { key = key, value = str(props[key]) })
+	var props_to_send: Array = props.keys().map(func(key: String) -> Dictionary: return {key = key, value = str(props[key])})
 
-	var res = await client.make_request(HTTPClient.METHOD_POST, "/%s/entries" % internal_name, {
+	var res := await client.make_request(HTTPClient.METHOD_POST, "/%s/entries" % internal_name, {
 		score = score,
 		props = props_to_send
 	})
@@ -72,6 +72,25 @@ func add_entry(internal_name: String, score: float, props: Dictionary = {}) -> A
 			var entry = TaloLeaderboardEntry.new(res.body.entry)
 			_entries_manager.upsert_entry(internal_name, entry)
 
-			return [entry, res.body.updated]
+			return AddEntryResult.new(entry, res.body.updated)
 		_:
-			return []
+			return null
+
+# Structs
+class EntriesPage:
+	var entries: Array[TaloLeaderboardEntry]
+	var count: int
+	var is_last_page: bool
+
+	func _init(entries: Array[TaloLeaderboardEntry], count: int, is_last_page: bool) -> void:
+		self.entries = entries
+		self.count = count
+		self.is_last_page = is_last_page
+
+class AddEntryResult:
+	var entry: TaloLeaderboardEntry
+	var updated: bool
+
+	func _init(entry: TaloLeaderboardEntry, updated: bool) -> void:
+		self.entry = entry
+		self.updated = updated

addons/talo/apis/player_auth_api.gd

@@ -5,8 +5,14 @@ class_name PlayerAuthAPI extends TaloAPI
 ##
 ## @tutorial: https://docs.trytalo.com/docs/godot/player-authentication
 
+enum LoginResult {
+	OK,
+	FAILED,
+	VERIFICATION_REQUIRED,
+}
+
 var session_manager = TaloSessionManager.new()
-var last_error: Variant = null
+var last_error: TaloAuthError = null
 
 func _handle_error(res: Dictionary, ret: Variant = FAILED) -> Variant:
 	if res.body != null and res.body.has("errorCode"):
@@ -37,7 +43,7 @@ func register(identifier: String, password: String, email: String = "", verifica
 			return _handle_error(res)
 
 ## Log in to an existing player account. If verification is required, a verification code will be sent to the player's email.
-func login(identifier: String, password: String) -> Array[Variant]: ## [Error, bool]
+func login(identifier: String, password: String) -> LoginResult:
 	var res = await client.make_request(HTTPClient.METHOD_POST, "/login", {
 		identifier = identifier,
 		password = password
@@ -50,9 +56,12 @@ func login(identifier: String, password: String) -> Array[Variant]: ## [Error, b
 			else:
 				session_manager.handle_session_created(res.body.alias, res.body.sessionToken, res.body.socketToken)
 
-			return [OK, res.body.has("verificationRequired")]
+			if res.body.has("verificationRequired"):
+				return LoginResult.VERIFICATION_REQUIRED
+			else:
+				return LoginResult.OK
 		_:
-			return _handle_error(res, [FAILED, false])
+			return _handle_error(res, LoginResult.FAILED)
 
 ## Verify a player account using the verification code sent to the player's email.
 func verify(verification_code: String) -> Error:
@@ -110,7 +119,7 @@ func forgot_password(email: String) -> Error:
 		204:
 			return OK
 		_:
-			return FAILED
+			return _handle_error(res)
 
 ## Reset the password of the player account using the code sent to the player's email.
 func reset_password(code: String, password: String) -> Error:

addons/talo/apis/players_api.gd

@@ -9,30 +9,38 @@ class_name PlayersAPI extends TaloAPI
 signal identified(player: TaloPlayer)
 
 ## Identify a player using a service (e.g. "username") and identifier (e.g. "bob").
-func identify(service: String, identifier: String) -> void:
+func identify(service: String, identifier: String) -> TaloPlayer:
 	var res = await client.make_request(HTTPClient.METHOD_GET, "/identify?service=%s&identifier=%s" % [service, identifier])
 	match (res.status):
 		200:
 			Talo.current_alias = TaloPlayerAlias.new(res.body.alias)
 			Talo.socket.set_socket_token(res.body.socketToken)
 			identified.emit(Talo.current_player)
+			return Talo.current_player
 		_:
 			if not await Talo.is_offline():
 				Talo.player_auth.session_manager.clear_session()
+			return null
 
 ## Identify a player using a Steam ticket.
-func identify_steam(ticket: String, identity: String = "") -> void:
+func identify_steam(ticket: String, identity: String = "") -> TaloPlayer:
 	if identity.is_empty():
-		identify("steam", ticket)
+		return await identify("steam", ticket)
 	else:
-		identify("steam", "%s:%s" % [identity, ticket])
+		return await identify("steam", "%s:%s" % [identity, ticket])
 
 ## Flush and sync the player's current data with Talo.
-func update() -> void:
+func update() -> TaloPlayer:
 	var res = await client.make_request(HTTPClient.METHOD_PATCH, "/%s" % Talo.current_player.id, { props = Talo.current_player.get_serialized_props() })
 	match (res.status):
 		200:
-			Talo.current_alias.player = TaloPlayer.new(res.body.player)
+			if is_instance_valid(Talo.current_alias.player):
+				Talo.current_alias.player.update_from_raw_data(res.body.player)
+			else:
+				Talo.current_alias.player = TaloPlayer.new(res.body.player)
+			return Talo.current_player
+		_:
+			return null
 
 ## Merge all of the data from player_id2 into player_id1 and delete player_id2.
 func merge(player_id1: String, player_id2: String) -> TaloPlayer:
@@ -58,7 +66,7 @@ func find(player_id: String) -> TaloPlayer:
 
 ## Generate a mostly-unique identifier.
 func generate_identifier() -> String:
-	var time_hash: String = str(TimeUtils.get_timestamp_msec()).sha256_text()
+	var time_hash: String = str(TaloTimeUtils.get_timestamp_msec()).sha256_text()
 	var size = 12
 	var split_start: int = RandomNumberGenerator.new().randi_range(0, time_hash.length() - size)
 	return time_hash.substr(split_start, size)

addons/talo/apis/saves_api.gd

@@ -29,7 +29,7 @@ var current: TaloGameSave:
 ## Sync an offline save with an online save using the offline save data.
 func replace_save_with_offline_save(offline_save: TaloGameSave) -> TaloGameSave:
 	var res = await client.make_request(HTTPClient.METHOD_PATCH, "/%s" % offline_save.id, {
-		name=offline_save.display_name,
+		name=offline_save.name,
 		content=offline_save.content
 	})
 
@@ -68,6 +68,8 @@ 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:
@@ -84,7 +86,7 @@ func create_save(save_name: String, content: Dictionary = {}) -> TaloGameSave:
 		save = TaloGameSave.new({
 			name=save_name,
 			content=save_content,
-			updatedAt=TimeUtils.get_current_datetime_string()
+			updatedAt=TaloTimeUtils.get_current_datetime_string()
 		})
 	else:
 		var res = await client.make_request(HTTPClient.METHOD_POST, "/", {
@@ -108,7 +110,9 @@ func register(loadable: TaloLoadable) -> void:
 
 ## Mark an object as loaded.
 func set_object_loaded(id: String) -> void:
-	_saves_manager.set_object_loaded(id)
+	_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:
@@ -120,16 +124,16 @@ func update_save(save: TaloGameSave, new_name: String = "") -> TaloGameSave:
 
 	if await Talo.is_offline():
 		if not new_name.is_empty():
-			save.display_name = new_name
+			save.name = new_name
 
 		save.content = content
-		save.updated_at = TimeUtils.get_current_datetime_string()
+		save.updated_at = TaloTimeUtils.get_current_datetime_string()
 	else:
 		if Talo.identity_check() != OK:
 			return
 
 		var res = await client.make_request(HTTPClient.METHOD_PATCH, "/%s" % save.id, {
-			name=save.display_name if new_name.is_empty() else new_name,
+			name=save.name if new_name.is_empty() else new_name,
 			content=content
 		})