1. Epic GamesDeveloper
  3. ALobbyBeaconState

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

Unreal Engine C++ API Reference > Plugins > Lobby

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Transient, Config&61;Game, NotPlaceable&41;  
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

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

Constructors

  Type Name Description
Public function  

ALobbyBeaconState ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function ALobbyBeaconPlayerState *

AddPlayer ( const FText& PlayerName,
const FUniqueNetIdRepl& UniqueId
)

 Create and replicate the appropriate player state for the new player
Protected function Virtual ALobbyBeaconPlayerState *

CreateNewPlayer ( const FText& PlayerName,
const FUniqueNetIdRepl& UniqueId
)

 Create a new player for this lobby beacon state
Public function Const void Output current state of lobby to log
Public function Const int32  
Public function Const int32  
Public function ALobbyBeaconPlayerState *

GetPlayer ( const FUniqueNetIdRepl& UniqueId
)

 Get an existing player in the lobby
Public function ALobbyBeaconPlayerState *

GetPlayer ( const FString& UniqueId
)

 Get an existing player in the lobby
Public function ALobbyBeaconPlayerState *

GetPlayer ( const AOnlineBeaconClient* ClientActor
)

 Get an existing player in the lobby
Public function Const bool  
Protected function void One sec tick function to handle countdowns
Public function FOnLobbyStarted &  
Public function FOnLobbyWaitingForPlayersUpdate &  
Public function FOnPlayerLobbyStateChanged &  
Public function FOnPlayerLobbyStateChanged &  
Protected function Virtual void

OnPostLobbyStartedTickInternal ( double DeltaTime
)

 Internal helper function called as part of OneSecTick if the lobby has been started already
Protected function Virtual void

OnPreLobbyStartedTickInternal ( double DeltaTime
)

 Internal helper function called as part of OneSecTick if the lobby hasn't been started yet
Protected function UFunction void Handle the lobby starting
Protected function UFunction void Handle notification of time left to wait for lobby to start
Public function void

RemovePlayer ( const FUniqueNetIdRepl& UniqueId
)

 Remove an existing player from the lobby
Public function Virtual Const bool Determines whether the beacon state requires a full game before allowing a lobby to start; False by default
Public function void Start the lobby for incoming players
Public function Virtual void Start the waiting for other players (first player logged in success)
Public function void

UpdatePartyLeader ( const FUniqueNetIdRepl& PartyMemberId,
const FUniqueNetIdRepl& NewPartyLeaderId
)

 Update the party leader for a given player

Overridden from AActor

  Type Name Description
Public function Virtual Const bool

IsNetRelevantFor ( const AActor* RealViewer,
const AActor* ViewTarget,
const FVector& SrcLocation
)

 Checks to see if this actor is relevant for a specific network connection
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page