unreal.CustomizableObjectInstanceUsage

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

Bases: Object

This class can be used instead of a UCustomizableComponent (for example for non-BP projects) to link a UCustomizableObjectInstance and a USkeletalComponent so that the CustomizableObjectSystem takes care of updating it and its LODs, streaming, etc. It’s a UObject, so it will be much cheaper than a UCustomizableComponent as it won’t have to refresh its transforms every time it’s moved.

C++ Source:

  • Plugin: Mutable

  • Module: CustomizableObject

  • File: CustomizableObjectInstanceUsage.h

attach_to(skeletal_mesh_component) → None

Attach this Customizable Object Instance Usage to a Skeletal Mesh Component to be customized.

Parameters:

skeletal_mesh_component (SkeletalMeshComponent)

get_attach_parent() → SkeletalMeshComponent

Get the parent Skeletal Mesh Component this Customizable Object Instance Usage is attached to.

Return type:

SkeletalMeshComponent

get_component_name() → Name

Get Component Name

Return type:

Name

get_customizable_object_instance() → CustomizableObjectInstance

Get Customizable Object Instance

Return type:

CustomizableObjectInstance

get_skip_set_reference_skeletal_mesh() → bool

Get Skip Set Reference Skeletal Mesh

Return type:

bool

get_skip_set_skeletal_mesh_on_attach() → bool

Get Skip Set Skeletal Mesh on Attach

Return type:

bool

set_component_name(name) → None

Set Component Name

Parameters:

name (Name)

set_customizable_object_instance(customizable_object_instance) → None

Set Customizable Object Instance

Parameters:

customizable_object_instance (CustomizableObjectInstance)

set_skip_set_reference_skeletal_mesh(skip) → None

Set to true to avoid automatically replacing the Skeletal Mesh of the parent Skeletal Mesh Component by the Reference Skeletal Mesh. If SkipSetSkeletalMeshOnAttach is true, it will not replace it.

Parameters:

skip (bool)

set_skip_set_skeletal_mesh_on_attach(skip) → None

Set to true to avoid automatically replacing the Skeletal Mesh of the parent Skeletal Mesh Component with any mesh.

Parameters:

skip (bool)

update_skeletal_mesh_async(never_skip_update=False, ignore_close_dist=False, force_high_priority=False) → None

Update Skeletal Mesh asynchronously.

Parameters:

  • never_skip_update (bool)

  • ignore_close_dist (bool)

  • force_high_priority (bool)

update_skeletal_mesh_async_result(callback, ignore_close_dist=False, force_high_priority=False) → None

Update Skeletal Mesh asynchronously. Callback will be called once the update finishes, even if it fails.

Parameters: