unreal.DisplayClusterBlueprintLib

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

Bases: BlueprintFunctionLibrary

Blueprint API function library

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayCluster

  • File: DisplayClusterBlueprintLib.h

classmethod add_cluster_event_listener(listener) → None

Adds cluster event listener.

Parameters:

listener (DisplayClusterClusterEventListener) –

classmethod create_light_card(root_actor) → DisplayClusterLightCardActor

Create a new light card parented to the given nDisplay root actor.

Parameters:

root_actor (DisplayClusterRootActor) –

Return type:

DisplayClusterLightCardActor

classmethod duplicate_light_cards(original_lightcards) → Array[DisplayClusterLightCardActor]

Create duplicates of a list of existing light cards.

Parameters:

original_lightcards (Array[DisplayClusterLightCardActor]) –

Returns:

out_new_light_cards (Array[DisplayClusterLightCardActor]):

Return type:

Array[DisplayClusterLightCardActor]

classmethod emit_cluster_event_binary(event, primary_only) → None

Emits binary cluster event.

Parameters:
classmethod emit_cluster_event_json(event, primary_only) → None

Emits JSON cluster event.

Parameters:
classmethod find_chromakey_cards_for_root_actor(root_actor) → Set[DisplayClusterChromakeyCardActor]

Gets a list of all chromakey card actors on the level linked to the specified root actor.

Parameters:

root_actor (DisplayClusterRootActor) –

Returns:

out_chromakey_cards (Set[DisplayClusterChromakeyCardActor]):

Return type:

Set[DisplayClusterChromakeyCardActor]

classmethod find_light_cards_for_root_actor(root_actor) → Set[DisplayClusterLightCardActor]

Gets a list of all light card actors on the level linked to the specified root actor.

Parameters:

root_actor (DisplayClusterRootActor) –

Returns:

out_light_cards (Set[DisplayClusterLightCardActor]):

Return type:

Set[DisplayClusterLightCardActor]

classmethod 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]

classmethod get_active_nodes_amount() → int32

Returns amount of active nodes in a cluster.

Return type:

int32

classmethod get_api() → DisplayClusterBlueprintAPI

Get API deprecated: GetAPI has been deprecated. All functions are now availalbe in the main blueprint functions list under ‘nDisplay’ category.

Returns:

out_api (DisplayClusterBlueprintAPI):

Return type:

DisplayClusterBlueprintAPI

classmethod get_cluster_role() → DisplayClusterNodeRole

Returns the role of the current cluster node.

Return type:

DisplayClusterNodeRole

classmethod get_node_id() → str

Returns Id of the current node in a cluster.

Return type:

str

classmethod get_operation_mode() → DisplayClusterOperationMode

Returns current operation mode.

Return type:

DisplayClusterOperationMode

classmethod get_root_actor() → DisplayClusterRootActor

Returns currently active root actor.

Return type:

DisplayClusterRootActor

classmethod is_backup() → bool

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

Return type:

bool

classmethod is_primary() → bool

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

Return type:

bool

classmethod is_secondary() → bool

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

Return type:

bool

classmethod remove_cluster_event_listener(listener) → None

Removes cluster event listener.

Parameters:

listener (DisplayClusterClusterEventListener) –

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

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

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

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

Parameters: