1. Epic GamesDeveloper
  3. APartyBeaconClient

APartyBeaconClient

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 APartyBeaconClient
Type class
Header File /Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/PartyBeaconClient.h
Include Path #include "PartyBeaconClient.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

APartyBeaconClient ( const FObjectInitializer& ObjectInitializer
)

   PartyBeaconClient.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. PartyBeaconClient.h  

virtual void ClientCancelReservationResponse ( EPartyReservationResult::Type ReservationResponse
)

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

virtual void ClientReservationResponse ( EPartyReservationResult::Type ReservationResponse
)

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

virtual void ClientSendReservationFull()

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

virtual void ClientSendReservationUpdates ( int32 NumRemainingReservations
)

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

const FPartyReservation & GetPendingReservation()

   PartyBeaconClient.h  

FOnReservationCountUpdate & OnReservationCountUpdate()

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

FOnReservationFull & OnReservationFull()

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

FOnReservationRequestComplete & OnReservationRequestComplete()

 Delegate triggered when a response from the party beacon host has been received PartyBeaconClient.h  

virtual bool RequestAddOrUpdateReservation ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

 Sends a request to the remote host. PartyBeaconClient.h  

virtual bool RequestReservation ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

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

virtual bool RequestReservation ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PartyMembers
)

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

virtual bool RequestReservationUpdate ( const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session. PartyBeaconClient.h  

virtual bool RequestReservationUpdate ( const FOnlineSessionSearchResult& DesiredHost,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session. PartyBeaconClient.h  

virtual bool RequestReservationUpdate ( const FString& ConnectInfoStr,
const FString& InSessionId,
const FUniqueNetIdRepl& RequestingPartyLeader,
const TArray< FPlayerReservation >& PlayersToAdd,
bool bRemovePlayers
)

 Sends an update request to the remote host to append additional members to an existing party in the host's session. PartyBeaconClient.h  

Overridden from AOnlineBeaconClient

Name Remarks Include Path Unreal Specifiers

virtual void OnConnected()

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

Overridden from AOnlineBeacon

Name Remarks Include Path Unreal Specifiers

virtual void OnFailure()

 Notification that failure needs to be handled PartyBeaconClient.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   PartyBeaconClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearTimers ( bool bCallFailSafeIfNeeded
)

 Clear out all the timer handles listed above PartyBeaconClient.h  

FTimerHandle DelayResponse ( FTimerDelegate& Delegate,
float Delay
)

 Trigger the given delegate at a later time PartyBeaconClient.h  

void OnCancelledComplete()

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

void OnCancelledFailsafe()

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

void ProcessCancelReservationResponse ( EPartyReservationResult::Type ReservationResponse
)

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

void ProcessReservationFull()

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

void ProcessReservationResponse ( EPartyReservationResult::Type ReservationResponse
)

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

void ProcessReservationUpdate ( int32 NumRemainingReservations
)

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

virtual void ServerAddOrUpdateReservationRequest ( const FString& SessionId,
const FPartyReservation& Reservation
)

 Tell the server about the reservation add or update request being made PartyBeaconClient.h
  • Server
  • Reliable
  • WithValidation

virtual void ServerCancelReservationRequest ( const FUniqueNetIdRepl& PartyLeader
)

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

virtual void ServerRemoveMemberFromReservationRequest ( const FString& SessionId,
const FPartyReservation& ReservationUpdate
)

 Tell the server that we are removing members from our reservation PartyBeaconClient.h
  • Server
  • Reliable
  • WithValidation

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

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

virtual void ServerUpdateReservationRequest ( const FString& SessionId,
const FPartyReservation& ReservationUpdate
)

 Tell the server about the reservation update request being made PartyBeaconClient.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