unreal.LightmassWorldInfoSettings

class unreal.LightmassWorldInfoSettings(static_lighting_level_scale: float = 0.0, num_indirect_lighting_bounces: int = 0, num_sky_lighting_bounces: int = 0, indirect_lighting_quality: float = 0.0, indirect_lighting_smoothness: float = 0.0, environment_color: Color = Ellipsis, environment_intensity: float = 0.0, diffuse_boost: float = 0.0, volume_lighting_method: VolumeLightingMethod = Ellipsis, use_ambient_occlusion: bool = False, generate_ambient_occlusion_material_mask: bool = False, visualize_material_diffuse: bool = False, visualize_ambient_occlusion: bool = False, compress_lightmaps: bool = False, volumetric_lightmap_detail_cell_size: float = 0.0, volumetric_lightmap_maximum_brick_memory_mb: float = 0.0, volumetric_lightmap_spherical_harmonic_smoothing: float = 0.0, volume_light_sample_placement_scale: float = 0.0, direct_illumination_occlusion_fraction: float = 0.0, indirect_illumination_occlusion_fraction: float = 0.0, occlusion_exponent: float = 0.0, fully_occluded_samples_fraction: float = 0.0, max_occlusion_distance: float = 0.0)

Bases: StructBase

Lightmass World Info Settings

C++ Source:

• Module: Engine

• File: WorldSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

• compress_lightmaps (bool): [Read-Write] Whether to compress lightmap textures. Disabling lightmap texture compression will reduce artifacts but increase memory and disk size by 4x. Use caution when disabling this.

• diffuse_boost (float): [Read-Write] Scales the diffuse contribution of all materials in the scene.

• direct_illumination_occlusion_fraction (float): [Read-Write] How much of the AO to apply to direct lighting.

• environment_color (Color): [Read-Write] Represents a constant color light surrounding the upper hemisphere of the level, like a sky. This light source currently does not get bounced as indirect lighting and causes reflection capture brightness to be incorrect. Prefer using a Static Skylight instead.

• environment_intensity (float): [Read-Write] Scales EnvironmentColor to allow independent color and brightness controls.

• fully_occluded_samples_fraction (float): [Read-Write] Fraction of samples taken that must be occluded in order to reach full occlusion.

• generate_ambient_occlusion_material_mask (bool): [Read-Write] Whether to generate textures storing the AO computed by Lightmass. These can be accessed through the PrecomputedAOMask material node, Which is useful for blending between material layers on environment assets. Be sure to set DirectIlluminationOcclusionFraction and IndirectIlluminationOcclusionFraction to 0 if you only want the PrecomputedAOMask!

• indirect_illumination_occlusion_fraction (float): [Read-Write] How much of the AO to apply to indirect lighting.

• indirect_lighting_quality (float): [Read-Write] Warning: Setting this higher than 1 will greatly increase build times! Can be used to increase the GI solver sample counts in order to get higher quality for levels that need it. It can be useful to reduce IndirectLightingSmoothness somewhat (~.75) when increasing quality to get defined indirect shadows. Note that this can’t affect compression artifacts, UV seams or other texture based artifacts.

• indirect_lighting_smoothness (float): [Read-Write] Smoothness factor to apply to indirect lighting. This is useful in some lighting conditions when Lightmass cannot resolve accurate indirect lighting. 1 is default smoothness tweaked for a variety of lighting situations. Higher values like 3 smooth out the indirect lighting more, but at the cost of indirect shadows losing detail.

• max_occlusion_distance (float): [Read-Write] Maximum distance for an object to cause occlusion on another object.

• num_indirect_lighting_bounces (int32): [Read-Write] Number of light bounces to simulate for point / spot / directional lights, starting from the light source. 0 is direct lighting only, 1 is one bounce, etc. Bounce 1 takes the most time to calculate and contributes the most to visual quality, followed by bounce 2. Successive bounces don’t really affect build times, but have a much lower visual impact, unless the material diffuse colors are close to 1.

• num_sky_lighting_bounces (int32): [Read-Write] Number of skylight and emissive bounces to simulate. Lightmass uses a non-distributable radiosity method for skylight bounces whose cost is proportional to the number of bounces.

• occlusion_exponent (float): [Read-Write] Higher exponents increase contrast.

• static_lighting_level_scale (float): [Read-Write] Warning: Setting this to less than 1 will greatly increase build times! Scale of the level relative to real world scale (1 Unreal Unit = 1 cm). All scale-dependent Lightmass setting defaults have been tweaked to work well with real world scale, Any levels with a different scale should use this scale to compensate. For large levels it can drastically reduce build times to set this to 2 or 4.

• use_ambient_occlusion (bool): [Read-Write] If true, AmbientOcclusion will be enabled.

• visualize_ambient_occlusion (bool): [Read-Write] If true, override normal direct and indirect lighting with just the AO term.

• visualize_material_diffuse (bool): [Read-Write] If true, override normal direct and indirect lighting with just the exported diffuse term.

• volume_light_sample_placement_scale (float): [Read-Write] Scales the distances at which volume lighting samples are placed. Volume lighting samples are computed by Lightmass and are used for GI on movable components. Using larger scales results in less sample memory usage and reduces Indirect Lighting Cache update times, but less accurate transitions between lighting areas.

• volume_lighting_method (VolumeLightingMethod): [Read-Write] Technique to use for providing precomputed lighting at all positions inside the Lightmass Importance Volume

• volumetric_lightmap_detail_cell_size (float): [Read-Write] Size of an Volumetric Lightmap voxel at the highest density (used around geometry), in world space units. This setting has a large impact on build times and memory, use with caution. Halving the DetailCellSize can increase memory by up to a factor of 8x.

• volumetric_lightmap_maximum_brick_memory_mb (float): [Read-Write] Maximum amount of memory to spend on Volumetric Lightmap Brick data. High density bricks will be discarded until this limit is met, with bricks furthest from geometry discarded first.

• volumetric_lightmap_spherical_harmonic_smoothing (float): [Read-Write] Controls how much smoothing should be done to Volumetric Lightmap samples during Spherical Harmonic de-ringing. Whenever highly directional lighting is stored in a Spherical Harmonic, a ringing artifact occurs which manifests as unexpected black areas on the opposite side. Smoothing can reduce this artifact. Smoothing is only applied when the ringing artifact is present. 0 = no smoothing, 1 = strong smooth (little directionality in lighting).

property compress_lightmaps: bool

[Read-Write] Whether to compress lightmap textures. Disabling lightmap texture compression will reduce artifacts but increase memory and disk size by 4x. Use caution when disabling this.

Type:

(bool)

property diffuse_boost: float

[Read-Write] Scales the diffuse contribution of all materials in the scene.

Type:

(float)

property direct_illumination_occlusion_fraction: float

[Read-Write] How much of the AO to apply to direct lighting.

Type:

(float)

property environment_color: Color

[Read-Write] Represents a constant color light surrounding the upper hemisphere of the level, like a sky. This light source currently does not get bounced as indirect lighting and causes reflection capture brightness to be incorrect. Prefer using a Static Skylight instead.

Type:

(Color)

property environment_intensity: float

[Read-Write] Scales EnvironmentColor to allow independent color and brightness controls.

Type:

(float)

property fully_occluded_samples_fraction: float

[Read-Write] Fraction of samples taken that must be occluded in order to reach full occlusion.

Type:

(float)

property generate_ambient_occlusion_material_mask: bool

[Read-Write] Whether to generate textures storing the AO computed by Lightmass. These can be accessed through the PrecomputedAOMask material node, Which is useful for blending between material layers on environment assets. Be sure to set DirectIlluminationOcclusionFraction and IndirectIlluminationOcclusionFraction to 0 if you only want the PrecomputedAOMask!

Type:

(bool)

property indirect_illumination_occlusion_fraction: float

[Read-Write] How much of the AO to apply to indirect lighting.

Type:

(float)

property indirect_lighting_quality: float

Setting this higher than 1 will greatly increase build times! Can be used to increase the GI solver sample counts in order to get higher quality for levels that need it. It can be useful to reduce IndirectLightingSmoothness somewhat (~.75) when increasing quality to get defined indirect shadows. Note that this can’t affect compression artifacts, UV seams or other texture based artifacts.

Type:

(float)

Type:

[Read-Write] Warning

property indirect_lighting_smoothness: float

[Read-Write] Smoothness factor to apply to indirect lighting. This is useful in some lighting conditions when Lightmass cannot resolve accurate indirect lighting. 1 is default smoothness tweaked for a variety of lighting situations. Higher values like 3 smooth out the indirect lighting more, but at the cost of indirect shadows losing detail.

Type:

(float)

property max_occlusion_distance: float

[Read-Write] Maximum distance for an object to cause occlusion on another object.

Type:

(float)

property num_indirect_lighting_bounces: int

[Read-Write] Number of light bounces to simulate for point / spot / directional lights, starting from the light source. 0 is direct lighting only, 1 is one bounce, etc. Bounce 1 takes the most time to calculate and contributes the most to visual quality, followed by bounce 2. Successive bounces don’t really affect build times, but have a much lower visual impact, unless the material diffuse colors are close to 1.

Type:

(int32)

property num_sky_lighting_bounces: int

[Read-Write] Number of skylight and emissive bounces to simulate. Lightmass uses a non-distributable radiosity method for skylight bounces whose cost is proportional to the number of bounces.

Type:

(int32)

property occlusion_exponent: float

[Read-Write] Higher exponents increase contrast.

Type:

(float)

property static_lighting_level_scale: float

Setting this to less than 1 will greatly increase build times! Scale of the level relative to real world scale (1 Unreal Unit = 1 cm). All scale-dependent Lightmass setting defaults have been tweaked to work well with real world scale, Any levels with a different scale should use this scale to compensate. For large levels it can drastically reduce build times to set this to 2 or 4.

Type:

(float)

Type:

[Read-Write] Warning

property use_ambient_occlusion: bool

[Read-Write] If true, AmbientOcclusion will be enabled.

Type:

(bool)

property visualize_ambient_occlusion: bool

[Read-Write] If true, override normal direct and indirect lighting with just the AO term.

Type:

(bool)

property visualize_material_diffuse: bool

[Read-Write] If true, override normal direct and indirect lighting with just the exported diffuse term.

Type:

(bool)

property volume_light_sample_placement_scale: float

[Read-Write] Scales the distances at which volume lighting samples are placed. Volume lighting samples are computed by Lightmass and are used for GI on movable components. Using larger scales results in less sample memory usage and reduces Indirect Lighting Cache update times, but less accurate transitions between lighting areas.

Type:

(float)

property volume_lighting_method: VolumeLightingMethod

[Read-Write] Technique to use for providing precomputed lighting at all positions inside the Lightmass Importance Volume

Type:

(VolumeLightingMethod)

property volumetric_lightmap_detail_cell_size: float

[Read-Write] Size of an Volumetric Lightmap voxel at the highest density (used around geometry), in world space units. This setting has a large impact on build times and memory, use with caution. Halving the DetailCellSize can increase memory by up to a factor of 8x.

Type:

(float)

property volumetric_lightmap_maximum_brick_memory_mb: float

[Read-Write] Maximum amount of memory to spend on Volumetric Lightmap Brick data. High density bricks will be discarded until this limit is met, with bricks furthest from geometry discarded first.

Type:

(float)

property volumetric_lightmap_spherical_harmonic_smoothing: float

[Read-Write] Controls how much smoothing should be done to Volumetric Lightmap samples during Spherical Harmonic de-ringing. Whenever highly directional lighting is stored in a Spherical Harmonic, a ringing artifact occurs which manifests as unexpected black areas on the opposite side. Smoothing can reduce this artifact. Smoothing is only applied when the ringing artifact is present. 0 = no smoothing, 1 = strong smooth (little directionality in lighting).

Type:

(float)