1. Epic GamesDeveloper
  3. AOnlineBeacon

AOnlineBeacon

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

API > API/Plugins > API/Plugins/OnlineSubsystemUtils

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function  

AOnlineBeacon ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function Virtual void Beacon cleanup and net driver destruction
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Const EBeaconState::Type Get the current state of the beacon
Public function Virtual Const UNetConnection *  
Public function Virtual Const const AActor *  
Public function 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
Protected function Virtual Const bool Overridden to return that player controllers are capable of RPCs
Protected function Virtual bool Common initialization for all beacon types
Public function Virtual Const bool  
Public function Virtual Const bool

IsNetRelevantFor ( const AActor* RealViewer,
const AActor* ViewTarget,
const FVector& SrcLocation
)

  
Public function Virtual Const bool

IsRelevancyOwnerFor ( const AActor* ReplicatedActor,
const AActor* ActorOwner,
const AActor* ConnectionActor
)

  
Public function Virtual void

NotifyAcceptedConnection ( UNetConnection* Connection
)

  
Public function Virtual bool

NotifyAcceptingChannel ( UChannel* Channel
)

  
Public function Virtual EAcceptConnection::Type  
Public function Virtual void

NotifyControlMessage ( UNetConnection* Connection,
uint8 MessageType,
FInBunch& Bunch
)

  
Public function Virtual void

OnActorChannelOpen ( FInBunch& InBunch,
UNetConnection* Connection
)

  
Protected function Virtual void Notification that failure needs to be handled
Public function void

PauseBeaconRequests ( bool bPause
)

 Set Beacon state@bPause should the beacon stop accepting requests

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page