Class: GKLocalPlayer
Overview
The GKLocalPlayer class is a special subclass of GKPlayer that represents the authenticated player running your game on the device. At any given time, only one player may be authenticated on the device; this player must log out before another player can log in.
Instance Attribute Summary (collapse)
-
- authenticated
readonly
A Boolean value that indicates whether a local player is currently signed in to Game Center.
-
- friends
readonly
A list of player identifiers for the local player’s friends.
-
- underage
readonly
A Boolean value that declares whether the local player is underage.
Attributes inherited from GKPlayer
#alias, #displayName, #isFriend, #playerID
Class Method Summary (collapse)
-
+ localPlayer
Retrieves the shared instance of the local player.
Instance Method Summary (collapse)
-
- loadDefaultLeaderboardCategoryIDWithCompletionHandler:
Loads the category identifier for the local player’s default leaderboard.
-
- loadFriendsWithCompletionHandler:
Retrieves a list of player identifiers for the local player’s friends.
-
- setDefaultLeaderboardCategoryID:completionHandler:
Sets the category identifier for the local player’s default leaderboard.
Methods inherited from GKPlayer
#loadPhotoForSize:withCompletionHandler:, loadPlayersForIdentifiers:withCompletionHandler:
Methods inherited from NSObject
#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version
Constructor Details
This class inherits a constructor from NSObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class NSObject
Instance Attribute Details
- (Boolean) authenticated (readonly)
A Boolean value that indicates whether a local player is currently signed in to Game Center. (read-only)
- (Array) friends (readonly)
A list of player identifiers for the local player’s friends. (read-only) This property is invalid until a call to loadFriendsWithCompletionHandler: succeeds.
- (Boolean) underage (readonly)
A Boolean value that declares whether the local player is underage. (read-only) Some Game Center features are disabled if the local player is underage. Your game can also test this property if it wants to disable some of its own features based on the player’s age.
Class Method Details
+ (GKLocalPlayer) localPlayer
Retrieves the shared instance of the local player. You never directly create a local player object. Instead, you retrieve the singleton object by calling this class method.
Instance Method Details
- (Object) loadDefaultLeaderboardCategoryIDWithCompletionHandler(completionHandler)
Loads the category identifier for the local player’s default leaderboard. When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your completion handler. Keep in mind that the completion handler may be called on a thread other than the one originally used to invoke the method. This means that the code in your block needs to be thread-safe.
- (Object) loadFriendsWithCompletionHandler(completionHandler)
Retrieves a list of player identifiers for the local player’s friends. When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your completion handler. Keep in mind that the completion handler may be called on a thread other than the one originally used to invoke the method. This means that the code in your block needs to be thread-safe.Once this call is completed, the friends property of the shared local player object is set to the same list of players returned in the completion handler.
- (Object) setDefaultLeaderboardCategoryID(categoryID, completionHandler:completionHandler)
Sets the category identifier for the local player’s default leaderboard. When this method is called, it creates a new background task to handle the request. The method then returns control to your game. Later, when the task is complete, Game Kit calls your completion handler. Keep in mind that the completion handler may be called on a thread other than the one originally used to invoke the method. This means that the code in your block needs to be thread-safe.The default leaderboard is configured in iTunes Connect as part of configuring your game’s leaderboards. All players normally start with this leaderboard as the default leaderboard. Calling this method changes the default leaderboard only for the local player.