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 (BlueprintType, Config=Engine)  
class UCustomizableObject : public UObject

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bDisableTableMaterialsParentCheck 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.
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 bEnableAssetUserDataMerge When this is enabled generated meshes will merge the AssetUserData from all of its constituent mesh parts.
Public variable UProperty Category, EditAnywhere bool bEnableClothing  
Public variable UProperty Category, EditAnywhere bool bEnableMeshCache 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.
Public variable UProperty Category, EditAnywhere bool bEnableMeshStreaming If true, Mesh LODs will be streamed on demand.
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 Category, EditAnywhere displayname bool bPreserveUserLODsOnFirstGeneration Use the Instance MinLOD, and RequestedLODs in the descriptor when performing the initial generation (ignore LOD Management).
Public variable UProperty Transient TArray< FCustomizableObjectMeshToMeshVertData > ClothMeshToMeshVertData  
Public variable UProperty Transient TArray< FCustomizableObjectClothConfigData > ClothSharedConfigsData  
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 Category, EditAnywhere, Meta FMutableLODSettings LODSettings  
Public variable UProperty Category, EditAnywhere EMutableCompileMeshType MeshCompileType Options when compiling this customizable object (see EMutableCompileMeshType declaration for info)
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< 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 TObjectPtr< UEdGraph > Source Editor graph.
Public variable UProperty Category, EditAnywhere TObjectPtr< UObject > VersionBridge The optional VersionBridge asset, which must implement the ICustomizableObjectVersionBridgeInterface, will be used to decide which Mutable child CustomizableObjects and table rows must be included in a compilation/cook depending on its version struct/column by comparing it to the game-specific version system.
Public variable UProperty Category, EditAnywhere FInstancedStruct VersionStruct This optional struct is used to define which version this child CustomizableObject belongs to.
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 bool Compile the object if Automatic Compilation is enabled and has not been already compiled.
Public function UFunction BlueprintCallable, Category UCustomizableObjectInstance * Create a new instance of this object.
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 from its name. Return -1 if the parameter is not found.
Public function Const int32

FindState ( const FString& Name
)

  
Public function Const UFunction BlueprintCallable, Category bool

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

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

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

 Get the default value of a parameter of type Color.
Public function Const UFunction BlueprintCallable, Category int32 Get the number of components this Customizable Object has.
Public function Const UFunction BlueprintCallable, Category float

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

 Get the default value of a parameter of type Float.
Public function Const UFunction BlueprintCallable, Category const FString & 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 ( UPARAM(DisplayName="Parameter Name") const FString& InParameterName
)

 Get the default value of a parameter of type Int.
Public function Const UFunction BlueprintCallable, Category int32 Returns how many possible options an int parameter has, if the parameter is an enumeration.
Public function Const int32  
Public function Const UFunction BlueprintCallable, Category int32 Get the number of parameters available in instances of this object.
Public function Const UFunction BlueprintCallable, Category, Meta int32

GetParameterDescriptionCount ( const FString& ParamName
)

 Deprecated. It will always return 0.
Public function Const UFunction BlueprintCallable, Category const FString &

GetParameterName ( int32 ParamIndex
)

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

GetParameterType ( int32 ParamIndex
)

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

GetParameterUIMetadata ( const FString& ParamName
)

 Return the metadata associated to an object parameter by parameter name.
Public function Const UFunction BlueprintCallable, Category FParameterUIData Return the metadata associated to an object parameter by parameter index (from 0 to GetParameterCount-1).
Public function Const FPostCompileDelegate &  
Public function Const UCustomizableObjectPrivate *  
Public function Const UFunction BlueprintCallable, Category 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
)

 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 Const USkeletalMesh *

GetRefSkeletalMesh ( int32 ComponentIndex
)

  
Public function Const UFunction BlueprintCallable, Category int32 Return the number of object states that are defined in the CustomizableObject.
Public function Const UFunction BlueprintCallable, Category FString

GetStateName ( int32 StateIndex
)

 Return the name of an object state from its index.
Public function Const UFunction BlueprintCallable, Category int32

GetStateParameterCount ( const FString& StateName
)

 Return the number of parameters that are editable at runtime for a specific state.
Public function Const int32

GetStateParameterCount ( int32 StateIndex
)

  
Public function Const int32

GetStateParameterIndex ( int32 StateIndex,
int32 ParameterIndex
)

  
Public function Const UFunction BlueprintCallable, Category FString

GetStateParameterName ( int32 StateIndex,
int32 ParameterIndex
)

  
Public function Const UFunction BlueprintCallable, Category FString

GetStateParameterName ( const FString& StateName,
int32 ParameterIndex
)

 Return the name of one of the state's runtime parameters, by its index (from 0 to GetStateParameterCount-1).
Public function Const UFunction BlueprintCallable, Category FParameterUIData

GetStateUIMetadata ( const FString& StateName
)

 Return the metadata associated to an object state by name.
Public function Const UFunction BlueprintCallable, Category FParameterUIData Return the metadata associated to an object state by state index.
Public function Const FName

GetTextureParameterDefaultValue ( const FString& InParameterName
)

 Get the default value of a parameter of type Texture.
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category bool Check if the CustomizableObject asset has been compiled.
Public function Const bool

IsParameterMultidimensional ( const int32& InParamIndex
)

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

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

 Return true if the parameter at the index provided is multidimensional.

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 Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
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 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 Called from within SavePackage on the passed in base/root object.
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page