Navigation
API > API/Plugins > API/Plugins/OnlineServicesInterface > API/Plugins/OnlineServicesInterface/Online
References
| Module | OnlineServicesInterface |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesInterface/Public/Online/Lobbies.h |
| Include | #include "Online/Lobbies.h" |
Syntax
class ILobbies
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TOnlineAsyncOpHandle< FCreateLobby > | CreateLobby
(
FCreateLobby::Params&& Params |
Create and join a new lobby. |
 |
TOnlineAsyncOpHandle< FDeclineLobbyInvitation > | DeclineLobbyInvitation
(
FDeclineLobbyInvitation::Params&& Params |
Decline an invitation to join a lobby. |
 |
TOnlineAsyncOpHandle< FFindLobbies > | FindLobbies
(
FFindLobbies::Params&& Params |
Search for lobbies using filtering parameters. |
 |
TOnlineResult< FGetJoinedLobbies > | GetJoinedLobbies
(
FGetJoinedLobbies::Params&& Params |
Retrieve the list of joined lobbies for the target local user. |
 |
TOnlineResult< FGetPresenceLobby > | GetPresenceLobby
(
FGetPresenceLobby::Params&& Params |
Retrieve the presence Lobby for the given user, if any is set |
 |
TOnlineResult< FGetReceivedInvitations > | GetReceivedInvitations
(
FGetReceivedInvitations::Params&& Params |
Retrieve the list of received invitations for the target local user. |
 |
TOnlineAsyncOpHandle< FInviteLobbyMember > | InviteLobbyMember
(
FInviteLobbyMember::Params&& Params |
Invite a player to join a lobby. |
 |
TOnlineResult< FIsPresenceLobby > | IsPresenceLobby
(
FIsPresenceLobby::Params&& Params |
Return whether the Lobby with the given id is set as presence lobby for the given user |
 |
TOnlineAsyncOpHandle< FJoinLobby > | JoinLobby
(
FJoinLobby::Params&& Params |
Join a lobby using its id. |
 |
TOnlineAsyncOpHandle< FKickLobbyMember > | KickLobbyMember
(
FKickLobbyMember::Params&& Params |
Kick a member from a the target lobby. |
 |
TOnlineAsyncOpHandle< FLeaveLobby > | LeaveLobby
(
FLeaveLobby::Params&& Params |
Leave a joined lobby. |
 |
TOnlineAsyncOpHandle< FModifyLobbyAttributes > | ModifyLobbyAttributes
(
FModifyLobbyAttributes::Params&& Params |
Change the attributes applied to the lobby. |
 |
TOnlineAsyncOpHandle< FModifyLobbyJoinPolicy > | ModifyLobbyJoinPolicy
(
FModifyLobbyJoinPolicy::Params&& Params |
Change the join policy applied to the lobby. Only the lobby leader may change the join policy. |
 |
TOnlineAsyncOpHandle< FModifyLobbyMemberAttributes > | Change the attributes applied to a lobby member. | |
 |
TOnlineAsyncOpHandle< FModifyLobbySchema > | ModifyLobbySchema
(
FModifyLobbySchema::Params&& Params |
Change the schema applied to the lobby and member attributes. |
 |
TOnlineEvent< void(const FLobbyAttributesChanged &)> | Get the event that is triggered when lobby attributes have changed. | |
 |
TOnlineEvent< void(const FLobbyInvitationAdded &)> | Get the event that is triggered when an invitation is received. | |
 |
TOnlineEvent< void(const FLobbyInvitationRemoved &)> | Get the event that is triggered when an invitation is removed. | |
 |
TOnlineEvent< void(const FLobbyJoined &)> | Get the event that is triggered when a lobby is joined. | |
 |
TOnlineEvent< void(const FLobbyLeaderChanged &)> | Get the event that is triggered when the leadership of a lobby changes. | |
 |
TOnlineEvent< void(const FLobbyLeft &)> | OnLobbyLeft () |
Get the event that is triggered when a lobby has been left by all local members. |
 |
TOnlineEvent< void(const FLobbyMemberAttributesChanged &)> | Get the event that is triggered when lobby member attributes have changed. | |
 |
TOnlineEvent< void(const FLobbyMemberJoined &)> | Get the event that is triggered when a lobby member joins. | |
 |
TOnlineEvent< void(const FLobbyMemberLeft &)> | Get the event that is triggered when a lobby member leaves a joined lobby. | |
 |
TOnlineEvent< void(const FLobbySchemaChanged &)> | Get the event that is triggered when the attribute schema of a lobby changes. | |
 |
TOnlineEvent< void(const FUILobbyJoinRequested &)> | Get the event that is triggered when a join is requested through an external mechanism. | |
 |
TOnlineAsyncOpHandle< FPromoteLobbyMember > | PromoteLobbyMember
(
FPromoteLobbyMember::Params&& Params |
Promote another lobby member to leader. |
 |
TOnlineAsyncOpHandle< FRestoreLobbies > | RestoreLobbies
(
FRestoreLobbies::Params&& Params |
Try to rejoin previously joined lobbies. |