unreal.MetaHumanCharacterEditorBuildParameters

class unreal.MetaHumanCharacterEditorBuildParameters(pipeline_type: MetaHumanDefaultPipelineType = Ellipsis, pipeline_quality: MetaHumanQualityLevel = Ellipsis, animation_system_name: Name = 'None', absolute_build_path: str = '', name_override: str = '', common_folder_path: str = '', enable_wardrobe_item_validation: bool = False)

Bases: StructBase

Parameters to configure MetaHuman Character build.

C++ Source:

  • Plugin: MetaHumanCharacter

  • Module: MetaHumanCharacterEditor

  • File: MetaHumanCharacterBuild.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_build_path (str): [Read-Write] Absolute location where the built assets will end up in. If empty, build will unpack assets in respect to the options set by the palette.

    Only relevant when Pipeline type is Cinematic, Optimized

  • animation_system_name (Name): [Read-Write] Target animation system name to be used by the assembled MetaHuman.

  • common_folder_path (str): [Read-Write] Optional path to a directory where Common MH assets should be shared or copied if needed. Only relevant when PipelineType is Cinematic or Optimized

  • enable_wardrobe_item_validation (bool): [Read-Write] If disabled, won’t run validation of wardrobe items, allowing potentially incompatible items to be present in the assembled MetaHuman. Setting this to false bEnableWardrobeItemValidation defined in the Project Settings.

  • name_override (str): [Read-Write] Optional string to be used instead of the character name for the final unpacking folder. Only relevant when Pipeline type is Cinematic, Optimized

  • pipeline_quality (MetaHumanQualityLevel): [Read-Write] The quality of build to perform. Only relevant when PipelineType is Optimized or UEFN

  • pipeline_type (MetaHumanDefaultPipelineType): [Read-Write] Which type of build to perform.

property absolute_build_path: str

[Read-Write] Absolute location where the built assets will end up in. If empty, build will unpack assets in respect to the options set by the palette.

Only relevant when Pipeline type is Cinematic, Optimized

Type:

(str)

property animation_system_name: Name

[Read-Write] Target animation system name to be used by the assembled MetaHuman.

Type:

(Name)

property common_folder_path: str

[Read-Write] Optional path to a directory where Common MH assets should be shared or copied if needed. Only relevant when PipelineType is Cinematic or Optimized

Type:

(str)

property enable_wardrobe_item_validation: bool

[Read-Write] If disabled, won’t run validation of wardrobe items, allowing potentially incompatible items to be present in the assembled MetaHuman. Setting this to false bEnableWardrobeItemValidation defined in the Project Settings.

Type:

(bool)

property name_override: str

[Read-Write] Optional string to be used instead of the character name for the final unpacking folder. Only relevant when Pipeline type is Cinematic, Optimized

Type:

(str)

property pipeline_quality: MetaHumanQualityLevel

[Read-Write] The quality of build to perform. Only relevant when PipelineType is Optimized or UEFN

Type:

(MetaHumanQualityLevel)

property pipeline_type: MetaHumanDefaultPipelineType

[Read-Write] Which type of build to perform.

Type:

(MetaHumanDefaultPipelineType)