Navigation
API > API/Plugins > API/Plugins/CustomizableObject
| Name | UCustomizableObjectInstance |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/CustomizableObject/Public/MuCO/CustomizableObjectInstance.h |
| Include Path | #include "MuCO/CustomizableObjectInstance.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, HideCategories=(CustomizableObjectInstance))
class UCustomizableObjectInstance : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCustomizableObjectInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCustomizableObjectInstance() |
MuCO/CustomizableObjectInstance.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PreSetSkeletalMeshDelegate | FPreSetSkeletalMeshDelegate | Broadcast before setting the generated Skeletal Mesh to the Skeletal Mesh Components. | MuCO/CustomizableObjectInstance.h | |
| PreSetSkeletalMeshNativeDelegate | FPreSetSkeletalMeshNativeDelegate | Broadcast before setting the generated Skeletal Mesh to the Skeletal Mesh Components. | MuCO/CustomizableObjectInstance.h | |
| UpdatedDelegate | FObjectInstanceUpdatedDelegate | Broadcast when the Customizable Object Instance is updated. | MuCO/CustomizableObjectInstance.h |
|
| UpdatedNativeDelegate | FObjectInstanceUpdatedNativeDelegate | Broadcast when the Customizable Object Instance is updated. | MuCO/CustomizableObjectInstance.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Descriptor | FCustomizableObjectInstanceDescriptor | MuCO/CustomizableObjectInstance.h | ||
| FMutableUpdateCandidate | friend | MuCO/CustomizableObjectInstance.h | ||
| PrivateData | TObjectPtr< UCustomizableInstancePrivate > | MuCO/CustomizableObjectInstance.h | ||
| UCustomizableInstancePrivate | friend | Friends. | MuCO/CustomizableObjectInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 AddValueToFloatRange
(
const FString& ParamName |
Increases the range of values of the float with ParamName, returns the index of the new float value, -1 otherwise. | MuCO/CustomizableObjectInstance.h |
|
int32 AddValueToIntRange
(
const FString& ParamName |
Increases the range of values of the integer with ParamName and returns the index of the new integer value, -1 otherwise. | MuCO/CustomizableObjectInstance.h |
|
int32 AddValueToProjectorRange
(
const FString& ParamName |
Increases the range of values of the projector with ParamName, returns the index of the new projector value, -1 otherwise. | MuCO/CustomizableObjectInstance.h |
|
void AnimInstanceFixup
(
UAnimInstance* AnimInstance |
Fix the given UAnimInstance instance. | MuCO/CustomizableObjectInstance.h | |
bool AnimInstanceNeedsFixup
(
TSubclassOf< UAnimInstance > AnimInstance |
Check if the given UAnimInstance class requires to be fixed up. | MuCO/CustomizableObjectInstance.h | |
void Bake
(
const FBakingConfiguration& InBakingConfiguration |
Performs the baking of the instance resources in an async fashion. | MuCO/CustomizableObjectInstance.h |
|
UCustomizableObjectInstance * Clone() |
Clones the instance creating a new identical transient instance. | MuCO/CustomizableObjectInstance.h |
|
UCustomizableObjectInstance * CloneStatic
(
UObject* Outer |
Clones the instance creating a new identical static instance with the given Outer. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsBoolParameter
(
const FString& ParameterName |
Return true if the Bool Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsEnumParameter
(
const FString& ParameterName |
Return true if the Int Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsFloatParameter
(
const FString& ParameterName |
Return true if the Float Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsIntParameter
(
const FString& ParameterName |
DEPRECATED. Use ContainsEnumParameter instead. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsMaterialParameter
(
const FString& ParameterName |
Return true if the Material Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsProjectorParameter
(
const FString& ParameterName |
Return true if the Projector Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsSkeletalMeshParameter
(
const FString& ParameterName |
Return true if the Skeletal Mesh Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsTextureParameter
(
const FString& ParameterName |
Return true if the Texture Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsTransformParameter
(
const FString& ParameterName |
Return true if the Transform Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
bool ContainsVectorParameter
(
const FString& ParameterName |
Return true if the Vector Parameter exists. | MuCO/CustomizableObjectInstance.h |
|
void CopyParametersFromInstance
(
UCustomizableObjectInstance* Instance |
Copy parameters from the given Instance. | MuCO/CustomizableObjectInstance.h | |
void DestroyLiveUpdateInstance() |
Immediately destroy the Mutable Core Live Update Instance attached to this (if exists). | MuCO/CustomizableObjectInstance.h | |
void ForEachAnimInstance
(
int32 ObjectComponentIndex, |
DEPRECATED: Use ForEachComponentAnimInstance. | MuCO/CustomizableObjectInstance.h | |
void ForEachAnimInstance
(
int32 ObjectComponentIndex, |
DEPRECATED: Use ForEachComponentAnimInstance. | MuCO/CustomizableObjectInstance.h |
|
void ForEachComponentAnimInstance
(
FName ComponentName, |
Execute a delegate for each animation instance involved in this customizable object instance. | MuCO/CustomizableObjectInstance.h |
|
void ForEachComponentAnimInstance
(
FName ComponentName, |
MuCO/CustomizableObjectInstance.h | ||
const FGameplayTagContainer & GetAnimationGameplayTags() |
Return the list of tags for this instance. | MuCO/CustomizableObjectInstance.h |
|
TSubclassOf< UAnimInstance > GetAnimBP
(
FName ComponentName, |
Returns the animation BP for the parameter component and slot, gathered from all the meshes that compose this instance. | MuCO/CustomizableObjectInstance.h |
|
bool GetBoolParameterSelectedOption
(
const FString& BoolParamName |
Gets the bool value "BoolValue" of a bool parameter with name "BoolParamName". | MuCO/CustomizableObjectInstance.h |
|
bool GetBuildParameterRelevancy() |
Return true if the parameter relevancy will be updated when this instance is generated. | MuCO/CustomizableObjectInstance.h |
|
FLinearColor GetColorParameterSelectedOption
(
const FString& ColorParamName |
Gets the value of a color parameter with name "ColorParamName". | MuCO/CustomizableObjectInstance.h |
|
USkeletalMesh * GetComponentMeshSkeletalMesh
(
const FName& ComponentName |
DEPRECATED: Use GetSkeletalMeshComponentSkeletalMesh. | MuCO/CustomizableObjectInstance.h |
|
TArray< FName > GetComponentNames () |
Return the list of names of components generated for this instance. | MuCO/CustomizableObjectInstance.h |
|
FString GetCurrentState() |
Return the name of the current CustomizableObject state this is instance is set to. | MuCO/CustomizableObjectInstance.h |
|
UCustomizableObject * GetCustomizableObject() |
Get the CustomizableObject that this is an instance of. | MuCO/CustomizableObjectInstance.h |
|
| Return the name of the option currently set in the given parameter. | MuCO/CustomizableObjectInstance.h |
|
|
FInstancedStruct GetExtensionInstanceData
(
const UCustomizableObjectExtension* Extension |
MuCO/CustomizableObjectInstance.h |
|
|
float GetFloatParameterSelectedOption
(
const FString& FloatParamName, |
Gets the value of a float parameter with name "FloatParamName". | MuCO/CustomizableObjectInstance.h |
|
int32 GetFloatValueRange
(
const FString& ParamName |
For multidimensional parameters, return the number of dimensions that the given float parameter supports. | MuCO/CustomizableObjectInstance.h |
|
| DEPRECATED. Use GetEnumParameterSelectedOption instead. | MuCO/CustomizableObjectInstance.h |
|
|
int32 GetIntValueRange
(
const FString& ParamName |
For multidimensional parameters, return the number of dimensions that the given int parameter supports. | MuCO/CustomizableObjectInstance.h |
|
bool GetIsBeingUsedByComponentInPlay() |
MuCO/CustomizableObjectInstance.h | ||
bool GetIsDiscardedBecauseOfTooManyInstances() |
MuCO/CustomizableObjectInstance.h | ||
UMaterialInterface * GetMaterialParameterSelectedOption
(
const FString& MaterialParamName, |
Gets the value of a Material parameter with name "MaterialParamName". | MuCO/CustomizableObjectInstance.h |
|
TSet< UAssetUserData * > GetMergedAssetUserData
(
int32 ComponentIndex |
Returns the AssetUserData that was gathered from all the constituent mesh parts during the last update. | MuCO/CustomizableObjectInstance.h |
|
float GetMinSquareDistToPlayer() |
MuCO/CustomizableObjectInstance.h | ||
int32 GetNumComponents () |
Return the total number of components that can be generated with the CustomizableObject (unrelated to this instance parameters). | MuCO/CustomizableObjectInstance.h |
|
const TArray< TObjectPtr< UMaterialInterface > > * GetOverrideMaterials
(
int32 ComponentIndex |
DEPRECATED: Use GetSkeletalMeshComponentOverrideMaterials. | MuCO/CustomizableObjectInstance.h | |
UCustomizableInstancePrivate * GetPrivate() |
MuCO/CustomizableObjectInstance.h | ||
FCustomizableObjectProjector GetProjector
(
const FString& ParamName, |
Get the current projector for the parameter with the given name. | MuCO/CustomizableObjectInstance.h | |
float GetProjectorAngle
(
const FString& ParamName, |
Get the current cylindrical projector angle for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
FVector GetProjectorDirection
(
const FString& ParamName, |
Get the current projector direction vector for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
ECustomizableObjectProjectorType GetProjectorParameterType
(
const FString& ParamName, |
Get the current projector type for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
FVector GetProjectorPosition
(
const FString& ParamName, |
Get the current projector position for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
FVector GetProjectorScale
(
const FString& ParamName, |
Get the current projector scale for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
FVector GetProjectorUp
(
const FString& ParamName, |
Get the current projector up vector for the parameter with the given name. | MuCO/CustomizableObjectInstance.h |
|
void GetProjectorValue
(
const FString& ProjectorParamName, |
Get the projector values of a projector parameter with index "ProjectorParamIndex". | MuCO/CustomizableObjectInstance.h |
|
void GetProjectorValueF
(
const FString& ProjectorParamName, |
MuCO/CustomizableObjectInstance.h | ||
int32 GetProjectorValueRange
(
const FString& ParamName |
For multidimensional parameters, return the number of dimensions that the given projector parameter supports. | MuCO/CustomizableObjectInstance.h |
|
USkeletalMesh * GetSkeletalMesh
(
int32 ComponentIndex |
DEPRECATED: Use GetSkeletalMeshComponentSkeletalMesh. | MuCO/CustomizableObjectInstance.h |
|
TArray< UMaterialInterface * > GetSkeletalMeshComponentOverrideMaterials
(
const FName& ComponentName |
MuCO/CustomizableObjectInstance.h |
|
|
USkeletalMesh * GetSkeletalMeshComponentSkeletalMesh
(
const FName& ComponentName |
Given a Mesh Component name, return its generated Skeletal Mesh. | MuCO/CustomizableObjectInstance.h |
|
USkeletalMesh * GetSkeletalMeshParameterSelectedOption
(
const FString& SkeletalMeshParamName, |
Gets the value of a Skeletal Mesh parameter with name "SkeletalMeshParamName". | MuCO/CustomizableObjectInstance.h |
|
| Gets the value of a texture parameter with name "TextureParamName". | MuCO/CustomizableObjectInstance.h |
|
|
int32 GetTextureValueRange
(
const FString& ParamName |
For multidimensional parameters, return the number of dimensions that the given texture parameter supports. | MuCO/CustomizableObjectInstance.h |
|
FTransform GetTransformParameterSelectedOption
(
const FString& TransformParamName |
Gets the value of a transform parameter with name "TransformParamName". | MuCO/CustomizableObjectInstance.h |
|
bool HasAnyParameters() |
Return true if the instance has any parameters. | MuCO/CustomizableObjectInstance.h |
|
bool HasAnySkeletalMesh() |
Return true if a skeletal mesh has been generated for any component of this instance. | MuCO/CustomizableObjectInstance.h |
|
bool IsParameterDirty
(
const FString& ParamName, |
Return true if the parameter has changed but the Instance has not yet been updated. | MuCO/CustomizableObjectInstance.h |
|
bool IsParameterRelevant
(
int32 ParameterIndex |
Return true if changing the parameter would affect the Instance given its current generation. | MuCO/CustomizableObjectInstance.h | |
bool IsParameterRelevant
(
const FString& ParamName |
Return true if the given parameter has any effect in the current object state, and considering the current values of the other parameters. | MuCO/CustomizableObjectInstance.h |
|
void LoadDescriptor
(
FArchive& CustomizableObjectDescriptor |
See FCustomizableObjectInstanceDescriptor::LoadDescriptor. | MuCO/CustomizableObjectInstance.h | |
void MultilayerProjectorCreateLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::CreateLayer. | MuCO/CustomizableObjectInstance.h |
|
FMultilayerProjectorLayer MultilayerProjectorGetLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::GetLayer. | MuCO/CustomizableObjectInstance.h |
|
int32 MultilayerProjectorNumLayers
(
const FName& ProjectorParamName |
Multilayer ProjectorsSee FMultilayerProjector::NumLayers. | MuCO/CustomizableObjectInstance.h |
|
void MultilayerProjectorRemoveLayerAt
(
const FName& ProjectorParamName, |
See FMultilayerProjector::RemoveLayerAt. | MuCO/CustomizableObjectInstance.h |
|
void MultilayerProjectorUpdateLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::UpdateLayer. | MuCO/CustomizableObjectInstance.h |
|
int32 RemoveValueFromFloatRange
(
const FString& ParamName, |
Remove the FRangeIndex element of the float range of values from the parameter ParamName. | MuCO/CustomizableObjectInstance.h |
|
int32 RemoveValueFromIntRange
(
const FString& ParamName, |
Remove the FRangeIndex element of the integer range of values from the parameter ParamName. | MuCO/CustomizableObjectInstance.h |
|
int32 RemoveValueFromProjectorRange
(
const FString& ParamName, |
Remove the FRangeIndex element of the projector range of values from the parameter ParamName. | MuCO/CustomizableObjectInstance.h |
|
void SaveDescriptor
(
FArchive& CustomizableObjectDescriptor, |
See FCustomizableObjectInstanceDescriptor::SaveDescriptor. | MuCO/CustomizableObjectInstance.h | |
void SetBoolParameterSelectedOption
(
const FString& BoolParamName, |
Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName". | MuCO/CustomizableObjectInstance.h |
|
void SetBuildParameterRelevancy
(
bool Value |
Set the flag that controls if parameter relevancy will be updated when this instance is generated. | MuCO/CustomizableObjectInstance.h |
|
void SetColorParameterSelectedOption
(
const FString& ColorParamName, |
Sets the color value "ColorValue" of a color parameter with index "ColorParamIndex". | MuCO/CustomizableObjectInstance.h |
|
void SetCurrentState
(
const FString& StateName |
Set the CustomizableObject state that this instance will be generated into. | MuCO/CustomizableObjectInstance.h |
|
void SetDefaultValue
(
const FString& ParamName |
Sets a parameter to its default value | MuCO/CustomizableObjectInstance.h |
|
void SetDefaultValues() |
Set all parameters to their default value. | MuCO/CustomizableObjectInstance.h |
|
| Set the currently selected option value for the given parameter, by parameter name and option name. | MuCO/CustomizableObjectInstance.h |
|
|
void SetFloatParameterSelectedOption
(
const FString& FloatParamName, |
Sets the float value "FloatValue" of a float parameter with index "FloatParamIndex". | MuCO/CustomizableObjectInstance.h |
|
void SetForceGenerateResidentMips
(
bool bForceGenerateResidentMips |
If enabled, low-priority textures will generate resident mipmaps too. | MuCO/CustomizableObjectInstance.h | |
| DEPRECATED. Use SetEnumParameterSelectedOption instead. | MuCO/CustomizableObjectInstance.h |
|
|
void SetIsBeingUsedByComponentInPlay
(
bool bIsUsedByComponent |
The following methods should only be used in an LOD management class. | MuCO/CustomizableObjectInstance.h | |
void SetIsDiscardedBecauseOfTooManyInstances
(
bool bIsDiscarded |
MuCO/CustomizableObjectInstance.h | ||
void SetIsPlayerOrNearIt
(
bool NewValue |
MuCO/CustomizableObjectInstance.h | ||
void SetMaterialParameterSelectedOption
(
const FString& MaterialParamName, |
Sets the Material value "MaterialParamName" of a Material parameter with index "MaterialParamName". | MuCO/CustomizableObjectInstance.h |
|
void SetMinSquareDistToPlayer
(
float NewValue |
MuCO/CustomizableObjectInstance.h | ||
void SetObject
(
UCustomizableObject* InObject |
Set the CustomizableObject this instance will be generated from. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorAngle
(
const FString& ProjectorParamName, |
Set only the cylindrical projector angle keeping the rest of values. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorDirection
(
const FString& ProjectorParamName, |
Set only the projector direction vector keeping the rest of values. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorPosition
(
const FString& ProjectorParamName, |
Set only the projector position keeping the rest of values. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorScale
(
const FString& ProjectorParamName, |
Set only the projector scale keeping the rest of values. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorUp
(
const FString& ProjectorParamName, |
Set only the projector up vector keeping the rest of values. | MuCO/CustomizableObjectInstance.h |
|
void SetProjectorValue
(
const FString& ProjectorParamName, |
Sets the projector values of a projector parameter with index "ProjectorParamIndex". | MuCO/CustomizableObjectInstance.h |
|
void SetRandomValues() |
Set random values to the parameters. | MuCO/CustomizableObjectInstance.h |
|
void SetRandomValuesFromStream
(
const FRandomStream& InStream |
Set random values to the parameters using a stream. | MuCO/CustomizableObjectInstance.h |
|
void SetReplacePhysicsAssets
(
bool bReplaceEnabled |
Enable physics asset replacement so that generated skeletal meshes have the merged physics assets of their skeletal mesh parts and reference mesh. | MuCO/CustomizableObjectInstance.h |
|
void SetRequestedLODs
(
const TMap< FName, uint8 >& InMinLODs, |
Sets an array of LODs to generate per component. | MuCO/CustomizableObjectInstance.h | |
void SetReuseInstanceTextures
(
bool bTextureReuseEnabled |
Enables the reuse of all possible textures when the instance is updated without any changes in geometry or state (the first update after creation doesn't reuse any) It will only work if the textures aren't compressed, so set the instance to a Mutable state with texture compression disabled WARNING! If texture reuse is enabled, do NOT keep external references to the textures of the instance. | MuCO/CustomizableObjectInstance.h | |
void SetSkeletalMeshParameterSelectedOption
(
const FString& SkeletalMeshParamName, |
Sets the Skeletal Mesh value "SkeletalMeshValue" of a Skeletal Mesh parameter with index "SkeletalMeshParamName". | MuCO/CustomizableObjectInstance.h |
|
| Sets the texture value "TextureValue" of a texture parameter with index "TextureParamIndex". | MuCO/CustomizableObjectInstance.h |
|
|
void SetTransformParameterSelectedOption
(
const FString& TransformParamName, |
Sets the transform value "TransformValue" of a transform parameter with name "TransformParamName". | MuCO/CustomizableObjectInstance.h |
|
void SetVectorParameterSelectedOption
(
const FString& VectorParamName, |
Sets the vector value "VectorValue" of a vector parameter with index "VectorParamIndex". | MuCO/CustomizableObjectInstance.h |
|
void UpdateSkeletalMeshAsync
(
bool bIgnoreCloseDist, |
Generate the instance with the current parameters and update all the components Skeletal Meshes asynchronously. | MuCO/CustomizableObjectInstance.h |
|
void UpdateSkeletalMeshAsyncResult
(
FInstanceUpdateDelegate Callback, |
Generate the instance with the current parameters and update all the components Skeletal Meshes asynchronously. | MuCO/CustomizableObjectInstance.h |
|
void UpdateSkeletalMeshAsyncResult
(
FInstanceUpdateNativeDelegate Callback, |
MuCO/CustomizableObjectInstance.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
MuCO/CustomizableObjectInstance.h | ||
virtual bool CanEditChange
(
const FProperty* InProperty |
MuCO/CustomizableObjectInstance.h | ||
virtual FString GetDesc() |
MuCO/CustomizableObjectInstance.h | ||
virtual bool IsEditorOnly() |
MuCO/CustomizableObjectInstance.h | ||
virtual bool IsReadyForFinishDestroy() |
MuCO/CustomizableObjectInstance.h | ||
virtual void PostInitProperties() |
MuCO/CustomizableObjectInstance.h | ||
virtual void PostLoad() |
MuCO/CustomizableObjectInstance.h | ||
virtual void PostTransacted
(
const FTransactionObjectEvent& TransactionEvent |
MuCO/CustomizableObjectInstance.h | ||
virtual void Serialize
(
FArchive& Ar |
MuCO/CustomizableObjectInstance.h |