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 > ALobbyBeaconPlayerState

Light Theme

Dark Theme

ALobbyBeaconPlayerState

Lightweight representation of a player while connected to the game through the lobby exists for the lifetime of a player whether they are in the lobby or not assumption that the data here doesn't change often and locks when they actually join the server

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AInfo

ALobbyBeaconPlayerState

References

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

Syntax

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

Remarks

Lightweight representation of a player while connected to the game through the lobby exists for the lifetime of a player whether they are in the lobby or not assumption that the data here doesn't change often and locks when they actually join the server

Variables

	Name	Description
bool	bInLobby	Is the player in the lobby or game
TObjectPtr< AOn...	ClientActor	Reference to the beacon actor related to this player
FText	DisplayName	Visible friendly player name
FUniqueNetIdRep...	PartyOwnerUniqueId	Party owner id
FUniqueNetIdRep...	UniqueId	Player unique id

Constructors

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

Functions

	Name	Description
bool	IsValid()
FOnPlayerSta...	OnPartyOwnerChanged()
FOnPlayerSta...	OnPlayerStateChanged()
void	OnRep_InLobby()	Player has joined or left the lobby
void	OnRep_PartyOwner()	Party owner has changed
void	OnRep_UniqueId()	Unique Id has replicated
FOnPlayerSta...	OnUniqueIdReplicated()

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

Classes

	Name	Description
	FOnPlayerStateChanged	Delegate fired when this player state has changed in some way

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

Take our survey

Cancel