Skip to main content

_tagEOS_Sessions_JoinSessionOptions

Struct _tagEOS_Sessions_JoinSessionOptions 

Source
#[repr(C)]
pub struct _tagEOS_Sessions_JoinSessionOptions { pub ApiVersion: i32, pub SessionName: *const c_char, pub SessionHandle: EOS_HSessionDetails, pub LocalUserId: EOS_ProductUserId, pub bPresenceEnabled: EOS_Bool, }
Expand description

Input parameters for the EOS_Sessions_JoinSession function.

Fields§

§ApiVersion: i32

API Version: Set this to EOS_SESSIONS_JOINSESSION_API_LATEST.

§SessionName: *const c_char

Name of the session to create after joining session

§SessionHandle: EOS_HSessionDetails

Session handle to join

§LocalUserId: EOS_ProductUserId

The Product User ID of the local user who is joining the session

§bPresenceEnabled: EOS_Bool

Determines whether or not this session should be the one associated with the local user’s presence information. If true, this session will be associated with presence. Only one session at a time can have this flag true. 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_Sessions_CreateSessionModificationOptions

Trait Implementations§

Source§

impl Clone for _tagEOS_Sessions_JoinSessionOptions

Source§

fn clone(&self) -> _tagEOS_Sessions_JoinSessionOptions

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_Sessions_JoinSessionOptions

Source§

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

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

impl Default for _tagEOS_Sessions_JoinSessionOptions

Source§

fn default() -> Self

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

impl Copy for _tagEOS_Sessions_JoinSessionOptions

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.