World(ID)

base classes — bpy_struct, ID

class bpy.types.World(ID)

World data-block describing the environment and ambient lighting of a scene

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

color

Color of the background (array of 3 items, in [0, inf], default (0.05, 0.05, 0.05))

Type:

mathutils.Color

light_settings

World lighting settings (readonly, never None)

Type:

WorldLighting

lightgroup

Lightgroup that the world belongs to (default “”, never None)

Type:

str

mist_settings

World mist settings (readonly, never None)

Type:

WorldMistSettings

node_tree

Node tree for node based worlds (readonly)

Type:

NodeTree

probe_resolution

Resolution when baked to a texture (default '1024')

Type:

Literal[‘128’, ‘256’, ‘512’, ‘1024’, ‘2048’, ‘4096’]

sun_angle

Angular diameter of the Sun as seen from the Earth (in [0, 3.14159], default 0.00918043)

Type:

float

sun_shadow_filter_radius

Blur shadow aliasing using Percentage Closer Filtering (in [0, inf], default 1.0)

Type:

float

sun_shadow_jitter_overblur

Apply shadow tracing to each jittered sample to reduce under-sampling artifacts (in [0, 100], default 10.0)

Type:

float

sun_shadow_maximum_resolution

Maximum size of a shadow map pixel. Higher values use less memory at the cost of shadow quality. (in [0, inf], default 0.001)

Type:

float

sun_threshold

If non-zero, the maximum value for world contribution that will be recorded inside the world light probe. The excess contribution is converted to a sun light. This reduces the light bleeding caused by very bright light sources. (in [0, inf], default 10.0)

Type:

float

use_eevee_finite_volume

The world’s volume used to be rendered by EEVEE Legacy. Conversion is needed for it to render properly. (default False)

Type:

bool

use_nodes

Use shader nodes to render the world (default False)

Deprecated since version 5.0: removal planned in version 6.0

Unused but kept for compatibility reasons. Setting the property has no effect, and getting it always returns True.

Type:

bool

use_sun_shadow

Enable sun shadow casting (default True)

Type:

bool

use_sun_shadow_jitter

Enable jittered soft shadows to increase shadow precision (disabled in viewport unless enabled in the render settings). Has a high performance impact. (default False)

Type:

bool

inline_shader_nodes()

Get the inlined shader nodes of this world. This preprocesses the node tree to remove nested groups, repeat zones and more.

Returns:

The inlined shader nodes.

Return type:

bpy.types.InlineShaderNodes

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References