GKLocalPlayer¶

Inherits: GKPlayer < RefCounted < Object

Represents the signed-in Game Center player and exposes local-only APIs.

Description¶

Use GKLocalPlayer to inspect authentication flags and to fetch the local player’s friends as shown in the “Players” section of GameCenterGuide.md. Every asynchronous call mirrors Apple’s API and invokes your Callable with the requested data plus an optional error Variant (which contains a GKError on failure). Refer to Apple’s documentation at Apple’s GKLocalPlayer reference for platform-specific behavior.

Sample from the guide that fetches the local player when your scene loads:

var game_center: GameCenterManager
var local: GKLocalPlayer

func _ready() -> void:
    game_center = GameCenterManager.new()
    local = game_center.local_player
    print("ONREADY: local, is auth: %s" % local.is_authenticated)
    print("ONREADY: local, player ID: %s" % local.game_player_id)

Friends-related helpers mirror the snippets in the guide (assuming you stored the player reference in local):

# Loads the local player's friends list if access is granted.
local.load_friends(func(friends: Array[GKPlayer], error: Variant) -> void:
    if error:
        print(error)
    else:
        for friend in friends:
            print(friend.display_name)
)

# Loads players the local user can challenge.
local.load_challengeable_friends(func(friends: Array[GKPlayer], error: Variant) -> void:
    if error:
        print(error)
    else:
        for friend in friends:
            print(friend.display_name)
)

# Loads the friends or recent players list.
local.load_recent_friends(func(friends: Array[GKPlayer], error: Variant) -> void:
    if error:
        print(error)
    else:
        for friend in friends:
            print(friend.display_name)
)

Properties¶

bool	is_authenticated	`false`
bool	is_multiplayer_gaming_restricted	`true`
bool	is_personalized_communication_restricted	`true`
bool	is_underage	`false`

Methods¶

void	delete_saved_games(named: String, callback: Callable)
void	fetch_items_for_identity_verification_signature(callback: Callable)
void	fetch_saved_games(callback: Callable)
void	load_challengeable_friends(callback: Callable)
void	load_default_leaderboard_identifier(callback: Callable)
void	load_friends(callback: Callable)
void	load_friends_authorization_status(callback: Callable)
void	load_friends_with_identifiers(identifiers: PackedStringArray, callback: Callable)
void	load_recent_friends(callback: Callable)
void	register_listener()
void	resolve_conflicting_saved_games(conflicts: Array, data: PackedByteArray, callback: Callable)
void	save_game_data(data: PackedByteArray, withName: String, callback: Callable)
void	set_default_leaderboard_identifier(identifier: String, callback: Callable)
void	unregister_listener()

Signals¶

challenge_completed(player: GKPlayer, challenge: GKChallenge, friend_player: GKPlayer) 🔗

Emitted when the local player completes a challenge issued by friend_player.

challenge_other_player_accepted(player: GKPlayer, challenge: GKChallenge) 🔗

Emitted when another player accepts a challenge that the local player issued.

challenge_other_player_completed(player: GKPlayer, challenge: GKChallenge, friend_player: GKPlayer) 🔗

Emitted when friend_player completes a challenge issued by the local player.

challenge_received(player: GKPlayer, challenge: GKChallenge) 🔗

Emitted when the local player receives a new challenge.

conflicting_saved_games(player: GKPlayer, conflicting_saved_games: Array) 🔗

Emitted when there is a conflict between saved games. You should listen to this signal and then call resolve_conflicting_saved_games() with the chosen data.

exchange_canceled(player: GKPlayer, exchange: GKTurnBasedExchange, match: GKTurnBasedMatch) 🔗