LightGroup

class LightGroup
property id

The id of the group.

Type

str, read-only

property name

The name of the group.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this group.

Type

LightingLayer, read-only

property parent_group

The parent group of this group or None if the group is at the root of the hierarchy.

Type

LightGroup or None

Raises

  • ReadOnlyError -- If Database is in read only mode.

  • ValueError -- If trying to move the group into one of its children or trying to move the layer to itself.

list_child_groups(recursive = True)

List the child light groups of this group.

Parameters

recursive (bool) -- If True, list light groups of this group recursively, otherwise only the direct child groups are returned.

Returns

The list of child groups.

Return type

list(LightGroup)

list_lights(recursive = True)

List the lights of this group.

Parameters

recursive (bool) -- If True, list all lights in this group recursively, otherwise only the direct child lights are returned.

Returns

The list of lights in the group.

Return type

list(Light)

remove(force = False)

Delete the light group

Note

By default, only empty groups can be deleted (NotEmptyError is raised otherwise), use force to force deletion of non empty groups.

Parameters

force (bool) -- Force the deletion of the group even if it contains lights and/or groups.

Raises