Class: GKPlayer

Inherits:
NSObject show all

Overview

GKPlayer objects provide information about a player on Game Center.

Direct Known Subclasses

GKLocalPlayer

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

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

- (String) alias (readonly)

A string chosen by the player to identify themselves to other players. (read-only) A player’s alias is used when a player is not a friend of the local player. Typically, you never display the alias string directly in your user interface. Instead use the displayName property.

Returns:

- (String) displayName (readonly)

A string to display for the player. (read-only) The display name for a player depends on whether the player is a friend of the local player authenticated on the device. If the player is a friend of the local player, then the display name is the actual name of the player. If the player is not a friend, then the display name is the player’s alias.

Returns:

- (Boolean) isFriend (readonly)

A Boolean value that indicates whether this player is a friend of the local player. (read-only) Players use the Game Center app to declare other players as friends.

Returns:

  • (Boolean)

- (String) playerID (readonly)

A string assigned by Game Center to uniquely identify a player. (read-only) The player identifier should never be displayed to the player. Use it only as a way to identify a particular player.Do not make assumptions about the contents of the player identifier string. Its format and length are subject to change.

Returns:

Class Method Details

+ (Object) loadPlayersForIdentifiers(identifiers, withCompletionHandler:completionHandler)

Loads information from Game Center about a list of players. 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.

Parameters:

  • identifiers

    An array of NSString objects, each a unique identifier for a Game Center player.

  • completionHandler

    A block to be called when the player data is retrieved from Game Center.The block receives the following parameters:playersAn array of GKPlayer objects, one per identifier. If an error occurred, this may be non-nil. In that case, the array holds whatever data Game Kit was able to retrieve for the requested players.errorIf an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

  • players

    An array of GKPlayer objects, one per identifier. If an error occurred, this may be non-nil. In that case, the array holds whatever data Game Kit was able to retrieve for the requested players.

  • error

    If an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

Returns:

Instance Method Details

- (Object) loadPhotoForSize(size, withCompletionHandler:completionHandler)

Loads a photo of this player from Game Center. 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.Important: The size of the image returned to your game is dependent on both the constant you provided in the initial request and the user interface idiom of the device your game is running on.Note: On OS X, the returned image is an NSImage object.

Parameters:

  • size

    A constant that determines the size of the photo to load.

  • completionHandler

    A block to be called when the player data is retrieved from Game Center.The block receives the following parameters:photoAn image for the player. If an error occurred, this may still be non-nil. In this case, the image reflects an image cached by Game Kit on the device.errorIf an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

  • photo

    An image for the player. If an error occurred, this may still be non-nil. In this case, the image reflects an image cached by Game Kit on the device.

  • error

    If an error occurred, this error object describes the error. If the operation completed successfully, this is nil.

Returns: