1. Epic GamesDeveloper
  3. ASpectatorBeaconHost

ASpectatorBeaconHost

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/SpectatorBeaconHost.h
Include #include "SpectatorBeaconHost.h"

Syntax

UCLASS&40;Transient, NotPlaceable, Config&61;Engine&41;  
class ASpectatorBeaconHost : public AOnlineBeaconHostObject

Remarks

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

Variables

  Type Name Description
Protected variable UProperty Config bool bIsValidationStrRequired Do spectators require validation strings.
Protected variable UProperty Config bool bLogoutOnSessionTimeout Do the timeouts below cause a player to be removed from the reservation list
Protected variable FOnCancelationReceived CancelationReceived Delegate fired when the beacon indicates a reservation cancellation
Protected variable FOnSpectatorDuplicateReservation DuplicateReservation Delegate fired when the beacon detects a duplicate reservation
Protected variable FOnNewPlayerAdded NewPlayerAddedDelegate Delegate fired when reservation has been added
Protected variable FOnReservationUpdate ReservationChanged Delegate fired when the beacon indicates a reservation add/remove
Protected variable FOnReservationUpdate ReservationsFull Delegate fired when the beacon indicates all reservations are taken
Protected variable UProperty Transient, Config float SessionTimeoutSecs Seconds that can elapse before a reservation is removed due to player not being registered with the session
Protected variable UProperty TObjectPtr< USpectatorBeaconState > State State of the beacon
Protected variable UProperty Transient, Config float TravelSessionTimeoutSecs Seconds that can elapse before a reservation is removed due to player not being registered with the session during a travel
Protected variable FOnSpectatorValidatePlayers ValidatePlayers Delegate fired when asking the beacon owner if this reservation is legit

Constructors

  Type Name Description
Public function  

ASpectatorBeaconHost ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual ESpectatorReservationResult::Type

AddSpectatorReservation ( const FSpectatorReservation& ReservationRequest
)

 Attempts to add a spectator reservation to the beacon
Protected function Const bool

DoesSessionMatch ( const FString& SessionId
)

 Does the session match the one associated with this beacon
Public function Virtual Const void Output current state of reservations to log
Public function Virtual Const int32 Get the maximum number of reservations allowed inside the beacon
Public function Virtual Const int32 Get the number of reservations actually used/consumed across all parties inside the beacon
Public function Virtual Const bool

GetPlayerValidation ( const FUniqueNetId& PlayerId,
FString& OutValidation
)

 Obtain player validation string from spectator reservation entry
Public function Virtual Const int32 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!
Protected function Virtual Const TSubclassOf< USpectatorBeaconState >  
Public function Const USpectatorBeaconState *  
Public function Virtual void

HandlePlayerLogout ( const FUniqueNetIdRepl& PlayerId
)

 Notify the beacon of a player logout
Public function Virtual bool Initialize the spectator host beacon from a previous state/configuration all existing reservations and configuration values are preserved
Public function Virtual bool

InitHostBeacon ( int32 InMaxReservations,
FName InSessionName
)

 Initialize the spectator host beacon
Protected function void

NewPlayerAdded ( const FPlayerReservation& NewPlayer
)

 Handle a newly added player
Protected function void  
Public function FOnCancelationReceived & Delegate fired when a the beacon host cancels a reservation
Public function FOnSpectatorDuplicateReservation & Delegate fired when a the beacon detects a duplicate reservation
Public function FOnNewPlayerAdded & Delegate fired when the beacon host adds a new player
Public function FOnReservationUpdate & Delegate fired when a the beacon host detects that all reservations are full
Public function FOnReservationUpdate & Crossplay Delegate fired when a the beacon host detects a reservation addition/removal
Public function FOnSpectatorValidatePlayers & Delegate called when the beacon gets any request, allowing the owner to validate players at a higher level (bans,etc)
Public function Virtual Const bool

PlayerHasReservation ( const FUniqueNetId& PlayerId
)

 Does a given player id have an existing reservation
Public function Virtual void Handle a reservation cancellation request received from an incoming client
Public function Virtual void

ProcessReservationRequest ( ASpectatorBeaconClient* Client,
const FString& SessionId,
const FSpectatorReservation& ReservationRequest
)

 Handle a reservation request received from an incoming client
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 ESpectatorReservationResult::Type Attempts to remove a spectator reservation from the beacon
Protected function void Update clients with current reservation information

Overridden from AActor

  Type Name Description
Public function Virtual void

Tick ( float DeltaSeconds
)

 Function called every frame on this Actor.

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