FLobbiesCommon

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IOnlineComponent

TOnlineComponent

FLobbiesCommon

FLobbiesEOS

References

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

Syntax

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

Variables

		Name	Description
	TSharedPtr< FLo...	LobbySchemaRegistry
	TOnlineEventCal...	OnLobbyAttributesChangedEvent
	TOnlineEventCal...	OnLobbyInvitationAddedEvent
	TOnlineEventCal...	OnLobbyInvitationRemovedEvent
	TOnlineEventCal...	OnLobbyJoinedEvent
	TOnlineEventCal...	OnLobbyLeaderChangedEvent
	TOnlineEventCal...	OnLobbyLeftEvent
	TOnlineEventCal...	OnLobbyMemberAttributesChangedEvent
	TOnlineEventCal...	OnLobbyMemberJoinedEvent
	TOnlineEventCal...	OnLobbyMemberLeftEvent
	TOnlineEventCal...	OnLobbySchemaChangedEvent
	TSharedPtr< FLo...	ServiceSchema

Constructors

	Name	Description
	FLobbiesCommon ( FOnlineServicesCommon& InServices )

Functions

	Name	Description
TFuture< TDe...	AwaitInvitation ( FOnlineAccountIdHandle TargetAccoun..., FOnlineLobbyIdHandle LobbyId, float TimeoutSeconds )
TFunction< T...	CaptureOperationStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., const FString& ResultKey, Function Func, typename SecondaryOpType::Params&&... )
TFunction< T...	CaptureOperationStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., const FString& ResultKey, Function Func )
TFunction< T...	CaptureStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., const FString& ResultKey, Function Func, typename SecondaryOpType::Params&&... )
TFunction< T...	CaptureStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., const FString& ResultKey, Function Func )
TFunction< T...	ConsumeOperationStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., Function Func, typename SecondaryOpType::Params&&... )
TFunction< T...	ConsumeOperationStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., Function Func )
TFunction< T...	ConsumeStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., Function Func )
TFunction< T...	ConsumeStepResult ( TOnlineAsyncOp< OpType >& InAsyncO..., Function Func, typename SecondaryOpType::Params&&... )
TOnlineAsync...	CreateLobby ( FCreateLobby::Params&& Params )	ILobbies.
TOnlineAsync...	DeclineLobbyInvitation ( FDeclineLobbyInvitation::Params&& ... )	Decline an invitation to join a lobby.
TOnlineAsync...	FindLobby ( FFindLobby::Params&& Params )	Search for lobbies using filtering parameters.
TOnlineAsync...	FunctionalTest ( FFunctionalTestLobbies::Params&& P... )
TFuture< TOn...	FunctionalTestLoginUser ( FFunctionalTestLoginUser::Params&&... )
TFuture< TOn...	FunctionalTestLogoutAllUsers ( FFunctionalTestLogoutAllUsers::Para... )
TFuture< TOn...	FunctionalTestLogoutUser ( FFunctionalTestLogoutUser::Params&... )
TOnlineResul...	GetJoinedLobbies ( FGetJoinedLobbies::Params&& Params )	Retrieve the list of joined lobbies for the target local user.
TOnlineResul...	GetReceivedInvitations ( FGetReceivedInvitations::Params&& ... )	Retrieve the list of received invitations for the target local user.
TOnlineAsync...	InviteLobbyMember ( FInviteLobbyMember::Params&& Param... )	Invite a player to join a lobby.
TOnlineAsync...	JoinLobby ( FJoinLobby::Params&& Params )	Join a lobby using its id.
TOnlineAsync...	KickLobbyMember ( FKickLobbyMember::Params&& Params )	Kick a member from a the target lobby.
TOnlineAsync...	LeaveLobby ( FLeaveLobby::Params&& Params )	Leave a joined lobby.
TOnlineAsync...	ModifyLobbyAttributes ( FModifyLobbyAttributes::Params&& P... )	Change the attributes applied to the lobby.
TOnlineAsync...	ModifyLobbyJoinPolicy ( FModifyLobbyJoinPolicy::Params&& P... )	Change the join policy applied to the lobby. Only the lobby leader may change the join policy.
TOnlineAsync...	ModifyLobbyMemberAttributes ( FModifyLobbyMemberAttributes::Param... )	Change the attributes applied to a lobby member.
TOnlineAsync...	ModifyLobbySchema ( FModifyLobbySchema::Params&& Param... )	Change the schema applied to the lobby and member attributes.
TOnlineEvent...	OnLobbyAttributesChanged()	Get the event that is triggered when lobby attributes have changed.
TOnlineEvent...	OnLobbyInvitationAdded()	Get the event that is triggered when an invitation is received.
TOnlineEvent...	OnLobbyInvitationRemoved()	Get the event that is triggered when an invitation is removed.
TOnlineEvent...	OnLobbyJoined()	Get the event that is triggered when a lobby is joined.
TOnlineEvent...	OnLobbyLeaderChanged()	Get the event that is triggered when the leadership of a lobby changes.
TOnlineEvent...	OnLobbyLeft()	Get the event that is triggered when a lobby has been left by all local members.
TOnlineEvent...	OnLobbyMemberAttributesChanged()	Get the event that is triggered when lobby member attributes have changed.
TOnlineEvent...	OnLobbyMemberJoined()	Get the event that is triggered when a lobby member joins.
TOnlineEvent...	OnLobbyMemberLeft()	Get the event that is triggered when a lobby member leaves a joined lobby.
TOnlineEvent...	OnLobbySchemaChanged()	Get the event that is triggered when the attribute schema of a lobby changes.
TOnlineAsync...	PromoteLobbyMember ( FPromoteLobbyMember::Params&& Para... )	Promote another lobby member to leader.
TOnlineAsync...	RestoreLobbies ( FRestoreLobbies::Params&& Params )	Try to rejoin previously joined lobbies.

Overridden from TOnlineComponent

		Name	Description
	void	RegisterCommands()

Overridden from IOnlineComponent

		Name	Description
	void	Initialize()	TOnlineComponent.

Classes

	Name	Description
	FFunctionalTestLoginUser
	FFunctionalTestLogoutAllUsers
	FFunctionalTestLogoutUser

Typedefs

Name	Description
Super