AOnlineBeacon | Unreal Engine 5.7 Documentation

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


Name	AOnlineBeacon
Type	class
Header File	/Engine/Plugins/Online/OnlineSubsystemUtils/Source/OnlineSubsystemUtils/Public/OnlineBeacon.h
Include Path	#include "OnlineBeacon.h"

Syntax

UCLASS (MinimalAPI, Transient, Config=Engine, NotPlaceable)  
class AOnlineBeacon :  
    public AActor ,  
    public FNetworkNotify

Name	Remarks	Include Path	Unreal Specifiers
AOnlineBeacon ( const FObjectInitializer& ObjectInitializer )		OnlineBeacon.h

Name	Remarks	Include Path
virtual void DestroyBeacon()	Beacon cleanup and net driver destruction	OnlineBeacon.h
EBeaconState::Type GetBeaconState()	Get the current state of the beacon	OnlineBeacon.h
virtual void HandleNetworkFailure ( UWorld* World, UNetDriver* NetDriver, ENetworkFailure::Type FailureType, const FString& ErrorString )	Notification of network error messages, allows a beacon to handle the failure	OnlineBeacon.h
void PauseBeaconRequests ( bool bPause )	Set Beacon state@bPause should the beacon stop accepting requests	OnlineBeacon.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason )		OnlineBeacon.h
virtual UNetConnection * GetNetConnection()		OnlineBeacon.h
virtual const AActor * GetNetOwner()		OnlineBeacon.h
virtual bool IsLevelBoundsRelevant()		OnlineBeacon.h
virtual bool IsNetRelevantFor ( const AActor* RealViewer, const AActor* ViewTarget, const FVector& SrcLocation ) const		OnlineBeacon.h
virtual bool IsRelevancyOwnerFor ( const AActor* ReplicatedActor, const AActor* ActorOwner, const AActor* ConnectionActor ) const		OnlineBeacon.h
virtual void OnActorChannelOpen ( FInBunch& InBunch, UNetConnection* Connection )		OnlineBeacon.h

Name	Remarks	Include Path	Unreal Specifiers
virtual void NotifyAcceptedConnection ( UNetConnection* Connection )		OnlineBeacon.h
virtual bool NotifyAcceptingChannel ( UChannel* Channel )		OnlineBeacon.h
virtual EAcceptConnection::Type NotifyAcceptingConnection()		OnlineBeacon.h
virtual void NotifyControlMessage ( UNetConnection* Connection, uint8 MessageType, FInBunch& Bunch )		OnlineBeacon.h

Name	Remarks	Include Path
void CleanupNetDriver()		OnlineBeacon.h
virtual bool InitBase()	Common initialization for all beacon types	OnlineBeacon.h
virtual void OnFailure()	Notification that failure needs to be handled	OnlineBeacon.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool HasNetOwner()	Overridden to return that player controllers are capable of RPCs	OnlineBeacon.h