unreal.MovieGraphLightModifierNode

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

Bases: MovieGraphSettingNode

A node which modifies properties on light components within the world.

There are several common light properties (eg, Light Color) that can be modified directly. For less common light properties, they can be modified by adding them as “Custom” properties. The common properties apply to all standard light types; custom properties apply only to a specific light type.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphLightModifierNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affects_world (bool): [Read-Write] Whether the light can affect the world, or whether it is disabled. A disabled light will not contribute to the scene in any way. This setting cannot be changed at runtime and unbuilds lighting when changed. Setting this to false has the same effect as deleting the light, so it is useful for non-destructive experiments.

  • cast_shadows (bool): [Read-Write] Whether the light should cast any shadows.

  • directional_light_intensity (float): [Read-Write] Maximum illumination from the light (in lux).

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

  • indirect_lighting_intensity (float): [Read-Write] Scales the indirect lighting contribution from this light. A value of 0 disables any GI from this light. Default is 1.

  • intensity (float): [Read-Write] Total energy that the light emits.

  • intensity_method (MovieGraphLightModifierIntensityMethod): [Read-Write] Whether point, rect, and spot lights share the same intensity, or the intensity (and intensity units) are unique for each type.

  • intensity_units (LightUnits): [Read-Write] Units used for the intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

  • light_color (Color): [Read-Write] Filter color of the light. Note that this can change the light’s effective intensity.

  • lighting_channels (LightingChannels): [Read-Write] Channels that this light should affect. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing. Lighting channels are only supported on translucent materials using forward shading (i.e. when not using the translucency lighting volume).

  • modifier_name (str): [Read-Write] The name of this modifier.

  • override_b_affects_world (bool): [Read-Write]

  • override_cast_shadows (bool): [Read-Write]

  • override_directional_light_intensity (bool): [Read-Write]

  • override_indirect_lighting_intensity (bool): [Read-Write]

  • override_intensity (bool): [Read-Write]

  • override_intensity_method (bool): [Read-Write]

  • override_intensity_units (bool): [Read-Write]

  • override_light_color (bool): [Read-Write]

  • override_lighting_channels (bool): [Read-Write]

  • override_point_light_intensity (bool): [Read-Write]

  • override_point_light_intensity_units (bool): [Read-Write]

  • override_rect_light_intensity (bool): [Read-Write]

  • override_rect_light_intensity_units (bool): [Read-Write]

  • override_samples_per_pixel (bool): [Read-Write]

  • override_sky_light_intensity_scale (bool): [Read-Write]

  • override_spot_light_intensity (bool): [Read-Write]

  • override_spot_light_intensity_units (bool): [Read-Write]

  • override_volumetric_scattering_intensity (bool): [Read-Write]

  • point_light_intensity (float): [Read-Write] Total energy that the point light emits.

  • point_light_intensity_units (LightUnits): [Read-Write] Units used for the point light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

  • rect_light_intensity (float): [Read-Write] Total energy that the rect light emits.

  • rect_light_intensity_units (LightUnits): [Read-Write] Units used for the rect light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

  • samples_per_pixel (int32): [Read-Write] Samples per pixel for ray tracing.

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

  • sky_light_intensity_scale (float): [Read-Write] Total energy that the sky light emits.

  • spot_light_intensity (float): [Read-Write] Total energy that the spot light emits.

  • spot_light_intensity_units (LightUnits): [Read-Write] Units used for the spot light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

  • volumetric_scattering_intensity (float): [Read-Write] Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

add_collection(collection_name) → None

Adds a collection identified by the given name which will be affected by the modifiers on this node.

Parameters:

collection_name (Name)

add_custom_light_property(light_component_class, property_name) → bool

Adds the property from the specified class to the “Custom” lighting properties. Does nothing if the Custom properties already contains it. Returns true on success, else false.

Adding a custom property does not immediately make it take effect. Its override state needs to be set to “true” via UpdateCustomLightPropertyOverrideState().

Parameters:
Return type:

bool

property affects_world: bool

[Read-Write] Whether the light can affect the world, or whether it is disabled. A disabled light will not contribute to the scene in any way. This setting cannot be changed at runtime and unbuilds lighting when changed. Setting this to false has the same effect as deleting the light, so it is useful for non-destructive experiments.

Type:

(bool)

property cast_shadows: bool

[Read-Write] Whether the light should cast any shadows.

Type:

(bool)

property directional_light_intensity: float

[Read-Write] Maximum illumination from the light (in lux).

Type:

(float)

get_all_collections() → Array[Name]

Gets all collections that will be affected by the modifiers used by this node.

Return type:

Array[Name]

get_all_modifiers() → Array[MovieGraphModifierBase]

Gets all modifiers that will be applied with this modifier node.

Return type:

Array[MovieGraphModifierBase]

get_num_custom_light_properties() → int32

Gets how many “Custom” lighting properties have been added.

Return type:

int32

has_custom_light_property(light_component_class, property_name) → bool

Determines if the given property exists within the “Custom” lighting properties.

Parameters:
Return type:

bool

property indirect_lighting_intensity: float

[Read-Write] Scales the indirect lighting contribution from this light. A value of 0 disables any GI from this light. Default is 1.

Type:

(float)

property intensity: float

[Read-Write] Total energy that the light emits.

Type:

(float)

property intensity_method: MovieGraphLightModifierIntensityMethod

[Read-Write] Whether point, rect, and spot lights share the same intensity, or the intensity (and intensity units) are unique for each type.

Type:

(MovieGraphLightModifierIntensityMethod)

property intensity_units: LightUnits

[Read-Write] Units used for the intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

Type:

(LightUnits)

is_collection_enabled(collection_name) → bool

Gets the enable state (within this modifier) of the collection with the given name.

Parameters:

collection_name (Name)

Return type:

bool

is_custom_light_property_overridden(light_component_class, property_name) → bool

Determines if the given “Custom” light property has been marked as overridden. A custom property MUST be marked as overridden in order to take effect. The override state is visualized as the checkbox in front of the property name the UI.

Parameters:
Return type:

bool

property light_color: Color

[Read-Write] Filter color of the light. Note that this can change the light’s effective intensity.

Type:

(Color)

property lighting_channels: LightingChannels

[Read-Write] Channels that this light should affect. These channels only apply to opaque materials, direct lighting, and dynamic lighting and shadowing. Lighting channels are only supported on translucent materials using forward shading (i.e. when not using the translucency lighting volume).

Type:

(LightingChannels)

property modifier_name: str

[Read-Write] The name of this modifier.

Type:

(str)

property override_b_affects_world: bool

[Read-Write]

Type:

(bool)

property override_cast_shadows: bool

[Read-Write]

Type:

(bool)

property override_directional_light_intensity: bool

[Read-Write]

Type:

(bool)

property override_indirect_lighting_intensity: bool

[Read-Write]

Type:

(bool)

property override_intensity: bool

[Read-Write]

Type:

(bool)

property override_intensity_method: bool

[Read-Write]

Type:

(bool)

property override_intensity_units: bool

[Read-Write]

Type:

(bool)

property override_light_color: bool

[Read-Write]

Type:

(bool)

property override_lighting_channels: bool

[Read-Write]

Type:

(bool)

property override_point_light_intensity: bool

[Read-Write]

Type:

(bool)

property override_point_light_intensity_units: bool

[Read-Write]

Type:

(bool)

property override_rect_light_intensity: bool

[Read-Write]

Type:

(bool)

property override_rect_light_intensity_units: bool

[Read-Write]

Type:

(bool)

property override_samples_per_pixel: bool

[Read-Write]

Type:

(bool)

property override_sky_light_intensity_scale: bool

[Read-Write]

Type:

(bool)

property override_spot_light_intensity: bool

[Read-Write]

Type:

(bool)

property override_spot_light_intensity_units: bool

[Read-Write]

Type:

(bool)

property override_volumetric_scattering_intensity: bool

[Read-Write]

Type:

(bool)

property point_light_intensity: float

[Read-Write] Total energy that the point light emits.

Type:

(float)

property point_light_intensity_units: LightUnits

[Read-Write] Units used for the point light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

Type:

(LightUnits)

property rect_light_intensity: float

[Read-Write] Total energy that the rect light emits.

Type:

(float)

property rect_light_intensity_units: LightUnits

[Read-Write] Units used for the rect light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

Type:

(LightUnits)

remove_collection(collection_name) → bool

Removes a collection identified by the given name. Returns true if the collection was found and removed successfully, else false.

Parameters:

collection_name (Name)

Return type:

bool

remove_custom_light_property(light_component_class, property_name) → bool

Removes the property in the specified class from the “Custom” lighting properties. Does nothing if the Custom properties don’t contain the property. Returns true on success, else false.

Parameters:
Return type:

bool

property samples_per_pixel: int

[Read-Write] Samples per pixel for ray tracing.

Type:

(int32)

set_collection_enabled(collection_name, is_collection_enabled) → None

Sets the enable state (within this modifier) of the collection with the given name. Disabled collections will not be modified by this modifier node. Collections that are added to the modifier are enabled by default.

Parameters:

  • collection_name (Name)

  • is_collection_enabled (bool)

property sky_light_intensity_scale: float

[Read-Write] Total energy that the sky light emits.

Type:

(float)

property spot_light_intensity: float

[Read-Write] Total energy that the spot light emits.

Type:

(float)

property spot_light_intensity_units: LightUnits

[Read-Write] Units used for the spot light intensity. The peak luminous intensity is measured in candelas, while the luminous flux is measured in lumens. When the units are set in Nits, the light’s power is also determined by the size of the light source (larger sources will emit more light).

Type:

(LightUnits)

supports_collections() → bool

Gets whether this modifier node supports/uses collections.

Return type:

bool

update_custom_light_property_override_state(light_component_class, property_name, is_overridden) → bool

Updates the override state for a “Custom” light property. A custom property MUST be marked as overridden in order to take effect. Returns true on success, else false.

Parameters:
Return type:

bool

property volumetric_scattering_intensity: float

[Read-Write] Intensity of the volumetric scattering from this light. This scales Intensity and LightColor.

Type:

(float)