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:
event (DisplayClusterClusterEventBinary) –
primary_only (bool) –
- emit_cluster_event_json(event, primary_only) None ¶
Emits JSON cluster event.
- Parameters:
event (DisplayClusterClusterEventJson) –
primary_only (bool) –
- get_active_node_ids() Array[str] ¶
Returns List of the active nodes in the runtime cluster node in a cluster.
- 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:
- get_operation_mode() DisplayClusterOperationMode ¶
Returns current operation mode.
- Return type:
- get_root_actor() DisplayClusterRootActor ¶
Returns DisplayCluster root actor.
- Return type:
- 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:
address (str) –
port (int32) –
event (DisplayClusterClusterEventBinary) –
primary_only (bool) –
- send_cluster_event_json_to(address, port, event, primary_only) None ¶
Sends JSON cluster event to a specific target (outside of the cluster).
- Parameters:
address (str) –
port (int32) –
event (DisplayClusterClusterEventJson) –
primary_only (bool) –