1. Epic GamesDeveloper
  3. UDisplayClusterBlueprintLib

UDisplayClusterBlueprintLib

Blueprint API function library

API > API/Plugins > API/Plugins/DisplayCluster

Blueprint API function library

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

Syntax

UCLASS ()  
class UDisplayClusterBlueprintLib : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddClusterEventListener ( TScriptInterface< IDisplayClusterClusterEventListener > Listener
)

 Adds cluster event listener. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Add Cluster Event Listener")
  • Category="NDisplay|Cluster|Events"

static ADisplayClusterLightCardActor * CreateLightCard ( ADisplayClusterRootActor* RootActor
)

 Create a new light card parented to the given nDisplay root actor. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Create Light Card")
  • Category="NDisplay|LC & CK"

static void DuplicateLightCards ( TArray< ADisplayClusterLightCardActor* > OriginalLightcards,
TArray< ADisplayClusterLightCardActor* >& OutNewLightCards
)

 Create duplicates of a list of existing light cards. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Duplicate Light Cards")
  • Category="NDisplay|LC & CK"

static void EmitClusterEventBinary ( const FDisplayClusterClusterEventBinary& Event,
bool bPrimaryOnly
)

 Emits binary cluster event. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Emit Binary Cluster Event")
  • Category="NDisplay|Cluster|Events"

static void EmitClusterEventJson ( const FDisplayClusterClusterEventJson& Event,
bool bPrimaryOnly
)

 Emits JSON cluster event. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Emit JSON Cluster Event")
  • Category="NDisplay|Cluster|Events"

static void FindChromakeyCardsForRootActor ( const ADisplayClusterRootActor* RootActor,
TSet< ADisplayClusterChromakeyCardActor* >& OutChromakeyCards
)

 Gets a list of all chromakey card actors on the level linked to the specified root actor. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Find Chromakey Cards")
  • Category="NDisplay|LC & CK"

static void FindLightCardsForRootActor ( const ADisplayClusterRootActor* RootActor,
TSet< ADisplayClusterLightCardActor* >& OutLightCards
)

 Gets a list of all light card actors on the level linked to the specified root actor. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Find Light Cards")
  • Category="NDisplay|LC & CK"

static void GetActiveNodeIds ( TArray< FString >& OutNodeIds
)

 Returns List of the active nodes in the runtime cluster node in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Cluster Node IDs")
  • Category="NDisplay|Cluster"

static int32 GetActiveNodesAmount()

 Returns amount of active nodes in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Cluster Nodes Amount")
  • Category="NDisplay|Cluster"

static void GetAPI ( TScriptInterface< IDisplayClusterBlueprintAPI >& OutAPI
)

 [DEPRECATED] Return Display Cluster API interface. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DeprecatedFunction, DeprecationMessage="GetAPI has been deprecated. All functions are now available in the main blueprint functions list under 'nDisplay' category.")

static EDisplayClusterNodeRole GetClusterRole()

 Returns the role of the current cluster node. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Cluster Node Role")
  • Category="NDisplay|Cluster"

static FString GetNodeId()

 Returns Id of the current node in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Node ID")
  • Category="NDisplay|Cluster"

static EDisplayClusterOperationMode GetOperationMode()

 Returns current operation mode. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Operation Mode")
  • Category="NDisplay"

static ADisplayClusterRootActor * GetRootActor()

 Returns currently active root actor. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Get Active Root Actor")
  • Category="NDisplay"

static bool HasClusterRole ( EDisplayClusterNodeRole Role
)

 Checks if the node has a specific role. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Has a Role")
  • Category="NDisplay|Cluster"

static bool IsBackup()

 Returns true if current node is a backup node in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Is Backup Node")
  • Category="NDisplay|Cluster"

static bool IsPrimary()

 Returns true if current node is a primary node in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Is Primary Node")
  • Category="NDisplay|Cluster"

static bool IsSecondary()

 Returns true if current node is a secondary node in a cluster. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintPure
  • Meta=(DisplayName="Is Secondary Node")
  • Category="NDisplay|Cluster"

static void RemoveClusterEventListener ( TScriptInterface< IDisplayClusterClusterEventListener > Listener
)

 Removes cluster event listener. Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Remove Cluster Event Listener")
  • Category="NDisplay|Cluster|Events"

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

 Sends binary cluster event to a specific target (may be outside of the cluster). Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Send Binary Event To Host")
  • Category="NDisplay|Cluster|Events"

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

 Sends JSON cluster event to a specific target (may be outside of the cluster). Blueprints/DisplayClusterBlueprintLib.h
  • BlueprintCallable
  • Meta=(DisplayName="Send JSON Event To Host")
  • Category="NDisplay|Cluster|Events"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page