unreal.CEClonerLibrary

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

Bases: BlueprintFunctionLibrary

Blueprint operations for cloner

C++ Source:

  • Plugin: ClonerEffector

  • Module: ClonerEffector

  • File: CEClonerLibrary.h

classmethod get_cloner_extension_classes() → Set[type(Class)]

Retrieves all extension classes available for a cloner

Returns:

out_extension_classes (Set[type(Class)]): [Out] Extension classes available

Return type:

Set[type(Class)]

classmethod get_cloner_layout_class(layout_name) → type(Class) or None

Retrieves the layout class from a layout name

Parameters:

layout_name (Name) – Layout name to get the class from

Returns:

true when the layout class was retrieved

out_layout_class (type(Class)): [Out] Layout class

Return type:

type(Class) or None

classmethod get_cloner_layout_classes() → Set[type(Class)]

Retrieves all layout classes available for a cloner

Returns:

out_layout_classes (Set[type(Class)]): [Out] Layout classes available

Return type:

Set[type(Class)]

classmethod get_cloner_layout_name(layout_class) → Name or None

Retrieves the layout name from a layout class

Parameters:

layout_class (type(Class)) – Layout class to get the name from

Returns:

true when the layout name was retrieved

out_layout_name (Name): [Out] Layout name

Return type:

Name or None

classmethod get_cloner_layout_names() → Set[Name] or None

Retrieves all the layout names

Returns:

true when the layout names were retrieved

out_layout_names (Set[Name]): [Out] Layout names

Return type:

Set[Name] or None

classmethod set_cloner_layout_by_class(world_context, latent_info, cloner, layout_class) -> (out_success=bool, out_layout=CEClonerLayoutBase)

Sets the active layout of a cloner and wait until the layout is loaded and active

Parameters:
Returns:

out_success (bool): [Out] True when the layout class is set

out_layout (CEClonerLayoutBase): [Out] Layout object corresponding to the layout class

Return type:

tuple

classmethod set_cloner_layout_by_name(world_context, latent_info, cloner, layout_name) -> (out_success=bool, out_layout=CEClonerLayoutBase)

Sets the active layout of a cloner and wait until the layout is loaded and active

Parameters:
Returns:

out_success (bool): [Out] True when the layout class is set

out_layout (CEClonerLayoutBase): [Out] Layout object corresponding to the layout class

Return type:

tuple