GCKPlayerInfo Class

  • The GCKPlayerInfo class represents data for a single player in a game session, including player ID, state, and custom data.

  • This class is part of the Game Manager API, which is deprecated and will be removed in a future release.

  • Players have properties such as playerID, playerState, playerData, isConnected, and isControllable that provide information about their status and connection.

  • A player is considered connected if their playerState is Available, Ready, Idle, or Playing.

  • isControllable indicates if the player was created on the current sender device.
Instance Methods | Properties
GCKPlayerInfo Class Reference

Overview

Represents data for a single player.

Deprecated:
The Game Manager API is no longer supported and will be removed in a future release.

Inherits NSObject.

Instance Method Summary

(instancetype) - init
 Default initializer is not available. More...
 

Property Summary

NSString * playerID
 The unique string identifier of this player. More...
 
GCKPlayerState playerState
 The current state of the player. More...
 
id playerData
 Player-specific data defined by the game. More...
 
BOOL isConnected
 True if this player is in a connected state. More...
 
BOOL isControllable
 True if this player is was created on this sender device. More...
 

Method Detail

- (instancetype) init

Default initializer is not available.

Property Detail

- (NSString*) playerID
readnonatomiccopy

The unique string identifier of this player.

- (GCKPlayerState) playerState
readnonatomicassign

The current state of the player.

- (id) playerData
readnonatomiccopy

Player-specific data defined by the game.

This data is persisted while the game is running. Will be either an object that can be serialized to JSON using NSJSONSerialization, or nil.

- (BOOL) isConnected
readnonatomicassign

True if this player is in a connected state.

A player is considered to be in a connected state if the associated GCKPlayerInfo::playerState is one of GCKPlayerStateAvailable, GCKPlayerStateReady, GCKPlayerStateIdle, or GCKPlayerStatePlaying.

- (BOOL) isControllable
readnonatomicassign

True if this player is was created on this sender device.