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

Adds cluster event listener.

Parameters:

listener (DisplayClusterClusterEventListener) –

emit_cluster_event_binary(event, primary_only) → None

Emits binary cluster event.

Parameters:
emit_cluster_event_json(event, primary_only) → None

Emits JSON cluster event.

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

Returns the role of the current cluster node.

Return type:

DisplayClusterNodeRole

get_node_id() → str

Returns Id of the current node in a cluster.

Return type:

str

get_operation_mode() → DisplayClusterOperationMode

Returns current operation mode.

Return type:

DisplayClusterOperationMode

get_root_actor() → DisplayClusterRootActor

Returns DisplayCluster 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

Returns true if the module has been initialized.

Return type:

bool

is_primary() → bool

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

Return type:

bool

is_secondary() → bool

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

Return type:

bool

remove_cluster_event_listener(listener) → None

Removes cluster event listener.

Parameters:

listener (DisplayClusterClusterEventListener) –

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

Sends binary cluster event to a specific target (outside of the cluster).

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

Sends JSON cluster event to a specific target (outside of the cluster).

Parameters: