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

Light Theme

Dark Theme

AOnlineBeacon

Base class for beacon communication (Unreal Networking, but outside normal gameplay traffic)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AOnlineBeacon

AOnlineBeaconClient

	ALobbyBeaconClient
	APartyBeaconClient
	AQosBeaconClient
	ASpectatorBeaconClient
	ATestBeaconClient

AOnlineBeaconHost

References

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

Syntax

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

Remarks

Base class for beacon communication (Unreal Networking, but outside normal gameplay traffic)

Variables

	Name	Description
float	BeaconConnectionInitialTimeout	Time beacon will wait to establish a connection with the beacon host
float	BeaconConnectionTimeout	Time beacon will wait for packets after establishing a connection before giving up
EBeaconState::T...	BeaconState	State of beacon
FDelegateHandle	HandleNetworkFailureDelegateHandle	Handle to the registered HandleNetworkFailure delegate
UNetDriver *...	NetDriver	Net driver routing network traffic
FName	NetDriverDefinitionName	Name of definition to use when creating the net driver

Constructors

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

Functions

	Name	Description
void	DestroyBeacon()	Beacon cleanup and net driver destruction
EBeaconState...	GetBeaconState()	Get the current state of the beacon
void	HandleNetworkFailure ( UWorld* World, UNetDriver* NetDriver, ENetworkFailure::Type FailureType, const FString& ErrorString )	Notification of network error messages, allows a beacon to handle the failure
bool	InitBase()	Common initialization for all beacon types
void	OnFailure()	Notification that failure needs to be handled
void	PauseBeaconRequests ( bool bPause )	Set Beacon state should the beacon stop accepting requests

Overridden from AActor

	Name	Description
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
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
bool	HasNetOwner()	Overridden to return that player controllers are capable of RPCs
bool	IsLevelBoundsRelevant()	Indicates whether this actor should participate in level bounds calculations
bool	IsNetRelevantFor ( const AActor* RealViewer, const AActor* ViewTarget, const FVector& SrcLocation )	Checks to see if this actor is relevant for a specific network connection
bool	IsRelevancyOwnerFor ( const AActor* ReplicatedActor, const AActor* ActorOwner, const AActor* ConnectionActor )	Check if this actor is the owner when doing relevancy checks for actors marked bOnlyRelevantToOwner
void	OnActorChannelOpen ( FInBunch& InBunch, UNetConnection* Connection )	Allows for a specific response from the actor when the actor channel is opened (client side)

Overridden from FNetworkNotify

	Name	Description
void	NotifyAcceptedConnection ( UNetConnection* Connection )	Notification that a new connection has been created/established as a result of a remote request, previously approved by NotifyAcceptingConnection
bool	NotifyAcceptingChannel ( UChannel* Channel )	Notification that a new channel is being created/opened as a result of a remote request (Actor creation, etc)
EAcceptConne...	NotifyAcceptingConnection()	Notification that an incoming connection is pending, giving the interface a chance to reject the request
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())

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

Take our survey

Dismiss