Some optimizations ( type safe, avoid unnecessary memory manage, etc...).

addons/talo/apis/api.gd

@@ -2,7 +2,7 @@ class_name TaloAPI extends Node
 
 var client: TaloClient
 
-func _init(base_path: String):
+func _init(base_path: String) -> void:
 	name = "Talo%s" % base_path
 	client = TaloClient.new(base_path)
 	add_child(client)

addons/talo/apis/channels_api.gd

@@ -1,4 +1,5 @@
-class_name ChannelsAPI extends TaloAPI
+## ChannelsAPI
+extends TaloAPI
 ## An interface for communicating with the Talo Channels API.
 ##
 ## This API is used to send messages between players who are subscribed to channels.
@@ -7,18 +8,36 @@ 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.playerAlias))
+		"v1.channels.deleted":
+			channel_deleted.emit(TaloChannel.new(data.channel))
 
 ## Get a channel by its ID.
 func find(channel_id: int) -> TaloChannel:
-	var res = await client.make_request(HTTPClient.METHOD_GET, "/%s" % channel_id)
+	var res := await client.make_request(HTTPClient.METHOD_GET, "/%s" % channel_id)
 
 	match (res.status):
 		200:
@@ -27,41 +46,41 @@ func find(channel_id: int) -> TaloChannel:
 			return null
 
 ## Get a list of channels that players can join.
-func get_channels(page: int) -> Array:
-	var res = await client.make_request(HTTPClient.METHOD_GET, "?page=%s" % page)
+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]
+			channels.assign(res.body.channels.map(func (channel: Dictionary) -> TaloChannel: return TaloChannel.new(channel)))
+			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]:
 	if Talo.identity_check() != OK:
 		return []
 
-	var res = await client.make_request(HTTPClient.METHOD_GET, "/subscriptions")
+	var res := await client.make_request(HTTPClient.METHOD_GET, "/subscriptions")
 
 	match (res.status):
 		200:
 			var channels: Array[TaloChannel] = []
-			channels.assign(res.body.channels.map(func (channel: Dictionary): return TaloChannel.new(channel)))
+			channels.assign(res.body.channels.map(func (channel: Dictionary) -> TaloChannel: return TaloChannel.new(channel)))
 			return channels
 		_:
 			return []
 
 ## Create a new channel. The player who creates this channel will automatically become the owner. If auto cleanup is enabled, the channel will be deleted when the owner or the last member leaves.
-func create(name: String, auto_cleanup: bool = false, props: Dictionary = {}) -> TaloChannel:
+func create(p_name: String, auto_cleanup: bool = false, props: Dictionary = {}) -> TaloChannel:
 	if Talo.identity_check() != OK:
 		return
 
-	var props_to_send = props.keys().map(func (key: String): return { key = key, value = str(props[key]) })
+	var props_to_send := props.keys().map(func (key: String) -> Dictionary: return { key = key, value = str(props[key]) })
 
-	var res = await client.make_request(HTTPClient.METHOD_POST, "", {
-		name = name,
+	var res := await client.make_request(HTTPClient.METHOD_POST, "", {
+		name = p_name,
 		autoCleanup = auto_cleanup,
 		props = props_to_send
 	})
@@ -77,7 +96,7 @@ func join(channel_id: int) -> TaloChannel:
 	if Talo.identity_check() != OK:
 		return
 
-	var res = await client.make_request(HTTPClient.METHOD_POST, "/%s/join" % channel_id)
+	var res := await client.make_request(HTTPClient.METHOD_POST, "/%s/join" % channel_id)
 
 	match (res.status):
 		200:
@@ -93,19 +112,19 @@ func leave(channel_id: int) -> void:
 	await client.make_request(HTTPClient.METHOD_POST, "/%s/leave" % channel_id)
 
 ## Update a channel. This will only work if the current player is the owner of the channel.
-func update(channel_id: int, name: String = "", new_owner_alias_id: int = -1, props: Dictionary = {}) -> TaloChannel:
+func update(channel_id: int, p_name: String = "", new_owner_alias_id: int = -1, props: Dictionary = {}) -> TaloChannel:
 	if Talo.identity_check() != OK:
 		return
 
-	var data = {}
-	if not name.is_empty():
-		data.name = name
+	var data := {}
+	if not p_name.is_empty():
+		data.name = p_name
 	if new_owner_alias_id != -1:
 		data.ownerAliasId = new_owner_alias_id
 	if props.size() > 0:
 		data.props = props
 
-	var res = await client.make_request(HTTPClient.METHOD_PUT, "/%s" % channel_id, data)
+	var res := await client.make_request(HTTPClient.METHOD_PUT, "/%s" % channel_id, data)
 
 	match (res.status):
 		200:
@@ -121,7 +140,7 @@ func delete(channel_id: int) -> void:
 	if Talo.identity_check() != OK:
 		return
 
-	var res = await client.make_request(HTTPClient.METHOD_DELETE, "/%s" % channel_id)
+	var res := await client.make_request(HTTPClient.METHOD_DELETE, "/%s" % channel_id)
 
 	match (res.status):
 		403:
@@ -138,3 +157,15 @@ func send_message(channel_id: int, message: String) -> void:
 		},
 		message = message
 	})
+
+
+# Structs
+class ChannelPage:
+	var channels: Array[TaloChannel]
+	var count: int
+	var last_page: bool
+
+	func _init(p_channels: Array[TaloChannel], p_count: int, p_last_page: bool) -> void:
+		channels = p_channels
+		count = p_count
+		last_page = p_last_page

addons/talo/apis/events_api.gd

@@ -1,12 +1,13 @@
-class_name EventsAPI extends TaloAPI
+## EventsAPI
+extends TaloAPI
 ## An interface for communicating with the Talo Events API.
 ##
 ## This API is used to track events in your game. Events are used to measure user interactions such as button clicks, level completions and other kinds of game interactions.
 ##
 ## @tutorial: https://docs.trytalo.com/docs/godot/events
 
-var _queue = []
-var _min_queue_size = 10
+var _queue := []
+var _min_queue_size := 10
 
 func _get_window_mode() -> String:
 	match DisplayServer.window_get_mode():
@@ -29,24 +30,24 @@ func _build_meta_props() -> Array[TaloProp]:
 	]
 
 func _has_errors(errors: Array) -> bool:
-	return errors.any((func (err: Array): return err.size() > 0))
+	return errors.any((func (err: Array) -> bool: return err.size() > 0))
 
 ## Track an event with optional props (key-value pairs) and add it to the queue of events ready to be sent to the backend. If the queue reaches the minimum size, it will be flushed.
-func track(name: String, props: Dictionary = {}) -> void:
+func track(p_name: String, props: Dictionary = {}) -> void:
 	if Talo.identity_check() != OK:
 		return
 
-	var final_props = _build_meta_props()
+	var final_props := _build_meta_props()
 	final_props.append_array(
 		props
 			.keys()
-			.map(func (key: String): return TaloProp.new(key, str(props[key])))
+			.map(func (key: String) -> TaloProp: return TaloProp.new(key, str(props[key])))
 	)
 
 	_queue.push_back({
-		name = name,
-		props = final_props.map(func (prop: TaloProp): return prop.to_dictionary()),
-		timestamp = TimeUtils.get_timestamp_msec()
+		name = p_name,
+		props = final_props.map(func (prop: TaloProp) -> Dictionary: return prop.to_dictionary()),
+		timestamp = TaloTimeUtils.get_timestamp_msec()
 	})
 
 	if _queue.size() >= _min_queue_size:
@@ -57,7 +58,7 @@ func flush() -> void:
 	if _queue.size() == 0:
 		return
 
-	var res = await client.make_request(HTTPClient.METHOD_POST, "/", { events = _queue })
+	var res := await client.make_request(HTTPClient.METHOD_POST, "/", { events = _queue })
 	_queue.clear()
 
 	match (res.status):

addons/talo/apis/feedback_api.gd

@@ -1,4 +1,5 @@
-class_name FeedbackAPI extends TaloAPI
+## FeedbackAPI
+extends TaloAPI
 ## An interface for communicating with the Talo Feedback API.
 ##
 ## This API is used to submit feedback across different categories from your players.
@@ -7,12 +8,12 @@ class_name FeedbackAPI extends TaloAPI
 
 ## Get a list of feedback categories that are available for players to submit feedback.
 func get_categories() -> Array[TaloFeedbackCategory]:
-	var res = await client.make_request(HTTPClient.METHOD_GET, "/categories")
+	var res := await client.make_request(HTTPClient.METHOD_GET, "/categories")
 
 	match (res.status):
 		200:
 			var categories: Array[TaloFeedbackCategory] = []
-			categories.assign(res.body.feedbackCategories.map(func (category: Dictionary): return TaloFeedbackCategory.new(category)))
+			categories.assign(res.body.feedbackCategories.map(func (category: Dictionary) -> TaloFeedbackCategory: return TaloFeedbackCategory.new(category)))
 			return categories
 		_:
 			return []

addons/talo/apis/game_config_api.gd

@@ -1,4 +1,5 @@
-class_name GameConfigAPI extends TaloAPI
+## GameConfigAPI
+extends TaloAPI
 ## An interface for communicating with the Talo Live Config API.
 ##
 ## This API is used to fetch the live config for your game. The live config is a set of key-value pairs that can be updated in the Talo dashboard.
@@ -20,9 +21,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:
-	var res = await client.make_request(HTTPClient.METHOD_GET, "/")
+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/health_check_api.gd

@@ -1,4 +1,5 @@
-class_name HealthCheckAPI extends TaloAPI
+## HealthCheckAPI
+extends TaloAPI
 ## An interface for communicating with the Talo Health Check API.
 ##
 ## This API is used to check if Talo can be reached by Continuity. You shouldn't need to use this API directly in your game.
@@ -7,5 +8,5 @@ class_name HealthCheckAPI extends TaloAPI
 
 ## Ping the Talo Health Check API to check if Talo can be reached.
 func ping() -> bool:
-	var res = await client.make_request(HTTPClient.METHOD_GET, "")
+	var res := await client.make_request(HTTPClient.METHOD_GET, "")
 	return res.status == 204