unreal.DisplayClusterBlueprintAPI

class unreal.DisplayClusterBlueprintAPI(outer: Object | None = None, name: Name | str = 'None')

Bases: Interface

Display Cluster Blueprint API

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayCluster

  • File: IDisplayClusterBlueprintAPI.h

add_cluster_event_listener(listener) → None

Add Cluster Event Listener deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters:

listener (DisplayClusterClusterEventListener)

emit_cluster_event_binary(event, primary_only) → None

Emit Cluster Event Binary deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters:
emit_cluster_event_json(event, primary_only) → None

Emit Cluster Event Json deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters:
get_active_node_ids() → Array[str]

Get Active Node Ids deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Returns:

out_node_ids (Array[str]):

Return type:

Array[str]

get_active_nodes_amount() → int32

Get Active Nodes Amount deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

int32

get_cluster_role() → DisplayClusterNodeRole

Get Cluster Role deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

DisplayClusterNodeRole

get_node_id() → str

Get Node Id deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

str

get_operation_mode() → DisplayClusterOperationMode

Get Operation Mode deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

DisplayClusterOperationMode

get_root_actor() → DisplayClusterRootActor

Get Root Actor deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

DisplayClusterRootActor

is_backup() → bool

Is Backup deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

bool

is_module_initialized() → bool

Is Module Initialized deprecated: This function has been deprecated and will be removed soon.

Return type:

bool

is_primary() → bool

Is Primary deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

bool

is_secondary() → bool

Is Secondary deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Return type:

bool

remove_cluster_event_listener(listener) → None

Remove Cluster Event Listener deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters:

listener (DisplayClusterClusterEventListener)

send_cluster_event_binary_to(address, port, event, primary_only) → None

Send Cluster Event Binary To deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters:
send_cluster_event_json_to(address, port, event, primary_only) → None

Send Cluster Event Json To deprecated: This function is now available in the main blueprint functions list under ‘nDisplay’ section.

Parameters: