Struct GKPlayer

Source

pub struct GKPlayer { /* private fields */ }

Available on crate features GKBasePlayer and GKPlayer only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GKPlayer

Source

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.

Source

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

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

Source

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.

Source

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.

Source

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.

Source

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

Source

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

Source

pub unsafe fn isInvitable(&self) -> bool

Source §

impl GKPlayer

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl GKPlayer

UI.

Source

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.

Asynchronously load the player’s photo. Error will be nil on success. Possible reasons for error:

Communications failure

Source §

impl GKPlayer

Deprecated.

Source

pub unsafe fn isFriend(&self) -> bool

👎Deprecated

Source

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

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

Source

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

👎Deprecated

Available on crate feature block2 only.

Load the Game Center players for the playerIDs provided. Error will be nil on success. Possible reasons for error:

Unauthenticated local player
Communications failure
Invalid player identifier

Methods from Deref<Target = GKBasePlayer>§

Source

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

👎Deprecated

Source

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>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}