Struct GKLocalPlayer

#[repr(C)]
pub struct GKLocalPlayer { /* private fields */ }

Available on crate features GKBasePlayer and GKLocalPlayer and GKPlayer only.

Apple’s documentation

Implementations

impl GKLocalPlayer

pub unsafe fn local() -> Retained<GKLocalPlayer>

Obtain the primary GKLocalPlayer object. The player is only available for offline play until logged in. A temporary player is created if no account is set up.

pub unsafe fn localPlayer() -> Retained<GKLocalPlayer>

pub unsafe fn isAuthenticated(&self) -> bool

Authentication state

pub unsafe fn isUnderage(&self) -> bool

Indicates if a player is under age

pub unsafe fn isMultiplayerGamingRestricted(&self) -> bool

A Boolean value that declares whether or not multiplayer gaming is restricted on this device.

pub unsafe fn isPersonalizedCommunicationRestricted(&self) -> bool

A Boolean value that declares whether personalized communication is restricted on this device. If it is restricted, the player will not be able to read or write personalized messages on game invites, challenges, or enable voice communication in multiplayer games. Note: this value will always be true when isUnderage is true.

pub unsafe fn loadRecentPlayersWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>>, )

Available on crate feature block2 only.

Asynchronously load the recent players list as an array of GKPlayer. A recent player is someone that you have played a game with or is a legacy game center friend. Calls completionHandler when finished. Error will be nil on success. Possible reasons for error:

1. Communications problem
2. Unauthenticated player

pub unsafe fn loadChallengableFriendsWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>>, )

Available on crate feature block2 only.

Asynchronously load the challengable friends list as an array of GKPlayer. A challengable player is a friend player with friend level FL1 and FL2. Calls completionHandler when finished. Error will be nil on success. Possible reasons for error:

1. Communications problem
2. Unauthenticated player

pub unsafe fn setDefaultLeaderboardIdentifier_completionHandler( &self, leaderboard_identifier: &NSString, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Set the default leaderboard for the current game Possible reasons for error:

1. Communications problem
2. Unauthenticated player
3. Leaderboard not present

pub unsafe fn loadDefaultLeaderboardIdentifierWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSString, *mut NSError)>>, )

Available on crate feature block2 only.

Load the default leaderboard identifier for the local player Possible reasons for error:

1. Communications problem
2. Unauthenticated player
3. Leaderboard not present

pub unsafe fn fetchItemsForIdentityVerificationSignature( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSURL, *mut NSData, *mut NSData, u64, *mut NSError)>>, )

Available on crate feature block2 only.

Generates a signature allowing 3rd party server to authenticate the GKLocalPlayer Possible reasons for error:

1. Communications problem
2. Unauthenticated player

impl GKLocalPlayer

Methods declared on superclass GKPlayer.

pub unsafe fn anonymousGuestPlayerWithIdentifier( guest_identifier: &NSString, ) -> Retained<Self>

impl GKLocalPlayer

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

impl GKLocalPlayer

GKLocalPlayerEvents.

pub unsafe fn registerListener( &self, listener: &ProtocolObject<dyn GKLocalPlayerListener>, )

Available on crate features GKEventListener and GKMatchmaker and GKSavedGameListener and GKTurnBasedMatch only.

A single listener may be registered once. Registering multiple times results in undefined behavior. The registered listener will receive callbacks for any selector it responds to.

pub unsafe fn unregisterListener( &self, listener: &ProtocolObject<dyn GKLocalPlayerListener>, )

Available on crate features GKEventListener and GKMatchmaker and GKSavedGameListener and GKTurnBasedMatch only.

pub unsafe fn unregisterAllListeners(&self)

impl GKLocalPlayer

Deprecated.

pub unsafe fn setDefaultLeaderboardCategoryID_completionHandler( &self, category_id: Option<&NSString>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

pub unsafe fn loadDefaultLeaderboardCategoryIDWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSString, *mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

pub unsafe fn authenticateWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

pub unsafe fn loadFriendPlayersWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

pub unsafe fn generateIdentityVerificationSignatureWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSURL, *mut NSData, *mut NSData, u64, *mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

Generates a signature allowing 3rd party server to authenticate the GKLocalPlayer Possible reasons for error:

1. Communications problem
2. Unauthenticated player

impl GKLocalPlayer

Obsoleted.

pub unsafe fn loadFriendsWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<NSString>, *mut NSError)>>, )

👎Deprecated

Available on crate feature block2 only.

This method is obsolete. It will never be invoked and its implementation does nothing**

pub unsafe fn friends(&self) -> Option<Retained<NSArray<NSString>>>

👎Deprecated

This property is obsolete. **

impl GKLocalPlayer

FriendsList.

pub unsafe fn loadFriendsAuthorizationStatus( &self, completion_handler: &DynBlock<dyn Fn(GKFriendsAuthorizationStatus, *mut NSError)>, )

Available on crate feature block2 only.

pub unsafe fn loadFriends( &self, completion_handler: &DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>, )

Available on crate feature block2 only.

pub unsafe fn loadFriendsWithIdentifiers_completionHandler( &self, identifiers: &NSArray<NSString>, completion_handler: &DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>, )

Available on crate feature block2 only.

impl GKLocalPlayer

UI.

pub unsafe fn authenticateHandler( &self, mtm: MainThreadMarker, ) -> *mut DynBlock<dyn Fn(*mut NSViewController, *mut NSError)>

Available on crate feature block2 and crate feature objc2-app-kit and macOS only.

pub unsafe fn setAuthenticateHandler( &self, authenticate_handler: Option<&DynBlock<dyn Fn(*mut NSViewController, *mut NSError)>>, )

Available on crate feature block2 and crate feature objc2-app-kit and macOS only.

Setter for authenticateHandler.

pub unsafe fn isPresentingFriendRequestViewController(&self) -> bool

observable property that becomes true when the friend request view controller is displayed. It becomes false when it is dismissed

pub unsafe fn presentFriendRequestCreatorFromViewController_error( &self, view_controller: &NSViewController, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-app-kit and macOS only.

pub unsafe fn presentFriendRequestCreatorFromWindow_error( &self, window: Option<&NSWindow>, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-app-kit and macOS only.

impl GKLocalPlayer

GKSavedGame.

pub unsafe fn fetchSavedGamesWithCompletionHandler( &self, handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKSavedGame>, *mut NSError)>>, )

Available on crate features GKSavedGame and block2 only.

Asynchronously fetch saved games. The handler is called with an array of GKSavedGame objects or an error. If there is more than one saved game with the same name then a conflict exists. The application should determine the correct data to use and call resolveConflictingSavedGames:withData:completionHandler:. This may require data merging or asking the user.

pub unsafe fn saveGameData_withName_completionHandler( &self, data: &NSData, name: &NSString, handler: Option<&DynBlock<dyn Fn(*mut GKSavedGame, *mut NSError)>>, )

Available on crate features GKSavedGame and block2 only.

Asynchronously save game data. If a saved game with that name already exists it is overwritten, otherwise a new one is created. The completion handler is called with the new / modified GKSavedGame or an error. If the saved game was in conflict then the overwritten version will be the one with the same deviceName if present, otherwise the most recent overall.

pub unsafe fn deleteSavedGamesWithName_completionHandler( &self, name: &NSString, handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate features GKSavedGame and block2 only.

Asynchronously delete saved games with the given name. The completion handler will indicate whether or not the deletion was successful.

pub unsafe fn resolveConflictingSavedGames_withData_completionHandler( &self, conflicting_saved_games: &NSArray<GKSavedGame>, data: &NSData, handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKSavedGame>, *mut NSError)>>, )

Available on crate features GKSavedGame and block2 only.

Asynchronously resolve a saved game conflict. This deletes all versions included in conflictingSavedGames and creates a new version with the given data. The completion handler is called with the newly created save and all other remaining versions or an error.

Methods from Deref<Target = GKPlayer>

pub unsafe fn scopedIDsArePersistent(&self) -> bool

This convenience method checks if the gamePlayerID and the teamPlayerID (scopedIDs) are persistent or unique for the instantiation of this app.

pub unsafe fn gamePlayerID(&self) -> Retained<NSString>

This is the player’s unique and persistent ID that is scoped to this application.

pub unsafe fn teamPlayerID(&self) -> Retained<NSString>

This is the player’s unique and persistent ID that is scoped to the Apple Store Connect Team identifier of this application.

pub unsafe fn displayName(&self) -> Retained<NSString>

This is player’s alias to be displayed. The display name may be very long, so be sure to use appropriate string truncation API when drawing.

pub unsafe fn alias(&self) -> Retained<NSString>

The alias property contains the player’s nickname. When you need to display the name to the user, consider using displayName instead. The nickname is unique but not invariant: the player may change their nickname. The nickname may be very long, so be sure to use appropriate string truncation API when drawing.

pub unsafe fn guestIdentifier(&self) -> Option<Retained<NSString>>

pub unsafe fn isInvitable(&self) -> bool

pub unsafe fn loadPhotoForSize_withCompletionHandler( &self, size: GKPhotoSize, completion_handler: Option<&DynBlock<dyn Fn(*mut NSImage, *mut NSError)>>, )

Available on crate feature block2 and crate feature objc2-app-kit and macOS only.

pub unsafe fn isFriend(&self) -> bool

👎Deprecated

pub unsafe fn playerID(&self) -> Retained<NSString>

👎Deprecated: Use GKPlayer/gamePlayerID or GKPlayer/teamPlayerID instead.

Methods from Deref<Target = GKBasePlayer>

pub unsafe fn playerID(&self) -> Option<Retained<NSString>>

👎Deprecated

pub unsafe fn displayName(&self) -> Option<Retained<NSString>>

This player’s name representation as displayed in the Game Center in-game UI. Use this when you need to display the player’s name. The display name may be very long, so be sure to use appropriate string truncation API when drawing.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for GKLocalPlayer

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GKBasePlayer> for GKLocalPlayer

fn as_ref(&self) -> &GKBasePlayer

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GKLocalPlayer> for GKLocalPlayer

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<GKPlayer> for GKLocalPlayer

fn as_ref(&self) -> &GKPlayer

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for GKLocalPlayer

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for GKLocalPlayer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GKBasePlayer> for GKLocalPlayer

fn borrow(&self) -> &GKBasePlayer

Immutably borrows from an owned value.

impl Borrow<GKPlayer> for GKLocalPlayer

fn borrow(&self) -> &GKPlayer

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKLocalPlayer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKLocalPlayer

const NAME: &'static str = "GKLocalPlayer"

The name of the Objective-C class that this type represents.

type Super = GKPlayer

The superclass of this class.

type ThreadKind = <<GKLocalPlayer as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for GKLocalPlayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for GKLocalPlayer

type Target = GKPlayer

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl GKSavedGameListener for GKLocalPlayer

Available on crate feature GKSavedGame only.

unsafe fn player_didModifySavedGame( &self, player: &GKPlayer, saved_game: &GKSavedGame, )

where Self: Sized + Message,

Available on crate features GKBasePlayer and GKPlayer and GKSavedGameListener only.

Called when a player’s saved game data has been modified.

unsafe fn player_hasConflictingSavedGames( &self, player: &GKPlayer, saved_games: &NSArray<GKSavedGame>, )

where Self: Sized + Message,

Available on crate features GKBasePlayer and GKPlayer and GKSavedGameListener only.

Called when a conflict has arisen between different versions of the same saved game. This can happen when multiple devices write to the same saved game while one or more is offline. The application should determine the correct data to use, then call resolveConflictingSavedGames:withData:completionHandler:. This may require data merging or asking the user.

impl Hash for GKLocalPlayer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for GKLocalPlayer

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GKLocalPlayer

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for GKLocalPlayer

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for GKLocalPlayer

const ENCODING_REF: Encoding = <GKPlayer as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for GKLocalPlayer

impl Eq for GKLocalPlayer