UMetaHumanCharacterEditorSettings

Settings for the MetaHuman Character Editor plug-in.

API > API/Plugins > API/Plugins/MetaHumanCharacterEditor

Settings for the MetaHuman Character Editor plug-in.

   
Name UMetaHumanCharacterEditorSettings
Type class
Header File /Engine/Plugins/MetaHuman/MetaHumanCharacter/Source/MetaHumanCharacterEditor/Public/MetaHumanCharacterEditorSettings.h
Include Path #include "MetaHumanCharacterEditorSettings.h"

Syntax

UCLASS (BlueprintType, Config=MetaHumanCharacter, defaultconfig)  
class UMetaHumanCharacterEditorSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMetaHumanCharacterEditorSettings()

 Constructor MetaHumanCharacterEditorSettings.h  

Typedefs

Name Type Remarks Include Path
FOnWardrobePathsChanged TMulticastDelegate_NoParams< void > Triggers when we change the wardrobe paths MetaHumanCharacterEditorSettings.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutoSpawnPreviewActor bool When enabled, automatically spawns the MetaHuman preview actor when the Custom Light Preset level is opened MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Lighting Environments"
  • Meta=(EditCondition="bOpenCustomLightPresetInLevelEditor")
bEnableExperimentalWorkflows bool   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Pipeline"
bEnableWardrobeItemValidation bool Whether or not to run validation of wardrobe items. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Wardrobe|Validation"
bOpenCustomLightPresetInLevelEditor bool When enabled, automatically opens the duplicated Custom Light Preset level in the Level Editor after creation MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Lighting Environments"
bShowCompatibilityModeBodies bool   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Fixed Body Types"
bSuppressMessageLogWhenValidatingItems bool If enabled, prevents the Message Log from automatically opening even if there are warnings or errors. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Wardrobe|Validation"
bUseVirtualTextures bool Controls which type of materials are created when assembling a MetaHuman Character. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Rendering"
bValidateLightingEnvironments bool When enabled, the MetaHuman lighting environments are validated and MetaHuman Message Log shows validation warnings when a lighting environment uses World Partition or is missing the actors that drive the Light Rig Rotation and Background Color controls. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Lighting Environments"
CameraSpeedSettings FEditorViewportCameraSpeedSettings   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Camera Options"
CustomLightPresets TMap< FString, TSoftObjectPtr< UWorld > >   MetaHumanCharacterEditorSettings.h
  • Config
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Lighting Environments"
  • Meta=(GetAssetFilter="CustomLightPresetAssetsFilter")
DefaultLightingEnvironment FName The default lighting environment to use when opening a character. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Lighting Environments"
  • Meta=(GetOptions="GetDefaultLightingEnvironmentOptions")
KeyPointCharacterManipulatorMesh TSoftObjectPtr< class UStaticMesh >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Mesh Import|Manipulators"
KeyPointTargetManipulatorMesh TSoftObjectPtr< class UStaticMesh >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Mesh Import|Manipulators"
MigratedNamePrefix FString Prefix to be added to the name of the migrated MetaHuman Character asset. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Migration"
MigratedNameSuffix FString Suffix to be added to the name of the migrated MetaHuman Character asset. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Migration"
MigratedPackagePath FDirectoryPath Where new MetaHuman Character assets are going to be placed. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Migration"
  • Meta=(ContentDir)
MigrationAction EMetaHumanCharacterMigrationAction What happens when adding a MetaHuman from Bridge. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Migration"
MouseSensitivityModifier float   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Camera Options"
  • Meta=(ClampMin="0.0", ClampMax="1.0")
MoveManipulatorMesh TSoftObjectPtr< class UStaticMesh >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Face Editing|Manipulators"
OnCustomLightPresetsChanged FSimpleMulticastDelegate The delegate executed when the CustomLightPresets has changed MetaHumanCharacterEditorSettings.h  
OnExperimentalAssemblyOptionsStateChanged FSimpleDelegate The delegate executed when the experimental assembly options enable state has changed MetaHumanCharacterEditorSettings.h  
OnUseVirtualTexturesChanged FSimpleMulticastDelegate The delegate executed when bUseVirtualTextures has changed MetaHumanCharacterEditorSettings.h  
OnWardrobePathsChanged FOnWardrobePathsChanged   MetaHumanCharacterEditorSettings.h  
PresetsDirectories TArray< FDirectoryPath > Where MetaHuman Character presets are going to be searched. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Presets"
  • DisplayName="Presets Directories"
  • Meta=(ContentDir)
PresetsThumbnailType EMetaHumanCharacterThumbnailCameraPosition   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Presets"
ScalableNormalsTypeMaterials TMap< FName, TSoftObjectPtr< UMaterialInstanceConstant > >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Pipeline"
SculptManipulatorMesh TSoftObjectPtr< class UStaticMesh >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Face Editing|Manipulators"
ShowHandsPose TSoftObjectPtr< class UAnimSequence >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Animation"
TemplateAnimationDataTableAssets TArray< FSoftObjectPath >   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Animation"
TextureStreamingBoost int32 Boost factor to apply when streaming textures in the MetaHumanCharacter asset editor. A higher boost value will stream higher resolution textures in the viewport. MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Viewport"
  • Meta=(ClampMin="1", ClampMax="5")
TextureSynthesisModelDir FDirectoryPath   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Face Editing|Texture Synthesis"
  • DisplayName="Texture Synthesis Model Directory"
TextureSynthesisThreadCount int32   MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Face Editing|Texture Synthesis"
WardrobePaths TArray< FMetaHumanCharacterAssetsSection > User defined wardrobe paths MetaHumanCharacterEditorSettings.h
  • Config
  • EditAnywhere
  • Category="Wardrobe"
  • Meta=(DisplayName="New Wardrobe Default Asset Paths")

Protected

Name Type Remarks Include Path Unreal Specifiers
DefaultRenderingQualityProfiles TArray< FMetaHumanCharacterRenderingQualityProfile > Default rendering quality profiles (Epic, High, Medium). MetaHumanCharacterEditorSettings.h
  • Transient
InvalidOperationError TWeakPtr< class SNotificationItem >   MetaHumanCharacterEditorSettings.h  
OnPresetsDirectoriesChanged FSimpleDelegate The delegate executed when the presets directory paths have been changed MetaHumanCharacterEditorSettings.h  
OnThumbnailTypeChanged FSimpleMulticastDelegate The delegate executed when the ThumbnailType has changed MetaHumanCharacterEditorSettings.h  
UserRenderingQualityProfiles TArray< FMetaHumanCharacterRenderingQualityProfile > User-created rendering quality profiles. Serialized to config. MetaHumanCharacterEditorSettings.h
  • Config
  • VisibleAnywhere
  • Category="Lighting Environments"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddUserRenderingQualityProfile ( const FMetaHumanCharacterRenderingQualityProfile& InProfile
)

 Adds a new user rendering quality profile MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

TArray< FMetaHumanCharacterRenderingQualityProfile > GetAllRenderingQualityProfiles()

 Returns all rendering quality profiles, with defaults first followed by user profiles MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

int32 GetAllRenderingQualityProfilesNum()

   MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

FSimpleDelegate & GetOnPresetsDirectoriesChanged()

 Gets a reference to the OnPresetsDirectoriesChanged delegate MetaHumanCharacterEditorSettings.h  

FSimpleMulticastDelegate & GetOnThumbnailTypeChanged()

 Gets a reference to the OnThumbnailTypeChanged delegate MetaHumanCharacterEditorSettings.h  

FMetaHumanCharacterRenderingQualityProfile GetRenderingQualityProfile ( const int32 InIndex
) const

 Returns the rendering quality profile at the given combined index MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

int32 GetUserRenderingQualityProfileIndex ( const int32 InCombinedIndex
) const

 Converts a combined profile index to a user profile index. MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

bool IsValidRenderingQualityProfileIndex ( const int32 InIndex
) const

 Returns true if the given combined index is valid across both default and user profiles MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

bool RemoveUserRenderingQualityProfile ( const int32 InIndex
)

 Removes the user rendering quality profile at the given index. Returns false if index is invalid MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

void ResolveDefaultLightingEnvironment ( EMetaHumanCharacterEnvironment& OutEnvironment,
FString& OutCustomPresetKey,
TSoftObjectPtr< UWorld >& OutCustomPresetWorld
) const

 Resolves DefaultLightingEnvironment into an environment enum and (when applicable) the matching custom preset. MetaHumanCharacterEditorSettings.h  

void SetRenderingQualityProfile ( const int32 InIndex,
const FMetaHumanCharacterRenderingQualityProfile& InProfile
)

 Sets the rendering quality profile at the given combined index, routing to default or user array based on bMetaHumanCharacterDefault MetaHumanCharacterEditorSettings.h
  • BlueprintCallable
  • Category="Rendering"

const bool ShouldUseVirtualTextures()

 Whether or not we should use virtual textures in the MetaHuman Character Editor. MetaHumanCharacterEditorSettings.h  

void ShowInvalidOperationError ( const FText& ErrorText
)

   MetaHumanCharacterEditorSettings.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   MetaHumanCharacterEditorSettings.h  

virtual void PostInitProperties()

   MetaHumanCharacterEditorSettings.h  

virtual void PostTransacted ( const FTransactionObjectEvent& InTransactionEvent
)

   MetaHumanCharacterEditorSettings.h  

Overridden from UDeveloperSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetCategoryName()

   MetaHumanCharacterEditorSettings.h  

virtual FName GetContainerName()

   MetaHumanCharacterEditorSettings.h  

virtual FText GetSectionDescription()

   MetaHumanCharacterEditorSettings.h  

virtual FName GetSectionName()

   MetaHumanCharacterEditorSettings.h  

virtual FText GetSectionText()

   MetaHumanCharacterEditorSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   MetaHumanCharacterEditorSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool IsReservedLightingEnvironmentName ( const FString& InName
)

 Returns true if the given name matches a built-in lighting environment name (e.g. Studio, Fireside, etc.) MetaHumanCharacterEditorSettings.h  

static FString MakeUniqueKey ( const FString& InDesiredKey,
TFunctionRef< bool(const FString&)> KeyExists
)

   MetaHumanCharacterEditorSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
CameraSpeed_DEPRECATED int32   MetaHumanCharacterEditorSettings.h
  • Config

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page