FLobbiesCommon | Unreal Engine 4.27 Documentation

API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online

Inheritance Hierarchy

References


Module	OnlineServicesCommon
Header	/Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/LobbiesCommon.h
Include	#include "Online/LobbiesCommon.h"

Syntax

class FLobbiesCommon : public UE::Online::TOnlineComponent< ILobbies >

Variables

	Type	Name	Description
	FLobbyEvents	LobbyEvents
	TMap< FAccountId, FLobbyId >	PresenceLobbiesUserMap
	TSharedRef< FSchemaRegistry >	SchemaRegistry

Constructors

	Type	Name	Description
		FLobbiesCommon ( FOnlineServicesCommon& InServices )

Functions

Type	Name	Description
TOnlineAsyncOpHandle< FCreateLobby >	CreateLobby ( FCreateLobby::Params&& Params )	ILobbies.
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.
TOnlineAsyncOpHandle< FFunctionalTestLobbies >	FunctionalTest ( FFunctionalTestLobbies::Params&& Params )
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 >	ModifyLobbyMemberAttributes ( FModifyLobbyMemberAttributes::Params&& Params )	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 &)>	OnLobbyAttributesChanged ()	Get the event that is triggered when lobby attributes have changed.
TOnlineEvent< void(const FLobbyInvitationAdded &)>	OnLobbyInvitationAdded ()	Get the event that is triggered when an invitation is received.
TOnlineEvent< void(const FLobbyInvitationRemoved &)>	OnLobbyInvitationRemoved ()	Get the event that is triggered when an invitation is removed.
TOnlineEvent< void(const FLobbyJoined &)>	OnLobbyJoined ()	Get the event that is triggered when a lobby is joined.
TOnlineEvent< void(const FLobbyLeaderChanged &)>	OnLobbyLeaderChanged ()	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 &)>	OnLobbyMemberAttributesChanged ()	Get the event that is triggered when lobby member attributes have changed.
TOnlineEvent< void(const FLobbyMemberJoined &)>	OnLobbyMemberJoined ()	Get the event that is triggered when a lobby member joins.
TOnlineEvent< void(const FLobbyMemberLeft &)>	OnLobbyMemberLeft ()	Get the event that is triggered when a lobby member leaves a joined lobby.
TOnlineEvent< void(const FLobbySchemaChanged &)>	OnLobbySchemaChanged ()	Get the event that is triggered when the attribute schema of a lobby changes.
TOnlineEvent< void(const FUILobbyJoinRequested &)>	OnUILobbyJoinRequested ()	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.