1. Epic GamesDeveloper
  3. APartyBeaconHost

APartyBeaconHost

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

Syntax

UCLASS&40;Transient, NotPlaceable, Config&61;Engine&41;  
class APartyBeaconHost : 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 party members 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 FOnDuplicateReservation 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< UPartyBeaconState > 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 FOnValidatePlayers ValidatePlayers Delegate fired when asking the beacon owner if this reservation is legit

Constructors

  Type Name Description
Public function  

APartyBeaconHost ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual EPartyReservationResult::Type

AddPartyReservation ( const FPartyReservation& ReservationRequest
)

 Attempts to add a party reservation to the beacon
Public function Virtual bool

ChangeTeam ( const FUniqueNetIdRepl& PartyLeader,
int32 NewTeamNum
)

 Place a party on a new team, party must fit and team must exist
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 Determine the maximum team size that can be accommodated based on the current reservation slots occupied.
Public function Virtual Const int32 Get the max number of players per team
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 Const int32

GetNumPlayersOnTeam ( int32 TeamIdx
)

 Get the number of players on a team across all existing reservations
Public function Const int32 Get the number of teams.
Protected function Virtual Const TSubclassOf< UPartyBeaconState >  
Public function Const bool

GetPartyLeader ( const FUniqueNetIdRepl& InPartyMemberId,
FUniqueNetIdRepl& OutPartyLeaderId
)

 Get the party leader for a given unique id
Public function Const int32

GetPlayersOnTeam ( int32 TeamIndex,
TArray< FUniqueNetIdRepl >& TeamMembers
)

 Get all the known players on a given team
Public function Virtual Const bool

GetPlayerValidation ( const FUniqueNetId& PlayerId,
FString& OutValidation
)

 Obtain player validation string from party 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!
Public function Virtual Const int32

GetReservationPlatformCount ( const FString& InPlatform,
bool bIncludeMappedPlatforms
)

 Get a count of all players for a given platform
Public function Const UPartyBeaconState *  
Public function Const int32 Finds the current team assignment of the given player net id.
Public function Virtual void

HandlePlayerLogout ( const FUniqueNetIdRepl& PlayerId
)

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

InitHostBeacon ( int32 InTeamCount,
int32 InTeamSize,
int32 InMaxReservations,
FName InSessionName,
int32 InForceTeamNum,
bool bInEnableRemovalRequests
)

 Initialize the party host beacon
Public function Const bool Do party members require validation strings.
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 FOnDuplicateReservation & 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 a reservation addition/removal
Public function FOnReservationUpdate & Delegate fired when a the beacon host detects that all reservations are full
Public function FOnValidatePlayers & 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
Protected function void

PlayerRemoved ( const FPlayerReservation& RemovedPlayer
)

 Handle a newly removed player
Public function Virtual void Handle a reservation cancellation request received from an incoming client
Public function Virtual void

ProcessReservationAddOrUpdateRequest ( APartyBeaconClient* Client,
const FString& SessionId,
const FPartyReservation& ReservationRequest
)

 Handle a reservation add or update request depending on reservation existance received from an incoming client
Public function Virtual void

ProcessReservationRequest ( APartyBeaconClient* Client,
const FString& SessionId,
const FPartyReservation& ReservationRequest
)

 Handle a reservation request received from an incoming client
Public function Virtual void

ProcessReservationUpdateRequest ( APartyBeaconClient* Client,
const FString& SessionId,
const FPartyReservation& ReservationUpdateRequest,
bool bIsRemovingMember
)

 Handle a reservation update request received from an incoming client
Public function Virtual bool

ReconfigureTeamAndPlayerCount ( int32 InNumTeams,
int32 InNumPlayersPerTeam,
int32 InNumReservations
)

 Reconfigures the beacon for a different team/player count configuration Allows dedicated server to change beacon parameters after a playlist configuration has been made Does no real checking against current reservations because we assume the UI wouldn't let this party start a gametype if they were too big to fit on a team together
Public function void

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

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

RemovePartyReservation ( const FUniqueNetIdRepl& PartyLeader
)

 Attempts to remove a party reservation from the beacon
Protected function void Update clients with current reservation information
Public function Virtual void

SetCompetitiveIntegrity ( bool bNewCompetitiveIntegrity
)

 Competitive integrity represents how "fair" we need to keep the game.
Public function Virtual void

SetTeamAssignmentMethod ( FName NewAssignmentMethod
)

 Define the method for assignment new reservations to teams
Public function Virtual Const bool Competitive integrity represents how "fair" we need to keep the game.
Public function Virtual bool

SwapTeams ( const FUniqueNetIdRepl& PartyLeader,
const FUniqueNetIdRepl& OtherPartyLeader
)

 Swap the parties between teams, parties must be of same size
Public function Virtual void

UpdatePartyLeader ( const FUniqueNetIdRepl& InPartyMemberId,
const FUniqueNetIdRepl& NewPartyLeaderId
)

 Update party leader for a given player with the reservation beacon (needed when party leader leaves, reservation beacon is in a temp/bad state until someone updates this)
Public function Virtual EPartyReservationResult::Type

UpdatePartyReservation ( const FPartyReservation& ReservationUpdateRequest,
bool bIsRemovingMembers
)

 Updates an existing party reservation on the beacon An existing reservation for this party leader must already exist

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