Struct GKMatchRequest

Source

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

Available on crate feature GKMatchmaker only.

Expand description

GKMatchRequest represents the parameters needed to create the match.

Implementations§

Source §

impl GKMatchRequest

Source

pub unsafe fn minPlayers(&self) -> NSUInteger

Minimum number of players for the match

Source

pub unsafe fn setMinPlayers(&self, min_players: NSUInteger)

Setter for minPlayers.

Source

pub unsafe fn maxPlayers(&self) -> NSUInteger

Maximum number of players for the match

Source

pub unsafe fn setMaxPlayers(&self, max_players: NSUInteger)

Setter for maxPlayers.

Source

pub unsafe fn playerGroup(&self) -> NSUInteger

The player group identifier. Matchmaking will only take place between players in the same group.

Source

pub unsafe fn setPlayerGroup(&self, player_group: NSUInteger)

Setter for playerGroup.

Source

pub unsafe fn playerAttributes(&self) -> u32

optional mask that specifies the role that the local player would like to play in the game. If this value is 0, it will be set to 0xFFFFFFFF (the default), and this property will be ignored. If the value is nonzero, then automatching uses the value as a mask that restricts the role the player can play in the group. Automatching with player attributes matches new players into the game so that the bitwise OR of the masks of all the players in the resulting match equals 0xFFFFFFFF.

Source

pub unsafe fn setPlayerAttributes(&self, player_attributes: u32)

Setter for playerAttributes.

Source

pub unsafe fn recipients(&self) -> Option<Retained<NSArray<GKPlayer>>>

Available on crate features GKBasePlayer and GKPlayer only.

Array of GKPlayers to invite, or nil if none. This array can also include local guest players.

Source

pub unsafe fn setRecipients(&self, recipients: Option<&NSArray<GKPlayer>>)

Available on crate features GKBasePlayer and GKPlayer only.

Setter for recipients.

Source

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

Message sent to invited players, may be modified if using GKMatchmakerViewController Will return nil if the player is underage or restricted.

Source

pub unsafe fn setInviteMessage(&self, invite_message: Option<&NSString>)

Setter for inviteMessage.

Source

pub unsafe fn defaultNumberOfPlayers(&self) -> NSUInteger

Default number of players to use during matchmaking. If not set we will default to the number that the player previously set for this game, or maxPlayers.

Source

pub unsafe fn setDefaultNumberOfPlayers( &self, default_number_of_players: NSUInteger, )

Setter for defaultNumberOfPlayers.

Source

pub unsafe fn restrictToAutomatch(&self) -> bool

👎Deprecated

Whether or not a match will be created only using automatch. If YES, then a player will not be able to invite anyone (including contacts, friends, and nearby players) to the match, but rely on automatching to find players for the match. Default is NO.

Source

pub unsafe fn setRestrictToAutomatch(&self, restrict_to_automatch: bool)

👎Deprecated

Setter for restrictToAutomatch.

Source

pub unsafe fn recipientResponseHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<GKPlayer>, GKInviteRecipientResponse)>

Available on crate features GKBasePlayer and GKPlayer and block2 only.

An recipientResponseHandler can be set in order to receive responses from programmatically invited players.

Source

pub unsafe fn setRecipientResponseHandler( &self, recipient_response_handler: Option<&DynBlock<dyn Fn(NonNull<GKPlayer>, GKInviteRecipientResponse)>>, )

Available on crate features GKBasePlayer and GKPlayer and block2 only.

Setter for recipientResponseHandler.

Source

pub unsafe fn inviteeResponseHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<NSString>, GKInviteeResponse)>

👎Deprecated

Available on crate feature block2 only.

Source

pub unsafe fn setInviteeResponseHandler( &self, invitee_response_handler: Option<&DynBlock<dyn Fn(NonNull<NSString>, GKInviteeResponse)>>, )

👎Deprecated

Available on crate feature block2 only.

Setter for inviteeResponseHandler.

Source

pub unsafe fn maxPlayersAllowedForMatchOfType( match_type: GKMatchType, ) -> NSUInteger

To determine the maximum allowed players for each type of match supported.

Source

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

👎Deprecated

Source

pub unsafe fn setPlayersToInvite( &self, players_to_invite: Option<&NSArray<NSString>>, )

👎Deprecated

Setter for playersToInvite.

Source

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

The name of the queue, if rule-based matchmaking is used.

Source

pub unsafe fn setQueueName(&self, queue_name: Option<&NSString>)

Setter for queueName.

Source

pub unsafe fn properties(&self) -> Option<Retained<GKMatchProperties>>

Available on crate feature GKDefines only.

The match properties, if rule-based matchmaking is used.

Source

pub unsafe fn setProperties(&self, properties: Option<&GKMatchProperties>)

Available on crate feature GKDefines only.

Setter for properties.

Source

pub unsafe fn recipientProperties( &self, ) -> Option<Retained<NSDictionary<GKPlayer, GKMatchProperties>>>

Available on crate features GKBasePlayer and GKDefines and GKPlayer only.

The recipient specific match properties, if rule-based matchmaking is used when inviting players.

Source

pub unsafe fn setRecipientProperties( &self, recipient_properties: Option<&NSDictionary<GKPlayer, GKMatchProperties>>, )

Available on crate features GKBasePlayer and GKDefines and GKPlayer only.

Setter for recipientProperties.

Source §

impl GKMatchRequest

Methods declared on superclass NSObject.

Source

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

Source

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

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