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

Light Theme

Dark Theme

AOnlineBeaconClient

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AOnlineBeacon

AOnlineBeaconClient

	ALobbyBeaconClient
	APartyBeaconClient
	AQosBeaconClient
	ASpectatorBeaconClient
	ATestBeaconClient

References

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

Syntax

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

Remarks

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

This is the actual actor that replicates across client/server and where all RPCs occur On the host, the life cycle is managed by an AOnlineBeaconHostObject On the client, the life cycle is managed by the game

Variables

	Name	Description
UNetConnection ...	BeaconConnection	Network connection associated with this beacon client instance
AOnlineBeaconHo...	BeaconOwner	Owning beacon host of this beacon actor (server only)
EBeaconConnecti...	ConnectionState	State of the connection
FOnHostConnecti...	HostConnectionFailure	Delegate for host beacon connection failures
FTimerHandle	TimerHandle_OnFailure	Handle for efficient management of OnFailure timer

Constructors

	Name	Description
	AOnlineBeaconClient ( const FObjectInitializer& ObjectIn... )	For backwards compatibility with newer engine encryption API

Functions

	Name	Description
AOnlineBeaco...	GetBeaconOwner()	Get the owner of this beacon actor, some host that is listening for connections (server side only, clients have no access)
FString	GetBeaconType()	Each beacon must have a unique type identifier
EBeaconConne...	GetConnectionState()	Get the connection state Higher level than the net connection because of the handshaking of the actors
const FUniqu...	GetUniqueId()	Get the unique id of the user on this connection (server side only)
bool	InitClient ( FURL& URL )	Initialize the client beacon with connection endpoint Creates the net driver and attempts to connect with the destination
void	OnConnected()	A connection has been made and RPC/replication can begin
FOnHostConne...	OnHostConnectionFailure()	Delegate triggered on failures to connect to a host beacon
void	SendInitialJoin()	Send the packet for triggering the initial join
void	SetBeaconOwner ( AOnlineBeaconHostObject* InBea... )	Set the owner of this beacon actor, some host that is listening for connections (server side only, clients have no access)
void	SetConnectionState ( EBeaconConnectionState NewConnectio... )	Set the connection state Higher level than the net connection because of the handshaking of the actors
void	SetEncryptionData ( const FEncryptionData& InEncryptio... )	Sets the encryption data that will be used for server connections.
void	SetNetConnection ( UNetConnection* NetConnection )	Associate this beacon with a network connection

Overridden from AOnlineBeacon

		Name	Description
	void	DestroyBeacon()	Beacon cleanup and net driver destruction
	void	OnFailure()	Notification that failure needs to be handled

Overridden from AActor

	Name	Description
bool	DestroyNetworkActorHandled()	Called by DestroyActor(), gives actors a chance to op out of actor destruction Used by network code to have the net connection timeout/cleanup first
UNetConnecti...	GetNetConnection()	Get the owning connection used for communicating between client/server
const AActor...	GetNetOwner()	Return the actor responsible for replication, if any. Typically the player controller
void	OnNetCleanup ( UNetConnection* Connection )	Handles cleaning up the associated Actor when killing the connection
void	Tick ( float DeltaSeconds )	Function called every frame on this Actor.
bool	UseShortConnectTimeout()	Used by the net connection to determine if a net owning actor should switch to using the shortened timeout value

Overridden from FNetworkNotify

		Name	Description
	void	NotifyControlMessage ( UNetConnection* Connection, uint8 MessageType, FInBunch& Bunch )	Handler for messages sent through a remote connection's control channel not required to handle the message, but if it reads any data from Bunch, it MUST read the ENTIRE data stream for that message (i.e. use FNetControlMessage::Receive())

Deprecated Functions

		Name	Description
	void	SetEncryptionKey ( TArrayView< uint8 > InEncryptionKey )	Use SetEncryptionData instead
	void	SetEncryptionToken ( const FString& InEncryptionToken )	Use SetEncryptionData instead

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

Take our survey

Dismiss