unreal.ConcertReplicationBlueprintFunctionLibrary

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

Bases: BlueprintFunctionLibrary

Concert Replication Blueprint Function Library

C++ Source:

  • Plugin: ConcertReplicationScripting

  • Module: ConcertReplicationScripting

  • File: ConcertReplicationBlueprintFunctionLibrary.h

classmethod get_all_properties(class_) → Array[ConcertPropertyChainWrapper]

Gets all properties in the class that are valid for replicating.

Parameters:

class (type(Class)) – The class in which to search

Returns:

All properties in the class that are valid for replicating.

Return type:

Array[ConcertPropertyChainWrapper]

classmethod get_child_properties(parent, class_, only_direct=False) → Array[ConcertPropertyChainWrapper]

Returns all child properties of Parent that are valid for replicating.

Parameters:

  • parent (ConcertPropertyChainWrapper) – The property of which to find child properties

  • class (type(Class)) – The class in which to search

  • only_direct (bool) – Whether you only want direct children of Parent

Returns:

All child properties of Parent that are valid for replicating.

Return type:

Array[ConcertPropertyChainWrapper]

classmethod get_properties_in(class_, filter) → Array[ConcertPropertyChainWrapper]

Builds an array of property paths that pass the given filter.

Parameters:

  • class (type(Class)) – The class in which to search for properties

  • filter (PropertyChainPredicate) – Decides whether a property path should be included

Returns:

An array of all property paths in the given class that passed the filter

Return type:

Array[ConcertPropertyChainWrapper]

classmethod get_property_from_leaf(path, index=0) → Name

Gets the property at Index starting from the leaf most property. Example: The leaf Index 0 for [“RelativeLocation”, “X”] would return “X”.

Parameters:

  • path (ConcertPropertyChainWrapper) – The property path to get the sub-property from.

  • index (int32) – The index in the path counting from the right, leaf property.

Returns:

The property name at Index or None if Index is invalid.

Return type:

Name

classmethod get_property_from_root(path, index=0) → Name

Gets the property at Index starting from the root most property. Example: The root Index 0 for [“RelativeLocation”, “X”] would return “RelativeLocation”.

Parameters:

  • path (ConcertPropertyChainWrapper) – The property path to get the sub-property from.

  • index (int32) – The index in the path counting from the left, root property.

Returns:

The property name at Index or None if Index is invalid.

Return type:

Name

classmethod get_property_string_path(path) → Array[Name]

Gets the path as string array. Example: [“RelativeLocation”, “X”]

Parameters:

path (ConcertPropertyChainWrapper) – The property path to extract from

Returns:

The path as string array

Return type:

Array[Name]

classmethod is_child_of(to_test, parent) → bool

Checks whether ToTest is a child property of Parent.

Parameters:
Returns:

Whether ToTest is a child property of Parent

Return type:

bool

classmethod is_direct_child_of(to_test, parent) → bool

Checks whether ToTest is a direct child property of Parent.

Parameters:
Returns:

Whether ToTest is a direct child property of Parent

Return type:

bool

classmethod make_property_chain_by_literal_path(class_, path_to_property) → ConcertPropertyChainWrapper or None

Tries to make concert property chain by specifying a path manually.

Parameters:

  • class (type(Class)) – The class in which to search for the property path

  • path_to_property (Array[Name]) – The path to the property

Returns:

Whether Result is valid.

result (ConcertPropertyChainWrapper): The resulting path

Return type:

ConcertPropertyChainWrapper or None

classmethod to_string(property_chain) → str

Converts the the property to a string.

Parameters:

property_chain (ConcertPropertyChainWrapper) –

Return type:

str