Skip to main content

Identifying a player

Aliases​

Players within your Talo account can have multiple aliases. For example, a player could have Steam and Epic Games login credentials but both would be tied to them, allowing the player to use either to log in.

You should identify a player after they have authenticated and before you attempt to track any events, add leaderboard entries or do anything related directly to the player.

Identifying​

You can identify a player using Talo.players.identify(). The code sample below shows you how you could identify a player using a UI element (this example is also available in the Playground scene):

identify_button.gd
extends Button

@export var service: String
@export var identifier: String

func _on_pressed():
	Talo.players.identify(service, identifier)
caution

If you are using Talo Player Authentication, Talo.players.identify() will be invoked automatically and the Talo.players.identified signal will also emit as normal.

Visit the Player authentication docs to learn more about identifying players with authentication enabled.

Generating a mostly-unique identifier​

You can easily create an identifier with Talo.players.generate_identifier(). This is useful for temporarily identifying players before you know who they are, and then merging them with an identified player later on.

The "identified" signal​

After a successful identification, the Talo.players.identified signal will emit, returning the identified player. This allows you to, for example, put the player's name on a label:

player_name.gd
extends Label

func _ready() -> void:
	Talo.players.identified.connect(_on_identified)

func _on_identified(player: TaloPlayer) -> void:
	text = player.get_prop("display_name")

The "identification_started" and "identification_failed" signals​

When Talo.players.identify() is called, the Talo.players.identification_started signal is emitted.

If identification fails, the Talo.players.identification_failed signal is emitted.

func _ready() -> void:
    Talo.players.identification_started.connect(func (): go_to_loading())
    Talo.players.identification_failed.connect(func (): go_to_login())

Checking identification​

Sometimes you might need to check if a player has been identified before. You can use Talo.identity_check() to verify this - it throws an error if a player hasn't been identified yet:

func do_stuff_if_authenticated() -> void:
	if Talo.identity_check() != OK:
		return

	# do stuff

Clearing the identified player​

You can clear the current player using Talo.players.clear_identity(). This will set Talo.current_alias and Talo.current_player to null. It will also clear any cached or pending data that identifies the player like the offline alias cache, pending events and continuity requests. For players using Talo authentication, it will also clear session data.

Once all the relevant data has been cleared, the Talo.players.identity_cleared signal will be emitted.

Merging players​

As described above, sometimes a player may have one or more aliases and there are times where you know for certain some aliases belong to the same player. You can merge players using Talo.players.merge() by providing the IDs of both players.

The merge process takes all the props, aliases, and associated data (events, leaderboard entries, saves, etc.) from Player 2 and merge them into Player 1. This means that duplicate props in Player 1 will be replaced by the ones from Player 2.

Steamworks integration​

If you have the Steamworks integration enabled, Talo can sync a Steam player using the Steam User Auth API (as described here). You can do this via the Talo.players.identify_steam function. Here's an example using GodotSteam:

extends Node

var identity = "talo"

func _ready() -> void:
	Steam.steamInitEx()
	Steam.get_ticket_for_web_api.connect(_on_get_ticket_for_web_api)
	Steam.getAuthTicketForWebApi(identity)

func _on_get_ticket_for_web_api(_auth_ticket: int, _result: int, _ticket_size: int, ticket_buffer: Array) -> void:
	Talo.players.identify_steam(PackedByteArray(ticket_buffer).hex_encode(), identity)

func _process(_delta: float) -> void:
	Steam.run_callbacks()

The identity parameter is optional but strongly recommended as it ensures proper identification of the service verifying the ticket. It can be anything you like but must be the same as the identity passed to Steam when fetching the ticket.

Offline player cache​

If the cache_player_on_identify setting is enabled (default true), Talo will store player data locally. If a player tries to identify while offline, Talo will try and use local data if it exists.

Searching for players​

You can use Talo.players.search() to query players. This function accepts a single query parameter that will search your playerbase for matching player IDs, alias identifiers or prop values. You can use this function to find players by their username, their ID or if they have a prop with a specific value.

var search_page := await Talo.players.search("bob")
if search_page.count == 0:
	print("No players found")
	return

var identifiers = []
for player in search_page.players:
	identifiers.append(player.get_alias().identifier)

print("Found %s results: %s" % [search_page.count, ", ".join(identifiers)])