`unreal.MetaHumanCharacterInstanceParameterBlueprintLibrary`¶

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

Bases: BlueprintFunctionLibrary

brief: Provides Get/Set functions for FMetaHumanCharacterInstanceParameter. Calling a Set function applies the new value to the instance that the parameter was queried from, immediately.

C++ Source:

Plugin: MetaHumanCharacter
Module: MetaHumanCharacterPalette
File: MetaHumanCollectionBlueprintLibrary.h

classmethod get_bool(instance_param: MetaHumanCharacterInstanceParameter) → bool | None¶: deprecated: ‘get_bool’ was renamed to ‘get_bool_instance_parameter’.

classmethod get_bool_instance_parameter(instance_param) → bool or None¶

Get Bool Instance Parameter

Parameters:: instance_param (MetaHumanCharacterInstanceParameter)
Returns:: out_value (bool):
Return type:: bool or None

classmethod get_color(instance_param: MetaHumanCharacterInstanceParameter) → LinearColor | None¶: deprecated: ‘get_color’ was renamed to ‘get_color_instance_parameter’.

classmethod get_color_instance_parameter(instance_param) → LinearColor or None¶

Get Color Instance Parameter

Parameters:: instance_param (MetaHumanCharacterInstanceParameter)
Returns:: out_value (LinearColor):
Return type:: LinearColor or None

classmethod get_float(instance_param: MetaHumanCharacterInstanceParameter) → float | None¶: deprecated: ‘get_float’ was renamed to ‘get_float_instance_parameter’.

classmethod get_float_instance_parameter(instance_param) → float or None¶

Get Float Instance Parameter

Parameters:: instance_param (MetaHumanCharacterInstanceParameter)
Returns:: out_value (float):
Return type:: float or None

classmethod get_name_instance_parameter(instance_param) → Name or None¶

Get Name Instance Parameter

Parameters:: instance_param (MetaHumanCharacterInstanceParameter)
Returns:: out_value (Name):
Return type:: Name or None

classmethod get_object(instance_param: MetaHumanCharacterInstanceParameter) → Object | None¶: deprecated: ‘get_object’ was renamed to ‘get_object_instance_parameter’.

classmethod get_object_instance_parameter(instance_param) → Object or None¶

Get the object value of an Object-typed parameter.

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)

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

classmethod get_soft_object(instance_param: MetaHumanCharacterInstanceParameter) → Object | None¶: deprecated: ‘get_soft_object’ was renamed to ‘get_soft_object_instance_parameter’.

classmethod get_soft_object_instance_parameter(instance_param) → Object or None¶

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

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)

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

classmethod get_string_instance_parameter(instance_param) → str or None¶

Get String Instance Parameter

Parameters:: instance_param (MetaHumanCharacterInstanceParameter)
Returns:: out_value (str):
Return type:: str or None

classmethod set_bool(instance_param: MetaHumanCharacterInstanceParameter, value: bool) → bool¶: deprecated: ‘set_bool’ was renamed to ‘set_bool_instance_parameter’.

classmethod set_bool_instance_parameter(instance_param, value) → bool¶

Set Bool Instance Parameter

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)
value (bool)

Return type:

bool

classmethod set_color(instance_param: MetaHumanCharacterInstanceParameter, value: LinearColor) → bool¶: deprecated: ‘set_color’ was renamed to ‘set_color_instance_parameter’.

classmethod set_color_instance_parameter(instance_param, value) → bool¶

Set Color Instance Parameter

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)
value (LinearColor)

Return type:

bool

classmethod set_float(instance_param: MetaHumanCharacterInstanceParameter, value: float) → bool¶: deprecated: ‘set_float’ was renamed to ‘set_float_instance_parameter’.

classmethod set_float_instance_parameter(instance_param, value) → bool¶

Set Float Instance Parameter

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)
value (float)

Return type:

bool

classmethod set_name_instance_parameter(instance_param, value) → bool¶

Set Name Instance Parameter

Parameters:

instance_param (MetaHumanCharacterInstanceParameter)
value (Name)

Return type:

bool

classmethod set_object(instance_param: MetaHumanCharacterInstanceParameter, value: Object) → bool¶: deprecated: ‘set_object’ was renamed to ‘set_object_instance_parameter’.

classmethod set_object_instance_parameter(instance_param, 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:

instance_param (MetaHumanCharacterInstanceParameter)
value (Object)

Returns:

true if the write succeeded.

Return type:

bool

classmethod set_soft_object(instance_param: MetaHumanCharacterInstanceParameter, value: Object) → bool¶: deprecated: ‘set_soft_object’ was renamed to ‘set_soft_object_instance_parameter’.