unreal.InterchangeUserDefinedAttributesAPI

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

Bases: Object

UInterchangeUserDefinedAttributesAPI is used to store and retrieve user-defined attributes such as DCC node attributes, so that pipelines have access to those attributes. Every user-defined attribute has a name, a value, and an optional AnimationPayloadKey: an FRichCurve that is a float curve. The value type must be supported by the UE::Interchange::EAttributeTypes enumeration.

C++ Source:

• Module: InterchangeCore

• File: InterchangeUserDefinedAttribute.h

classmethod create_user_defined_attribute_boolean(interchange_node, user_defined_attribute_name, value, payload_key, requires_delegate=False) → bool

Create User Defined Attribute Boolean

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

• value (bool) –

• payload_key (str) –

• requires_delegate (bool) –

Return type:

bool

classmethod create_user_defined_attribute_double(interchange_node, user_defined_attribute_name, value, payload_key, requires_delegate=False) → bool

Create User Defined Attribute Double

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

• value (double) –

• payload_key (str) –

• requires_delegate (bool) –

Return type:

bool

classmethod create_user_defined_attribute_f_string(interchange_node, user_defined_attribute_name, value, payload_key, requires_delegate=False) → bool

Create User Defined Attribute FString

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

• value (str) –

• payload_key (str) –

• requires_delegate (bool) –

Return type:

bool

classmethod create_user_defined_attribute_float(interchange_node, user_defined_attribute_name, value, payload_key, requires_delegate=False) → bool

Create User Defined Attribute Float

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

• value (float) –

• payload_key (str) –

• requires_delegate (bool) –

Return type:

bool

classmethod create_user_defined_attribute_int32(interchange_node, user_defined_attribute_name, value, payload_key, requires_delegate=False) → bool

Create User Defined Attribute Int 32

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

• value (int32) –

• payload_key (str) –

• requires_delegate (bool) –

Return type:

bool

classmethod duplicate_all_user_defined_attribute(interchange_source_node, interchange_destination_node, add_source_node_name) → None

Duplicate All User Defined Attribute

Parameters:

• interchange_source_node (InterchangeBaseNode) –

• interchange_destination_node (InterchangeBaseNode) –

• add_source_node_name (bool) –

classmethod get_user_defined_attribute_boolean(interchange_node, user_defined_attribute_name) → (out_value=bool, out_payload_key=str) or None

Get User Defined Attribute Boolean

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

Returns:

out_value (bool):

out_payload_key (str):

Return type:

tuple or None

classmethod get_user_defined_attribute_double(interchange_node, user_defined_attribute_name) → (out_value=double, out_payload_key=str) or None

Get User Defined Attribute Double

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

Returns:

out_value (double):

out_payload_key (str):

Return type:

tuple or None

classmethod get_user_defined_attribute_f_string(interchange_node, user_defined_attribute_name) → (out_value=str, out_payload_key=str) or None

Get User Defined Attribute FString

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

Returns:

out_value (str):

out_payload_key (str):

Return type:

tuple or None

classmethod get_user_defined_attribute_float(interchange_node, user_defined_attribute_name) → (out_value=float, out_payload_key=str) or None

Get User Defined Attribute Float

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

Returns:

out_value (float):

out_payload_key (str):

Return type:

tuple or None

classmethod get_user_defined_attribute_infos(interchange_node) → Array[InterchangeUserDefinedAttributeInfo]

Get User Defined Attribute Infos

Parameters:

interchange_node (InterchangeBaseNode) –

Returns:

user_defined_attribute_infos (Array[InterchangeUserDefinedAttributeInfo]):

Return type:

Array[InterchangeUserDefinedAttributeInfo]

classmethod get_user_defined_attribute_int32(interchange_node, user_defined_attribute_name) → (out_value=int32, out_payload_key=str) or None

Get User Defined Attribute Int 32

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) –

Returns:

out_value (int32):

out_payload_key (str):

Return type:

tuple or None

classmethod remove_user_defined_attribute(interchange_node, user_defined_attribute_name) → bool

Remove the specified user-defined attribute.

Parameters:

• interchange_node (InterchangeBaseNode) –

• user_defined_attribute_name (str) – The name of the user-defined attribute to remove.

Returns:

True if the attribute exists and was removed, or if the attribute doesn’t exist. Returns false if the attribute exists but could not be removed. Note - User-defined attributes are the user custom attributes from the DCC translated node (for example, extra attributes in Maya). The payload key points to an FRichCurve payload.

Return type:

bool