1. Epic GamesDeveloper
  3. ASpectatorBeaconClient

ASpectatorBeaconClient

A beacon client used for making reservations with an existing game session

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

A beacon client used for making reservations with an existing game session

   
Name ASpectatorBeaconClient
Type class
Header File /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/SpectatorBeaconClient.h
Include Path #include "SpectatorBeaconClient.h"

Syntax

UCLASS (MinimalAPI, Transient, NotPlaceable, Config=Engine)  
class ASpectatorBeaconClient : public AOnlineBeaconClient

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ASpectatorBeaconClient ( const FObjectInitializer& ObjectInitializer
)

   SpectatorBeaconClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CancelReservation ()

 Cancel an existing request to the remote host to revoke allocated space on the server. SpectatorBeaconClient.h  

virtual void ClientCancelReservationResponse ( ESpectatorReservationResult::Type ReservationResponse
)

 Response from the host session after making a cancellation request SpectatorBeaconClient.h
  • Client
  • Reliable

virtual void ClientReservationResponse ( ESpectatorReservationResult::Type ReservationResponse
)

 Response from the host session after making a reservation request SpectatorBeaconClient.h
  • Client
  • Reliable

virtual void ClientSendReservationFull()

 Response from the host session that the reservation is full SpectatorBeaconClient.h
  • Client
  • Reliable

virtual void ClientSendReservationUpdates ( int32 NumRemainingReservations
)

 Response from the host session that the reservation count has changed SpectatorBeaconClient.h
  • Client
  • Reliable

const FSpectatorReservation & GetPendingReservation()

   SpectatorBeaconClient.h  

FOnReservationCountUpdate & OnReservationCountUpdate()

 Delegate triggered when the host indicated a reservation count has changed SpectatorBeaconClient.h  

FOnReservationFull & OnReservationFull()

 Delegate triggered when the host indicated the reservation is full SpectatorBeaconClient.h  

FOnSpectatorReservationRequestComplete & OnReservationRequestComplete()

 Delegate triggered when a response from the spectator beacon host has been received SpectatorBeaconClient.h  

virtual bool RequestReservation ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingSpectator,
const FPlayerReservation& Reservation
)

 Sends a request to the remote host to allow the specified members to reserve space in the host's session. SpectatorBeaconClient.h  

virtual bool RequestReservation ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingSpectator,
const FPlayerReservation& Reservation
)

 Sends a request to the remote host to allow the specified members to reserve space in the host's session. SpectatorBeaconClient.h  

Overridden from AOnlineBeaconClient

Name Remarks Include Path Unreal Specifiers

virtual void OnConnected()

 A connection has been made and RPC/replication can begin SpectatorBeaconClient.h  

Overridden from AOnlineBeacon

Name Remarks Include Path Unreal Specifiers

virtual void OnFailure()

 Notification that failure needs to be handled SpectatorBeaconClient.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   SpectatorBeaconClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearTimers ( bool bCallFailSafeIfNeeded
)

 Clear out all the timer handles listed above SpectatorBeaconClient.h  

FTimerHandle DelayResponse ( FTimerDelegate& Delegate,
float Delay
)

 Trigger the given delegate at a later time SpectatorBeaconClient.h  

void OnCancelledComplete()

 Delegate triggered when a cancel reservation request is complete SpectatorBeaconClient.h  

void OnCancelledFailsafe()

 Delegate triggered if the client doesn't hear from the server in time SpectatorBeaconClient.h  

void ProcessCancelReservationResponse ( ESpectatorReservationResult::Type ReservationResponse
)

 Process a response to our CancelReservation request to the server SpectatorBeaconClient.h  

void ProcessReservationFull()

 Process a response from the server that the reservation beacon is full SpectatorBeaconClient.h  

void ProcessReservationResponse ( ESpectatorReservationResult::Type ReservationResponse
)

 Process a response to our RequestReservation request to the server SpectatorBeaconClient.h  

void ProcessReservationUpdate ( int32 NumRemainingReservations
)

 Process a response from the server with an update to the number of consumed reservations SpectatorBeaconClient.h  

virtual void ServerCancelReservationRequest ( const FUniqueNetIdRepl& Spectator
)

 Tell the server to cancel a pending or existing reservation SpectatorBeaconClient.h
  • Server
  • Reliable
  • WithValidation

virtual void ServerReservationRequest ( const FString& SessionId,
const FSpectatorReservation& Reservation
)

 Tell the server about the reservation request being made SpectatorBeaconClient.h
  • Server
  • Reliable
  • WithValidation

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page