unreal.MovieGraphGlobalGameOverridesNode

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

Bases: MovieGraphSettingNode

A node which configures the global game overrides.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphGlobalGameOverrides.h

Editor Properties: (see get_editor_property/set_editor_property)

  • disable_hlods (bool): [Read-Write] Determines if hierarchical LODs should be disabled and their real meshes used instead, regardless of distance. Note that this does not affect World Partition HLODs.

  • disable_lods (bool): [Read-Write] Disabling LODs will use the highest quality LOD for meshes and particle systems, regardless of distance. Note that this does not affect Nanite.

    Configures the following cvars: - r.ForceLOD - r.SkeletalMeshLODBias - r.ParticleLODBias - foliage.DitheredLOD - foliage.ForceLOD

  • disable_texture_streaming (bool): [Read-Write] Toggles whether texture streaming is disabled. Can solve objects being blurry after camera cuts.

    Configures the following cvars: - r.TextureStreaming

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

  • flush_asset_compiler (bool): [Read-Write] This ensures that any asynchronously compiled assets (static meshes, distance fields, etc.) required for rendering the frame are completed before rendering the frame. This feature generally only adds to render times on the frames where a new asset is introduced (ie, spawned) that may not be fully compiled. Results are stored in the DDC on subsequent uses.

  • flush_grass_streaming (bool): [Read-Write] Flushing grass streaming prevents visible pop-in/culling of grass instances, but may come at a high GPU memory cost (depending on rendering feature set), and grass density. Try turning this off if you are low on GPU memory and have dense grass.

  • flush_level_streaming (bool): [Read-Write] Flushing level streaming ensures that any pending changes to sub-levels or world partition are fully processed before we render the frame. This feature generally only adds to render times on the frames that have level visibility state changes, so generally safe to leave turned on all the time.

  • flush_shader_compiler (bool): [Read-Write] This ensures that any asynchronously compiled shader permutations are completed before rendering the frame. When using On Demand Shader Compilation the editor will skip compiling currently unneeded permutations for the material graph to decrease artist iteration time, but these permutations need to be compiled when rendering. Results are stored in the DDC on subsequent uses.

  • flush_streaming_managers (bool): [Read-Write] This ensures that we wait on any streaming managers that may have outstanding work to finish their work before we render the frame. Many GPU-based features rely on a feedback loop where a frame is rendered, then results are read back from the GPU to the CPU. These results are analyzed, and additional data is loaded to be used in a subsequent frame. This feature ensures that the data is fully loaded before we render the next frame, but does NOT solve issues related to generating the those feedback requests in the first place. Virtual Textures and Nanite must render the frame to generate the request – this option cannot solve that; it only helps ensure that the requests that are made are fully processed before the frame is rendered.

    Configures the following cvars: - r.Streaming.SyncStatesWhenBlocking

  • game_mode_override (type(Class)): [Read-Write] deprecated: Please use the SoftGameModeOverride property instead.

  • override_b_rebuild_lumen_scene_between_render_layers (bool): [Read-Write]

  • override_disable_hlods (bool): [Read-Write]

  • override_disable_lods (bool): [Read-Write]

  • override_disable_texture_streaming (bool): [Read-Write]

  • override_flush_asset_compiler (bool): [Read-Write]

  • override_flush_grass_streaming (bool): [Read-Write]

  • override_flush_level_streaming (bool): [Read-Write]

  • override_flush_shader_compiler (bool): [Read-Write]

  • override_flush_streaming_managers (bool): [Read-Write]

  • override_game_mode_override (bool): [Read-Write] deprecated: Please use the bOverride_SoftGameModeOverride property instead.

  • override_scalability_quality_level (bool): [Read-Write]

  • override_soft_game_mode_override (bool): [Read-Write]

  • override_virtual_texture_feedback_factor (bool): [Read-Write]

  • rebuild_lumen_scene_between_render_layers (bool): [Read-Write] When rendering multiple Render Layers, Lumen’s surface cache may not be able to keep up with content switching between hidden/visible states. This setting mitigates the problem by resetting the surface cache for each Render Layer on each frame. Enabling this setting has a performance cost. Disabling Screen Traces can also improve consistency when using Render Layers with Lumen. This setting may be removed in a future engine release if it is no longer needed.

    Configures the following Console Variables:

    • r.LumenScene.Radiosity.UpdateFactor = 1

    • r.LumenScene.SurfaceCache.CardCaptureFactor = 1

    • r.LumenScene.SurfaceCache.Feedback = 0

    • r.LumenScene.SurfaceCache.RecaptureEveryFrame = 1

  • scalability_quality_level (MovieGraphScalabilityQualityLevel): [Read-Write] The scalability quality level that should be used in renders. See the Scalability Reference documentation for information on how to edit cvars to add/change default quality values.

  • 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.

  • soft_game_mode_override (Class): [Read-Write] Optional game mode to override the map’s default game mode with. This can be useful if the game’s normal mode displays UI elements or loading screens that you don’t want captured.

  • virtual_texture_feedback_factor (int32): [Read-Write] The virtual texture feedback resolution factor. A lower factor will increase virtual texture feedback resolution.

property b_disable_hlo_ds: bool

‘b_disable_hlo_ds’ was renamed to ‘disable_hlods’.

Type:

deprecated

property disable_hlods: bool

[Read-Write] Determines if hierarchical LODs should be disabled and their real meshes used instead, regardless of distance. Note that this does not affect World Partition HLODs.

Type:

(bool)

property disable_lo_ds: bool

‘disable_lo_ds’ was renamed to ‘disable_lods’.

Type:

deprecated

property disable_lods: bool

[Read-Write] Disabling LODs will use the highest quality LOD for meshes and particle systems, regardless of distance. Note that this does not affect Nanite.

Configures the following cvars: - r.ForceLOD - r.SkeletalMeshLODBias - r.ParticleLODBias - foliage.DitheredLOD - foliage.ForceLOD

Type:

(bool)

property disable_texture_streaming: bool

[Read-Write] Toggles whether texture streaming is disabled. Can solve objects being blurry after camera cuts.

Configures the following cvars: - r.TextureStreaming

Type:

(bool)

property flush_asset_compiler: bool

[Read-Write] This ensures that any asynchronously compiled assets (static meshes, distance fields, etc.) required for rendering the frame are completed before rendering the frame. This feature generally only adds to render times on the frames where a new asset is introduced (ie, spawned) that may not be fully compiled. Results are stored in the DDC on subsequent uses.

Type:

(bool)

property flush_grass_streaming: bool

[Read-Write] Flushing grass streaming prevents visible pop-in/culling of grass instances, but may come at a high GPU memory cost (depending on rendering feature set), and grass density. Try turning this off if you are low on GPU memory and have dense grass.

Type:

(bool)

property flush_level_streaming: bool

[Read-Write] Flushing level streaming ensures that any pending changes to sub-levels or world partition are fully processed before we render the frame. This feature generally only adds to render times on the frames that have level visibility state changes, so generally safe to leave turned on all the time.

Type:

(bool)

property flush_shader_compiler: bool

[Read-Write] This ensures that any asynchronously compiled shader permutations are completed before rendering the frame. When using On Demand Shader Compilation the editor will skip compiling currently unneeded permutations for the material graph to decrease artist iteration time, but these permutations need to be compiled when rendering. Results are stored in the DDC on subsequent uses.

Type:

(bool)

property flush_streaming_managers: bool

[Read-Write] This ensures that we wait on any streaming managers that may have outstanding work to finish their work before we render the frame. Many GPU-based features rely on a feedback loop where a frame is rendered, then results are read back from the GPU to the CPU. These results are analyzed, and additional data is loaded to be used in a subsequent frame. This feature ensures that the data is fully loaded before we render the next frame, but does NOT solve issues related to generating the those feedback requests in the first place. Virtual Textures and Nanite must render the frame to generate the request – this option cannot solve that; it only helps ensure that the requests that are made are fully processed before the frame is rendered.

Configures the following cvars: - r.Streaming.SyncStatesWhenBlocking

Type:

(bool)

property game_mode_override: Class

[Read-Write] deprecated: Please use the SoftGameModeOverride property instead.

Type:

(type(Class))

property override_b_disable_hlo_ds: bool

‘override_b_disable_hlo_ds’ was renamed to ‘override_disable_hlods’.

Type:

deprecated

property override_b_disable_lo_ds: bool

‘override_b_disable_lo_ds’ was renamed to ‘override_disable_lods’.

Type:

deprecated

property override_b_disable_texture_streaming: bool

‘override_b_disable_texture_streaming’ was renamed to ‘override_disable_texture_streaming’.

Type:

deprecated

property override_b_flush_asset_compiler: bool

‘override_b_flush_asset_compiler’ was renamed to ‘override_flush_asset_compiler’.

Type:

deprecated

property override_b_flush_grass_streaming: bool

‘override_b_flush_grass_streaming’ was renamed to ‘override_flush_grass_streaming’.

Type:

deprecated

property override_b_flush_level_streaming: bool

‘override_b_flush_level_streaming’ was renamed to ‘override_flush_level_streaming’.

Type:

deprecated

property override_b_flush_shader_compiler: bool

‘override_b_flush_shader_compiler’ was renamed to ‘override_flush_shader_compiler’.

Type:

deprecated

property override_b_flush_streaming_managers: bool

‘override_b_flush_streaming_managers’ was renamed to ‘override_flush_streaming_managers’.

Type:

deprecated

property override_b_rebuild_lumen_scene_between_render_layers: bool

[Read-Write]

Type:

(bool)

property override_disable_hlods: bool

[Read-Write]

Type:

(bool)

property override_disable_lods: bool

[Read-Write]

Type:

(bool)

property override_disable_texture_streaming: bool

[Read-Write]

Type:

(bool)

property override_flush_asset_compiler: bool

[Read-Write]

Type:

(bool)

property override_flush_grass_streaming: bool

[Read-Write]

Type:

(bool)

property override_flush_level_streaming: bool

[Read-Write]

Type:

(bool)

property override_flush_shader_compiler: bool

[Read-Write]

Type:

(bool)

property override_flush_streaming_managers: bool

[Read-Write]

Type:

(bool)

property override_game_mode_override: bool

[Read-Write] deprecated: Please use the bOverride_SoftGameModeOverride property instead.

Type:

(bool)

property override_scalability_quality_level: bool

[Read-Write]

Type:

(bool)

property override_soft_game_mode_override: bool

[Read-Write]

Type:

(bool)

property override_virtual_texture_feedback_factor: bool

[Read-Write]

Type:

(bool)

property rebuild_lumen_scene_between_render_layers: bool

[Read-Write] When rendering multiple Render Layers, Lumen’s surface cache may not be able to keep up with content switching between hidden/visible states. This setting mitigates the problem by resetting the surface cache for each Render Layer on each frame. Enabling this setting has a performance cost. Disabling Screen Traces can also improve consistency when using Render Layers with Lumen. This setting may be removed in a future engine release if it is no longer needed.

Configures the following Console Variables:

  • r.LumenScene.Radiosity.UpdateFactor = 1

  • r.LumenScene.SurfaceCache.CardCaptureFactor = 1

  • r.LumenScene.SurfaceCache.Feedback = 0

  • r.LumenScene.SurfaceCache.RecaptureEveryFrame = 1

Type:

(bool)

property scalability_quality_level: MovieGraphScalabilityQualityLevel

[Read-Write] The scalability quality level that should be used in renders. See the Scalability Reference documentation for information on how to edit cvars to add/change default quality values.

Type:

(MovieGraphScalabilityQualityLevel)

property soft_game_mode_override: Class

[Read-Write] Optional game mode to override the map’s default game mode with. This can be useful if the game’s normal mode displays UI elements or loading screens that you don’t want captured.

Type:

(Class)

property virtual_texture_feedback_factor: int

[Read-Write] The virtual texture feedback resolution factor. A lower factor will increase virtual texture feedback resolution.

Type:

(int32)