1. Epic GamesDeveloper
  3. UCustomizableObject

UCustomizableObject

API > API/Plugins > API/Plugins/CustomizableObject

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Config=Engine)  
class UCustomizableObject : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCustomizableObject()

   MuCO/CustomizableObject.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableTableMaterialsParentCheck bool Disabling the Table Materials parent material check will let the user use any material regardless of its parent when connecting a material from a table column to a material node. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnable16BitBoneWeights bool   MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableAltSkinWeightProfiles bool   MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableAnimBpPhysicsAssetsManipualtion bool Experimental MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableAssetUserDataMerge bool When this is enabled generated meshes will merge the AssetUserData from all of its constituent mesh parts MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableClothing bool   MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableMeshCache bool If true, reuse previously generated USkeletalMesh (if still valid and the the number of LOD have not changed) USkeletalMeshes are only reused between the same CO. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CustomizableObject
bEnableMeshStreaming bool Experimental - If true, Mesh LODs will be streamed on demand. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CustomizableObject
bEnablePhysicsAssetMerge bool   MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableRealTimeMorphTargets bool   MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
bEnableUseRefSkeletalMeshAsPlaceholder bool True to use the Reference Skeletal Mesh as a placeholder while the Generated Skeletal Mesh is not ready. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CustomizableObject
bPreserveUserLODsOnFirstGeneration bool Use the Instance MinLOD, and RequestedLODs in the descriptor when performing the initial generation (ignore LOD Management). MuCO/CustomizableObject.h
  • Category="CustomizableObject"
  • EditAnywhere
  • DisplayName="Preserve User LODs On First Generation"
LODSettings FMutableLODSettings   MuCO/CustomizableObject.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Moved to Mesh Component Node")
MeshCompileType EMutableCompileMeshType Options when compiling this customizable object (see EMutableCompileMeshType declaration for info) MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions
VersionBridge TObjectPtr< UObject > Optional Version Bridge asset. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=Versioning
VersionStruct FInstancedStruct Optional struct. MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=Versioning
WorkingSet TArray< TSoftObjectPtr< UCustomizableObject > > Array of elements to use with compile option CompileType = WorkingSet MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CompileOptions

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsChildObject bool True if this object references a parent object. MuCO/CustomizableObject.h  
BulkData TObjectPtr< UCustomizableObjectBulk > BulkData that stores all in-game resources used by Mutable when generating instances. MuCO/CustomizableObject.h  
CustomizableObjectClassTags TArray< FString > Customizable Object Population data start ---------------------------------------------------. MuCO/CustomizableObject.h  
CustomizableObjectParametersTags TMap< FString, FParameterTags > Map of parameters available for the Customizable Object and their tags MuCO/CustomizableObject.h  
InstancePropertiesProfiles TArray< FProfileParameterDat >   MuCO/CustomizableObject.h  
LowPriorityTextures TArray< FName > Textures marked as low priority will generate defaulted resident mips (if texture streaming is enabled). MuCO/CustomizableObject.h
  • EditAnywhere
  • Category=CustomizableObject
PopulationClassTags TArray< FString > Array to store all the Population Class tags MuCO/CustomizableObject.h  
Private TObjectPtr< UCustomizableObjectPrivate >   MuCO/CustomizableObject.h  
Source TObjectPtr< UEdGraph > Editor graph. MuCO/CustomizableObject.h  
UCustomizableObjectPrivate friend   MuCO/CustomizableObject.h  
VersionId FGuid Used to verify the derived data matches this version of the Customizable Object. MuCO/CustomizableObject.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Compile ( const FCompileParams& Params
)

 Compile the Customizable Object. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject
DEPRECATED. MuCO/CustomizableObject.h  

bool ContainsEnumParameterValue ( const FString& ParameterName,
const FString Value
) const

 Return true if the enum parameter contains this value a possible option. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

bool ContainsParameter ( const FString& ParameterName
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject
Create a new instance of this object. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 FindIntParameterValue ( int32 ParamIndex,
const FString& Value
) const

   MuCO/CustomizableObject.h  

FString FindIntParameterValueName ( int32 ParamIndex,
int32 ParamValue
) const

   MuCO/CustomizableObject.h  

int32 FindParameter ( const FString& Name
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 FindState ( const FString& Name
) const

   MuCO/CustomizableObject.h  

bool GetBoolParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a parameter of type Bool. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FLinearColor GetColorParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a parameter of type Color. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetComponentCount()

 Get the number of components this Customizable Object has. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

USkeletalMesh * GetComponentMeshReferenceSkeletalMesh ( const FName& Name
) const

 Given a Mesh Component name, return its reference Skeletal Mesh. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FName GetComponentName ( int32 ComponentIndex
) const

 Return the name of the component. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetEnumParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a parameter of type Int. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

ECustomizableObjectGroupType GetEnumParameterGroupType ( const FString& ParamName
) const

 Returns the group type of the given integer parameter MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetEnumParameterNumValues ( const FString& ParameterName
) const

 If the given parameter is enum int parameter, return how many possible values an enum parameter has. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

const FString & GetEnumParameterValue ( const FString& ParameterName,
int32 ValueIndex
) const

 Gets the Name of the value at position ValueIndex in the list of available values for the int parameter. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

TArray< TSoftObjectPtr< UDataTable > > GetEnumParameterValueDataTable ( const FString& ParamName,
const FString& Value
)

 Return the DataTables used by the given parameter and its value (if any). MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FMutableParamUIMetadata GetEnumParameterValueUIMetadata ( const FString& ParamName,
const FString& OptionName
) const

 Return the metadata associated to the given enum parameter value. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

float GetFloatParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a parameter of type Float. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

const FString & GetIntParameterAvailableOption ( int32 ParamIndex,
int32 K
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetIntParameterDefaultValue ( UPARAM(DisplayName="Parameter Name") const FString& InParameterName
) const

   MuCO/CustomizableObject.h  

ECustomizableObjectGroupType GetIntParameterGroupType ( const FString& ParamName
) const

   MuCO/CustomizableObject.h  

int32 GetIntParameterNumOptions ( int32 ParamIndex
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

TArray< TSoftObjectPtr< UDataTable > > GetIntParameterOptionDataTable ( const FString& ParamName,
const FString& OptionName
)

   MuCO/CustomizableObject.h  

FMutableParamUIMetadata GetIntParameterOptionUIMetadata ( const FString& ParamName,
const FString& OptionName
) const

   MuCO/CustomizableObject.h  

int32 GetParameterCount()

 Get the number of parameters available in instances of this object. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

const FString & GetParameterName ( int32 ParamIndex
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

EMutableParameterType GetParameterType ( int32 ParamIndex
) const

   MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

EMutableParameterType GetParameterTypeByName ( const FString& Name
) const

 Get the type of a parameter from its name. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FMutableParamUIMetadata GetParameterUIMetadata ( const FString& ParamName
) const

 Return the metadata associated to a parameter. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FPostCompileDelegate & GetPostCompileDelegate()

   MuCO/CustomizableObject.h  

UCustomizableObjectPrivate * GetPrivate ()

   MuCO/CustomizableObject.h  

const UCustomizableObjectPrivate * GetPrivate ()

   MuCO/CustomizableObject.h  

FCustomizableObjectProjector GetProjectorParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a projector with the provided name MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

void GetProjectorParameterDefaultValue ( UPARAM(DisplayName="Parameter Name") const FString& InParameterName,
UPARAM(DisplayName="Position") FVector3f& OutPos,
UPARAM(DisplayName="Direction") FVector3f& OutDirection,
UPARAM(DisplayName="Up") FVector3f& OutUp,
UPARAM(DisplayName="Scale") FVector3f& OutScale,
UPARAM(DisplayName="Angle") float& OutAngle,
UPARAM(DisplayName="Type") ECustomizableObjectProjectorType& OutType
) const

   MuCO/CustomizableObject.h  

USkeletalMesh * GetRefSkeletalMesh ( int32 ObjectComponentIndex
) const

   MuCO/CustomizableObject.h  

int32 GetStateCount()

 Return the number of object states that are defined in the CustomizableObject. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FString GetStateName ( int32 StateIndex
) const

 Return the name of an object state from its index. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetStateParameterCount ( const FString& StateName
) const

 Return the number of parameters that are editable at runtime for a specific state. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

int32 GetStateParameterCount ( int32 StateIndex
) const

   MuCO/CustomizableObject.h  

int32 GetStateParameterIndex ( int32 StateIndex,
int32 ParameterIndex
) const

   MuCO/CustomizableObject.h  

FString GetStateParameterName ( int32 StateIndex,
int32 ParameterIndex
) const

   MuCO/CustomizableObject.h  

FString GetStateParameterName ( const FString& StateName,
int32 ParameterIndex
) const

 Return the name of one of the state's runtime parameters, by its index (from 0 to GetStateParameterCount - 1). MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FMutableStateUIMetadata GetStateUIMetadata ( const FString& StateName
) const

 Return the metadata associated to a state. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

FName GetTextureParameterDefaultValue ( const FString& InParameterName
) const

 Get the default value of a parameter of type Texture. MuCO/CustomizableObject.h  

FTransform GetTransformParameterDefaultValue ( const FString& ParameterName
) const

 Get the default value of a parameter of type Transform. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

bool IsChildObject ()

 Return true if this Customizable Object has references to a parent Customizable Object. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

bool IsCompiled ()

 Check if the CustomizableObject asset has been compiled. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

bool IsLoading ()

 Return true if the Customizable Object is still being loaded. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

bool IsParameterMultidimensional ( const int32& InParamIndex
) const

   MuCO/CustomizableObject.h  

bool IsParameterMultidimensional ( UPARAM(DisplayName="Parameter Name") const FString& InParameterName
) const

 Return true if the parameter at the index provided is multidimensional. MuCO/CustomizableObject.h
  • BlueprintCallable
  • Category=CustomizableObject

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   MuCO/CustomizableObject.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   MuCO/CustomizableObject.h  

virtual FString GetDesc()

   MuCO/CustomizableObject.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   MuCO/CustomizableObject.h  

virtual bool IsEditorOnly()

   MuCO/CustomizableObject.h  

virtual void PostLoad()

   MuCO/CustomizableObject.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

   MuCO/CustomizableObject.h  

virtual void PostSaveRoot ( FObjectPostSaveRootContext ObjectSaveContext
)

   MuCO/CustomizableObject.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   MuCO/CustomizableObject.h  

virtual void Serialize ( FArchive& Ar
)

   MuCO/CustomizableObject.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page