EOS_Lobby_JoinLobbyOptions

EOS API reference page for EOS_Lobby_JoinLobbyOptions

実装方法を選んでください。

C

C#

This data structure is part of the [Lobby Interface](Interfaces/Lobby).

Remarks

Input parameters for the EOS_Lobby_JoinLobby function.

Properties

EOS_Lobby_JoinLobbyOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_LOBBY_JOINLOBBY_API_LATEST.

EOS_HLobbyDetails LobbyDetailsHandle

The handle of the lobby to join

EOS_ProductUserId LocalUserId

The Product User ID of the local user joining the lobby

EOS_Bool bPresenceEnabled

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.

  • using the bPresenceEnabled flags within the Sessions interface

  • using the bPresenceEnabled flags within the Lobby interface

  • using EOS_PresenceModification_SetJoinInfo

const EOS_Lobby_LocalRTCOptions* 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.

Related API Members

This data structure is part of the [Lobby Interface](Interfaces/Lobby).

Remarks

Input parameters for the EOS_Lobby_JoinLobby function.

Properties

Lobby.JoinLobbyOptions

Property

Value

int ApiVersion

API Version: Set this to EOS_LOBBY_JOINLOBBY_API_LATEST.

LobbyDetails LobbyDetailsHandle

The handle of the lobby to join

ProductUserId LocalUserId

The Product User ID of the local user joining the lobby

bool PresenceEnabled

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.

  • using the bPresenceEnabled flags within the Sessions interface

  • using the bPresenceEnabled flags within the Lobby interface

  • using EOS_PresenceModification_SetJoinInfo

LocalRTCOptions 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.

Related API Members

タグ