1. Epic GamesDeveloper
  3. UCustomizableObjectInstance

UCustomizableObjectInstance

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, BlueprintType, HideCategories=(CustomizableObjectInstance))  
class UCustomizableObjectInstance : public UObject

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere TArray< TObjectPtr< UTexture2D > > TextureParameterDeclarations Textures which can used as values in Texture Parameters.
Public variable UProperty Category BlueprintAssignable Transient FObjectInstanceUpdatedDelegate UpdatedDelegate Broadcast when the Customizable Object Instance is updated.
Public variable FObjectInstanceUpdatedNativeDelegate UpdatedNativeDelegate Broadcast when the Customizable Object Instance is updated.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category 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.
Public function Const void

AnimInstanceFixup ( UAnimInstance* AnimInstance
)

 Fix the given UAnimInstance instance.
Public function Const bool

AnimInstanceNeedsFixup ( TSubclassOf< UAnimInstance > AnimInstance
)

 Check if the given UAnimInstance class requires to be fixed up.
Public function Const bool Return true if the instance is not locked and if it's compiled.
Public function UFunction BlueprintCallable, Category UCustomizableObjectInstance *

Clone ()

 Clones the instance creating a new identical transient instance.
Public function UFunction BlueprintCallable, Category UCustomizableObjectInstance *

CloneStatic ( UObject* Outer
)

 Clones the instance creating a new identical static instance with the given Outer.
Public function void Copy parameters from the given Instance.
Public function UFunction BlueprintCallable, Category bool

CreateMultiLayerProjector ( const FName& ProjectorParamName
)

 Multilayer Projectors
Public function void Immediately destroy the Mutable Core Live Update Instance attached to this (if exists).
Public function Const UFunction BlueprintCallable, Category int32

FindBoolParameterNameIndex ( const FString& ParamName
)

 Finds in BoolParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const UFunction BlueprintCallable, Category int32

FindFloatParameterNameIndex ( const FString& ParamName
)

 Finds in FloatParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const UFunction BlueprintCallable, Category int32

FindIntParameterNameIndex ( const FString& ParamName
)

 Finds in IntParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const UFunction BlueprintCallable, Category int32 Finds in ProjectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const UFunction BlueprintCallable, Category int32

FindVectorParameterNameIndex ( const FString& ParamName
)

 Finds in VectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise.
Public function Const void  
Public function Const UFunction BlueprintCallable, Category void Execute a delegate for each animation instance involved in this customizable object instance.
Public function Const UFunction BlueprintCallable, Category const FGameplayTagContainer & Return the list of tags for this instance.
Public function Const UFunction BlueprintCallable, Category TSubclassOf< UAnimInstance >

GetAnimBP ( int32 ComponentIndex,
const FName& Slot
)

 Returns the animation BP for the parameter component and slot, gathered from all the meshes that compose this instance.
Public function Const const TArray< FCustomizableObjectBoolParameterValue > &  
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectBoolParameterValue > & Get the array of parameters in the instance that are of type "bool".
Public function Const UFunction BlueprintCallable, Category bool

GetBoolParameterSelectedOption ( const FString& BoolParamName
)

 Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName".
Public function Const UFunction BlueprintCallable, Category bool Return true if the parameter relevancy will be updated when this instance is generated.
Public function Const UFunction BlueprintCallable, Category FLinearColor

GetColorParameterSelectedOption ( const FString& ColorParamName
)

 Gets the value of a color parameter with name "ColorParamName".
Public function Const int32 Return the min LOD this Instance is using.
Public function Const UFunction BlueprintCallable, Category FString Return the name of the current CustomizableObject state this is instance is set to.
Public function Const UFunction BlueprintCallable, Category UCustomizableObject * Get the CustomizableObject that this is an instance of.
Public function Const const FCustomizableObjectInstanceDescriptor &  
Public function Const const TArray< FCustomizableObjectFloatParameterValue > &  
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectFloatParameterValue > & Get the array of parameters in the instance that are of type "float".
Public function Const UFunction BlueprintCallable, Category float

GetFloatParameterSelectedOption ( const FString& FloatParamName,
int32 RangeIndex
)

 Gets the value of a float parameter with name "FloatParamName".
Public function Const UFunction BlueprintCallable, Category int32

GetFloatValueRange ( const FString& ParamName
)

 For multidimensional parameters, return the number of dimensions that the given float parameter supports.
Public function Const const TArray< FCustomizableObjectIntParameterValue > &  
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectIntParameterValue > & Get the array of parameters in the instance that are of type "integer".
Public function Const UFunction BlueprintCallable, Category const FString &

GetIntParameterSelectedOption ( const FString& ParamName,
int32 RangeIndex
)

 Return the name of the option currently set in the given parameter.
Public function Const UFunction BlueprintCallable, Category int32

GetIntValueRange ( const FString& ParamName
)

 For multidimensional parameters, return the number of dimensions that the given int parameter supports.
Public function Const bool  
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category TSet< UAssetUserData * >

GetMergedAssetUserData ( int32 ComponentIndex
)

 Returns the AssetUserData that was gathered from all the constituent mesh parts during the last update.
Public function Const int32 Return the min LOD that will be used in the next Instance update.
Public function Const float  
Public function Const UFunction BlueprintCallable, Category int32 Return the number of components generated in this instance.
Public function Const int32  
Public function Const const TArray< TObjectPtr< UMaterialInterface > > *

GetOverrideMaterials ( int32 ComponentIndex
)

  
Public function Const UCustomizableInstancePrivate *  
Public function Const FCustomizableObjectProjector

GetProjector ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category float

GetProjectorAngle ( const FString& ParamName,
int32 RangeIndex
)

 Get the current cylindrical projector angle for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category FVector

GetProjectorDirection ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector direction vector for the parameter with the given name.
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectProjectorParameterValue > & Get the array of parameters in the instance that are of type "projector".
Public function Const const TArray< FCustomizableObjectProjectorParameterValue > &  
Public function Const UFunction BlueprintCallable, Category ECustomizableObjectProjectorType

GetProjectorParameterType ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector type for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category FVector

GetProjectorPosition ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector position for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category FVector

GetProjectorScale ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector scale for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category FVector

GetProjectorUp ( const FString& ParamName,
int32 RangeIndex
)

 Get the current projector up vector for the parameter with the given name.
Public function Const UFunction BlueprintCallable, Category void

GetProjectorValue ( const FString& ProjectorParamName,
FVector& OutPos,
FVector& OutDirection,
FVector& OutUp,
FVector& OutScale,
float& OutAngle,
ECustomizableObjectProjectorType& OutType,
int32 RangeIndex
)

 Get the projector values of a projector parameter with index "ProjectorParamIndex".
Public function Const void

GetProjectorValueF ( const FString& ProjectorParamName,
FVector3f& Pos,
FVector3f& Direction,
FVector3f& Up,
FVector3f& Scale,
float& Angle,
ECustomizableObjectProjectorType& Type,
int32 RangeIndex
)

  
Public function Const UFunction BlueprintCallable, Category int32

GetProjectorValueRange ( const FString& ParamName
)

 For multidimensional parameters, return the number of dimensions that the given projector parameter supports.
Public function Const const TArray< uint16 > &  
Public function Const UFunction BlueprintCallable, Category USkeletalMesh *

GetSkeletalMesh ( int32 ComponentIndex
)

 Get the skeletal mesh generated for this instance.
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectTextureParameterValue > & Get the array of parameters in the instance that are of type "texture".
Public function Const const TArray< FCustomizableObjectTextureParameterValue > &  
Public function Const UFunction BlueprintCallable, Category FName

GetTextureParameterSelectedOption ( const FString& TextureParamName,
int32 RangeIndex
)

 Gets the value of a texture parameter with name "TextureParamName".
Public function Const UFunction BlueprintCallable, Category int32

GetTextureValueRange ( const FString& ParamName
)

 For multidimensional parameters, return the number of dimensions that the given texture parameter supports.
Public function Const const TArray< FCustomizableObjectVectorParameterValue > &  
Public function UFunction BlueprintCallable, Category TArray< FCustomizableObjectVectorParameterValue > & Get the array of parameters in the instance that are of type "vector".
Public function Const UFunction BlueprintCallable, Category bool Return true if the instance has any parameters.
Public function Const UFunction BlueprintCallable, Category bool Return true if a skeletal mesh has been generated for any component of this instance.
Public function Const UFunction BlueprintCallable, Category 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.
Public function Const bool

IsParameterRelevant ( int32 ParameterIndex
)

 Return true if changing the parameter would affect the Instance given its current generation.
Public function void

LoadDescriptor ( FArchive& CustomizableObjectDescriptor
)

 See FCustomizableObjectInstanceDescriptor::LoadDescriptor.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorCreateLayer ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::CreateLayer.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorCreateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::VirtualLayer.
Public function UFunction BlueprintCallable, Category FMultilayerProjectorVirtualLayer

MultilayerProjectorFindOrCreateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::FindOrCreateVirtualLayer.
Public function Const UFunction BlueprintCallable, Category FMultilayerProjectorLayer

MultilayerProjectorGetLayer ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::GetLayer.
Public function Const UFunction BlueprintCallable, Category FMultilayerProjectorVirtualLayer

MultilayerProjectorGetVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::GetVirtualLayer.
Public function Const UFunction BlueprintCallable, Category TArray< FName >

MultilayerProjectorGetVirtualLayers ( const FName& ProjectorParamName
)

 See FMultilayerProjector::GetVirtualLayers.
Public function Const UFunction BlueprintCallable, Category int32

MultilayerProjectorNumLayers ( const FName& ProjectorParamName
)

 See FMultilayerProjector::NumLayers.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorRemoveLayerAt ( const FName& ProjectorParamName,
int32 Index
)

 See FMultilayerProjector::RemoveLayerAt.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorRemoveVirtualLayer ( const FName& ProjectorParamName,
const FName& Id
)

 See FMultilayerProjector::RemoveVirtualLayer.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorUpdateLayer ( const FName& ProjectorParamName,
int32 Index,
const FMultilayerProjectorLayer& Layer
)

 See FMultilayerProjector::UpdateLayer.
Public function UFunction BlueprintCallable, Category void

MultilayerProjectorUpdateVirtualLayer ( const FName& ProjectorParamName,
const FName& Id,
const FMultilayerProjectorVirtualLayer& Layer
)

 See FMultilayerProjector::UpdateVirtualLayer.
Public function UFunction BlueprintCallable, Category void

RemoveMultilayerProjector ( const FName& ProjectorParamName
)

 Given Multilayer Projector name, remove a Multilayer Projector Helper.
Public function int32

RemoveValueFromFloatRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the float range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left.
Public function UFunction BlueprintCallable, Category int32

RemoveValueFromFloatRange ( const FString& ParamName
)

 Remove the last of the float range of values from the parameter ParamName, returns the index of the last valid float, -1 if no values left.
Public function UFunction BlueprintCallable, Category int32

RemoveValueFromIntRange ( const FString& ParamName
)

 Remove the last of the integer range of values from the parameter ParamName, returns the index of the last valid integer, -1 if no values left.
Public function int32

RemoveValueFromIntRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the integer range of values from the parameter ParamName, returns the index of the last valid integer, -1 if no values left.
Public function UFunction BlueprintCallable, Category int32

RemoveValueFromProjectorRange ( const FString& ParamName
)

 Remove the last of the projector range of values from the parameter ParamName, returns the index of the last valid projector, -1 if no values left.
Public function int32

RemoveValueFromProjectorRange ( const FString& ParamName,
int32 RangeIndex
)

 Remove the RangeIndex element of the projector range of values from the parameter ParamName, returns the index of the last valid projector, -1 if no values left.
Public function void

SaveDescriptor ( FArchive& CustomizableObjectDescriptor,
bool bUseCompactDescriptor
)

 See FCustomizableObjectInstanceDescriptor::SaveDescriptor.
Public function UFunction BlueprintCallable, Category void

SetBoolParameterSelectedOption ( const FString& BoolParamName,
bool BoolValue
)

 Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName".
Public function UFunction BlueprintCallable, Category void Set the flag that controls if parameter relevancy will be updated when this instance is generated.
Public function UFunction BlueprintCallable, Category void

SetColorParameterSelectedOption ( const FString& ColorParamName,
const FLinearColor& ColorValue
)

 Sets the color value "ColorValue" of a color parameter with index "ColorParamIndex".
Public function UFunction BlueprintCallable, Category void

SetCurrentState ( const FString& StateName
)

 Set the CustomizableObject state that this instance will be generated into.
Public function void  
Public function UFunction BlueprintCallable, Category void

SetFloatParameterSelectedOption ( const FString& FloatParamName,
float FloatValue,
int32 RangeIndex
)

 Sets the float value "FloatValue" of a float parameter with index "FloatParamIndex".
Public function void

SetForceGenerateResidentMips ( bool bForceGenerateResidentMips
)

 If enabled, low-priority textures will generate resident mipmaps too.
Public function void

SetIntParameterSelectedOption ( int32 IntParamIndex,
const FString& SelectedOption,
int32 RangeIndex
)

 Set the currently selected option value for the given parameter, by parameter index and option name.
Public function UFunction BlueprintCallable, Category void

SetIntParameterSelectedOption ( const FString& ParamName,
const FString& SelectedOptionName,
int32 RangeIndex
)

 Set the currently selected option value for the given parameter, by parameter name and option name.
Public function void

SetIsBeingUsedByComponentInPlay ( bool bIsUsedByComponent
)

 The following methods should only be used in an LOD management class.
Public function void  
Public function void

SetIsPlayerOrNearIt ( bool NewValue
)

  
Public function void

SetMinSquareDistToPlayer ( float NewValue
)

  
Public function UFunction BlueprintCallable, Category void Set the CustomizableObject this instance will be generated from.
Public function UFunction BlueprintCallable, Category void

SetProjectorAngle ( const FString& ProjectorParamName,
float Angle,
int32 RangeIndex
)

 Set only the cylindrical projector angle keeping the rest of values.
Public function UFunction BlueprintCallable, Category void

SetProjectorDirection ( const FString& ProjectorParamName,
const FVector& Direction,
int32 RangeIndex
)

 Set only the projector direction vector keeping the rest of values.
Public function UFunction BlueprintCallable, Category void

SetProjectorPosition ( const FString& ProjectorParamName,
const FVector& Pos,
int32 RangeIndex
)

 Set only the projector position keeping the rest of values.
Public function UFunction BlueprintCallable, Category void

SetProjectorScale ( const FString& ProjectorParamName,
const FVector& Scale,
int32 RangeIndex
)

 Set only the projector scale keeping the rest of values.
Public function UFunction BlueprintCallable, Category void

SetProjectorUp ( const FString& ProjectorParamName,
const FVector& Up,
int32 RangeIndex
)

 Set only the projector up vector keeping the rest of values.
Public function UFunction BlueprintCallable, Category void

SetProjectorValue ( const FString& ProjectorParamName,
const FVector& OutPos,
const FVector& OutDirection,
const FVector& OutUp,
const FVector& OutScale,
float OutAngle,
int32 RangeIndex
)

 Sets the projector values of a projector parameter with index "ProjectorParamIndex".
Public function UFunction BlueprintCallable, Category void Set random values to the parameters.
Public function UFunction BlueprintCallable, Category void Set random values to the parameters using a stream.
Public function UFunction BlueprintCallable, Category 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.
Public function void

SetRequestedLODs ( int32 InMinLOD,
int32 InMaxLOD,
const TArray< uint16 >& InRequestedLODsPerComponent,
FMutableInstanceUpdateMap& InOutRequestedUpdates
)

 Sets an array of LODs to generate per component.
Public function 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.
Public function UFunction BlueprintCallable, Category void

SetTextureParameterSelectedOption ( const FString& TextureParamName,
const FString& TextureValue,
int32 RangeIndex
)

 Sets the texture value "TextureValue" of a texture parameter with index "TextureParamIndex".
Public function UFunction BlueprintCallable, Category void

SetVectorParameterSelectedOption ( const FString& VectorParamName,
const FLinearColor& VectorValue
)

 Sets the vector value "VectorValue" of a bool parameter with index "VectorParamIndex".
Public function UFunction BlueprintCallable, Category void

UpdateSkeletalMeshAsync ( bool bIgnoreCloseDist,
bool bForceHighPriority
)

 Generate the instance with the current parameters and update all the components Skeletal Meshes asynchronously.
Public function UFunction BlueprintCallable, Category void

UpdateSkeletalMeshAsyncResult ( FInstanceUpdateDelegate Callback,
bool bIgnoreCloseDist,
bool bForceHighPriority
)

 Generate the instance with the current parameters and update all the components Skeletal Meshes asynchronously.
Public function void

UpdateSkeletalMeshAsyncResult ( FInstanceUpdateNativeDelegate Callback,
bool bIgnoreCloseDist,
bool bForceHighPriority
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual Const bool Called during saving to determine if the object is forced to be editor only or not
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
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