StudioLights(bpy_struct)#

base class — bpy_struct

class bpy.types.StudioLights(bpy_struct)#

Collection of studio lights

load(path, type)#

Load studiolight from file

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

  • type (enum in ['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 (string, (never None)) – Path, Path to the file that will contain the lighting info (without extension)

Returns:

Newly created StudioLight

Return type:

StudioLight

remove(studio_light)#

Remove a studio light

Parameters:

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

refresh()#

Refresh Studio Lights from disk

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

id (str) – 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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#

References#