ILobbies

Choose your operating system:

Windows

macOS

Linux

References

Module

OnlineServicesInterface

Header

/Engine/Plugins/Online/Experimental/OnlineServices/Source/OnlineServicesInterface/Public/Online/Lobbies.h

Include

#include "Online/Lobbies.h"

Syntax

class ILobbies

Functions

Name Description

Public function

TOnlineAsync...

 

CreateLobby

(
    FCreateLobby::Params&& Params
)

Create and join a new lobby.

Public function

TOnlineAsync...

 

DeclineLobbyInvitation

Decline an invitation to join a lobby.

Public function

TOnlineAsync...

 

FindLobby

(
    FFindLobby::Params&& Params
)

Search for lobbies using filtering parameters.

Public function

TOnlineResul...

 

GetJoinedLobbies

(
    FGetJoinedLobbies::Params&& Params
)

Retrieve the list of joined lobbies for the target local user.

Public function

TOnlineResul...

 

GetReceivedInvitations

Retrieve the list of received invitations for the target local user.

Public function

TOnlineAsync...

 

InviteLobbyMember

(
    FInviteLobbyMember::Params&& Param...
)

Invite a player to join a lobby.

Public function

TOnlineAsync...

 

JoinLobby

(
    FJoinLobby::Params&& Params
)

Join a lobby using its id.

Public function

TOnlineAsync...

 

KickLobbyMember

(
    FKickLobbyMember::Params&& Params
)

Kick a member from a the target lobby.

Public function

TOnlineAsync...

 

LeaveLobby

(
    FLeaveLobby::Params&& Params
)

Leave a joined lobby.

Public function

TOnlineAsync...

 

ModifyLobbyAttributes

Change the attributes applied to the lobby.

Public function

TOnlineAsync...

 

ModifyLobbyJoinPolicy

Change the join policy applied to the lobby. Only the lobby leader may change the join policy.

Public function

TOnlineAsync...

 

ModifyLobbyMemberAttributes

Change the attributes applied to a lobby member.

Public function

TOnlineAsync...

 

ModifyLobbySchema

(
    FModifyLobbySchema::Params&& Param...
)

Change the schema applied to the lobby and member attributes.

Public function

TOnlineEvent...

 

OnLobbyAttributesChanged()

Get the event that is triggered when lobby attributes have changed.

Public function

TOnlineEvent...

 

OnLobbyInvitationAdded()

Get the event that is triggered when an invitation is received.

Public function

TOnlineEvent...

 

OnLobbyInvitationRemoved()

Get the event that is triggered when an invitation is removed.

Public function

TOnlineEvent...

 

OnLobbyJoined()

Get the event that is triggered when a lobby is joined.

Public function

TOnlineEvent...

 

OnLobbyLeaderChanged()

Get the event that is triggered when the leadership of a lobby changes.

Public function

TOnlineEvent...

 

OnLobbyLeft()

Get the event that is triggered when a lobby has been left by all local members.

Public function

TOnlineEvent...

 

OnLobbyMemberAttributesChanged()

Get the event that is triggered when lobby member attributes have changed.

Public function

TOnlineEvent...

 

OnLobbyMemberJoined()

Get the event that is triggered when a lobby member joins.

Public function

TOnlineEvent...

 

OnLobbyMemberLeft()

Get the event that is triggered when a lobby member leaves a joined lobby.

Public function

TOnlineEvent...

 

OnLobbySchemaChanged()

Get the event that is triggered when the attribute schema of a lobby changes.

Public function

TOnlineAsync...

 

PromoteLobbyMember

(
    FPromoteLobbyMember::Params&& Para...
)

Promote another lobby member to leader.

Public function

TOnlineAsync...

 

RestoreLobbies

(
    FRestoreLobbies::Params&& Params
)

Try to rejoin previously joined lobbies.