unreal.MetaHumanCharacterInstanceBlueprintLibrary

class unreal.MetaHumanCharacterInstanceBlueprintLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

brief: Exposes blueprint functions to operate on UMetaHumanInstance for procedural authoring.

C++ Source:

  • Plugin: MetaHumanCharacter

  • Module: MetaHumanCharacterPalette

  • File: MetaHumanCollectionBlueprintLibrary.h

classmethod duplicate_meta_human_instance(source, outer=None) → MetaHumanInstance

Creates a new transient UMetaHumanInstance that is an unassembled duplicate of the source

Parameters:

  • source (MetaHumanInstance) – The instance to duplicate. If null, returns null.

  • outer (Object) – Optional outer for the new instance. If null, the transient package is used.

Returns:

The new instance, or null if Source was null.

Return type:

MetaHumanInstance

classmethod get_allowed_item_keys_for_slot(instance, slot_name) → Array[MetaHumanPaletteItemKey]

Returns the item keys targeting the given slot that are allowed by the Instance’s Collection Pipeline given the Instance’s current slot selections.

Use this to ask “with what I’ve already picked, which items can I now select for SlotName?”. For example, after picking a body, this can return the heads compatible with that body.

Parameters:
Return type:

Array[MetaHumanPaletteItemKey]

classmethod get_instance_parameter_item_paths(instance) → Array[MetaHumanPaletteItemPath]

Returns every item path on this instance that has any instance parameters defined.

The empty path represents the Collection itself.

Parameters:

instance (MetaHumanInstance)

Return type:

Array[MetaHumanPaletteItemPath]

classmethod get_instance_parameters(instance: MetaHumanInstance, item_path: MetaHumanPaletteItemPath) → None

deprecated: ‘get_instance_parameters’ was renamed to ‘get_instance_parameters_for_item’.

classmethod get_instance_parameters_for_item(instance, item_path) → Array[MetaHumanCharacterInstanceParameter]

brief: Gets the list of all instance parameters for a given item.

Parameters:
Return type:

Array[MetaHumanCharacterInstanceParameter]

classmethod try_get_instance_parameter(instance, item_path, parameter_name) → MetaHumanCharacterInstanceParameter or None

Look up a single parameter on the instance by item path and name.

Parameters:
Returns:

true if found.

out_parameter (MetaHumanCharacterInstanceParameter):

Return type:

MetaHumanCharacterInstanceParameter or None