Navigation
API > API/Plugins > API/Plugins/CustomizableObject > API/Plugins/CustomizableObject/MuCO
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UCustomizableObjectInstance
References
| Module | CustomizableObject |
| Header | /Engine/Plugins/Experimental/Mutable/Source/CustomizableObject/Classes/MuCO/CustomizableObjectInstance.h |
| Include | #include "MuCO/CustomizableObjectInstance.h" |
Syntax
UCLASS&40;Blueprintable, BlueprintType, HideCategories&61;&40;CustomizableObjectInstance&41;&41;
class UCustomizableObjectInstance : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | AvoidResetProjectorVisibilityForNonNode | TEMP VARIABLE to avoid the projector selection being reset after pasting transform. | |
| bool | bEditorPropertyChanged | Flag to know if a property of this instance changed in the editor | |
| FBeginDestroyDelegate | BeginDestroyDelegate | Broadcast when UObject::BeginDestroy is being called. | |
| FBeginDestroyNativeDelegate | BeginDestroyNativeDelegate | Broadcast when UObject::BeginDestroy is being called. | |
| FBeginUpdateDelegate | BeginUpdateDelegate | Broadcast at the beginning of an Instance update. | |
| FBeginUpdateNativeDelegate | BeginUpdateNativeDelegate | Broadcast at the beginning of an Instance update. | |
| bool | bSelectedProfileDirty | ||
| bool | bShowOnlyRelevantParameters | ||
| bool | bShowOnlyRuntimeParameters | ||
| FString | LastSelectedProjectorParameter | If there's a projector parameter pending to be hidden, name of that projector parameter | |
| FString | LastSelectedProjectorParameterWithIndex | For the case of projector parameter in several layers (the name of the projector is the same and only the index will change | |
| int32 | LastUpdateMutableRuntimeCycles | During editor, always remember the duration of the last update in the mutable runtime, for profiling. | |
| meta | |||
| TWeakObjectPtr< UCustomizableSkeletalComponent > | NearestToActor | TEMP VARIABLE to check the Min desired LODs for this instance. | |
| TWeakObjectPtr< const AActor > | NearestToViewCenter | ||
| FText | ParametersSearchFilter | Preview Instance Properties search box filter. | |
| TMap< FString, bool > | ParamNameToExpandedMap | ||
| FString | PreUpdateSkeletalMeshStatus | Will store the previous status description to avoid losing notifications with partial updates. | |
| bool | ProjectorAlphaChange | Flag to avoid resetting projector state when editing the alpha value of a layer | |
| bool | ProjectorLayerChange | Flag to ease detect a projector layer change event in FCustomizableObjectEditor::OnObjectModified | |
| FProjectorStateChangedDelegate | ProjectorStateChangedDelegate | ||
| bool | ProjectorUpdatedInViewport | ||
| FString | RemovedProjectorParameterNameWithIndex | Tag required to avoid updating the wrong projector parameter range index once removed. | |
| int32 | SelectedProfileIndex | Profile index the instance parameters are in and if the profile needs to be refreshed | |
| TArray< TObjectPtr< USkeletalMesh > > | SkeletalMeshes | The generated skeletal meshes for this Instance, one for each component | |
| FString | SkeletalMeshStatus | Will store status description of current skeletal mesh generation (for instance, "EmptyLOD0" or "EmptyMesh". | |
| FString | TempProjectorParameterName | TEMP VARIABLE to verify the projector parameter with transform modified by Paste Transform is set as selected. | |
| int32 | TempProjectorParameterRangeIndex | TEMP VARIABLE to verify the projector parameter with transform modified by Paste Transform is set as selected. | |
| bool | TempUpdateGizmoInViewport | TEMP VARIABLE to ease updating the gizmo in the editor after pasting a new projector's transform information. | |
| bool | UnselectProjector | Flag to unselect the projector | |
| FObjectInstanceUpdatedDelegate | UpdatedDelegate | Broadcast when the Customizable Object Instance is updated. | |
| FObjectInstanceUpdatedNativeDelegate | UpdatedNativeDelegate | Broadcast when the Customizable Object Instance is updated. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AdditionalAssetsAsyncLoaded
(
FGraphEventRef CompletionEvent |
||
| void | AddQueryTextureCoverage
(
const FString& TextureName, |
Adds/removes a texture channel coverage query to the instance update process. | |
| 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. | |
| int32 | AddValueToIntRange
(
const FString& ParamName |
Increases the range of values of the integer with ParamName, returns the index of the new integer value, -1 otherwise. | |
| 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. | |
| void | AnimInstanceFixup
(
UAnimInstance* AnimInstance |
||
| bool | AnimInstanceNeedsFixup
(
TSubclassOf< UAnimInstance > AnimInstance |
||
| bool | Return true if the instance is not locked and if it's compiled | ||
| UCustomizableObjectInstance * | Clone () |
Clones the instance creating a new identical transient instance. | |
| UCustomizableObjectInstance * | CloneStatic
(
UObject* Outer |
Clones the instance creating a new identical static instance. | |
| void | Save the Min and Max LOD that will be used for the update. | ||
| void | CopyParametersFromInstance
(
UCustomizableObjectInstance* Instance |
Copy parameters from input instance. | |
| bool | CreateMultiLayerProjector
(
const FName& ProjectorParamName |
Multilayer Projectors | |
| void | Immediately destroy the Mutable Core Live Update Instance attached to this (if exists). | ||
| void | DoUpdateSkeletalMesh
(
bool bIsCloseDistTick, |
Private API. | |
| int32 | FindBoolParameterNameIndex
(
const FString& ParamName |
Finds in BoolParameters a parameter with name ParamName, returns the index if found, -1 otherwise. | |
| int32 | FindFloatParameterNameIndex
(
const FString& ParamName |
Finds in FloatParameters a parameter with name ParamName, returns the index if found, -1 otherwise. | |
| int32 | FindIntParameterNameIndex
(
const FString& ParamName |
Finds in IntParameters a parameter with name ParamName, returns the index if found, -1 otherwise. | |
| int32 | FindProjectorParameterNameIndex
(
const FString& ParamName |
Finds in ProjectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise. | |
| int32 | FindVectorParameterNameIndex
(
const FString& ParamName |
Finds in VectorParameters a parameter with name ParamName, returns the index if found, -1 otherwise. | |
| void | FinishUpdate
(
EUpdateResult UpdateResult, |
Common end point of all updates. Even those which failed. | |
| void | ForEachAnimInstance
(
int32 ComponentIndex, |
||
| void | ForEachAnimInstance
(
int32 ComponentIndex, |
||
| const FGameplayTagContainer & | |||
| TSubclassOf< UAnimInstance > | Returns the animation BP for the parameter component and slot, gathered from all the meshes that compose this instance. | ||
| const TArray< FCustomizableObjectBoolParameterValue > & | |||
| TArray< FCustomizableObjectBoolParameterValue > & | |||
| bool | GetBoolParameterSelectedOption
(
const FString& BoolParamName |
Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName". | |
| bool | |||
| bool | |||
| FLinearColor | GetColorParameterSelectedOption
(
const FString& ColorParamName |
Gets the value of a color parameter with name "ColorParamName". | |
| int32 | Return the Max LOD this Instance is using (from the beginning of an update. If an update fails this value will be incorrect). | ||
| int32 | Return the Min LOD this Instance is using (from the beginning of an update. If an update fails this value will be incorrect). | ||
| FString | |||
| UCustomizableObject * | Get the current CustomizableObject. | ||
| const FCustomizableObjectInstanceDescriptor & | |||
| FCustomizableObjectInstanceDescriptor & | |||
| FDescriptorRuntimeHash | Return the UCustomizableObjectInstance::Descriptor hash on the last update request. | ||
| const TArray< FCustomizableObjectFloatParameterValue > & | |||
| TArray< FCustomizableObjectFloatParameterValue > & | |||
| float | GetFloatParameterSelectedOption
(
const FString& FloatParamName, |
Gets the value of a float parameter with name "FloatParamName". | |
| int32 | GetFloatValueRange
(
const FString& ParamName |
||
| const TArray< FCustomizableObjectIntParameterValue > & | |||
| TArray< FCustomizableObjectIntParameterValue > & | |||
| const FString & | GetIntParameterSelectedOption
(
const FString& ParamName, |
DEPRECATED: Use the method in the CustomizableObject instead which takes an index among all parameters Returns how many possible options an int parameter has int32 GetIntParameterNumOptions(int32 IntParamIndex); DEPRECATED: Use the method in the CustomizableObject instead which takes an index among all parameters Gets the Name of the option at position K in the list of available options for the int parameter. | |
| int32 | GetIntValueRange
(
const FString& ParamName |
||
| bool | |||
| bool | |||
| int32 | |||
| int32 | |||
| float | |||
| int32 | |||
| int32 | |||
| UTexture2D * | GetParameterDescription
(
const FString& ParamName, |
Returns de description texture (ex: color bar) for this parameter and DescIndex This will only be valid if bBuildParameterDecorations was set to true before the last update. | |
| UCustomizableInstancePrivateData * | GetPrivate () |
||
| FCustomizableObjectProjector | GetProjector
(
const FString& ParamName, |
See FCustomizableObjectInstanceDescriptor::GetProjector. | |
| float | GetProjectorAngle
(
const FString& ParamName, |
Get the current cylindrical projector angle for the parameter with the given name. | |
| FVector | GetProjectorDirection
(
const FString& ParamName, |
Get the current projector direction vector for the parameter with the given name. | |
| TArray< FCustomizableObjectProjectorParameterValue > & | |||
| const TArray< FCustomizableObjectProjectorParameterValue > & | |||
| ECustomizableObjectProjectorType | GetProjectorParameterType
(
const FString& ParamName, |
Get the current projector type for the parameter with the given name. | |
| FVector | GetProjectorPosition
(
const FString& ParamName, |
Get the current projector position for the parameter with the given name. | |
| FVector | GetProjectorScale
(
const FString& ParamName, |
Get the current projector scale for the parameter with the given name. | |
| EProjectorState::Type | GetProjectorState
(
const FString& ParamName, |
||
| FVector | GetProjectorUp
(
const FString& ParamName, |
Get the current projector up vector for the parameter with the given name. | |
| void | GetProjectorValue
(
const FString& ProjectorParamName, |
Get the projector values of a projector parameter with index "ProjectorParamIndex". | |
| void | GetProjectorValueF
(
const FString& ProjectorParamName, |
||
| int32 | GetProjectorValueRange
(
const FString& ParamName |
||
| float | GetQueryResultTextureCoverage
(
const FString& TextureName |
Returns the result of a texture coverage query previously registered with AddQueryTextureCoverage. | |
| float | GetQueryResultTextureCoverageMasked
(
const FString& TextureName |
||
| const TArray< uint16 > & | |||
| USkeletalMesh * | GetSkeletalMesh
(
int32 ComponentIndex |
||
| int32 | GetState () |
||
| TArray< FCustomizableObjectTextureParameterValue > & | |||
| const TArray< FCustomizableObjectTextureParameterValue > & | |||
| FName | GetTextureParameterSelectedOption
(
const FString& TextureParamName, |
Gets the value of a texture parameter with name "TextureParamName". | |
| int32 | GetTextureValueRange
(
const FString& ParamName |
||
| FDescriptorRuntimeHash | Return the UCustomizableObjectInstance::Descriptor hash on the last successful update. | ||
| EQueuePriorityType | GetUpdatePriority
(
bool bIsCloseDistTick, |
Returns the priority an update issued by DoUpdateSkeletalMesh would get in the current instance configuration and state | |
| TArray< FCustomizableObjectVectorParameterValue > & | |||
| const TArray< FCustomizableObjectVectorParameterValue > & | |||
| bool | See FCustomizableObjectInstanceDescriptor::HasAnyParameters. | ||
| bool | |||
| bool | IsParameterRelevant
(
int32 ParameterIndex |
||
| bool | IsParameterRelevant
(
const FString& ParamName |
||
| bool | |||
| void | LoadDescriptor
(
FArchive& CustomizableObjectDescriptor |
See FCustomizableObjectInstanceDescriptor::LoadDescriptor. | |
| bool | LoadParametersFromProfile
(
int32 ProfileIndex |
Utilities to manage saving and loading parameters from profiles. | |
| bool | MigrateProfileParametersToCurrentInstance
(
int32 ProfileIndex |
||
| void | MultilayerProjectorCreateLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::CreateLayer. | |
| void | MultilayerProjectorCreateVirtualLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::VirtualLayer. | |
| FMultilayerProjectorVirtualLayer | MultilayerProjectorFindOrCreateVirtualLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::FindOrCreateVirtualLayer. | |
| FMultilayerProjectorLayer | MultilayerProjectorGetLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::GetLayer. | |
| FMultilayerProjectorVirtualLayer | MultilayerProjectorGetVirtualLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::GetVirtualLayer. | |
| TArray< FName > | MultilayerProjectorGetVirtualLayers
(
const FName& ProjectorParamName |
See FMultilayerProjector::GetVirtualLayers. | |
| int32 | MultilayerProjectorNumLayers
(
const FName& ProjectorParamName |
See FMultilayerProjector::NumLayers. | |
| void | MultilayerProjectorRemoveLayerAt
(
const FName& ProjectorParamName, |
See FMultilayerProjector::RemoveLayerAt. | |
| void | MultilayerProjectorRemoveVirtualLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::RemoveVirtualLayer. | |
| void | MultilayerProjectorUpdateLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::UpdateLayer. | |
| void | MultilayerProjectorUpdateVirtualLayer
(
const FName& ProjectorParamName, |
See FMultilayerProjector::UpdateVirtualLayer. | |
| void | ReleaseMutableResources
(
bool bCalledFromBeginDestroy |
Releases all the mutable resources this instance holds, should only be called when it is not going to be used any more. | |
| void | RemoveMultilayerProjector
(
const FName& ProjectorParamName |
Given Multilayer Projector name, remove a Multilayer Projector Helper. | |
| void | RemoveQueryTextureCoverage
(
const FString& TextureName |
||
| 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. | |
| int32 | RemoveValueFromFloatRange
(
const FString& ParamName, |
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. | |
| int32 | RemoveValueFromIntRange
(
const FString& ParamName, |
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. | |
| 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. | |
| 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. | |
| int32 | RemoveValueFromProjectorRange
(
const FString& ParamName, |
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. | |
| void | |||
| void | SaveDescriptor
(
FArchive& CustomizableObjectDescriptor, |
See FCustomizableObjectInstanceDescriptor::SaveDescriptor. | |
| bool | SaveParametersToProfile
(
int32 ProfileIndex |
||
| void | SetBoolParameterSelectedOption
(
const FString& BoolParamName, |
Sets the bool value "BoolValue" of a bool parameter with name "BoolParamName". | |
| void | SetBuildParameterDecorations
(
bool Value |
||
| void | SetBuildParameterRelevancy
(
bool Value |
||
| void | SetColorParameterSelectedOption
(
const FString& ColorParamName, |
Sets the color value "ColorValue" of a color parameter with index "ColorParamIndex". | |
| void | SetCurrentState
(
const FString& StateName |
||
| void | SetDescriptor
(
const FCustomizableObjectInstanceDescriptor& InDescriptor |
||
| void | SetFloatParameterSelectedOption
(
const FString& FloatParamName, |
Sets the float value "FloatValue" of a float parameter with index "FloatParamIndex". | |
| void | SetIntParameterSelectedOption
(
int32 IntParamIndex, |
Sets the selected option of an int parameter by the option's name. | |
| void | SetIntParameterSelectedOption
(
const FString& ParamName, |
Sets the selected option of an int parameter, by the option's name. | |
| void | SetIsBeingUsedByComponentInPlay
(
bool bIsUsedByComponent |
The following methods should only be used in an LOD management class. | |
| void | SetIsDiscardedBecauseOfTooManyInstances
(
bool bIsDiscarded |
||
| void | SetIsPlayerOrNearIt
(
bool NewValue |
||
| void | SetMinSquareDistToPlayer
(
float NewValue |
||
| void | SetObject
(
UCustomizableObject* InObject |
||
| void | SetProjectorPosition
(
const FString& ProjectorParamName, |
Set only the projector position. | |
| void | SetProjectorState
(
const FString& ParamName, |
Control the display of support widgets to edit projectors of this instance. | |
| void | SetProjectorValue
(
const FString& ProjectorParamName, |
Sets the projector values of a projector parameter with index "ProjectorParamIndex". | |
| void | Set random values to the parameters. Useful for testing only. | ||
| void | SetRandomValues
(
const int32 InRandomizationSeed |
Set random values to the parameters using a seed. Useful for testing only. | |
| 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. | |
| void | SetRequestedLODs
(
int32 InMinLOD, |
Sets an array of LODs to generate per component. | |
| 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. | |
| void | |||
| void | SetState
(
int32 InState |
||
| void | SetTextureParameterSelectedOption
(
const FString& TextureParamName, |
Sets the texture value "TextureValue" of a texture parameter with index "TextureParamIndex". | |
| void | SetVectorParameterSelectedOption
(
const FString& VectorParamName, |
Sets the vector value "VectorValue" of a bool parameter with index "VectorParamIndex". | |
| void | UpdateSkeletalMeshAsync
(
bool bIgnoreCloseDist, |
Update Skeletal Mesh asynchronously. | |
| void | UpdateSkeletalMeshAsyncResult
(
FInstanceUpdateDelegate Callback, |
Update Skeletal Mesh asynchronously. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | BeginDestroy () |
Called before destroying the object. | |
| bool | CanEditChange
(
const FProperty* InProperty |
Called by the editor to query whether a property of this object is allowed to be modified. | |
| FString | GetDesc () |
Return a one line description of an object for viewing in the thumbnail view of the generic browser | |
| bool | IsEditorOnly () |
Called during saving to determine if the object is forced to be editor only or not | |
| bool | Called to check if the object is ready for FinishDestroy. | ||
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | PreEditChange
(
FProperty* PropertyAboutToChange |
This is called when a property is about to be modified externally | |
| void | Handles reading, writing, and reference collecting using FArchive. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| void | SetMinMaxLODToLoad
(
FMutableInstanceUpdateMap& InOutRequestedUpdates, |
Use SetRequestedLODs instead. | |
| void | SetTextureParameterSelectedOptionT
(
const FString& TextureParamName, |
Use SetTextureParameterSelectedOption instead. |