unreal.MetaHumanCharacterInstanceParameter

class unreal.MetaHumanCharacterInstanceParameter(name: Name = 'None', type: MetaHumanCharacterInstanceParameterType = 0, item_path: MetaHumanPaletteItemPath = [], object_class: Class = Ellipsis)

Bases: StructBase

brief: Struct that represents a parameter of a particular item in a collection. This struct is designed to work in scripting environments and has functions to get and set values exposed via UMetaHumanCharacterInstanceParameterBlueprintLibrary. Note that calling one of the Set functions automatically updates the parameter value for the item it represents on the instance that was used when querying them.

C++ Source:

• Plugin: MetaHumanCharacter

• Module: MetaHumanCharacterPalette

• File: MetaHumanCollectionBlueprintLibrary.h

Editor Properties: (see get_editor_property/set_editor_property)

• item_path (MetaHumanPaletteItemPath): [Read-Only] The item path that this parameter belongs to.

• name (Name): [Read-Only] The name of the parameter.

• object_class (type(Class)): [Read-Only] For Object and SoftObject parameters, the class the property is constrained to.

  Useful for telling whether a particular Object parameter is asking for a UTexture2D, a UMaterialInterface, etc, before deciding what to set on it.

• type (MetaHumanCharacterInstanceParameterType): [Read-Only] The type of the parameter. Use this to decide which Set/Get function to call.

get_bool() → bool or None

Get Bool Instance Parameter

Returns:

out_value (bool):

Return type:

bool or None

get_color() → LinearColor or None

Get Color Instance Parameter

Returns:

out_value (LinearColor):

Return type:

LinearColor or None

get_float() → float or None

Get Float Instance Parameter

Returns:

out_value (float):

Return type:

float or None

get_name() → Name or None

Get Name Instance Parameter

Returns:

out_value (Name):

Return type:

Name or None

get_object() → Object or None

Get the object value of an Object-typed parameter.

Returns:

true if the read succeeded, false on type mismatch or if the parameter could not be located on the instance.

out_value (Object): Receives the current value, possibly nullptr if the parameter is unset.

Return type:

Object or None

get_soft_object() → Object or None

Get the soft-object path of a SoftObject-typed parameter.

Returns:

true if the read succeeded.

out_value (Object): Receives the current path, which may be empty if the parameter is unset.

Return type:

Object or None

get_string() → str or None

Get String Instance Parameter

Returns:

out_value (str):

Return type:

str or None

property item_path: MetaHumanPaletteItemPath

[Read-Only] The item path that this parameter belongs to.

Type:

(MetaHumanPaletteItemPath)

property name: Name

[Read-Only] The name of the parameter.

Type:

(Name)

property object_class: Class

[Read-Only] For Object and SoftObject parameters, the class the property is constrained to.

Useful for telling whether a particular Object parameter is asking for a UTexture2D, a UMaterialInterface, etc, before deciding what to set on it.

Type:

(type(Class))

set_bool(value) → bool

Set Bool Instance Parameter

Parameters:

value (bool)

Return type:

bool

set_color(value) → bool

Set Color Instance Parameter

Parameters:

value (LinearColor)

Return type:

bool

set_float(value) → bool

Set Float Instance Parameter

Parameters:

value (float)

Return type:

bool

set_name(value) → bool

Set Name Instance Parameter

Parameters:

value (Name)

Return type:

bool

set_object(value) → bool

Set the object value of an Object-typed parameter.

The provided object’s class must derive from FMetaHumanCharacterInstanceParameter::ObjectClass. Pass nullptr to clear the parameter.

Parameters:

value (Object)

Returns:

true if the write succeeded.

Return type:

bool

set_soft_object(value) → bool

Set the soft-object value of a SoftObject-typed parameter.

The referenced asset’s class (when loaded) must derive from FMetaHumanCharacterInstanceParameter::ObjectClass. Pass an empty soft-pointer to clear.

Parameters:

value (Object)

Returns:

true if the write succeeded.

Return type:

bool

set_string(value) → bool

Set String Instance Parameter

Parameters:

value (str)

Return type:

bool

property type: MetaHumanCharacterInstanceParameterType

[Read-Only] The type of the parameter. Use this to decide which Set/Get function to call.

Type:

(MetaHumanCharacterInstanceParameterType)