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 > OnlineSubsystemUtils > ASpectatorBeaconHost

Light Theme

Dark Theme

ASpectatorBeaconHost

A beacon host used for taking reservations for an existing game session

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AOnlineBeaconHostObject

ASpectatorBeaconHost

References

Module	OnlineSubsystemUtils
Header	/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/SpectatorBeaconHost.h
Include	#include "SpectatorBeaconHost.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, NotPlaceable, Config=Engine)
class ASpectatorBeaconHost : public AOnlineBeaconHostObject

Remarks

A beacon host used for taking reservations for an existing game session

Variables

	Name	Description
bool	bLogoutOnSessionTimeout	Do the timeouts below cause a player to be removed from the reservation list
FOnCancelationR...	CancelationReceived	Delegate fired when the beacon indicates a reservation cancellation
FOnSpectatorDup...	DuplicateReservation	Delegate fired when the beacon detects a duplicate reservation
FOnNewPlayerAdd...	NewPlayerAddedDelegate	Delegate fired when reservation has been added
FOnReservationU...	ReservationChanged	Delegate fired when the beacon indicates a reservation add/remove
FOnReservationU...	ReservationsFull	Delegate fired when the beacon indicates all reservations are taken
float	SessionTimeoutSecs	Seconds that can elapse before a reservation is removed due to player not being registered with the session
USpectatorBeaco...	State	State of the beacon
float	TravelSessionTimeoutSecs	Seconds that can elapse before a reservation is removed due to player not being registered with the session during a travel
FOnSpectatorVal...	ValidatePlayers	Delegate fired when asking the beacon owner if this reservation is legit

Constructors

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

Functions

	Name	Description
ESpectatorRe...	AddSpectatorReservation ( const FSpectatorReservation& Reser... )	Attempts to add a spectator reservation to the beacon
bool	DoesSessionMatch ( const FString& SessionId )	Does the session match the one associated with this beacon
void	DumpReservations()	Output current state of reservations to log
int32	GetMaxReservations()	Get the maximum number of reservations allowed inside the beacon
int32	GetNumConsumedReservations()	Get the number of reservations actually used/consumed across all parties inside the beacon
bool	GetPlayerValidation ( const FUniqueNetId& PlayerId, FString& OutValidation )	Obtain player validation string from spectator reservation entry
int32	GetReservationCount()	Get the current reservation count inside the beacon NOTE: This is NOT the same as the number of consumed reservations across all parties, just the total number of reservations!
TSubclassOf<...	GetSpectatorBeaconHostClass()
USpectatorBe...	GetState()
void	HandlePlayerLogout ( const FUniqueNetIdRepl& PlayerId )	Notify the beacon of a player logout
bool	InitFromBeaconState ( USpectatorBeaconState* PrevSta... )	Initialize the spectator host beacon from a previous state/configuration all existing reservations and configuration values are preserved
bool	InitHostBeacon ( int32 InMaxReservations, FName InSessionName )	Initialize the spectator host beacon
void	NewPlayerAdded ( const FPlayerReservation& NewPlaye... )	Handle a newly added player
void	NotifyReservationEventNextFrame ( FOnReservationUpdate& ReservationE... )
FOnCancelati...	OnCancelationReceived()	Delegate fired when a the beacon host cancels a reservation
FOnSpectator...	OnDuplicateReservation()	Delegate fired when a the beacon detects a duplicate reservation
FOnNewPlayer...	OnNewPlayerAdded()	Delegate fired when the beacon host adds a new player
FOnReservati...	OnReservationChanged()	Delegate fired when a the beacon host detects that all reservations are full
FOnReservati...	OnReservationsFull()	Crossplay Delegate fired when a the beacon host detects a reservation addition/removal
FOnSpectator...	OnValidatePlayers()	Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc)
bool	PlayerHasReservation ( const FUniqueNetId& PlayerId )	Does a given player id have an existing reservation
void	ProcessCancelReservationRequest ( ASpectatorBeaconClient* Client, const FUniqueNetIdRepl& Spectator )	Handle a reservation cancellation request received from an incoming client
void	ProcessReservationRequest ( ASpectatorBeaconClient* Client, const FString& SessionId, const FSpectatorReservation& Reser... )	Handle a reservation request received from an incoming client
void	RegisterAuthTicket ( const FUniqueNetIdRepl& InSpectato..., const FString& InAuthTicket )	Register user auth ticket with the reservation system Must have an existing reservation entry
ESpectatorRe...	RemoveSpectatorReservation ( const FUniqueNetIdRepl& Spectator )	Attempts to remove a spectator reservation from the beacon
void	SendReservationUpdates()	Update clients with current reservation information

Overridden from AActor

		Name	Description
	void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.

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

Dismiss