1. Epic GamesDeveloper
  3. UCustomizableObjectInstanceUsage

UCustomizableObjectInstanceUsage

This class can be used instead of a UCustomizableComponent (for example for non-BP projects) to link a [UCustomizableObjectInstance](API\Plugins\CustomizableObject\UCustomizableObjectInstance) and a USkeletalComponent so that the CustomizableObjectSystem takes care of updating it and its LODs, streaming, etc.

API > API/Plugins > API/Plugins/CustomizableObject

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.

   
Name UCustomizableObjectInstanceUsage
Type class
Header File /Engine/Plugins/Mutable/Source/CustomizableObject/Public/MuCO/CustomizableObjectInstanceUsage.h
Include Path #include "MuCO/CustomizableObjectInstanceUsage.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(CustomizableObject))  
class UCustomizableObjectInstanceUsage : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCustomizableObjectInstanceUsage()

   MuCO/CustomizableObjectInstanceUsage.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
UpdatedDelegate FCustomizableObjectInstanceUsageUpdatedDelegate   MuCO/CustomizableObjectInstanceUsage.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bUsedSkipSetReferenceSkeletalMesh bool Used to avoid replacing the SkeletalMesh of the parent component by the ReferenceSkeletalMesh if bPendingSetSkeletalMesh is true. MuCO/CustomizableObjectInstanceUsage.h  
bUsedSkipSetSkeletalMeshOnAttach bool   MuCO/CustomizableObjectInstanceUsage.h  
Private TObjectPtr< UCustomizableObjectInstanceUsagePrivate >   MuCO/CustomizableObjectInstanceUsage.h
  • Instanced
UCustomizableObjectInstanceUsagePrivate friend   MuCO/CustomizableObjectInstanceUsage.h  
UsedComponentIndex int32 If the outer is no CustomizableSkeletalComponentd, this Index will be used DEPRECATED MuCO/CustomizableObjectInstanceUsage.h  
UsedComponentName FName Only used if the UsedComponentIndex is INDEX_NONE. MuCO/CustomizableObjectInstanceUsage.h  
UsedCustomizableObjectInstance TObjectPtr< UCustomizableObjectInstance > If the outer is no CustomizableSkeletalComponentd, this Instance will be used. MuCO/CustomizableObjectInstanceUsage.h  
UsedSkeletalMeshComponent TWeakObjectPtr< USkeletalMeshComponent > If the outer is no CustomizableSkeletalComponent, this SkeletalComponent will be used. MuCO/CustomizableObjectInstanceUsage.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AttachTo ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Attach this Customizable Object Instance Usage to a Skeletal Mesh Component to be customized. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

USkeletalMeshComponent * GetAttachParent()

 Get the parent Skeletal Mesh Component this Customizable Object Instance Usage is attached to. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

int32 GetComponentIndex()

 DEPRECATED: use GetComponentName. MuCO/CustomizableObjectInstanceUsage.h  

FName GetComponentName()

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

UCustomizableObjectInstance * GetCustomizableObjectInstance()

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

UCustomizableObjectInstanceUsagePrivate * GetPrivate ()

   MuCO/CustomizableObjectInstanceUsage.h  

const UCustomizableObjectInstanceUsagePrivate * GetPrivate ()

   MuCO/CustomizableObjectInstanceUsage.h  

bool GetSkipSetReferenceSkeletalMesh()

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

bool GetSkipSetSkeletalMeshOnAttach()

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

void SetComponentIndex ( int32 ObjectComponentIndex
)

 DEPRECATED: use SetComponentName. MuCO/CustomizableObjectInstanceUsage.h  

void SetComponentName ( const FName& Name
)

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

void SetCustomizableObjectInstance ( UCustomizableObjectInstance* CustomizableObjectInstance
)

   MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

void SetSkipSetReferenceSkeletalMesh ( bool bSkip
)

 Set to true to avoid automatically replacing the Skeletal Mesh of the parent Skeletal Mesh Component by the Reference Skeletal Mesh. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

void SetSkipSetSkeletalMeshOnAttach ( bool bSkip
)

 Set to true to avoid automatically replacing the Skeletal Mesh of the parent Skeletal Mesh Component with any mesh. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstanceUsage

void UpdateSkeletalMeshAsync ( bool bNeverSkipUpdate
)

 Update Skeletal Mesh asynchronously. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObject

void UpdateSkeletalMeshAsyncResult ( FInstanceUpdateDelegate Callback,
bool bIgnoreCloseDist,
bool bForceHighPriority
)

 Update Skeletal Mesh asynchronously. MuCO/CustomizableObjectInstanceUsage.h
  • BlueprintCallable
  • Category=CustomizableObjectInstance

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page