1. Epic GamesDeveloper
  3. UCustomizableObject

UCustomizableObject

API > API/Plugins > API/Plugins/CustomizableObject > API/Plugins/CustomizableObject/MuCO

Inheritance Hierarchy

References

   
Module CustomizableObject
Header /Engine/Plugins/Experimental/Mutable/Source/CustomizableObject/Classes/MuCO/CustomizableObject.h
Include #include "MuCO/CustomizableObject.h"

Syntax

UCLASS&40;BlueprintType, Config&61;Engine&41;  
class UCustomizableObject : public UObject

Variables

  Type Name Description
Public variable UProperty TArray< FCustomizableObjectExtensionData > AlwaysLoadedExtensionData mu::ExtensionData::Index is an index into this array when mu::ExtensionData::Origin is ConstantAlwaysLoaded
Public variable UProperty TMap< FString, TSoftClassPtr< UAnimInstance > > AnimBPAssetsMap Stores the UAnimBlueprint assets gathered from the SkeletalMesh nodes during compilation, to be used in mesh generation in-game
Public variable UProperty TArray< FAnimBpOverridePhysicsAssetsInfo > AnimBpOverridePhysiscAssetsInfo  
Public variable UProperty Category visibleanywhere bool bEnable16BitBoneWeights TODO: Enable 16 bit weights.
Public variable UProperty Category, EditAnywhere bool bEnableAltSkinWeightProfiles  
Public variable UProperty Category, EditAnywhere bool bEnableAnimBpPhysicsAssetsManipualtion  
Public variable UProperty Category, EditAnywhere bool bEnableClothing  
Public variable UProperty Category, EditAnywhere bool bEnablePhysicsAssetMerge  
Public variable UProperty Category, EditAnywhere bool bEnableRealTimeMorphTargets  
Public variable UProperty Category, EditAnywhere bool bEnableUseRefSkeletalMeshAsPlaceholder Use the SkeletalMesh of reference as a placeholder until the custom mesh is ready to use.
Public variable UProperty bool bIsChildObject True if this object references a parent object.
Public variable TMap< FString, FMutableCachedPlatformData > CachedPlatformsData Map of PlatformName to CachedPlatformData. Only valid while cooking.
Public variable UProperty Transient TArray< FCustomizableObjectMeshToMeshVertData > ClothMeshToMeshVertData  
Public variable UProperty Transient TArray< FCustomizableObjectClothConfigData > ClothSharedConfigsData  
Public variable ECustomizableObjectCompilationState CompilationState  
Public variable UProperty FCompilationOptions CompileOptions Compilation options to use in editor and for packaging for this object.
Public variable UProperty Transient TArray< FCustomizableObjectClothingAssetData > ContributingClothingAssetsData  
Public variable UProperty Transient TArray< FMorphTargetInfo > ContributingMorphTargetsInfo  
Public variable UProperty TArray< FString > CustomizableObjectClassTags Customizable Object Population data start ------------------------------------------------.
Public variable UProperty TSet< FGuid > CustomizableObjectGuidsInCompilation Set of all the guids of all the CustomizableObjects in the compilation.
Public variable UProperty TMap< FString, FParameterTags > CustomizableObjectParametersTags Map of parameters available for the Customizable Object and their tags
Public variable UProperty Transient TMap< FString, FString > CustomizableObjectPathMap Map to identify what CustomizableObject owns a parameter.
Public variable UProperty Transient TMap< FString, FCustomizableObjectIdPair > GroupNodeMap  
Public variable UProperty TMap< uint64, FMutableStreamableBlock > HashToStreamableBlock Map of Hash to Streaming blocks, used to stream a block of data representing a resource from the BulkData
Public variable UProperty Transient FGuid Identifier Unique Identifier - used to locate Model and Streamable data on disk. Should not be modified.
Public variable UProperty Category visibleanywhere TArray< FMutableModelImageProperties > ImageProperties  
Public variable UProperty TArray< FProfileParameterDat > InstancePropertiesProfiles  
Public variable UProperty Category, EditAnywhere, Meta FMutableLODSettings LODSettings  
Public variable UProperty Category, EditAnywhere TArray< FName > LowPriorityTextures Textures marked as low priority will generate defaulted resident mips (if texture streaming is enabled).
Public variable UProperty TSoftObjectPtr< UMutableMaskOutCache > MaskOutCache Stores the textures that will be used to mask-out areas in projectors.
Public variable UProperty Category, EditAnywhere EMutableCompileMeshType MeshCompileType Options when compiling this customizable object (see EMutableCompileMeshType declaration for info)
Public variable UProperty Transient TArray< FMorphTargetVertexData > MorphTargetReconstructionData  
Public variable UProperty int32 NumMeshComponentsInRoot Amount of components in this CO. Set at the end of the model compilation process.
Public variable UProperty TMap< FString, FParameterUIData > ParameterUIDataMap Stores all the parameter UI metadata information for all the dependencies of this Customizable Object
Public variable UProperty TMap< FString, TSoftObjectPtr< class UPhysicsAsset > > PhysicsAssetsMap Stores the physics assets gathered from the SkeletalMesh nodes during compilation, to be used in mesh generation in-game
Public variable UProperty TArray< FString > PopulationClassTags Array to strore all the Population Class tags
Public variable FPostCompileDelegate PostCompileDelegate  
Public variable UProperty TArray< TSoftObjectPtr< UMaterialInterface > > ReferencedMaterials List of Materials referenced by this or any child customizable object.
Public variable UProperty TArray< FName > ReferencedMaterialSlotNames List of Material slot names for the materials referenced by this or any child customizable object.
Public variable UProperty TArray< TSoftObjectPtr< UTexture > > ReferencedPassThroughTextures  
Public variable UProperty TArray< TSoftObjectPtr< USkeleton > > ReferencedSkeletons List of skeletons referenced by any of the parts of this customizable object.
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< class USkeletalMesh > > ReferenceSkeletalMeshes All the SkeletalMeshes generated for this CustomizableObject instances will use the Reference Skeletal Mesh properties for everything that Mutable doesn't create or modify.
Public variable UProperty TArray< FMutableRefSkeletalMeshData > ReferenceSkeletalMeshesData All the SkeletalMeshes generated for this CustomizableObject instances will use the Reference Skeletal Mesh properties for everything that Mutable doesn't create or modify.
Public variable UProperty ECustomizableObjectRelevancy Relevancy Hide this property because it is not used yet.
Public variable UProperty TArray< FMutableSkinWeightProfileInfo > SkinWeightProfilesInfo  
Public variable UProperty TArray< FMutableRefSocket > SocketArray Stores the sockets provided by the part skeletal meshes, to be merged in the generated meshes
Public variable UProperty TObjectPtr< UEdGraph > Source Editor graph.
Public variable UProperty TMap< FString, FParameterUIData > StateUIDataMap Stores all the state UI metadata information for all the dependencies of this Customizable Object
Public variable UProperty TArray< FCustomizableObjectStreamedExtensionData > StreamedExtensionData mu::ExtensionData::Index is an index into this array when mu::ExtensionData::Origin is ConstantStreamed
Public variable UProperty FGuid VersionId Used to verify the derived data matches this version of the Customizable Object.
Public variable UProperty Category, EditAnywhere TArray< TSoftObjectPtr< UCustomizableObject > > WorkingSet Array of elements to use with compile option CompileType = WorkingSet.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FReply Add a profile that stores the values of the parameters used by the CustomInstance.
Public function void

AddUncompiledCOWarning ( const FString& AdditionalLoggingInfo
)

  
Public function void

ApplyStateForcedValuesToParameters ( int32 State,
mu::Parameters* Parameters
)

 Modify the provided mutable parameters so that the forced values for the given customizable object state are applied.
Public function void

CacheMergedSkeleton ( const int32 ComponentIndex,
const TArray< uint16 >& SkeletonIds,
TObjectPtr< USkeleton > Skeleton
)

 Add merged skeleton to the cache. It'll be cached as a TWeakObjPtr.
Public function void

CachePlatformData ( const ITargetPlatform* InTargetPlatform,
const TArray64< uint8 >& InObjectBytes,
const TArray64< uint8 >& InBulkBytes
)

 Cache platform data for cook
Public function void Unless we are packaging there is no need for keeping all the data generated during compilation, this information is stored in the derived data.
Public function void

CompileForTargetPlatform ( const ITargetPlatform* TargetPlatform,
bool bIsOnCookStart
)

 Compile the object for a specific platform - Compile for Cook Customizable Object.
Public function bool Compile the object if Automatic Compilation is enabled and the object can be compiled.
Public function UFunction BlueprintCallable, Category UCustomizableObjectInstance *  
Public function void  
Public function Const int32

FindIntParameterValue ( int32 ParamIndex,
const FString& Value
)

  
Public function Const FString

FindIntParameterValueName ( int32 ParamIndex,
int32 ParamValue
)

  
Public function Const UFunction BlueprintCallable, Category int32

FindParameter ( const FString& Name
)

 Get the index of a parameter.
Public function Const int32

FindState ( const FString& Name
)

  
Public function Const const TArray< FName > &  
Public function Const UFunction BlueprintCallable, Category bool

GetBoolParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Bool.
Public function Const TObjectPtr< USkeleton >

GetCachedMergedSkeleton ( int32 ComponentIndex,
const TArray< uint16 >& SkeletonIds
)

 Return a valid Skeletons if cached. ComponentIndex and SkeletonIds are used as a key to find the skeleton.
Public function Const UFunction BlueprintCallable, Category FLinearColor

GetColorParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Color.
Public function Const FGuid  
Public function FString

GetCompiledDataFileName ( bool bIsModel,
const ITargetPlatform* InTargetPlatform,
bool bIsDiskStreamer
)

 Compose file name.
Public function Const FString

GetCompiledDataFolderPath ( bool bIsEditorData
)

 Compose folder name where the data is stored.
Public function Const UFunction BlueprintCallable, Category int32 Method to query the amount of components this Customizable Object has.
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category float

GetFloatParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Float.
Public function Const UFunction BlueprintCallable, Category const FString &

GetIntParameterAvailableOption ( int32 ParamIndex,
int32 K
)

 Gets the Name of the option at position K in the list of available options for the int parameter.
Public function Const UFunction BlueprintCallable, Category int32

GetIntParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Int.
Public function Const UFunction BlueprintCallable, Category int32

GetIntParameterNumOptions ( int32 ParamIndex
)

 Returns how many possible options an int parameter has.
Public function void

GetLowPriorityTextureNames ( TArray< FString >& OutTextureNames
)

 Return the names used by mutable to identify which mu::Image should be considered of LowPriority.
Public function Const TSharedPtr< mu::Model, ESPMode::ThreadSafe >  
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category int Get the number of parameters available in any instance.
Public function Const UFunction BlueprintCallable, Category, Meta int32

GetParameterDescriptionCount ( const FString& ParamName
)

 Get the number of description images available for a parameter.
Public function Const UFunction BlueprintCallable, Category const FString &

GetParameterName ( int32 ParamIndex
)

 Get the name of a parameter.
Public function Const UFunction BlueprintCallable, Category EMutableParameterType

GetParameterType ( int32 ParamIndex
)

 Get the type of a parameter.
Public function Const UFunction BlueprintCallable, Category EMutableParameterType Get the type of a parameter.
Public function Const UFunction BlueprintCallable, Category FParameterUIData

GetParameterUIMetadata ( const FString& ParamName
)

  
Public function Const UFunction BlueprintCallable, Category FParameterUIData

GetParameterUIMetadataFromIndex ( int32 ParamIndex
)

  
Public function Const FCustomizableObjectPrivateData *  
Public function Const UFunction BlueprintCallable, Category void

GetProjectorParameterDefaultValue ( const FString& InParameterName,
FVector3f& OutPos,
FVector3f& OutDirection,
FVector3f& OutUp,
FVector3f& OutScale,
float& OutAngle,
ECustomizableObjectProjectorType& OutType
)

 Get the default value of a parameter of type Projector.
Public function Const FCustomizableObjectProjector

GetProjectorParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a projector with the provided name
Public function TSoftObjectPtr< UMaterialInterface >  
Public function TSoftObjectPtr< USkeleton >  
Public function USkeletalMesh *

GetRefSkeletalMesh ( int32 ComponentIndex
)

  
Public function FMutableRefSkeletalMeshData *

GetRefSkeletalMeshData ( int32 ComponentIndex
)

  
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const UFunction BlueprintCallable, Category FString

GetStateName ( int32 StateIndex
)

  
Public function Const UFunction BlueprintCallable, Category int32

GetStateParameterCount ( const FString& StateName
)

  
Public function Const int32

GetStateParameterCount ( int32 StateIndex
)

  
Public function Const int32

GetStateParameterIndex ( int32 StateIndex,
int32 ParameterIndex
)

  
Public function Const FString

GetStateParameterName ( int32 StateIndex,
int32 ParameterIndex
)

  
Public function Const UFunction BlueprintCallable, Category FString

GetStateParameterName ( const FString& StateName,
int32 ParameterIndex
)

  
Public function Const UFunction BlueprintCallable, Category FParameterUIData

GetStateUIMetadata ( const FString& StateName
)

  
Public function Const UFunction BlueprintCallable, Category FParameterUIData

GetStateUIMetadataFromIndex ( int32 StateIndex
)

  
Public function Const const UCustomizableObjectBulk * Return a pointer to the BulkData subobject, only valid in packaged builds.
Public function Const FName

GetTextureParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Texture.
Public function Const FGuid  
Public function Const UFunction BlueprintCallable, Category bool This will always return true in a packaged game.
Public function Const bool See UCustomizableObjectSystem::LockObject()
Public function Const bool

IsParameterMultidimensional ( const int32& InParamIndex
)

 Return true or false depending if the parameter at the index provided is multidimensional or not.
Public function Const UFunction BlueprintCallable, Category bool

IsParameterMultidimensional ( const FString& InParameterName
)

 Return true or false depending if the parameter at the index provided is multidimensional or not.
Public function void

LoadCompiledData ( FArchive& Ar,
bool bSkipEditorOnlyData
)

  
Public function void

LoadCompiledDataFromDisk ( bool bIsEditorData,
const ITargetPlatform* InTargetPlatform
)

 Load compiled data from disk, this is used to load Editor Compilations and Cook Compilations (when using OnCookStart)
Public function void Data that may be stored in the asset itself, only in packaged builds.
Public function UFunction BlueprintCallable, Category void Call before using Mutable's Projector testing with mask out features.
Public function void To avoid missing resources in packages we load all the resources. Loading the references added in the BeginCacheForCookedPlatformData will help us ensure they are included in the final package.
Public function UFunction BlueprintCallable, Category void Called to load the reference SkeletalMesh if it needs to be used as a placeholder and it's not loaded.
Public function void Callback of LoadReferenceSkeletalMeshesAsync.
Public function void  
Public function void

SaveCompiledData ( FArchive& Ar,
bool bSkipEditorOnlyData
)

 Generic Save/Load methods to write/read compiled data
Public function void  
Public function void  
Public function void

SetBoneNamesArray ( const TArray< FName >& BoneNames
)

  
Public function void

SetModel ( TSharedPtr< mu::Model, ESPMode::ThreadSafe > Model
)

  
Public function void Remove skeletons that have been destroyed by the garbage collector from the cache.
Public function UFunction BlueprintCallable, Category void Call after having used Mutable's Projector testing with mask out features. It should be unloaded because it can spend quite a lot of memory.
Public function UFunction BlueprintCallable, Category void  
Public function void Rebuild HashToStreamableBlocks and ParameterProperties from the current compiled model.
Public function void Create new GUID for this CO.

Overridden from UObject

  Type Name Description
Public function Virtual void Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
Public function Virtual void Called before destroying the object.
Public function Virtual Const void Used to set the flag IsRoot
Public function Virtual FString

GetDesc ()

 Returns a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual Const bool Called during saving to determine if the object is forced to be editor only or not
Public function Virtual void  
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PostRename ( UObject* OldOuter,
const FName OldName
)

 Called at the end of Rename(), but only if the rename was actually carried out
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
CurrentSupportedVersion This is a manual version number for the binary blobs in this asset.

Deprecated Variables

  Type Name Description
Public variable UProperty TObjectPtr< class USkeletalMesh > ReferenceSkeletalMesh_DEPRECATED All the SkeletalMeshes generated for this CustomizableObject instances will use the Reference Skeletal Mesh properties for everything that Mutable doesn't create or modify.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page