BlendDataProbes(bpy_struct)

base class — bpy_struct

class bpy.types.BlendDataProbes(bpy_struct)

Collection of light probes

new(name, type)

Add a new probe to the main database

Parameters

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

  • type (enum in ['CUBE', 'PLANAR', 'GRID']) – Type, The type of lightprobe to add

Returns

New light probe data-block

Return type

LightProbe

remove(lightprobe, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove a probe from the current blendfile

Parameters

  • lightprobe (LightProbe, (never None)) – Probe to remove

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

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

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

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

Inherited Functions

References