unreal.DisplayClusterBlueprintAPIImpl

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

Bases: Object

Blueprint API interface implementation

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayCluster

  • File: DisplayClusterBlueprintAPIImpl.h

add_cluster_event_listener(listener) → None

Cluster events API

Parameters:

listener (DisplayClusterClusterEventListener) –

emit_cluster_event_binary(event, primary_only) → None

Emit Cluster Event Binary

Parameters:
emit_cluster_event_json(event, primary_only) → None

Emit Cluster Event Json

Parameters:
get_active_node_ids() → Array[str]

Returns List of the active nodes in the runtime cluster node in a cluster.

Returns:

out_node_ids (Array[str]):

Return type:

Array[str]

get_active_nodes_amount() → int32

Returns amount of active nodes in a cluster.

Return type:

int32

get_cluster_role() → DisplayClusterNodeRole

Get Cluster Role

Return type:

DisplayClusterNodeRole

get_node_id() → str

Runtime local node API

Return type:

str

get_operation_mode() → DisplayClusterOperationMode

Runtime Cluster API

Return type:

DisplayClusterOperationMode

get_root_actor() → DisplayClusterRootActor

Get Root Actor

Return type:

DisplayClusterRootActor

is_backup() → bool

Returns true if current node is a backup node in a cluster.

Return type:

bool

is_module_initialized() → bool

DisplayCluster module API

Return type:

bool

is_primary() → bool

Is Primary

Return type:

bool

is_secondary() → bool

Is Secondary

Return type:

bool

remove_cluster_event_listener(listener) → None

Remove Cluster Event Listener

Parameters:

listener (DisplayClusterClusterEventListener) –

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

Send Cluster Event Binary To

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

Send Cluster Event Json To

Parameters: