unreal.MoviePipelineConfigBase

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

Bases: Object

Movie Pipeline Config Base

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MoviePipelineConfigBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • settings (Array[MoviePipelineSetting]): [Read-Only] Array of settings classes that affect various parts of the output pipeline.

copy_from(config) None

Copy this configuration from another existing configuration.

Parameters:

config (MoviePipelineConfigBase) –

find_or_add_setting_by_class(class_, include_disabled_settings=False, exact_match=False) MoviePipelineSetting

Finds a setting of a particular type for this pipeline config, adding it if it doesn’t already exist.

Parameters:
  • class (type(Class)) – Class you wish to find or create the setting object for.

  • include_disabled_settings (bool) – if true, disabled settings will be included in the search

  • exact_match (bool) – if true, only exact matches of the specified class will be found, otherwise subclasses of the specified class will also be found

Returns:

An instance of this class as a setting on this config.

Return type:

MoviePipelineSetting

find_setting_by_class(class_, include_disabled_settings=False, exact_match=False) MoviePipelineSetting

Find a setting of a particular type for this config.

Parameters:
  • class (type(Class)) – Class that you wish to find the setting object for.

  • include_disabled_settings (bool) – if true, disabled settings will be included in the search

  • exact_match (bool) – if true, only exact matches of the specified class will be found, otherwise subclasses of the specified class will also be found

Returns:

An instance of this class if it already exists as a setting on this config, otherwise null.

Return type:

MoviePipelineSetting

find_settings_by_class(class_, include_disabled_settings=False, exact_match=False) Array[MoviePipelineSetting]

Find all settings of a particular type for this config.

Parameters:
  • class (type(Class)) – Class that you wish to find the setting object for.

  • include_disabled_settings (bool) – if true, disabled settings will be included in the search

  • exact_match (bool) – if true, only exact matches of the specified class will be found, otherwise subclasses of the specified class will also be found

Returns:

An array of instances of this class if it already exists as a setting on this config

Return type:

Array[MoviePipelineSetting]

get_config_origin() MoviePipelineConfigBase

Gets the config that this config was originally based on (if any). The origin will only be set on transient configs; the origin will be nullptr for non-transient configs because the origin will be this object.

Return type:

MoviePipelineConfigBase

get_user_settings() Array[MoviePipelineSetting]

Returns an array of all settings in this config that the user has added via the UI or via Scripting.

Return type:

Array[MoviePipelineSetting]

remove_setting(setting) None

Removes the specific instance from our Setting list.

Parameters:

setting (MoviePipelineSetting) –

set_config_origin(config) None

Sets the config that this config originated from (if any). The origin should only be set for transient configs.

Parameters:

config (MoviePipelineConfigBase) –