AMultiServerBeaconClient

An online beacon that helps manage connecting to MultiServer Networks, and replicating metadata about the MultiServer Network.

API > API/Plugins > API/Plugins/MultiServerReplication

An online beacon that helps manage connecting to MultiServer Networks, and replicating metadata about the MultiServer Network.

This Actor will exist on All MultiServer Nodes, and multiple MultiServerBeaconClient Actors may exist on non-Client Nodes, one for each other connected node.

   
Name AMultiServerBeaconClient
Type class
Header File /Engine/Plugins/Runtime/MultiServerReplication/Source/MultiServerReplication/Public/MultiServerBeaconClient.h
Include Path #include "MultiServerBeaconClient.h"

Syntax

UCLASS (Transient, Config=Engine, NotPlaceable)  
class AMultiServerBeaconClient : public AOnlineBeaconClient

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

AMultiServerBeaconClient()

   MultiServerBeaconClient.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OwningNode TObjectPtr< UMultiServerNode >   MultiServerBeaconClient.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetLocalPeerId()

 The Id on the local side of the connection MultiServerBeaconClient.h  

FString GetRemotePeerId()

 The Id on the other side of the connection MultiServerBeaconClient.h  
Actor Role on client beacons stays as authority, so this function can be used to determine whether this instance is acting as an authority. MultiServerBeaconClient.h  

void ServerUpdateMultipleLevelsVisibility ( const TArray< FUpdateLevelVisibilityLevelInfo >& LevelVisibilities
)

   MultiServerBeaconClient.h
  • Reliable
  • Server
  • WithValidation
  • SealedEvent

void SetOwningNode ( UMultiServerNode* InOwningNode
)

   MultiServerBeaconClient.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void ConnectToServer ( const FString& ConnectInfo
)

 Attempt to connect to another specified MultiServer node. MultiServerBeaconClient.h  

virtual void ServerUpdateLevelVisibility ( const FUpdateLevelVisibilityLevelInfo& LevelVisibility
)

   MultiServerBeaconClient.h
  • Reliable
  • Server
  • WithValidation

Overridden from AOnlineBeaconClient

Name Remarks Include Path Unreal Specifiers

virtual void OnConnected()

   MultiServerBeaconClient.h  

Overridden from AOnlineBeacon

Name Remarks Include Path Unreal Specifiers

virtual void DestroyBeacon()

   MultiServerBeaconClient.h  

virtual bool InitBase()

   MultiServerBeaconClient.h  

virtual void OnFailure()

   MultiServerBeaconClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

FName NetworkRemapPath ( FName InPackageName,
bool bReading
)

   MultiServerBeaconClient.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual void OnLevelAddedToWorld ( ULevel* Level,
UWorld* World
)

   MultiServerBeaconClient.h  

virtual void OnLevelRemovedFromWorld ( ULevel* Level,
UWorld* World
)

   MultiServerBeaconClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page