1. Epic GamesDeveloper
  3. ALobbyBeaconClient

ALobbyBeaconClient

A beacon client used for quality timings to a specified session

Unreal Engine C++ API Reference > Plugins > Lobby

Inheritance Hierarchy

References

   
Module Lobby
Header /Engine/Plugins/Online/OnlineFramework/Source/Lobby/Public/LobbyBeaconClient.h
Include #include "LobbyBeaconClient.h"

Syntax

UCLASS&40;Transient, Config&61;Engine, NotPlaceable&41;  
class ALobbyBeaconClient : public AOnlineBeaconClient

Remarks

A beacon client used for quality timings to a specified session

Variables

  Type Name Description
Protected variable bool bLoggedIn Has this beacon been properly logged in
Protected variable FString DestSessionId Session Id of the destination host
Protected variable FOnJoiningGame JoiningGame Delegate broadcast when this player is told to join the game by the server (clientside)
Protected variable FOnJoiningGame JoiningGameAck Delegate broadcast when the server acknowledges the client request to join the server (clientside)
Protected variable FOnLobbyConnectionEstablished LobbyConnectionEstablished Delegate broadcast when first connected to the lobby beacon (clientside)
Protected variable UProperty ELobbyBeaconJoinState LobbyJoinServerState True once the server has acknowledged our join intent
Public variable UProperty Replicated TObjectPtr< ALobbyBeaconState > LobbyState Client view of the lobby state
Protected variable FOnLobbyLoginComplete LoginCompleteDelegate Delegate broadcast when login is complete (clientside)
Protected variable FOnLobbyPlayerJoined PlayerJoinedDelegate Delegate broadcast when a new player joins (clientside)
Protected variable FOnLobbyPlayerLeft PlayerLeftDelegate Delegate broadcast when an existing player leaves (clientside)
Public variable UProperty Replicated TObjectPtr< ALobbyBeaconPlayerState > PlayerState Player state associated with this beacon (

Constructors

  Type Name Description
Public function  

ALobbyBeaconClient ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void Acknowledge that client is traveling
Protected function Virtual UFunction Client, Reliable void Acknowledge that client is traveling
Public function Virtual UFunction Client, Reliable void Tell the client to join the game
Protected function UFunction Client, Reliable void

ClientLoginComplete ( const FUniqueNetIdRepl& InUniqueId,
bool bWasSuccessful
)

 Client notification result for a single login attempt
Protected function Virtual UFunction Client, Reliable void

ClientPlayerJoined ( const FText& NewPlayerName,
const FUniqueNetIdRepl& InUniqueId
)

 Client notification that another player has joined the lobby
Protected function Virtual UFunction Client, Reliable void

ClientPlayerLeft ( const FUniqueNetIdRepl& InUniqueId
)

 Client notification that another player has left the lobby
Public function UFunction Client, Reliable void Send updated session settings to client
Protected function UFunction Client, Reliable void

ClientWasKicked ( const FText& KickReason
)

 This was client was kicked by the server
Public function Virtual void Initiate a connection to the lobby host beacon
Public function Virtual void Graceful disconnect from server with no intent of joining further
Public function Const bool  
Public function Virtual void Graceful notification that this client is going to join the server
Public function void

KickPlayer ( const FUniqueNetIdRepl& PlayerToKick,
const FText& Reason
)

 Ask the server to kick a given player (may not succeed)
Protected function Virtual void Internal function to log in a local players when first connected to the beacon
Public function FOnJoiningGame &  
Public function FOnJoiningGame &  
Public function FOnLobbyConnectionEstablished &  
Public function FOnLobbyLoginComplete &  
Public function FOnLobbyPlayerJoined &  
Public function FOnLobbyPlayerLeft &  
Public function UFunction Server, Reliable withvalidation void

ServerCheat ( const FString& Msg
)

 Run a cheat command on the server
Protected function Virtual UFunction Server, Reliable withvalidation void Make a graceful disconnect with the server
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerKickPlayer ( const FUniqueNetIdRepl& PlayerToKick,
const FText& Reason
)

 Make a request to kick a given player
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerLoginPlayer ( const FString& InSessionId,
const FUniqueNetIdRepl& InUniqueId,
const FString& UrlString
)

 Attempt to login a single local player with the lobby beacon
Protected function Virtual UFunction Server, Reliable withvalidation void Make a graceful request to actually join the server
Protected function Virtual UFunction Server, Reliable withvalidation void

ServerSetPartyOwner ( const FUniqueNetIdRepl& InUniqueId,
const FUniqueNetIdRepl& InPartyOwnerId
)

 Make a request to set the party owner for the given player
Protected function void

SetLobbyState ( ALobbyBeaconState* InLobbyState
)

 Set the lobby state for this client beacon
Public function Virtual void

SetPartyOwnerId ( const FUniqueNetIdRepl& InUniqueId,
const FUniqueNetIdRepl& InPartyOwnerId
)

 Tell the server to set a party owner

Overridden from AOnlineBeaconClient

  Type Name Description
Public function Virtual void A connection has been made and RPC/replication can begin

Overridden from AActor

  Type Name Description
Public function Virtual void Clear out any references to this in PlayerState

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page