StudioLights(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.StudioLights(bpy_prop_collection)

Collection of studio lights

load(path, type)

Load studiolight from file

Parameters:

  • path (str) – File Path, File path where the studio light file can be found (never None)

  • type (Literal['STUDIO', 'WORLD', 'MATCAP']) – Type, The type for the new studio light

Returns:

Newly created StudioLight

Return type:

StudioLight

new(path)

Create studiolight from default lighting

Parameters:

path (str) – Path, Path to the file that will contain the lighting info (without extension) (never None)

Returns:

Newly created StudioLight

Return type:

StudioLight

remove(studio_light)

Remove a studio light

Parameters:

studio_light (StudioLight) – The studio light to remove (never None)

refresh()

Refresh Studio Lights from disk

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