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