unreal.DMMaterialValue

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

Bases: DMMaterialLinkedComponent

A value used inside a material. Can be exported as a material parameter.

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterial

  • File: DMMaterialValue.h

Editor Properties: (see get_editor_property/set_editor_property)

  • component_dirty (bool): [Read-Only]

  • component_state (DMComponentLifetimeState): [Read-Only]

  • editable_properties (Array[Name]): [Read-Only]

  • local (bool): [Read-Only] True: The value is local to the stage it is used in. False: The value is a global value that can be used anywhere

  • parameter (DMMaterialParameter): [Read-Only] The parameter name used to expose this value in a material. If it isn’t provided, GetFName() will be used instead.

  • preview_material (Material): [Read-Only]

  • type (DMValueType): [Read-Only]

apply_default_value() → None

Subclasses should implement a SetDefaultValue.

classmethod create_material_value(material_model, name, type, local) → DMMaterialValue

Create Material Value

Parameters:
Return type:

DMMaterialValue

find_index() → int32

Find Index

Return type:

int32

get_description() → Text

Get Description

Return type:

Text

get_material_model() → DynamicMaterialModel

Get Material Model

Return type:

DynamicMaterialModel

get_material_parameter_name() → Name

Get Material Parameter Name

Return type:

Name

get_parameter() → DMMaterialParameter

Get Parameter

Return type:

DMMaterialParameter

get_preview_material() → Material

Get Preview Material

Return type:

Material

get_type() → DMValueType

Get Type

Return type:

DMValueType

get_type_name() → Text

Get Type Name

Return type:

Text

is_default_value() → bool

Is Default Value

Return type:

bool

is_local() → bool

Is Local

Return type:

bool

property local: bool

The value is local to the stage it is used in. False: The value is a global value that can be used anywhere

Type:

(bool)

Type:

[Read-Only] True

property parameter: DMMaterialParameter

[Read-Only] The parameter name used to expose this value in a material. If it isn’t provided, GetFName() will be used instead.

Type:

(DMMaterialParameter)

property preview_material: Material

[Read-Only]

Type:

(Material)

reset_default_value() → None

Resets to the default default value. 0, nullptr, etc.

set_parameter_name(base_name) → bool

Set Parameter Name

Parameters:

base_name (Name) –

Return type:

bool

property type: DMValueType

[Read-Only]

Type:

(DMValueType)