unreal.MovieRenderPipelineProjectSettings

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

Bases: unreal.Object

Universal Movie Render Pipeline settings that apply to the whole project.

C++ Source:

• Plugin: MovieRenderPipeline

• Module: MovieRenderPipelineEditor

• File: MovieRenderPipelineSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

• default_classes (Array(type(Class))): [Read-Write] Default Classes: The settings specified here will automatically be added to a Movie Pipeline Master Configuration when using the UI. This does not apply to scripting and does not apply to runtime. It is only a convenience function so that when a job is created, it can be pre-filled with some settings to make the render functional out of the gate. It can also be used to automatically add your own setting to jobs.

  This only applies to jobs created via the UI. If you do not use the UI (ie: Scripting/Python) you will need to add settings by hand for each job you create.

• default_executor_job (type(Class)): [Read-Write] Default Executor Job: Which Job class should we create by default when adding a job? This allows you to make custom jobs that will have editable properties in the UI for special handling with your executor. This can be made dynamic if you add jobs to the queue programatically instead of through the UI.

• default_local_executor (type(Class)): [Read-Write] Default Local Executor: When the user uses the UI to request we render a movie locally, which implementation should we use to execute the queue of things they want rendered. This allows you to implement your own executor which does different logic. See UMoviePipelineExecutorBase for more information. This is used for the Render button on the UI.

• default_pipeline (type(Class)): [Read-Write] Default Pipeline: This allows you to implement your own Pipeline to handle timing and rendering of a movie. Changing this will allow you to re-use the existing UI/Executors while providing your own logic for producing a single render.

• default_remote_executor (type(Class)): [Read-Write] Default Remote Executor: When the user uses the UI to request we render a movie remotely, which implementation should we use to execute the queue of things they want rendered. This allows you to implement your own executor which does different logic. See UMoviePipelineExecutorBase for more information. This is used for the Render Remotely button on the UI.

• last_preset_origin (MoviePipelineMasterConfig): [Read-Write] Last Preset Origin: What was the last configuration preset the user used? Can be null.

• preset_save_dir (DirectoryPath): [Read-Write] Preset Save Dir: Which directory should we try to save presets in by default?

property default_classes

[Read-Write] Default Classes: The settings specified here will automatically be added to a Movie Pipeline Master Configuration when using the UI. This does not apply to scripting and does not apply to runtime. It is only a convenience function so that when a job is created, it can be pre-filled with some settings to make the render functional out of the gate. It can also be used to automatically add your own setting to jobs.

This only applies to jobs created via the UI. If you do not use the UI (ie: Scripting/Python) you will need to add settings by hand for each job you create.

Type

(Array(type(Class)))

property default_executor_job

[Read-Write] Default Executor Job: Which Job class should we create by default when adding a job? This allows you to make custom jobs that will have editable properties in the UI for special handling with your executor. This can be made dynamic if you add jobs to the queue programatically instead of through the UI.

Type

(type(Class))

property default_local_executor

[Read-Write] Default Local Executor: When the user uses the UI to request we render a movie locally, which implementation should we use to execute the queue of things they want rendered. This allows you to implement your own executor which does different logic. See UMoviePipelineExecutorBase for more information. This is used for the Render button on the UI.

Type

(type(Class))

property default_pipeline

[Read-Write] Default Pipeline: This allows you to implement your own Pipeline to handle timing and rendering of a movie. Changing this will allow you to re-use the existing UI/Executors while providing your own logic for producing a single render.

Type

(type(Class))

property default_remote_executor

[Read-Write] Default Remote Executor: When the user uses the UI to request we render a movie remotely, which implementation should we use to execute the queue of things they want rendered. This allows you to implement your own executor which does different logic. See UMoviePipelineExecutorBase for more information. This is used for the Render Remotely button on the UI.

Type

(type(Class))

property last_preset_origin

[Read-Write] Last Preset Origin: What was the last configuration preset the user used? Can be null.

Type

(MoviePipelineMasterConfig)

property preset_save_dir

[Read-Write] Preset Save Dir: Which directory should we try to save presets in by default?

Type

(DirectoryPath)