1. Epic GamesDeveloper
  3. IDisplayClusterBlueprintAPI

IDisplayClusterBlueprintAPI

Blueprint API interface

API > API/Plugins > API/Plugins/DisplayCluster

Blueprint API interface

   
Name IDisplayClusterBlueprintAPI
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Blueprints/IDisplayClusterBlueprintAPI.h
Include Path #include "Blueprints/IDisplayClusterBlueprintAPI.h"

Syntax

class IDisplayClusterBlueprintAPI

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddClusterEventListener ( TScriptInterface< IDisplayClusterClusterEventListener > Listener
)

 Adds cluster event listener. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void EmitClusterEventBinary ( const FDisplayClusterClusterEventBinary& Event,
bool bPrimaryOnly
)

 Emits binary cluster event. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void EmitClusterEventJson ( const FDisplayClusterClusterEventJson& Event,
bool bPrimaryOnly
)

 Emits JSON cluster event. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void GetActiveNodeIds ( TArray< FString >& OutNodeIds
) const

 Returns List of the active nodes in the runtime cluster node in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

int32 GetActiveNodesAmount()

 Returns amount of active nodes in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

EDisplayClusterNodeRole GetClusterRole()

 Returns the role of the current cluster node. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

FString GetNodeId()

 Returns Id of the current node in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

EDisplayClusterOperationMode GetOperationMode()

 Returns current operation mode. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

ADisplayClusterRootActor * GetRootActor()

 Returns DisplayCluster root actor. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

bool IsBackup()

 Returns true if current node is a backup node in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

bool IsModuleInitialized()

 Returns true if the module has been initialized. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and will be removed soon.")

bool IsPrimary()

 Returns true if current node is a primary node in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

bool IsSecondary()

 Returns true if current node is a secondary node in a cluster. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void RemoveClusterEventListener ( TScriptInterface< IDisplayClusterClusterEventListener > Listener
)

 Removes cluster event listener. Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void SendClusterEventBinaryTo ( const FString& Address,
const int32 Port,
const FDisplayClusterClusterEventBinary& Event,
bool bPrimaryOnly
)

 Sends binary cluster event to a specific target (outside of the cluster). Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

void SendClusterEventJsonTo ( const FString& Address,
const int32 Port,
const FDisplayClusterClusterEventJson& Event,
bool bPrimaryOnly
)

 Sends JSON cluster event to a specific target (outside of the cluster). Blueprints/IDisplayClusterBlueprintAPI.h
  • BlueprintCallable
  • Meta=(DeprecatedFunction, DeprecationMessage="This function is now available in the main blueprint functions list under 'nDisplay' section.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page