Skip to content

Scene Controller

activate_scene(name)

Activates a scene

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
76
77
78
79
80
81
82
83
84
def activate_scene(name: str) -> bool:
    """Activates a scene

    Parameters:
        name: name

    Returns:
        did operation succeed
    """

add_elements_to_scene(name, element_i_ds)

Adds elements to a scene

Parameters:

Name Type Description Default
name str

name

 required
element_i_ds List[int]

element_i_ds

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
44
45
46
47
48
49
50
51
52
53
def add_elements_to_scene(name: str, element_i_ds: List[int]) -> bool:
    """Adds elements to a scene

    Parameters:
        name: name
        element_i_ds: element_i_ds

    Returns:
        did operation succeed
    """

add_scene(name)

Adds a new scene

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
13
14
15
16
17
18
19
20
21
def add_scene(name: str) -> bool:
    """Adds a new scene

    Parameters:
        name: name

    Returns:
        did operation succeed
    """

clear_errors()

clear errors

Returns:

Type Description
None

None
Source code in src/scene_controller/__init__.pyi 
86
87
88
89
90
91
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

delete_scene(name)

Deletes a scene

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
34
35
36
37
38
39
40
41
42
def delete_scene(name: str) -> bool:
    """Deletes a scene

    Parameters:
        name: name

    Returns:
        did operation succeed
    """

get_elements_from_scene(name)

Gets the elements from a scene

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
List[int]

element ID list
Source code in src/scene_controller/__init__.pyi 
66
67
68
69
70
71
72
73
74
def get_elements_from_scene(name: str) -> List[int]:
    """Gets the elements from a scene

    Parameters:
        name: name

    Returns:
        element ID list
    """

get_group_index_by_name(scene_group_name)

get group index by name

Parameters:

Name Type Description Default
scene_group_name str

scene_group_name

 required

Returns:

Type Description
int

int
Source code in src/scene_controller/__init__.pyi 
154
155
156
157
158
159
160
161
162
def get_group_index_by_name(scene_group_name: str) -> int:
    """get group index by name

    Parameters:
        scene_group_name: scene_group_name

    Returns:
        int
    """

get_last_error(error_code)

Gets the last error

Parameters:

Name Type Description Default
error_code int

error_code

 required

Returns:

Type Description
str

error string
Source code in src/scene_controller/__init__.pyi 
 3
 4
 5
 6
 7
 8
 9
10
11
def get_last_error(error_code: int) -> str:
    """Gets the last error

    Parameters:
        error_code: error_code

    Returns:
        error string
    """

get_scene_list()

get scene list

Returns:

Type Description
List[str]

List[str]
Source code in src/scene_controller/__init__.pyi 
93
94
95
96
97
98
def get_scene_list() -> List[str]:
    """get scene list

    Returns:
        List[str]
    """

group_scences(a0)

group scences

Parameters:

Name Type Description Default
a0 List[str]

a0

 required

Returns:

Type Description
int

int
Source code in src/scene_controller/__init__.pyi 
100
101
102
103
104
105
106
107
108
def group_scences(a0: List[str]) -> int:
    """group scences

    Parameters:
        a0: a0

    Returns:
        int
    """

group_scences_with_name(a0, a1)

group scences with name

Parameters:

Name Type Description Default
a0 List[str]

a0

 required
a1 str

a1

 required

Returns:

Type Description
int

int
Source code in src/scene_controller/__init__.pyi 
175
176
177
178
179
180
181
182
183
184
def group_scences_with_name(a0: List[str], a1: str) -> int:
    """group scences with name

    Parameters:
        a0: a0
        a1: a1

    Returns:
        int
    """

is_scene_present(name)

Queries of scene with name is present

Parameters:

Name Type Description Default
name str

name

 required

Returns:

Type Description
bool

presence of scene
Source code in src/scene_controller/__init__.pyi 
120
121
122
123
124
125
126
127
128
def is_scene_present(name: str) -> bool:
    """Queries of scene with name is present

    Parameters:
        name: name

    Returns:
        presence of scene
    """

remove_elements_from_scene(name, element_i_ds)

Removes elements from a scene

Parameters:

Name Type Description Default
name str

name

 required
element_i_ds List[int]

element_i_ds

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
55
56
57
58
59
60
61
62
63
64
def remove_elements_from_scene(name: str, element_i_ds: List[int]) -> bool:
    """Removes elements from a scene

    Parameters:
        name: name
        element_i_ds: element_i_ds

    Returns:
        did operation succeed
    """

rename_scene(old_name, new_name)

Renames a scene

Parameters:

Name Type Description Default
old_name str

old_name

 required
new_name str

new_name

 required

Returns:

Type Description
bool

did operation succeed
Source code in src/scene_controller/__init__.pyi 
23
24
25
26
27
28
29
30
31
32
def rename_scene(old_name: str, new_name: str) -> bool:
    """Renames a scene

    Parameters:
        old_name: old_name
        new_name: new_name

    Returns:
        did operation succeed
    """

rename_scene_group(old_name, new_name)

rename scene group

Parameters:

Name Type Description Default
old_name str

old_name

 required
new_name str

new_name

 required

Returns:

Type Description
None

None
Source code in src/scene_controller/__init__.pyi 
143
144
145
146
147
148
149
150
151
152
def rename_scene_group(old_name: str, new_name: str) -> None:
    """rename scene group

    Parameters:
        old_name: old_name
        new_name: new_name

    Returns:
        None
    """

rename_scene_group_by_index(group_index, new_name)

rename scene group by index

Parameters:

Name Type Description Default
group_index int

group_index

 required
new_name str

new_name

 required

Returns:

Type Description
None

None
Source code in src/scene_controller/__init__.pyi 
164
165
166
167
168
169
170
171
172
173
def rename_scene_group_by_index(group_index: int, new_name: str) -> None:
    """rename scene group by index

    Parameters:
        group_index: group_index
        new_name: new_name

    Returns:
        None
    """

set_group_tab_color(scene_group_name, red, green, blue)

set group tab color

Parameters:

Name Type Description Default
scene_group_name str

scene_group_name

 required
red int

red

 required
green int

green

 required
blue int

blue

 required

Returns:

Type Description
None

None
Source code in src/scene_controller/__init__.pyi 
130
131
132
133
134
135
136
137
138
139
140
141
def set_group_tab_color(scene_group_name: str, red: int, green: int, blue: int) -> None:
    """set group tab color

    Parameters:
        scene_group_name: scene_group_name
        red: red
        green: green
        blue: blue

    Returns:
        None
    """

ungroup_scences(a0)

ungroup scences

Parameters:

Name Type Description Default
a0 int

a0

 required

Returns:

Type Description
None

None
Source code in src/scene_controller/__init__.pyi 
110
111
112
113
114
115
116
117
118
def ungroup_scences(a0: int) -> None:
    """ungroup scences

    Parameters:
        a0: a0

    Returns:
        None
    """