Skip to main content

_tagEOS_Lobby_JoinLobbyByIdOptions

Struct _tagEOS_Lobby_JoinLobbyByIdOptions 

Source
#[repr(C)]
pub struct _tagEOS_Lobby_JoinLobbyByIdOptions { pub ApiVersion: i32, pub LobbyId: EOS_LobbyId, pub LocalUserId: EOS_ProductUserId, pub bPresenceEnabled: EOS_Bool, pub LocalRTCOptions: *const EOS_Lobby_LocalRTCOptions, pub bCrossplayOptOut: EOS_Bool, pub RTCRoomJoinActionType: EOS_ELobbyRTCRoomJoinActionType, }
Expand description

Input parameters for the EOS_Lobby_JoinLobbyById function.

Fields§

§ApiVersion: i32

API Version: Set this to EOS_LOBBY_JOINLOBBYBYID_API_LATEST.

§LobbyId: EOS_LobbyId

The ID of the lobby

§LocalUserId: EOS_ProductUserId

The Product User ID of the local user joining the lobby

§bPresenceEnabled: EOS_Bool

If true, this lobby will be associated with the user’s presence information. A user can only associate one lobby at a time with their presence information. This affects the ability of the Social Overlay to show game related actions to take in the user’s social graph.

@note The Social Overlay can handle only one of the following three options at a time:

  • using the bPresenceEnabled flags within the Sessions interface
  • using the bPresenceEnabled flags within the Lobby interface
  • using EOS_PresenceModification_SetJoinInfo

@see EOS_PresenceModification_SetJoinInfoOptions @see EOS_Lobby_CreateLobbyOptions @see EOS_Lobby_JoinLobbyOptions @see EOS_Lobby_JoinLobbyByIdOptions @see EOS_Sessions_CreateSessionModificationOptions @see EOS_Sessions_JoinSessionOptions

§LocalRTCOptions: *const EOS_Lobby_LocalRTCOptions

(Optional) Set this value to override the default local options for the RTC Room, if it is enabled for this lobby. Set this to NULL if your application does not use the Lobby RTC Rooms feature, or if you would like to use the default settings. This option is ignored if the specified lobby does not have an RTC Room enabled and will not cause errors.

§bCrossplayOptOut: EOS_Bool

This value indicates whether or not the local user allows crossplay interactions. If it is false, the local user will be treated as allowing crossplay.

§RTCRoomJoinActionType: EOS_ELobbyRTCRoomJoinActionType

For lobbies with the RTC Room feature enabled, this value indicates the action to take against the RTC Room when joining the lobby. This may be used to indicate the RTCRoom should be joined immediately or manually at a later time.

Trait Implementations§

Source§

impl Clone for _tagEOS_Lobby_JoinLobbyByIdOptions

Source§

fn clone(&self) -> _tagEOS_Lobby_JoinLobbyByIdOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for _tagEOS_Lobby_JoinLobbyByIdOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for _tagEOS_Lobby_JoinLobbyByIdOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for _tagEOS_Lobby_JoinLobbyByIdOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.