unreal.MovieGraphModifierNode

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

Bases: MovieGraphSettingNode

A modifier node which allows render properties and materials to be changed.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphModifierNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • dynamic_properties (InstancedPropertyBag): [Read-Write] Properties which can be dynamically declared on the node (vs. native properties which are always present).

  • modifier_name (str): [Read-Write] The name of this modifier.

  • script_tags (Array[str]): [Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

add_collection(collection_name) → None

Adds a collection identified by the given name which will be affected by the modifiers on this node.

Parameters:

collection_name (Name)

add_modifier(modifier_type) → MovieGraphCollectionModifier

Adds a new modifier of the specified type. Returns a pointer to the new modifier, or nullptr if a modifier of the specified type already exists on this node (only one modifier of each type can be added to the node).

Parameters:

modifier_type (type(Class))

Return type:

MovieGraphCollectionModifier

get_all_collections() → Array[Name]

Gets all collections that will be affected by the modifiers used by this node.

Return type:

Array[Name]

get_all_modifiers() → Array[MovieGraphModifierBase]

Gets all modifiers that will be applied with this modifier node.

Return type:

Array[MovieGraphModifierBase]

get_collections() → Array[Name]

Get Collections

Return type:

Array[Name]

get_modifier(modifier_type) → MovieGraphCollectionModifier

Gets the modifier of the specified type, or nullptr if one does not exist on this node.

Parameters:

modifier_type (type(Class))

Return type:

MovieGraphCollectionModifier

get_modifiers() → Array[MovieGraphCollectionModifier]

Get Modifiers

Return type:

Array[MovieGraphCollectionModifier]

is_collection_enabled(collection_name) → bool

Gets the enable state (within this modifier) of the collection with the given name.

Parameters:

collection_name (Name)

Return type:

bool

property modifier_name: str

[Read-Write] The name of this modifier.

Type:

(str)

remove_collection(collection_name) → bool

Removes a collection identified by the given name. Returns true if the collection was found and removed successfully, else false.

Parameters:

collection_name (Name)

Return type:

bool

remove_modifier(modifier_type) → bool

Removes the modifier of the specified type. Returns true on success, or false if a modifier of the specified type does not exist on the node.

Parameters:

modifier_type (type(Class))

Return type:

bool

set_collection_enabled(collection_name, is_collection_enabled) → None

Sets the enable state (within this modifier) of the collection with the given name. Disabled collections will not be modified by this modifier node. Collections that are added to the modifier are enabled by default.

Parameters:

  • collection_name (Name)

  • is_collection_enabled (bool)

supports_collections() → bool

Gets whether this modifier node supports/uses collections.

Return type:

bool