1. Epic GamesDeveloper
  3. MuCO

MuCO

API > API/Plugins > API/Plugins/CustomizableObject

Classes

  Type Name Description
Public class UClass ConversionRoot Blueprintable ClassGroup, Meta componentwrapperclass ACustomizableSkeletalMeshActor    
Public struct UStruct FAnimBpOverridePhysicsAssetsInfo    
Public class FBeginDestroyDelegate    
Public class FBeginUpdateDelegate When creating new delegates use the following conventions:  
Public struct UStruct FCompilationOptions    
Public struct UStruct BlueprintType FCustomizableObjectBoolParameterValue    
Public struct UStruct FCustomizableObjectClothConfigData    
Public struct UStruct FCustomizableObjectClothingAssetData    
Public class FCustomizableObjectCompilerBase    
Public struct FCustomizableObjectCustomVersion Custom serialization version for assets/classes in the CustomizableObject and CustomizableObjectEditor modules.  
Public struct UStruct FCustomizableObjectExtensionData Some data of an extension-defined type generated by a Customizable Object Extension  
Public struct FCustomizableObjectExternalTexture Opaque representation of a possible registered value for texture parameters.  
Public struct UStruct BlueprintType FCustomizableObjectFloatParameterValue    
Public struct UStruct BlueprintType FCustomizableObjectIdentifier    
Public struct UStruct BlueprintType FCustomizableObjectIdPair    
Public struct UStruct FCustomizableObjectInstanceDescriptor Set of parameters + state that defines a CustomizableObjectInstance.  
Public struct UStruct BlueprintType FCustomizableObjectIntParameterValue    
Public struct UStruct FCustomizableObjectMeshToMeshVertData A USTRUCT version of FMeshToMeshVertData in SkeletalMeshTypes.h We are taking advantage of the padding data to store from which asset this data comes from maintaining the same memory footprint than the original.  
Public struct FCustomizableObjectPinType A type of pin in the Mutable graph UI  
Public struct UStruct FCustomizableObjectProjector    
Public struct UStruct BlueprintType FCustomizableObjectProjectorParameterValue    
Public struct UStruct FCustomizableObjectStreamedExtensionData Used to store extension data that can be streamed in and out from an external package.  
Public struct UStruct BlueprintType FCustomizableObjectTextureParameterValue    
Public struct UStruct BlueprintType FCustomizableObjectVectorParameterValue    
Public class FDescriptorHash Hash of the Descriptor. Hashes everything except runtime information.  
Public class FDescriptorRuntimeHash Hash of the Descriptor. Hashes everything including runtime information.  
Public class FEachComponentAnimInstanceClassDelegate    
Public struct FEditorCompileSettings Struct used to keep a copy of the EditorSettings needed to compile Customizable Objects.  
Public struct UStruct FFParameterOptionsTags    
Public struct FInputPinDataContainer An Object node input pin and the data that was passed into it by the Customizable Object graph  
Public class FInstanceUpdateDelegate    
Public struct UStruct BlueprintType FIntegerParameterUIData    
Public struct UStruct FMaskOutTexture Represents a texture used for masking-out areas of an object from projectors.  
Public struct FMergedSkeleton    
Public struct UStruct FMorphTargetVertexData    
Public struct UStruct FMultilayerProjector Multilayer Projector Helper.  
Public struct UStruct BlueprintType FMultilayerProjectorLayer Data structure representing a Multilayer Projector Layer.  
Public struct UStruct BlueprintType FMultilayerProjectorVirtualLayer Data structure representing a Multilayer Projector Virtual Layer.  
Public struct FMutableCachedPlatformData    
Public struct FMutableImageOperationData Runtime data used during a mutable image mipmap update  
Public struct FMutableImageReference Key to identify an image inside a generated mutable runtime instance.  
Public struct UStruct FMutableLODSettings    
Public struct FMutableMipUpdateLevel    
Public struct UStruct FMutableModelImageProperties    
Public struct UStruct FMutableModelParameterProperties    
Public struct UStruct FMutableModelParameterValue    
Public struct UStruct BlueprintType FMutableParamUIMetadata    
Public struct UStruct FMutableRefAssetUserData    
Public struct UStruct FMutableRefLODData    
Public struct UStruct FMutableRefLODInfo    
Public struct UStruct FMutableRefLODRenderData    
Public struct UStruct FMutableRefSkeletalMeshData    
Public struct UStruct FMutableRefSkeletalMeshSettings    
Public struct UStruct FMutableRefSocket    
Public struct UStruct FMutableSkinWeightProfileInfo    
Public struct UStruct FMutableStreamableBlock    
Public class FMutableTaskGraph Mutable Tasks System.  
Public class FMutableTextureMipDataProvider    
Public class FMutableUpdateCandidate    
Public class FMutableUpdateContext This struct stores the data relevant for the construction of a specific texture.  
Public class FObjectInstanceUpdatedDelegate Broadcast when an Instance update has completed.  
Public struct FObjectNodeInputPin An input pin that will be added to Object nodes  
Public struct UStruct FParameterTags    
Public struct UStruct BlueprintType FParameterUIData    
Public struct UStruct FPendingReleaseSkeletalMeshInfo    
Public struct UStruct FProfileParameterDat    
Public struct FRegisteredCustomizableObjectPinType    
Public struct FRegisteredObjectNodeInputPin    
Public class FUnrealBakeHelpers    
Public class FUnrealExtensionDataStreamer An implementation of mu::ExtensionDataStreamer designed to work with the Customizable Object integration  
Public class FUnrealMutableModelBulkReader Implementation of a mutable streamer using bulk storage.  
Public class FUnrealMutableModelBulkWriter Implementation of a mutable streamer using bulk storage.  
Public struct UStruct FUpdateContext Instance Update Context. Used to avoid changing the delegate signature in the future.  
Public class ICustomizableObjectModule The public interface of the CustomizableObject module  
Public struct MutableCompiledDataStreamHeader Warning! MutableCompiledDataHeader must be the first data serialized in a stream.  
Public class Ptr Intrusive smart pointer similar to the one in the boost libraries (intrusive_ptr<>)  
Public class UClass Blueprintable, BlueprintType UCustomizableInstanceLODManagement    
Public class UClass Blueprintable, BlueprintType UCustomizableInstanceLODManagementBase This is an abstract base class, override it to create a new Instance LOD management system and register with UCustomizableObjectSystem::SetInstanceLODManagement.  
Public class UClass BlueprintType Config UCustomizableObject    
Public class UClass Config UCustomizableObjectBulk    
Public class UClass UCustomizableObjectExtension An extension that adds functionality to the Customizable Object system  
Public class UClass UCustomizableObjectExtensionDataContainer A simple container that's used to store the FCustomizableObjectStreamedExtensionData in a package  
Public class UClass Blueprintable, BlueprintType HideCategories UCustomizableObjectInstance    
Public class UClass Blueprintable, BlueprintType UCustomizableObjectSystem    
Public class UClass Blueprintable, BlueprintType ClassGroup, Meta UCustomizableSkeletalComponent    
Public class UClass Abstract UCustomizableSystemImageProvider Base class for Image provider.  
Public class UClass UDefaultImageProvider Simple image provider that translates UTexture2D to Mutable IDs.  
Public class UClass Abstract Blueprintable, BlueprintType UDGGUI    
Public class UClass UMutableMaskOutCache    
Public class UClass HideCategories UMutableTextureMipDataProviderFactory    
Public class UnrealMutableInputStream    
Public class UnrealMutableOutputStream    

Typedefs

Name Description
FBeginDestroyNativeDelegate  
FBeginUpdateNativeDelegate  
FEachComponentAnimInstanceClassNativeDelegate  
FMutableInstanceUpdateMap  
FMutableInstanceUpdateMap  
FObjectInstanceUpdatedNativeDelegate  
FPostCompileDelegate  
FProjectorStateChangedDelegate  
Type  
Type  

Enums

  Type Name Description
Public enum UEnum ECustomizableObjectCompilationState    
Public enum UEnum BlueprintType ECustomizableObjectGroupType    
Public enum UEnum ECustomizableObjectNumBoneInfluences    
Public enum UEnum ECustomizableObjectProjectorType    
Public enum UEnum ECustomizableObjectRelevancy    
Public enum UEnum BlueprintType EMutableCompileMeshType Customizable object mesh compilation options  
Public enum UEnum BlueprintType EMutableParameterType    
Public enum EQueuePriorityType Priority for the mutable update queue, Low is the normal distance-based priority, High is normally used for discards and Mid for LOD downgrades.  
Public enum EUpdateRequired Result of all the checks just before beginning an update.  
Public enum UEnum EUpdateResult Instance Update Result.  

Functions

  Type Name Description
Public function void

CopyTextureProperties ( UTexture2D* Texture,
const UTexture2D* SourceTexture
)

  
Public function void

FinishUpdateGlobal ( UCustomizableObjectInstance* Instance,
EUpdateResult UpdateResult,
FInstanceUpdateDelegate* UpdateCallback,
const FDescriptorRuntimeHash InUpdatedHash
)

 Before the Mutable Queue rework this made sense, but this is no longer the case. Remove this when doing MTBL-1409.
Public function CUSTOMIZABLEOBJECT_API UCustomizableSkeletalComponent *

GetPlayerCustomizableSkeletalComponent ( const int32 SlotID,
const UWorld* CurrentWorld,
const int32 PlayerIndex
)

 Utility function for commands
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function uint32  
Public function void Sets up all the channels that ought to be part of the Index Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupSkinBuffer ( const int32& InCurrentVertexBuffer,
const int32& MaxBoneIndexTypeSizeBytes,
const int32& MaxBoneWeightTypeSizeBytes,
const int32& MaxNumBonesPerVertex,
mu::FMeshBufferSet& OutTargetVertexBuffers
)

 Sets up all the channels that ought to be part of the Vertex Skin Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupSkinWeightProfileBuffer ( const int32& InCurrentVertexBuffer,
const int32& MaxBoneIndexTypeSizeBytes,
const int32& MaxBoneWeightTypeSizeBytes,
const int32& MaxNumBonesPerVertex,
const int32 SemanticsIndex,
mu::FMeshBufferSet& OutTargetVertexBuffers
)

 Sets up all the channels that ought to be part of the Vertex SkinWeightProfile Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupTangentBuffer ( const int32& InCurrentVertexBuffer,
mu::FMeshBufferSet& OutTargetVertexBuffers
)

 Sets up all the channels that ought to be part of the Vertex Tangent Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupTexCoordinatesBuffer ( const int32& InCurrentVertexBuffer,
const int32& InChannelCount,
mu::FMeshBufferSet& OutTargetVertexBuffers,
const int32* InTextureSemanticIndicesOverride
)

 Sets up all the channels that ought to be part of the Vertex Texture Coordinates Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupVertexColorBuffer ( const int32& InCurrentVertexBuffer,
mu::FMeshBufferSet& OutTargetVertexBuffers
)

 Sets up all the channels that ought to be part of the Vertex Color Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function void

MutableMeshBufferUtils::SetupVertexPositionsBuffer ( const int32& InCurrentVertexBuffer,
mu::FMeshBufferSet& OutTargetVertexBuffers
)

 Sets up all the channels that ought to be part of the Vertex Position Buffer of the Mutable mesh owning the provided MeshBufferSet
Public function CUSTOMIZABLEOBJECT_API ECustomizableObjectProjectorType Get with the equivalent type of CO projector provided a mutable internal projector type.
Public function CUSTOMIZABLEOBJECT_API mu::PROJECTOR_TYPE Get the equivalent mutable projector type to the CO mutable projector type.

Variables

  Type Name Description
Public variable const FString AsyncUpdatePending  
Public variable const Type BuiltInstances  
Public variable const FString Correct  
Public variable const Type Count  
Public variable TAutoConsoleVariable< bool > CVarClearWorkingMemoryOnUpdateEnd  
Public variable TAutoConsoleVariable< bool > CVarReuseImagesBetweenInstances  
Public variable const Type Hidden  
Public variable constexpr int32 MaxTexCordChannelCount Determines the max amount of channels that can inhabit a Texture Coordinate buffer.
Public variable const FString PostUpdateError  
Public variable const Type Rotate  
Public variable const Type Scale  
Public variable const Type Selected  
Public variable   STATCAT_Advanced Mutable stats.
Public variable const Type Translate  
Public variable const Type TypeChanged  
Public variable const FString UpdateError  
Public variable const Type UpdateOperations  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page