BlendDataLights(bpy_struct)

base class — bpy_struct

class bpy.types.BlendDataLights.BlendDataLights(bpy_struct)

Collection of lights

new(name, type)

Add a new light to the main database

Parameters
  • name (string, (never None)) – New name for the data-block

  • type (enum in ['POINT', 'SUN', 'SPOT', 'AREA']) –

    Type, The type of texture to add

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

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, (never None)) – Light to remove

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

  • do_id_user (boolean, (optional)) – Decrement user counter of all datablocks used by this light data

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

tag(value)

tag

Parameters

value (boolean) – Value

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

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

References

  • BlendData.lights