1. Epic GamesDeveloper
  3. USpectatorBeaconState

USpectatorBeaconState

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

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Transient, Config&61;Engine&41;  
class USpectatorBeaconState : public UObject

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Config bool bRestrictCrossConsole Are multiple consoles types allowed to play together
Protected variable UProperty Transient int32 MaxReservations Maximum allowed reservations
Protected variable UProperty Transient int32 NumConsumedReservations Number of currently consumed reservations
Protected variable TArray< FUniqueNetIdPtr > PlayersPendingJoin Players that are expected to join shortly
Protected variable UProperty Transient TArray< FSpectatorReservation > Reservations Current reservations in the system
Protected variable UProperty Transient FName SessionName Session tied to the beacon

Constructors

  Type Name Description
Public function  

USpectatorBeaconState ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool

AddReservation ( const FSpectatorReservation& ReservationRequest
)

 Add a reservation to the beacon state, tries to assign a team
Public function Virtual Const bool

CrossPlayAllowed ( const FSpectatorReservation& ReservationRequest
)

 Perform a cross play compatible check for the new reservation against existing reservations
Public function Virtual Const bool

DoesReservationFit ( const FSpectatorReservation& ReservationRequest
)

 Determine if this reservation fits all rules for fitting in the game
Public function Virtual Const void Output current state of reservations to log
Public function Virtual Const int32 Get an existing reservation for a given spectator
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Virtual Const bool

GetPlayerValidation ( const FUniqueNetId& PlayerId,
FString& OutValidation
)

 Obtain player validation string from spectator reservation entry
Public function Virtual Const int32  
Public function Virtual Const int32 Get the current reservation count inside the beacon this is NOT the number of players in the game
Public function Virtual Const int32

GetReservationPlatformCount ( const FString& InPlatform
)

 Get a count of all players for a given platform
Public function Virtual TArray< FSpectatorReservation > &  
Public function Virtual Const FName  
Public function Virtual Const bool  
Public function Virtual bool

InitState ( int32 InMaxReservations,
FName InSessionName
)

 Initialize this state object
Public function Virtual Const bool  
Public function Virtual Const bool

PlayerHasReservation ( const FUniqueNetId& PlayerId
)

 Does a given player id have an existing reservation
Public function void

RegisterAuthTicket ( const FUniqueNetIdRepl& InSpectatorId,
const FString& InAuthTicket
)

 Register user auth ticket with the reservation system Must have an existing reservation entry
Public function Virtual bool

RemovePlayer ( const FUniqueNetIdRepl& PlayerId
)

 Remove a single player from their reservationPlayerId player to remove
Public function Virtual bool

RemoveReservation ( const FUniqueNetIdRepl& Spectator
)

 Remove an entire reservation from this state object
Protected function Const void

SanityCheckReservations ( const bool bIgnoreEmptyReservations
)

 Check that our reservations are in a good state
Public function Virtual 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)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page