Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Lobby > ALobbyBeaconState

Light Theme

Dark Theme

ALobbyBeaconState

Shared state of the game from the lobby perspective Duplicates much of the data in the traditional [AGameState](API\Runtime\Engine\GameFramework\AGameState) object for sharing with players connected via beacon only

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

ALobbyBeaconState

References

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

Syntax

UCLASS(Transient, Config=Game, NotPlaceable)
class ALobbyBeaconState : public AInfo

Remarks

Shared state of the game from the lobby perspective Duplicates much of the data in the traditional AGameState object for sharing with players connected via beacon only

Variables

	Name	Description
friend	ALobbyBeaconHost
bool	bLobbyStarted	Has the lobby already been started
friend	FLobbyPlayerStateInfoArray
double	LastTickTime	Time that last tick occurred for calculating wait time
TSubclassOf< AL...	LobbyBeaconPlayerStateClass	Class to use for lobby beacon player states
FOnLobbyStarted	LobbyStarted	Delegate fired when the lobby starts
FOnLobbyWaiting...	LobbyWaitingForPlayersUpdate	Delegate fired as time counts down waiting for players in the lobby
int32	MaxPlayers	Total number of players allowed in the lobby
FTimerHandle	OneSecTimerHandle	Handle to manage a one sec timer
FOnPlayerLobbyS...	PlayerLobbyStateAdded	Delegate fired when a player is added to the lobby
FOnPlayerLobbyS...	PlayerLobbyStateRemoved	Delegate fired when a player is removed from the lobby
FLobbyPlayerSta...	Players	Array of players currently in the game, lobby or otherwise
float	WaitForPlayersTimeRemaining	Amount of time waiting for other players before starting the lobby

Constructors

	Name	Description
	ALobbyBeaconState ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
ALobbyBeacon...	AddPlayer ( const FText& PlayerName, const FUniqueNetIdRepl& UniqueId )	Create and replicate the appropriate player state for the new player
ALobbyBeacon...	CreateNewPlayer ( const FText& PlayerName, const FUniqueNetIdRepl& UniqueId )	Create a new player for this lobby beacon state
void	DumpState()	Output current state of lobby to log
int32	GetMaxPlayers()
int32	GetNumPlayers()
ALobbyBeacon...	GetPlayer ( const FUniqueNetIdRepl& UniqueId )	Get an existing player in the lobby
ALobbyBeacon...	GetPlayer ( const FString& UniqueId )	Get an existing player in the lobby
ALobbyBeacon...	GetPlayer ( const AOnlineBeaconClient* Cli... )	Get an existing player in the lobby
bool	HasLobbyStarted()
void	OneSecTick()	One sec tick function to handle countdowns
FOnLobbyStar...	OnLobbyStarted()
FOnLobbyWait...	OnLobbyWaitingForPlayersUpdate()
FOnPlayerLob...	OnPlayerLobbyStateAdded()
FOnPlayerLob...	OnPlayerLobbyStateRemoved()
void	OnPostLobbyStartedTickInternal ( double DeltaTime )	Internal helper function called as part of OneSecTick if the lobby has been started already
void	OnPreLobbyStartedTickInternal ( double DeltaTime )	Internal helper function called as part of OneSecTick if the lobby hasn't been started yet
void	OnRep_LobbyStarted()	Handle the lobby starting
void	OnRep_WaitForPlayersTimeRemaining()	Handle notification of time left to wait for lobby to start
void	RemovePlayer ( const FUniqueNetIdRepl& UniqueId )	Remove an existing player from the lobby
bool	RequireFullLobbyToStart()	Determines whether the beacon state requires a full game before allowing a lobby to start; False by default
void	StartLobby()	Start the lobby for incoming players
void	StartWaiting()	Start the waiting for other players (first player logged in success)
void	UpdatePartyLeader ( const FUniqueNetIdRepl& PartyMembe..., const FUniqueNetIdRepl& NewPartyLe... )	Update the party leader for a given player

Overridden from AActor

		Name	Description
	bool	IsNetRelevantFor ( const AActor* RealViewer, const AActor* ViewTarget, const FVector& SrcLocation )	Checks to see if this actor is relevant for a specific network connection
	void	PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel