Light(ID)

base classes — bpy_struct, ID

subclasses — AreaLight, PointLight, SpotLight, SunLight

class bpy.types.Light.Light(ID)

Light data-block for lighting a scene

animation_data

Animation data for this data-block

Type

AnimData, (readonly)

color

Light color

Type

float array of 3 items in [0, inf], default (1.0, 1.0, 1.0)

cutoff_distance

Distance at which the light influence will be set to 0

Type

float in [0, inf], default 40.0

cycles

Cycles light settings

Type

CyclesLightSettings, (readonly)

distance

Falloff distance - the light is at half the original intensity at this point

Type

float in [0, inf], default 25.0

node_tree

Node tree for node based lights

Type

NodeTree, (readonly)

specular_factor

Specular reflection multiplier

Type

float in [0, 9999], default 1.0

type

Type of Light

  • POINT Point, Omnidirectional point light source.

  • SUN Sun, Constant direction parallel ray light source.

  • SPOT Spot, Directional cone light source.

  • AREA Area, Directional area light source.

Type

enum in [‘POINT’, ‘SUN’, ‘SPOT’, ‘AREA’], default ‘POINT’

use_custom_distance

Use custom attenuation distance instead of global light threshold

Type

boolean, default False

use_nodes

Use shader nodes to render the light

Type

boolean, default False

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

  • ID.name

  • ID.name_full

  • ID.is_evaluated

  • ID.original

  • ID.users

  • ID.use_fake_user

  • ID.is_embedded_data

  • ID.tag

  • ID.is_library_indirect

  • ID.library

  • ID.override_library

  • ID.preview

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

  • ID.evaluated_get

  • ID.copy

  • ID.override_create

  • ID.user_clear

  • ID.user_remap

  • ID.make_local

  • ID.user_of_id

  • ID.animation_data_create

  • ID.animation_data_clear

  • ID.update_tag

  • ID.bl_rna_get_subclass

  • ID.bl_rna_get_subclass_py

References

  • BlendDataLights.new

  • BlendDataLights.remove