isPlayerConnected

abstract suspend fun isPlayerConnected(playerId: String): Boolean(source)

Retrieves whether a player with a specific identifier is currently connected to this instance and is therefore present on the player list of this instance. The return value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource.

The specific player tracking APIs of the AgonesSdk will eventually be superseded by the arbitrary Counts and Lists that cover a broader use-case and offer similar interfaces for tracking.

Return

Whether the player with the supplied unique identifier is currently present in the player list of this instance.

Parameters

playerId

The unique identifier of the player for whom to check if they are currently present in the player list of this instance.

See also

Throws

If null is supplied as the player identifier and therefore no player can be derived from it.