unreal.DMMaterialEffectStack

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

Bases: DMMaterialComponent

Container for effects. Effects can be applied to either layers (on a per stage basis) or to slots.

C++ Source:

  • Plugin: DynamicMaterial

  • Module: DynamicMaterialEditor

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

  • effects (Array[DMMaterialEffect]): [Read-Only]

  • enabled (bool): [Read-Only]

add_effect(effect) → bool

Add Effect

Parameters:

effect (DMMaterialEffect)

Return type:

bool

apply_preset(preset) → None

Apply the given preset to this stack. Does not remove old effects.

Parameters:

preset (DMMaterialEffectStackJson)

bp_get_effects() → Array[DMMaterialEffect]

BP Get Effects

Return type:

Array[DMMaterialEffect]

bp_move_effect_by_index(index, new_index) → bool

BP Move Effect by Index

Parameters:

  • index (int32)

  • new_index (int32)

Return type:

bool

bp_move_effect_by_value(effect, new_index) → bool

BP Move Effect by Value

Parameters:
Return type:

bool

bp_remove_effect_by_index(index) → DMMaterialEffect

BP Remove Effect by Index

Parameters:

index (int32)

Return type:

DMMaterialEffect

bp_remove_effect_by_value(effect) → bool

BP Remove Effect by Value

Parameters:

effect (DMMaterialEffect)

Return type:

bool

classmethod create_effect_stack_for_layer(layer) → DMMaterialEffectStack

Create Effect Stack for Layer

Parameters:

layer (DMMaterialLayerObject)

Return type:

DMMaterialEffectStack

classmethod create_effect_stack_for_slot(slot) → DMMaterialEffectStack

Create Effect Stack for Slot

Parameters:

slot (DMMaterialSlot)

Return type:

DMMaterialEffectStack

create_preset() → DMMaterialEffectStackJson

Creates a preset based on the current stage.

Return type:

DMMaterialEffectStackJson

property effects: None

[Read-Only]

Type:

(Array[DMMaterialEffect])

property enabled: bool

[Read-Only]

Type:

(bool)

get_effect(index) → DMMaterialEffect

Get Effect

Parameters:

index (int32)

Return type:

DMMaterialEffect

get_layer() → DMMaterialLayerObject

Get Layer

Return type:

DMMaterialLayerObject

get_slot() → DMMaterialSlot

Get Slot

Return type:

DMMaterialSlot

has_effect(effect) → bool

Has Effect

Parameters:

effect (DMMaterialEffect)

Return type:

bool

is_enabled() → bool

Is Enabled

Return type:

bool

set_effect(index, effect) → DMMaterialEffect

Set Effect

Parameters:
Return type:

DMMaterialEffect

set_enabled(is_enabled) → bool

Set Enabled

Parameters:

is_enabled (bool)

Return type:

bool