Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystemUtils > UPartyBeaconState

Light Theme

Dark Theme

UPartyBeaconState

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPartyBeaconState

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Transient, NotPlaceable, Config=Engine)
class UPartyBeaconState : public UObject

Remarks

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

Variables

	Name	Description
bool	bEnableRemovalRequests	Process requests from clients to remove players from beacon
bool	bRestrictCrossConsole	Are multiple consoles types allowed to play together
int32	ForceTeamNum	Team that everyone is forced to in single team games
int32	MaxReservations	Maximum allowed reservations
int32	NumConsumedReservations	Number of currently consumed reservations
int32	NumPlayersPerTeam	Number of players on each team for balancing
int32	NumTeams	Number of teams in the game
TArray< FString...	PlatformCrossplayRestrictions	Platform crossplay restrictions.
TArray< FPartyB...	PlatformTypeMapping
TArray< FUnique...	PlayersPendingJoin	Players that are expected to join shortly
TArray< FPartyR...	Reservations	Current reservations in the system
int32	ReservedHostTeamNum	Team that the host has been assigned to
FName	SessionName	Session tied to the beacon
FName	TeamAssignmentMethod	Team assignment method

Constructors

	Name	Description
	UPartyBeaconState ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AddReservation ( const FPartyReservation& Reservati... )	Add a reservation to the beacon state, tries to assign a team
bool	AreTeamsAvailable ( const FPartyReservation& Reservati... )	Determine if there are any teams that can fit the current party request.
void	BestFitTeamAssignmentJiggle()	Arrange reservations to make the most room available on a single team allowing larger parties to fit into this session Since teams change, this shouldn't be used after the teams have been set in the game logic
bool	ChangeTeam ( const FUniqueNetIdRepl& PartyLeade..., int32 NewTeamNum )	Place a party on a new team, party must fit and team must exist
bool	CrossPlayAllowed ( const FPartyReservation& Reservati... )	Perform a cross play compatible check for the new reservation against existing reservations
bool	DoesReservationFit ( const FPartyReservation& Reservati... )	Determine if this reservation fits all rules for fitting in the game
void	DumpReservations()	Output current state of reservations to log
int32	GetExistingReservation ( const FUniqueNetIdRepl& PartyLeade... )	Get an existing reservation for a given party
int32	GetExistingReservationContainingMember ( const FUniqueNetIdRepl& PartyMembe... )	Get an existing reservation containing a given party member
int32	GetMaxAvailableTeamSize()	Determine the maximum team size that can be accommodated based on the current reservation slots occupied.
int32	GetMaxPlayersPerTeam()	Get the max number of players per team
int32	GetMaxReservations()
int32	GetNumConsumedReservations()
int32	GetNumPlayersOnTeam ( int32 TeamIdx )	Get the number of current players on a given team.
int32	GetNumTeams()	Get the number of teams.
bool	GetPartyLeader ( const FUniqueNetIdRepl& InPartyMem..., FUniqueNetIdRepl& OutPartyLeaderId )	Get the party leader for a given unique id
int32	GetPlayersOnTeam ( int32 TeamIndex, TArray< FUniqueNetIdRepl >& TeamMe... )	Get all the known players on a given team
bool	GetPlayerValidation ( const FUniqueNetId& PlayerId, FString& OutValidation )	Obtain player validation string from party reservation entry
int32	GetRemainingReservations()
int32	GetReservationCount()	Get the current reservation count inside the beacon this is NOT the number of players in the game
int32	GetReservationPlatformCount ( const FString& InPlatform, bool bIncludeMappedPlatforms )	Get a count of all players for a given platform
TArray< FPar...	GetReservations()
FName	GetSessionName()
int32	GetTeamAssignment ( const FPartyReservation& Party )	Determine the team number for the given party reservation request.
int32	GetTeamForCurrentPlayer ( const FUniqueNetId& PlayerId )	Get the team index for a given player
bool	HasCrossplayOptOutReservation()
bool	InitState ( int32 InTeamCount, int32 InTeamSize, int32 InMaxReservations, FName InSessionName, int32 InForceTeamNum, bool bEnableRemovalRequests )	Initialize this state object
void	InitTeamArray()	Randomly assign a team for the reservation configuring the beacon
bool	IsBeaconFull()
bool	PlayerHasReservation ( const FUniqueNetId& PlayerId )	Does a given player id have an existing reservation
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
void	RegisterAuthTicket ( const FUniqueNetIdRepl& InPartyMem..., const FString& InAuthTicket )	Register user auth ticket with the reservation system Must have an existing reservation entry
bool	RemovePlayer ( const FUniqueNetIdRepl& PlayerId )	Remove a single player from their party's reservation PlayerId player to remove
bool	RemoveReservation ( const FUniqueNetIdRepl& PartyLeade... )	Remove an entire reservation from this state object
void	SanityCheckReservations ( const bool bIgnoreEmptyReservations )	Check that our reservations are in a good state
void	SetTeamAssignmentMethod ( FName NewAssignmentMethod )	Define the method for assignment new reservations to teams
bool	SwapTeams ( const FUniqueNetIdRepl& PartyLeade..., const FUniqueNetIdRepl& OtherParty... )	Swap the parties between teams, parties must be able to fit on other team after swap
bool	UpdateMemberPlatform ( const FUniqueNetIdRepl& PartyMembe..., const FString& PlatformName )	Updates the platform on an existing reservation (Used when MMS does not set a platform when handing out a match assignment)
void	UpdatePartyLeader ( const FUniqueNetIdRepl& InPartyMem..., const FUniqueNetIdRepl& NewPartyLe... )	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)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss