BlendDataLights(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.BlendDataLights(bpy_prop_collection)

Collection of lights

new(name, type)

Add a new light to the main database

Parameters:

  • name (str) – New name for the data-block (never None)

  • type (Literal[Light Type Items]) – Type, The type of light to add

Returns:

New light data-block

Return type:

Light

remove(light, *, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove a light from the current blendfile

Parameters:

  • light (Light) – Light to remove (never None)

  • do_unlink (bool) – Unlink all usages of this light before deleting it (WARNING: will also delete objects instancing that light data) (optional)

  • do_id_user (bool) – Decrement user counter of all data-blocks used by this light data (optional)

  • do_ui_user (bool) – Make sure interface does not reference this light data (optional)

tag(value)

tag

Parameters:

value (bool) – Value

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