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

Light Theme

Dark Theme

USpectatorBeaconState

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USpectatorBeaconState

References

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

Syntax

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

Remarks

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

Variables

	Name	Description
bool	bRestrictCrossConsole	Are multiple consoles types allowed to play together
int32	MaxReservations	Maximum allowed reservations
int32	NumConsumedReservations	Number of currently consumed reservations
TArray< TShared...	PlayersPendingJoin	Players that are expected to join shortly
TArray< FSpecta...	Reservations	Current reservations in the system
FName	SessionName	Session tied to the beacon

Constructors

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

Functions

	Name	Description
bool	AddReservation ( const FSpectatorReservation& Reser... )	Add a reservation to the beacon state, tries to assign a team
bool	CrossPlayAllowed ( const FSpectatorReservation& Reser... )	Perform a cross play compatible check for the new reservation against existing reservations
bool	DoesReservationFit ( const FSpectatorReservation& Reser... )	Determine if this reservation fits all rules for fitting in the game
void	DumpReservations()	Output current state of reservations to log
int32	GetExistingReservation ( const FUniqueNetIdRepl& Spectator )	Get an existing reservation for a given spectator
int32	GetMaxReservations()
int32	GetNumConsumedReservations()
bool	GetPlayerValidation ( const FUniqueNetId& PlayerId, FString& OutValidation )	Obtain player validation string from spectator reservation entry
int32	GetRemainingReservations()
int32	GetReservationCount()	Get the current reservation count inside the beacon this is NOT the number of players in the game
int32	GetReservationPlatformCount ( const FString& InPlatform )	Get a count of all players for a given platform
TArray< FSpe...	GetReservations()
FName	GetSessionName()
bool	HasCrossplayOptOutReservation()
bool	InitState ( int32 InMaxReservations, FName InSessionName )	Initialize this state object
bool	IsBeaconFull()
bool	PlayerHasReservation ( const FUniqueNetId& PlayerId )	Does a given player id have an existing reservation
void	RegisterAuthTicket ( const FUniqueNetIdRepl& InSpectato..., const FString& InAuthTicket )	Register user auth ticket with the reservation system Must have an existing reservation entry
bool	RemovePlayer ( const FUniqueNetIdRepl& PlayerId )	Remove a single player from their reservation PlayerId player to remove
bool	RemoveReservation ( const FUniqueNetIdRepl& Spectator )	Remove an entire reservation from this state object
void	SanityCheckReservations ( const bool bIgnoreEmptyReservations )	Check that our reservations are in a good state
bool	UpdateMemberPlatform ( const FUniqueNetIdRepl& Spectator, const FString& PlatformName )	Updates the platform on an existing reservation (Used when MMS does not set a platform when handing out a match assignment)

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

Take our survey

Dismiss