unreal.MovieGraphQuickRenderModeSettings

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

Bases: Object

Settings for a specific mode within Quick Render. Note that some modes share settings.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphQuickRenderSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • custom_end_frame (int32): [Read-Write] The frame in the level sequence that the render will end on. This frame number is exclusive, meaning that the rendered frames will include the frames up until (but excluding) this frame.

  • custom_start_frame (int32): [Read-Write] The frame in the level sequence that the render will begin on. This frame number is inclusive, meaning that this frame will be included in the rendered frames.

  • frame_range_type (MovieGraphQuickRenderFrameRangeType): [Read-Write] The frame range that should be used to render from. Not applicable to modes that only render stills.

  • graph_preset (MovieGraphConfig): [Read-Write] The graph preset that is used to configure the render. If not specified, the quick render default graph will be used.

  • graph_variable_assignments (Array[MovieJobVariableAssignmentContainer]): [Read-Write] Values that are set on the variables contained within the graph preset. See note on RefreshVariableAssignments().

  • level_sequence_override (LevelSequence): [Read-Write] If this override is set, this sequence will be used instead of the level sequence that’s active in Sequencer. In UI-based Quick Render, this property is never set directly because Sequencer is always used. However, for scripting purposes, there may be cases where Sequencer is not open, and a specific level sequence needs to be used.

  • override_viewport_look_flags (bool): [Read-Write] Enables/disables the ViewportLookFlags property from taking effect.

  • post_render_behavior (MovieGraphQuickRenderPostRenderActionType): [Read-Write] The action that quick render should perform after a render is finished.

  • viewport_look_flags (int32): [Read-Write] The properties of the viewport that should be applied to the quick render. These will override any equivalent properties specified in the graph.

property custom_end_frame: int

[Read-Write] The frame in the level sequence that the render will end on. This frame number is exclusive, meaning that the rendered frames will include the frames up until (but excluding) this frame.

Type:

(int32)

property custom_start_frame: int

[Read-Write] The frame in the level sequence that the render will begin on. This frame number is inclusive, meaning that this frame will be included in the rendered frames.

Type:

(int32)

property frame_range_type: MovieGraphQuickRenderFrameRangeType

[Read-Write] The frame range that should be used to render from. Not applicable to modes that only render stills.

Type:

(MovieGraphQuickRenderFrameRangeType)

get_variable_assignments_for_graph(graph_config_path) → MovieJobVariableAssignmentContainer

Gets the variable assignments for the specified graph asset. Note that there will normally only be one variable assignment container for these quick render settings (the assignments for the graph specified in GraphPreset). However, GraphPreset may have subgraphs, and subgraphs store their variable assignments in separate containers. If you need to update the variable assignments for those subgraph(s), this method provides a convenient way of getting their assignments (instead of iterating through GraphVariableAssignments).

Parameters:

graph_config_path (MovieGraphConfig)

Return type:

MovieJobVariableAssignmentContainer

property graph_preset: MovieGraphConfig

[Read-Write] The graph preset that is used to configure the render. If not specified, the quick render default graph will be used.

Type:

(MovieGraphConfig)

property graph_variable_assignments: None

[Read-Write] Values that are set on the variables contained within the graph preset. See note on RefreshVariableAssignments().

Type:

(Array[MovieJobVariableAssignmentContainer])

property level_sequence_override: LevelSequence

[Read-Write] If this override is set, this sequence will be used instead of the level sequence that’s active in Sequencer. In UI-based Quick Render, this property is never set directly because Sequencer is always used. However, for scripting purposes, there may be cases where Sequencer is not open, and a specific level sequence needs to be used.

Type:

(LevelSequence)

property override_viewport_look_flags: bool

[Read-Write] Enables/disables the ViewportLookFlags property from taking effect.

Type:

(bool)

property post_render_behavior: MovieGraphQuickRenderPostRenderActionType

[Read-Write] The action that quick render should perform after a render is finished.

Type:

(MovieGraphQuickRenderPostRenderActionType)

classmethod refresh_variable_assignments(settings) → None

Within the settings object provided, refreshes the variable assignments in the settings to match the setting’s GraphPreset. Note that changing the graph preset within the editor will do this automatically, but if changing the graph outside of the editor, this may need to be run manually.

Parameters:

settings (MovieGraphQuickRenderModeSettings)

property viewport_look_flags: int

[Read-Write] The properties of the viewport that should be applied to the quick render. These will override any equivalent properties specified in the graph.

Type:

(int32)