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 > AOnlineBeaconHostObject

Light Theme

Dark Theme

AOnlineBeaconHostObject

Base class for any unique beacon connectivity, paired with an [AOnlineBeaconClient](API\Plugins\OnlineSubsystemUtils\AOnlineBeaconClient) implementation

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AOnlineBeaconHostObject

	ALobbyBeaconHost
	APartyBeaconHost
	AQosBeaconHost
	ASpectatorBeaconHost
	ATestBeaconHost

References

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

Syntax

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

Remarks

Base class for any unique beacon connectivity, paired with an AOnlineBeaconClient implementation

By defining a beacon type and implementing the ability to spawn unique AOnlineBeaconClients, any two instances of the engine can communicate with each other without officially connecting through normal Unreal networking

Variables

	Name	Description
FString	BeaconTypeName	Custom name for this beacon
TArray< AOnline...	ClientActors	List of all client beacon actors with active connections
TSubclassOf< AO...	ClientBeaconActorClass	Class reference for spawning client beacon actor

Constructors

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

Functions

	Name	Description
void	DisconnectClient ( AOnlineBeaconClient* ClientAct... )	Disconnect a given client from the host
EBeaconState...	GetBeaconState()	Get the state of the beacon (accepting/rejecting connections)
const FStrin...	GetBeaconType()	Get the type of beacon supported by this host
TSubclassOf<...	GetClientBeaconActorClass()	Simple accessor for client beacon actor class
FName	GetNetDriverName()
int32	GetNumClientActors()
void	NotifyClientDisconnected ( AOnlineBeaconClient* LeavingCl... )	Notification that a client has been disconnected from the host in some way (timeout, client initiated, etc)
void	OnClientConnected ( AOnlineBeaconClient* NewClient..., UNetConnection* ClientConnecti... )	Delegate triggered when a new client connection is made
AOnlineBeaco...	SpawnBeaconActor ( UNetConnection* ClientConnecti... )	Each beacon host must be able to spawn the appropriate client beacon actor to communicate with the initiating client
void	Unregister()	Called when this class is unregistered by the beacon host Do any necessary cleanup.

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

Take our survey

Dismiss