unreal.DMMaterialEffect

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

Bases: DMMaterialComponent

DMMaterial Effect

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterialEditor

  • File: DMMaterialEffect.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]

  • effect_target (DMMaterialEffectTarget): [Read-Only]

  • enabled (bool): [Read-Only]

classmethod create_effect(effect_stack, effect_class) → DMMaterialEffect

Create Effect

Parameters:
Return type:

DMMaterialEffect

property effect_target: DMMaterialEffectTarget

[Read-Only]

Type:

(DMMaterialEffectTarget)

property enabled: bool

[Read-Only]

Type:

(bool)

find_index() → int32

Retrieves the index of this effect in the effect stack.

Return type:

int32

get_effect_description() → Text

Get Effect Description

Return type:

Text

get_effect_name() → Text

Get Effect Name

Return type:

Text

get_effect_stack() → DMMaterialEffectStack

Get Effect Stack

Return type:

DMMaterialEffectStack

get_effect_target() → DMMaterialEffectTarget

Returns the type of nodes which this effect targets.

Return type:

DMMaterialEffectTarget

is_enabled() → bool

Is Enabled

Return type:

bool

set_enabled(is_enabled) → bool

Set Enabled

Parameters:

is_enabled (bool)

Return type:

bool

classmethod stage_type_to_effect_type(stage_type) → DMMaterialEffectTarget

Stage Type to Effect Type

Parameters:

stage_type (DMMaterialLayerStage)

Return type:

DMMaterialEffectTarget