Navigation
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 |
|
void EmitClusterEventBinary
(
const FDisplayClusterClusterEventBinary& Event, |
Emits binary cluster event. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
void EmitClusterEventJson
(
const FDisplayClusterClusterEventJson& Event, |
Emits JSON cluster event. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
| Returns List of the active nodes in the runtime cluster node in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
|
int32 GetActiveNodesAmount() |
Returns amount of active nodes in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
EDisplayClusterNodeRole GetClusterRole() |
Returns the role of the current cluster node. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
FString GetNodeId() |
Returns Id of the current node in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
EDisplayClusterOperationMode GetOperationMode() |
Returns current operation mode. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
ADisplayClusterRootActor * GetRootActor() |
Returns DisplayCluster root actor. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
bool IsBackup() |
Returns true if current node is a backup node in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
bool IsModuleInitialized() |
Returns true if the module has been initialized. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
bool IsPrimary() |
Returns true if current node is a primary node in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
bool IsSecondary() |
Returns true if current node is a secondary node in a cluster. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
void RemoveClusterEventListener
(
TScriptInterface< IDisplayClusterClusterEventListener > Listener |
Removes cluster event listener. | Blueprints/IDisplayClusterBlueprintAPI.h |
|
void SendClusterEventBinaryTo
(
const FString& Address, |
Sends binary cluster event to a specific target (outside of the cluster). | Blueprints/IDisplayClusterBlueprintAPI.h |
|
void SendClusterEventJsonTo
(
const FString& Address, |
Sends JSON cluster event to a specific target (outside of the cluster). | Blueprints/IDisplayClusterBlueprintAPI.h |
|