unreal.MoviePipelineConfigBase

class unreal.MoviePipelineConfigBase(outer=None, name='None')

Bases: unreal.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)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

Returns

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

Return type

MoviePipelineSetting

find_setting_by_class(class_, include_disabled_settings=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

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)

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

Returns

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

Return type

Array(MoviePipelineSetting)

get_user_settings()

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

Returns

Return type

Array(MoviePipelineSetting)

remove_setting(setting)None

Removes the specific instance from our Setting list.

Parameters

setting (MoviePipelineSetting) –