fake-bpy-module 20240718__py3-none-any.whl → 20240720__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bl_operators/add_mesh_torus/__init__.pyi +1 -190
- bl_operators/anim/__init__.pyi +104 -1504
- bl_operators/assets/__init__.pyi +3 -535
- bl_operators/bone_selection_sets/__init__.pyi +187 -2680
- bl_operators/clip/__init__.pyi +144 -1894
- bl_operators/connect_to_output/__init__.pyi +3 -176
- bl_operators/console/__init__.pyi +5 -880
- bl_operators/constraint/__init__.pyi +4 -704
- bl_operators/file/__init__.pyi +3 -528
- bl_operators/freestyle/__init__.pyi +4 -704
- bl_operators/geometry_nodes/__init__.pyi +4 -704
- bl_operators/image/__init__.pyi +5 -869
- bl_operators/image_as_planes/__init__.pyi +4 -424
- bl_operators/mesh/__init__.pyi +3 -528
- bl_operators/node/__init__.pyi +159 -2065
- bl_operators/object/__init__.pyi +217 -2842
- bl_operators/object_align/__init__.pyi +1 -176
- bl_operators/object_quick_effects/__init__.pyi +4 -725
- bl_operators/object_randomize_transform/__init__.pyi +1 -176
- bl_operators/presets/__init__.pyi +405 -5487
- bl_operators/rigidbody/__init__.pyi +3 -528
- bl_operators/screen_play_rendered_anim/__init__.pyi +1 -176
- bl_operators/sequencer/__init__.pyi +119 -1507
- bl_operators/spreadsheet/__init__.pyi +1 -176
- bl_operators/userpref/__init__.pyi +383 -4757
- bl_operators/uvcalc_follow_active/__init__.pyi +1 -176
- bl_operators/uvcalc_lightmap/__init__.pyi +1 -176
- bl_operators/uvcalc_transform/__init__.pyi +2 -352
- bl_operators/vertexpaint_dirt/__init__.pyi +1 -176
- bl_operators/view3d/__init__.pyi +101 -1468
- bl_operators/wm/__init__.pyi +723 -8894
- bl_operators/world/__init__.pyi +1 -176
- bl_ui/__init__.pyi +3 -534
- bl_ui/anim/__init__.pyi +1 -244
- bl_ui/asset_shelf/__init__.pyi +1 -189
- bl_ui/generic_ui_list/__init__.pyi +3 -594
- bl_ui/node_add_menu/__init__.pyi +1 -244
- bl_ui/node_add_menu_compositor/__init__.pyi +226 -4600
- bl_ui/node_add_menu_geometry/__init__.pyi +654 -12802
- bl_ui/node_add_menu_shader/__init__.pyi +94 -2531
- bl_ui/node_add_menu_texture/__init__.pyi +81 -2268
- bl_ui/properties_collection/__init__.pyi +58 -1272
- bl_ui/properties_constraint/__init__.pyi +1508 -32656
- bl_ui/properties_data_armature/__init__.pyi +278 -3804
- bl_ui/properties_data_bone/__init__.pyi +151 -2062
- bl_ui/properties_data_camera/__init__.pyi +216 -3034
- bl_ui/properties_data_curve/__init__.pyi +214 -3117
- bl_ui/properties_data_curves/__init__.pyi +57 -1273
- bl_ui/properties_data_empty/__init__.pyi +2 -385
- bl_ui/properties_data_gpencil/__init__.pyi +285 -3922
- bl_ui/properties_data_grease_pencil/__init__.pyi +198 -3081
- bl_ui/properties_data_lattice/__init__.pyi +3 -595
- bl_ui/properties_data_light/__init__.pyi +200 -2502
- bl_ui/properties_data_lightprobe/__init__.pyi +212 -2704
- bl_ui/properties_data_mesh/__init__.pyi +323 -4380
- bl_ui/properties_data_metaball/__init__.pyi +38 -1011
- bl_ui/properties_data_modifier/__init__.pyi +157 -2451
- bl_ui/properties_data_pointcloud/__init__.pyi +68 -1087
- bl_ui/properties_data_shaderfx/__init__.pyi +1 -189
- bl_ui/properties_data_speaker/__init__.pyi +36 -1018
- bl_ui/properties_data_volume/__init__.pyi +104 -1660
- bl_ui/properties_freestyle/__init__.pyi +438 -5136
- bl_ui/properties_grease_pencil_common/__init__.pyi +197 -3852
- bl_ui/properties_mask_common/__init__.pyi +59 -1705
- bl_ui/properties_material/__init__.pyi +227 -3334
- bl_ui/properties_material_gpencil/__init__.pyi +187 -2221
- bl_ui/properties_object/__init__.pyi +197 -2908
- bl_ui/properties_output/__init__.pyi +286 -3895
- bl_ui/properties_paint_common/__init__.pyi +40 -923
- bl_ui/properties_particle/__init__.pyi +954 -10839
- bl_ui/properties_physics_cloth/__init__.pyi +219 -2979
- bl_ui/properties_physics_common/__init__.pyi +1 -196
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +429 -5411
- bl_ui/properties_physics_field/__init__.pyi +160 -2166
- bl_ui/properties_physics_fluid/__init__.pyi +541 -7352
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -189
- bl_ui/properties_physics_rigidbody/__init__.pyi +125 -1623
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +196 -2640
- bl_ui/properties_physics_softbody/__init__.pyi +238 -3135
- bl_ui/properties_render/__init__.pyi +1065 -11565
- bl_ui/properties_scene/__init__.pyi +209 -3090
- bl_ui/properties_texture/__init__.pyi +426 -5475
- bl_ui/properties_view_layer/__init__.pyi +264 -3827
- bl_ui/properties_workspace/__init__.pyi +7 -770
- bl_ui/properties_world/__init__.pyi +147 -2056
- bl_ui/space_clip/__init__.pyi +1013 -16279
- bl_ui/space_console/__init__.pyi +39 -1442
- bl_ui/space_dopesheet/__init__.pyi +450 -7213
- bl_ui/space_filebrowser/__init__.pyi +406 -6708
- bl_ui/space_graph/__init__.pyi +223 -4886
- bl_ui/space_image/__init__.pyi +1091 -16394
- bl_ui/space_info/__init__.pyi +39 -1442
- bl_ui/space_nla/__init__.pyi +216 -4157
- bl_ui/space_node/__init__.pyi +394 -6344
- bl_ui/space_outliner/__init__.pyi +156 -3448
- bl_ui/space_properties/__init__.pyi +3 -567
- bl_ui/space_sequencer/__init__.pyi +1224 -18036
- bl_ui/space_spreadsheet/__init__.pyi +1 -189
- bl_ui/space_statusbar/__init__.pyi +1 -189
- bl_ui/space_text/__init__.pyi +183 -3851
- bl_ui/space_time/__init__.pyi +69 -1622
- bl_ui/space_toolsystem_common/__init__.pyi +2 -118
- bl_ui/space_toolsystem_toolbar/__init__.pyi +13 -476
- bl_ui/space_topbar/__init__.pyi +322 -6269
- bl_ui/space_userpref/__init__.pyi +1758 -19735
- bl_ui/space_view3d/__init__.pyi +3853 -67593
- bl_ui/space_view3d_toolbar/__init__.pyi +1948 -23558
- bl_ui/temp_anim_layers/__init__.pyi +1 -189
- bl_ui/utils/__init__.pyi +0 -35
- bpy/ops/outliner/__init__.pyi +0 -1
- bpy/ops/sound/__init__.pyi +37 -7
- bpy/types/__init__.pyi +65 -8
- bpy_extras/node_shader_utils/__init__.pyi +0 -8
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/RECORD +120 -120
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/WHEEL +1 -1
- freestyle/utils/__init__.pyi +1 -1
- keyingsets_builtins/__init__.pyi +268 -4448
- nodeitems_builtins/__init__.pyi +1 -7
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/top_level.txt +0 -0
bl_ui/space_text/__init__.pyi
CHANGED
|
@@ -7,28 +7,12 @@ import bpy_types
|
|
|
7
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
8
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
9
9
|
|
|
10
|
-
class TEXT_HT_footer(bpy_types._GenericUI):
|
|
10
|
+
class TEXT_HT_footer(bpy.types.Header, bpy_types._GenericUI):
|
|
11
11
|
bl_region_type: typing.Any
|
|
12
12
|
bl_rna: typing.Any
|
|
13
13
|
bl_space_type: typing.Any
|
|
14
14
|
id_data: typing.Any
|
|
15
15
|
|
|
16
|
-
def append(self, draw_func):
|
|
17
|
-
"""Append a draw function to this menu,
|
|
18
|
-
takes the same arguments as the menus draw function
|
|
19
|
-
|
|
20
|
-
:param draw_func:
|
|
21
|
-
"""
|
|
22
|
-
...
|
|
23
|
-
|
|
24
|
-
def as_pointer(self) -> int:
|
|
25
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
26
|
-
|
|
27
|
-
:return: int (memory address).
|
|
28
|
-
:rtype: int
|
|
29
|
-
"""
|
|
30
|
-
...
|
|
31
|
-
|
|
32
16
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
33
17
|
"""
|
|
34
18
|
|
|
@@ -52,199 +36,132 @@ class TEXT_HT_footer(bpy_types._GenericUI):
|
|
|
52
36
|
"""
|
|
53
37
|
...
|
|
54
38
|
|
|
55
|
-
|
|
56
|
-
|
|
39
|
+
class TEXT_HT_header(bpy.types.Header, bpy_types._GenericUI):
|
|
40
|
+
bl_rna: typing.Any
|
|
41
|
+
bl_space_type: typing.Any
|
|
42
|
+
id_data: typing.Any
|
|
57
43
|
|
|
58
|
-
|
|
59
|
-
:rtype: bpy.types.FCurve
|
|
44
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
60
45
|
"""
|
|
61
|
-
...
|
|
62
|
-
|
|
63
|
-
def driver_remove(self) -> bool:
|
|
64
|
-
"""Remove driver(s) from the given property
|
|
65
46
|
|
|
66
|
-
:return:
|
|
67
|
-
:rtype:
|
|
47
|
+
:return: The RNA type or default when not found.
|
|
48
|
+
:rtype: bpy.types.Struct
|
|
68
49
|
"""
|
|
69
50
|
...
|
|
70
51
|
|
|
71
|
-
def
|
|
72
|
-
"""
|
|
73
|
-
when not found (matches Python's dictionary function of the same name).
|
|
52
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
53
|
+
"""
|
|
74
54
|
|
|
55
|
+
:return: The class or default when not found.
|
|
56
|
+
:rtype: typing.Any
|
|
75
57
|
"""
|
|
76
58
|
...
|
|
77
59
|
|
|
78
|
-
def
|
|
60
|
+
def draw(self, context):
|
|
79
61
|
"""
|
|
80
62
|
|
|
81
|
-
:
|
|
63
|
+
:param context:
|
|
82
64
|
"""
|
|
83
65
|
...
|
|
84
66
|
|
|
85
|
-
|
|
67
|
+
class TEXT_MT_context_menu(bpy.types.Menu, bpy_types._GenericUI):
|
|
68
|
+
bl_label: typing.Any
|
|
69
|
+
bl_rna: typing.Any
|
|
70
|
+
id_data: typing.Any
|
|
71
|
+
|
|
72
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
86
73
|
"""
|
|
87
74
|
|
|
88
|
-
:return:
|
|
75
|
+
:return: The RNA type or default when not found.
|
|
76
|
+
:rtype: bpy.types.Struct
|
|
89
77
|
"""
|
|
90
78
|
...
|
|
91
79
|
|
|
92
|
-
def
|
|
80
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
93
81
|
"""
|
|
94
82
|
|
|
95
|
-
:return:
|
|
83
|
+
:return: The class or default when not found.
|
|
84
|
+
:rtype: typing.Any
|
|
96
85
|
"""
|
|
97
86
|
...
|
|
98
87
|
|
|
99
|
-
def
|
|
100
|
-
def is_property_hidden(self) -> bool:
|
|
101
|
-
"""Check if a property is hidden.
|
|
102
|
-
|
|
103
|
-
:return: True when the property is hidden.
|
|
104
|
-
:rtype: bool
|
|
88
|
+
def draw(self, _context):
|
|
105
89
|
"""
|
|
106
|
-
...
|
|
107
|
-
|
|
108
|
-
def is_property_overridable_library(self) -> bool:
|
|
109
|
-
"""Check if a property is overridable.
|
|
110
90
|
|
|
111
|
-
:
|
|
112
|
-
:rtype: bool
|
|
91
|
+
:param _context:
|
|
113
92
|
"""
|
|
114
93
|
...
|
|
115
94
|
|
|
116
|
-
|
|
117
|
-
|
|
95
|
+
class TEXT_MT_edit(bpy.types.Menu, bpy_types._GenericUI):
|
|
96
|
+
bl_label: typing.Any
|
|
97
|
+
bl_rna: typing.Any
|
|
98
|
+
id_data: typing.Any
|
|
118
99
|
|
|
119
|
-
|
|
120
|
-
:rtype: bool
|
|
100
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
121
101
|
"""
|
|
122
|
-
...
|
|
123
102
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
:return: True when the property has been set.
|
|
128
|
-
:rtype: bool
|
|
103
|
+
:return: The RNA type or default when not found.
|
|
104
|
+
:rtype: bpy.types.Struct
|
|
129
105
|
"""
|
|
130
106
|
...
|
|
131
107
|
|
|
132
|
-
def
|
|
133
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
134
|
-
dictionary function of the same name).
|
|
135
|
-
|
|
136
|
-
:return: custom property key, value pairs.
|
|
108
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
137
109
|
"""
|
|
138
|
-
...
|
|
139
110
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
:return: Success of keyframe deletion.
|
|
144
|
-
:rtype: bool
|
|
111
|
+
:return: The class or default when not found.
|
|
112
|
+
:rtype: typing.Any
|
|
145
113
|
"""
|
|
146
114
|
...
|
|
147
115
|
|
|
148
|
-
def
|
|
149
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
150
|
-
|
|
151
|
-
:return: Success of keyframe insertion.
|
|
152
|
-
:rtype: bool
|
|
116
|
+
def draw(self, _context):
|
|
153
117
|
"""
|
|
154
|
-
...
|
|
155
118
|
|
|
156
|
-
|
|
157
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
158
|
-
dictionary function of the same name).
|
|
159
|
-
|
|
160
|
-
:return: custom property keys.
|
|
119
|
+
:param _context:
|
|
161
120
|
"""
|
|
162
121
|
...
|
|
163
122
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
168
|
-
to this struct and property (when given).
|
|
169
|
-
:rtype: str
|
|
123
|
+
@classmethod
|
|
124
|
+
def poll(cls, context):
|
|
170
125
|
"""
|
|
171
|
-
...
|
|
172
|
-
|
|
173
|
-
def path_resolve(self):
|
|
174
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
175
|
-
...
|
|
176
|
-
|
|
177
|
-
def pop(self):
|
|
178
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
179
|
-
when not found (matches Python's dictionary function of the same name).
|
|
180
126
|
|
|
127
|
+
:param context:
|
|
181
128
|
"""
|
|
182
129
|
...
|
|
183
130
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
131
|
+
class TEXT_MT_edit_to3d(bpy.types.Menu, bpy_types._GenericUI):
|
|
132
|
+
bl_label: typing.Any
|
|
133
|
+
bl_rna: typing.Any
|
|
134
|
+
id_data: typing.Any
|
|
187
135
|
|
|
188
|
-
|
|
136
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
189
137
|
"""
|
|
190
|
-
...
|
|
191
|
-
|
|
192
|
-
def property_overridable_library_set(self) -> bool:
|
|
193
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
194
138
|
|
|
195
|
-
:return:
|
|
196
|
-
:rtype:
|
|
139
|
+
:return: The RNA type or default when not found.
|
|
140
|
+
:rtype: bpy.types.Struct
|
|
197
141
|
"""
|
|
198
142
|
...
|
|
199
143
|
|
|
200
|
-
def
|
|
201
|
-
"""Unset a property, will use default value afterward."""
|
|
202
|
-
...
|
|
203
|
-
|
|
204
|
-
def remove(self, draw_func):
|
|
205
|
-
"""Remove a draw function that has been added to this menu
|
|
206
|
-
|
|
207
|
-
:param draw_func:
|
|
144
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
208
145
|
"""
|
|
209
|
-
...
|
|
210
|
-
|
|
211
|
-
def type_recast(self):
|
|
212
|
-
"""Return a new instance, this is needed because types
|
|
213
|
-
such as textures can be changed at runtime.
|
|
214
146
|
|
|
215
|
-
|
|
147
|
+
:return: The class or default when not found.
|
|
148
|
+
:rtype: typing.Any
|
|
216
149
|
"""
|
|
217
150
|
...
|
|
218
151
|
|
|
219
|
-
def
|
|
220
|
-
"""
|
|
221
|
-
dictionary function of the same name).
|
|
152
|
+
def draw(self, _context):
|
|
153
|
+
"""
|
|
222
154
|
|
|
223
|
-
|
|
155
|
+
:param _context:
|
|
224
156
|
"""
|
|
225
157
|
...
|
|
226
158
|
|
|
227
|
-
class
|
|
159
|
+
class TEXT_MT_editor_menus(bpy.types.Menu, bpy_types._GenericUI):
|
|
160
|
+
bl_idname: typing.Any
|
|
161
|
+
bl_label: typing.Any
|
|
228
162
|
bl_rna: typing.Any
|
|
229
|
-
bl_space_type: typing.Any
|
|
230
163
|
id_data: typing.Any
|
|
231
164
|
|
|
232
|
-
def append(self, draw_func):
|
|
233
|
-
"""Append a draw function to this menu,
|
|
234
|
-
takes the same arguments as the menus draw function
|
|
235
|
-
|
|
236
|
-
:param draw_func:
|
|
237
|
-
"""
|
|
238
|
-
...
|
|
239
|
-
|
|
240
|
-
def as_pointer(self) -> int:
|
|
241
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
242
|
-
|
|
243
|
-
:return: int (memory address).
|
|
244
|
-
:rtype: int
|
|
245
|
-
"""
|
|
246
|
-
...
|
|
247
|
-
|
|
248
165
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
249
166
|
"""
|
|
250
167
|
|
|
@@ -268,199 +185,123 @@ class TEXT_HT_header(bpy_types._GenericUI):
|
|
|
268
185
|
"""
|
|
269
186
|
...
|
|
270
187
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
:rtype: bpy.types.FCurve
|
|
276
|
-
"""
|
|
277
|
-
...
|
|
278
|
-
|
|
279
|
-
def driver_remove(self) -> bool:
|
|
280
|
-
"""Remove driver(s) from the given property
|
|
188
|
+
class TEXT_MT_format(bpy.types.Menu, bpy_types._GenericUI):
|
|
189
|
+
bl_label: typing.Any
|
|
190
|
+
bl_rna: typing.Any
|
|
191
|
+
id_data: typing.Any
|
|
281
192
|
|
|
282
|
-
|
|
283
|
-
:rtype: bool
|
|
193
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
284
194
|
"""
|
|
285
|
-
...
|
|
286
|
-
|
|
287
|
-
def get(self):
|
|
288
|
-
"""Returns the value of the custom property assigned to key or default
|
|
289
|
-
when not found (matches Python's dictionary function of the same name).
|
|
290
195
|
|
|
196
|
+
:return: The RNA type or default when not found.
|
|
197
|
+
:rtype: bpy.types.Struct
|
|
291
198
|
"""
|
|
292
199
|
...
|
|
293
200
|
|
|
294
|
-
def
|
|
201
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
295
202
|
"""
|
|
296
203
|
|
|
297
|
-
:return:
|
|
204
|
+
:return: The class or default when not found.
|
|
205
|
+
:rtype: typing.Any
|
|
298
206
|
"""
|
|
299
207
|
...
|
|
300
208
|
|
|
301
|
-
def
|
|
209
|
+
def draw(self, _context):
|
|
302
210
|
"""
|
|
303
211
|
|
|
304
|
-
:
|
|
212
|
+
:param _context:
|
|
305
213
|
"""
|
|
306
214
|
...
|
|
307
215
|
|
|
308
|
-
|
|
309
|
-
|
|
216
|
+
class TEXT_MT_select(bpy.types.Menu, bpy_types._GenericUI):
|
|
217
|
+
bl_label: typing.Any
|
|
218
|
+
bl_rna: typing.Any
|
|
219
|
+
id_data: typing.Any
|
|
310
220
|
|
|
311
|
-
|
|
221
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
312
222
|
"""
|
|
313
|
-
...
|
|
314
|
-
|
|
315
|
-
def is_extended(self): ...
|
|
316
|
-
def is_property_hidden(self) -> bool:
|
|
317
|
-
"""Check if a property is hidden.
|
|
318
223
|
|
|
319
|
-
:return:
|
|
320
|
-
:rtype:
|
|
224
|
+
:return: The RNA type or default when not found.
|
|
225
|
+
:rtype: bpy.types.Struct
|
|
321
226
|
"""
|
|
322
227
|
...
|
|
323
228
|
|
|
324
|
-
def
|
|
325
|
-
"""Check if a property is overridable.
|
|
326
|
-
|
|
327
|
-
:return: True when the property is overridable.
|
|
328
|
-
:rtype: bool
|
|
229
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
329
230
|
"""
|
|
330
|
-
...
|
|
331
|
-
|
|
332
|
-
def is_property_readonly(self) -> bool:
|
|
333
|
-
"""Check if a property is readonly.
|
|
334
231
|
|
|
335
|
-
:return:
|
|
336
|
-
:rtype:
|
|
232
|
+
:return: The class or default when not found.
|
|
233
|
+
:rtype: typing.Any
|
|
337
234
|
"""
|
|
338
235
|
...
|
|
339
236
|
|
|
340
|
-
def
|
|
341
|
-
"""Check if a property is set, use for testing operator properties.
|
|
342
|
-
|
|
343
|
-
:return: True when the property has been set.
|
|
344
|
-
:rtype: bool
|
|
237
|
+
def draw(self, _context):
|
|
345
238
|
"""
|
|
346
|
-
...
|
|
347
|
-
|
|
348
|
-
def items(self):
|
|
349
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
350
|
-
dictionary function of the same name).
|
|
351
239
|
|
|
352
|
-
|
|
240
|
+
:param _context:
|
|
353
241
|
"""
|
|
354
242
|
...
|
|
355
243
|
|
|
356
|
-
|
|
357
|
-
|
|
244
|
+
class TEXT_MT_templates(bpy.types.Menu, bpy_types._GenericUI):
|
|
245
|
+
bl_label: typing.Any
|
|
246
|
+
bl_rna: typing.Any
|
|
247
|
+
id_data: typing.Any
|
|
358
248
|
|
|
359
|
-
|
|
360
|
-
:rtype: bool
|
|
249
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
361
250
|
"""
|
|
362
|
-
...
|
|
363
251
|
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
:return: Success of keyframe insertion.
|
|
368
|
-
:rtype: bool
|
|
252
|
+
:return: The RNA type or default when not found.
|
|
253
|
+
:rtype: bpy.types.Struct
|
|
369
254
|
"""
|
|
370
255
|
...
|
|
371
256
|
|
|
372
|
-
def
|
|
373
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
374
|
-
dictionary function of the same name).
|
|
375
|
-
|
|
376
|
-
:return: custom property keys.
|
|
257
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
377
258
|
"""
|
|
378
|
-
...
|
|
379
259
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
384
|
-
to this struct and property (when given).
|
|
385
|
-
:rtype: str
|
|
260
|
+
:return: The class or default when not found.
|
|
261
|
+
:rtype: typing.Any
|
|
386
262
|
"""
|
|
387
263
|
...
|
|
388
264
|
|
|
389
|
-
def
|
|
390
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
391
|
-
...
|
|
392
|
-
|
|
393
|
-
def pop(self):
|
|
394
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
395
|
-
when not found (matches Python's dictionary function of the same name).
|
|
396
|
-
|
|
265
|
+
def draw(self, _context):
|
|
397
266
|
"""
|
|
398
|
-
...
|
|
399
267
|
|
|
400
|
-
|
|
401
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
402
|
-
the menus draw function
|
|
403
|
-
|
|
404
|
-
:param draw_func:
|
|
268
|
+
:param _context:
|
|
405
269
|
"""
|
|
406
270
|
...
|
|
407
271
|
|
|
408
|
-
|
|
409
|
-
|
|
272
|
+
class TEXT_MT_templates_osl(bpy.types.Menu, bpy_types._GenericUI):
|
|
273
|
+
bl_label: typing.Any
|
|
274
|
+
bl_rna: typing.Any
|
|
275
|
+
id_data: typing.Any
|
|
410
276
|
|
|
411
|
-
|
|
412
|
-
:rtype: bool
|
|
277
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
413
278
|
"""
|
|
414
|
-
...
|
|
415
|
-
|
|
416
|
-
def property_unset(self):
|
|
417
|
-
"""Unset a property, will use default value afterward."""
|
|
418
|
-
...
|
|
419
|
-
|
|
420
|
-
def remove(self, draw_func):
|
|
421
|
-
"""Remove a draw function that has been added to this menu
|
|
422
279
|
|
|
423
|
-
:
|
|
280
|
+
:return: The RNA type or default when not found.
|
|
281
|
+
:rtype: bpy.types.Struct
|
|
424
282
|
"""
|
|
425
283
|
...
|
|
426
284
|
|
|
427
|
-
def
|
|
428
|
-
"""
|
|
429
|
-
such as textures can be changed at runtime.
|
|
285
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
286
|
+
"""
|
|
430
287
|
|
|
431
|
-
|
|
288
|
+
:return: The class or default when not found.
|
|
289
|
+
:rtype: typing.Any
|
|
432
290
|
"""
|
|
433
291
|
...
|
|
434
292
|
|
|
435
|
-
def
|
|
436
|
-
"""
|
|
437
|
-
dictionary function of the same name).
|
|
293
|
+
def draw(self, _context):
|
|
294
|
+
"""
|
|
438
295
|
|
|
439
|
-
|
|
296
|
+
:param _context:
|
|
440
297
|
"""
|
|
441
298
|
...
|
|
442
299
|
|
|
443
|
-
class
|
|
300
|
+
class TEXT_MT_templates_py(bpy.types.Menu, bpy_types._GenericUI):
|
|
444
301
|
bl_label: typing.Any
|
|
445
302
|
bl_rna: typing.Any
|
|
446
303
|
id_data: typing.Any
|
|
447
304
|
|
|
448
|
-
def append(self, draw_func):
|
|
449
|
-
"""Append a draw function to this menu,
|
|
450
|
-
takes the same arguments as the menus draw function
|
|
451
|
-
|
|
452
|
-
:param draw_func:
|
|
453
|
-
"""
|
|
454
|
-
...
|
|
455
|
-
|
|
456
|
-
def as_pointer(self) -> int:
|
|
457
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
458
|
-
|
|
459
|
-
:return: int (memory address).
|
|
460
|
-
:rtype: int
|
|
461
|
-
"""
|
|
462
|
-
...
|
|
463
|
-
|
|
464
305
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
465
306
|
"""
|
|
466
307
|
|
|
@@ -484,3657 +325,148 @@ class TEXT_MT_context_menu(bpy_types._GenericUI):
|
|
|
484
325
|
"""
|
|
485
326
|
...
|
|
486
327
|
|
|
487
|
-
|
|
328
|
+
class TEXT_MT_text(bpy.types.Menu, bpy_types._GenericUI):
|
|
329
|
+
bl_label: typing.Any
|
|
330
|
+
bl_rna: typing.Any
|
|
331
|
+
id_data: typing.Any
|
|
332
|
+
|
|
333
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
488
334
|
"""
|
|
489
335
|
|
|
490
|
-
:
|
|
491
|
-
:
|
|
336
|
+
:return: The RNA type or default when not found.
|
|
337
|
+
:rtype: bpy.types.Struct
|
|
492
338
|
"""
|
|
493
339
|
...
|
|
494
340
|
|
|
495
|
-
def
|
|
496
|
-
"""
|
|
497
|
-
- preset_operator (string)
|
|
498
|
-
- preset_subdir (string)Optionally:
|
|
499
|
-
- preset_add_operator (string)
|
|
500
|
-
- preset_extensions (set of strings)
|
|
501
|
-
- preset_operator_defaults (dict of keyword args)
|
|
341
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
342
|
+
"""
|
|
502
343
|
|
|
503
|
-
|
|
344
|
+
:return: The class or default when not found.
|
|
345
|
+
:rtype: typing.Any
|
|
504
346
|
"""
|
|
505
347
|
...
|
|
506
348
|
|
|
507
|
-
def
|
|
508
|
-
"""
|
|
349
|
+
def draw(self, context):
|
|
350
|
+
"""
|
|
509
351
|
|
|
510
|
-
:
|
|
511
|
-
:rtype: bpy.types.FCurve
|
|
352
|
+
:param context:
|
|
512
353
|
"""
|
|
513
354
|
...
|
|
514
355
|
|
|
515
|
-
|
|
516
|
-
|
|
356
|
+
class TEXT_MT_view(bpy.types.Menu, bpy_types._GenericUI):
|
|
357
|
+
bl_label: typing.Any
|
|
358
|
+
bl_rna: typing.Any
|
|
359
|
+
id_data: typing.Any
|
|
517
360
|
|
|
518
|
-
|
|
519
|
-
:rtype: bool
|
|
361
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
520
362
|
"""
|
|
521
|
-
...
|
|
522
|
-
|
|
523
|
-
def get(self):
|
|
524
|
-
"""Returns the value of the custom property assigned to key or default
|
|
525
|
-
when not found (matches Python's dictionary function of the same name).
|
|
526
363
|
|
|
364
|
+
:return: The RNA type or default when not found.
|
|
365
|
+
:rtype: bpy.types.Struct
|
|
527
366
|
"""
|
|
528
367
|
...
|
|
529
368
|
|
|
530
|
-
def
|
|
369
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
531
370
|
"""
|
|
532
371
|
|
|
533
|
-
:return:
|
|
372
|
+
:return: The class or default when not found.
|
|
373
|
+
:rtype: typing.Any
|
|
534
374
|
"""
|
|
535
375
|
...
|
|
536
376
|
|
|
537
|
-
def
|
|
377
|
+
def draw(self, context):
|
|
538
378
|
"""
|
|
539
379
|
|
|
540
|
-
:
|
|
380
|
+
:param context:
|
|
541
381
|
"""
|
|
542
382
|
...
|
|
543
383
|
|
|
544
|
-
|
|
384
|
+
class TEXT_MT_view_navigation(bpy.types.Menu, bpy_types._GenericUI):
|
|
385
|
+
bl_label: typing.Any
|
|
386
|
+
bl_rna: typing.Any
|
|
387
|
+
id_data: typing.Any
|
|
388
|
+
|
|
389
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
545
390
|
"""
|
|
546
391
|
|
|
547
|
-
:return:
|
|
392
|
+
:return: The RNA type or default when not found.
|
|
393
|
+
:rtype: bpy.types.Struct
|
|
548
394
|
"""
|
|
549
395
|
...
|
|
550
396
|
|
|
551
|
-
def
|
|
552
|
-
|
|
553
|
-
"""Check if a property is hidden.
|
|
397
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
398
|
+
"""
|
|
554
399
|
|
|
555
|
-
:return:
|
|
556
|
-
:rtype:
|
|
400
|
+
:return: The class or default when not found.
|
|
401
|
+
:rtype: typing.Any
|
|
557
402
|
"""
|
|
558
403
|
...
|
|
559
404
|
|
|
560
|
-
def
|
|
561
|
-
"""
|
|
405
|
+
def draw(self, _context):
|
|
406
|
+
"""
|
|
562
407
|
|
|
563
|
-
:
|
|
564
|
-
:rtype: bool
|
|
408
|
+
:param _context:
|
|
565
409
|
"""
|
|
566
410
|
...
|
|
567
411
|
|
|
568
|
-
|
|
569
|
-
|
|
412
|
+
class TEXT_PT_find(bpy.types.Panel, bpy_types._GenericUI):
|
|
413
|
+
bl_category: typing.Any
|
|
414
|
+
bl_label: typing.Any
|
|
415
|
+
bl_region_type: typing.Any
|
|
416
|
+
bl_rna: typing.Any
|
|
417
|
+
bl_space_type: typing.Any
|
|
418
|
+
id_data: typing.Any
|
|
570
419
|
|
|
571
|
-
|
|
572
|
-
:rtype: bool
|
|
420
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
573
421
|
"""
|
|
574
|
-
...
|
|
575
|
-
|
|
576
|
-
def is_property_set(self) -> bool:
|
|
577
|
-
"""Check if a property is set, use for testing operator properties.
|
|
578
422
|
|
|
579
|
-
:return:
|
|
580
|
-
:rtype:
|
|
423
|
+
:return: The RNA type or default when not found.
|
|
424
|
+
:rtype: bpy.types.Struct
|
|
581
425
|
"""
|
|
582
426
|
...
|
|
583
427
|
|
|
584
|
-
def
|
|
585
|
-
"""
|
|
586
|
-
dictionary function of the same name).
|
|
428
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
429
|
+
"""
|
|
587
430
|
|
|
588
|
-
|
|
431
|
+
:return: The class or default when not found.
|
|
432
|
+
:rtype: typing.Any
|
|
589
433
|
"""
|
|
590
434
|
...
|
|
591
435
|
|
|
592
|
-
def
|
|
593
|
-
"""
|
|
436
|
+
def draw(self, context):
|
|
437
|
+
"""
|
|
594
438
|
|
|
595
|
-
:
|
|
596
|
-
:rtype: bool
|
|
439
|
+
:param context:
|
|
597
440
|
"""
|
|
598
441
|
...
|
|
599
442
|
|
|
600
|
-
|
|
601
|
-
|
|
443
|
+
class TEXT_PT_properties(bpy.types.Panel, bpy_types._GenericUI):
|
|
444
|
+
bl_category: typing.Any
|
|
445
|
+
bl_label: typing.Any
|
|
446
|
+
bl_region_type: typing.Any
|
|
447
|
+
bl_rna: typing.Any
|
|
448
|
+
bl_space_type: typing.Any
|
|
449
|
+
id_data: typing.Any
|
|
602
450
|
|
|
603
|
-
|
|
604
|
-
:rtype: bool
|
|
451
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
605
452
|
"""
|
|
606
|
-
...
|
|
607
|
-
|
|
608
|
-
def keys(self):
|
|
609
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
610
|
-
dictionary function of the same name).
|
|
611
453
|
|
|
612
|
-
|
|
454
|
+
:return: The RNA type or default when not found.
|
|
455
|
+
:rtype: bpy.types.Struct
|
|
613
456
|
"""
|
|
614
457
|
...
|
|
615
458
|
|
|
616
|
-
def
|
|
617
|
-
"""
|
|
459
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
460
|
+
"""
|
|
618
461
|
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
:rtype: str
|
|
462
|
+
:return: The class or default when not found.
|
|
463
|
+
:rtype: typing.Any
|
|
622
464
|
"""
|
|
623
465
|
...
|
|
624
466
|
|
|
625
|
-
def
|
|
626
|
-
self,
|
|
627
|
-
searchpaths: list[str],
|
|
628
|
-
operator: str,
|
|
629
|
-
*,
|
|
630
|
-
props_default: dict = None,
|
|
631
|
-
prop_filepath: str | None = "filepath",
|
|
632
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
633
|
-
filter_path=None,
|
|
634
|
-
display_name: collections.abc.Callable | None = None,
|
|
635
|
-
add_operator=None,
|
|
636
|
-
add_operator_props=None,
|
|
637
|
-
):
|
|
638
|
-
"""Populate a menu from a list of paths.
|
|
639
|
-
|
|
640
|
-
:param searchpaths: Paths to scan.
|
|
641
|
-
:type searchpaths: list[str]
|
|
642
|
-
:param operator: The operator id to use with each file.
|
|
643
|
-
:type operator: str
|
|
644
|
-
:param props_default: Properties to assign to each operator.
|
|
645
|
-
:type props_default: dict
|
|
646
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
647
|
-
:type prop_filepath: str | None
|
|
648
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
649
|
-
|
|
650
|
-
Returning false excludes the file from the list.
|
|
651
|
-
:type filter_ext: collections.abc.Callable | None
|
|
652
|
-
:param filter_path:
|
|
653
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
654
|
-
:type display_name: collections.abc.Callable | None
|
|
655
|
-
:param add_operator:
|
|
656
|
-
:param add_operator_props:
|
|
657
|
-
"""
|
|
658
|
-
...
|
|
659
|
-
|
|
660
|
-
def path_resolve(self):
|
|
661
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
662
|
-
...
|
|
663
|
-
|
|
664
|
-
def pop(self):
|
|
665
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
666
|
-
when not found (matches Python's dictionary function of the same name).
|
|
667
|
-
|
|
668
|
-
"""
|
|
669
|
-
...
|
|
670
|
-
|
|
671
|
-
def prepend(self, draw_func):
|
|
672
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
673
|
-
the menus draw function
|
|
674
|
-
|
|
675
|
-
:param draw_func:
|
|
676
|
-
"""
|
|
677
|
-
...
|
|
678
|
-
|
|
679
|
-
def property_overridable_library_set(self) -> bool:
|
|
680
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
681
|
-
|
|
682
|
-
:return: True when the overridable status of the property was successfully set.
|
|
683
|
-
:rtype: bool
|
|
684
|
-
"""
|
|
685
|
-
...
|
|
686
|
-
|
|
687
|
-
def property_unset(self):
|
|
688
|
-
"""Unset a property, will use default value afterward."""
|
|
689
|
-
...
|
|
690
|
-
|
|
691
|
-
def remove(self, draw_func):
|
|
692
|
-
"""Remove a draw function that has been added to this menu
|
|
693
|
-
|
|
694
|
-
:param draw_func:
|
|
695
|
-
"""
|
|
696
|
-
...
|
|
697
|
-
|
|
698
|
-
def type_recast(self):
|
|
699
|
-
"""Return a new instance, this is needed because types
|
|
700
|
-
such as textures can be changed at runtime.
|
|
701
|
-
|
|
702
|
-
:return: a new instance of this object with the type initialized again.
|
|
703
|
-
"""
|
|
704
|
-
...
|
|
705
|
-
|
|
706
|
-
def values(self):
|
|
707
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
708
|
-
dictionary function of the same name).
|
|
709
|
-
|
|
710
|
-
:return: custom property values.
|
|
711
|
-
"""
|
|
712
|
-
...
|
|
713
|
-
|
|
714
|
-
class TEXT_MT_edit(bpy_types._GenericUI):
|
|
715
|
-
bl_label: typing.Any
|
|
716
|
-
bl_rna: typing.Any
|
|
717
|
-
id_data: typing.Any
|
|
718
|
-
|
|
719
|
-
def append(self, draw_func):
|
|
720
|
-
"""Append a draw function to this menu,
|
|
721
|
-
takes the same arguments as the menus draw function
|
|
722
|
-
|
|
723
|
-
:param draw_func:
|
|
724
|
-
"""
|
|
725
|
-
...
|
|
726
|
-
|
|
727
|
-
def as_pointer(self) -> int:
|
|
728
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
729
|
-
|
|
730
|
-
:return: int (memory address).
|
|
731
|
-
:rtype: int
|
|
732
|
-
"""
|
|
733
|
-
...
|
|
734
|
-
|
|
735
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
736
|
-
"""
|
|
737
|
-
|
|
738
|
-
:return: The RNA type or default when not found.
|
|
739
|
-
:rtype: bpy.types.Struct
|
|
740
|
-
"""
|
|
741
|
-
...
|
|
742
|
-
|
|
743
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
744
|
-
"""
|
|
745
|
-
|
|
746
|
-
:return: The class or default when not found.
|
|
747
|
-
:rtype: typing.Any
|
|
748
|
-
"""
|
|
749
|
-
...
|
|
750
|
-
|
|
751
|
-
def draw(self, _context):
|
|
752
|
-
"""
|
|
753
|
-
|
|
754
|
-
:param _context:
|
|
755
|
-
"""
|
|
756
|
-
...
|
|
757
|
-
|
|
758
|
-
def draw_collapsible(self, context, layout):
|
|
759
|
-
"""
|
|
760
|
-
|
|
761
|
-
:param context:
|
|
762
|
-
:param layout:
|
|
763
|
-
"""
|
|
764
|
-
...
|
|
765
|
-
|
|
766
|
-
def draw_preset(self, _context):
|
|
767
|
-
"""Define these on the subclass:
|
|
768
|
-
- preset_operator (string)
|
|
769
|
-
- preset_subdir (string)Optionally:
|
|
770
|
-
- preset_add_operator (string)
|
|
771
|
-
- preset_extensions (set of strings)
|
|
772
|
-
- preset_operator_defaults (dict of keyword args)
|
|
773
|
-
|
|
774
|
-
:param _context:
|
|
775
|
-
"""
|
|
776
|
-
...
|
|
777
|
-
|
|
778
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
779
|
-
"""Adds driver(s) to the given property
|
|
780
|
-
|
|
781
|
-
:return: The driver(s) added.
|
|
782
|
-
:rtype: bpy.types.FCurve
|
|
783
|
-
"""
|
|
784
|
-
...
|
|
785
|
-
|
|
786
|
-
def driver_remove(self) -> bool:
|
|
787
|
-
"""Remove driver(s) from the given property
|
|
788
|
-
|
|
789
|
-
:return: Success of driver removal.
|
|
790
|
-
:rtype: bool
|
|
791
|
-
"""
|
|
792
|
-
...
|
|
793
|
-
|
|
794
|
-
def get(self):
|
|
795
|
-
"""Returns the value of the custom property assigned to key or default
|
|
796
|
-
when not found (matches Python's dictionary function of the same name).
|
|
797
|
-
|
|
798
|
-
"""
|
|
799
|
-
...
|
|
800
|
-
|
|
801
|
-
def id_properties_clear(self):
|
|
802
|
-
"""
|
|
803
|
-
|
|
804
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
805
|
-
"""
|
|
806
|
-
...
|
|
807
|
-
|
|
808
|
-
def id_properties_ensure(self):
|
|
809
|
-
"""
|
|
810
|
-
|
|
811
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
812
|
-
"""
|
|
813
|
-
...
|
|
814
|
-
|
|
815
|
-
def id_properties_ui(self):
|
|
816
|
-
"""
|
|
817
|
-
|
|
818
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
819
|
-
"""
|
|
820
|
-
...
|
|
821
|
-
|
|
822
|
-
def is_extended(self): ...
|
|
823
|
-
def is_property_hidden(self) -> bool:
|
|
824
|
-
"""Check if a property is hidden.
|
|
825
|
-
|
|
826
|
-
:return: True when the property is hidden.
|
|
827
|
-
:rtype: bool
|
|
828
|
-
"""
|
|
829
|
-
...
|
|
830
|
-
|
|
831
|
-
def is_property_overridable_library(self) -> bool:
|
|
832
|
-
"""Check if a property is overridable.
|
|
833
|
-
|
|
834
|
-
:return: True when the property is overridable.
|
|
835
|
-
:rtype: bool
|
|
836
|
-
"""
|
|
837
|
-
...
|
|
838
|
-
|
|
839
|
-
def is_property_readonly(self) -> bool:
|
|
840
|
-
"""Check if a property is readonly.
|
|
841
|
-
|
|
842
|
-
:return: True when the property is readonly (not writable).
|
|
843
|
-
:rtype: bool
|
|
844
|
-
"""
|
|
845
|
-
...
|
|
846
|
-
|
|
847
|
-
def is_property_set(self) -> bool:
|
|
848
|
-
"""Check if a property is set, use for testing operator properties.
|
|
849
|
-
|
|
850
|
-
:return: True when the property has been set.
|
|
851
|
-
:rtype: bool
|
|
852
|
-
"""
|
|
853
|
-
...
|
|
854
|
-
|
|
855
|
-
def items(self):
|
|
856
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
857
|
-
dictionary function of the same name).
|
|
858
|
-
|
|
859
|
-
:return: custom property key, value pairs.
|
|
860
|
-
"""
|
|
861
|
-
...
|
|
862
|
-
|
|
863
|
-
def keyframe_delete(self) -> bool:
|
|
864
|
-
"""Remove a keyframe from this properties fcurve.
|
|
865
|
-
|
|
866
|
-
:return: Success of keyframe deletion.
|
|
867
|
-
:rtype: bool
|
|
868
|
-
"""
|
|
869
|
-
...
|
|
870
|
-
|
|
871
|
-
def keyframe_insert(self) -> bool:
|
|
872
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
873
|
-
|
|
874
|
-
:return: Success of keyframe insertion.
|
|
875
|
-
:rtype: bool
|
|
876
|
-
"""
|
|
877
|
-
...
|
|
878
|
-
|
|
879
|
-
def keys(self):
|
|
880
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
881
|
-
dictionary function of the same name).
|
|
882
|
-
|
|
883
|
-
:return: custom property keys.
|
|
884
|
-
"""
|
|
885
|
-
...
|
|
886
|
-
|
|
887
|
-
def path_from_id(self) -> str:
|
|
888
|
-
"""Returns the data path from the ID to this object (string).
|
|
889
|
-
|
|
890
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
891
|
-
to this struct and property (when given).
|
|
892
|
-
:rtype: str
|
|
893
|
-
"""
|
|
894
|
-
...
|
|
895
|
-
|
|
896
|
-
def path_menu(
|
|
897
|
-
self,
|
|
898
|
-
searchpaths: list[str],
|
|
899
|
-
operator: str,
|
|
900
|
-
*,
|
|
901
|
-
props_default: dict = None,
|
|
902
|
-
prop_filepath: str | None = "filepath",
|
|
903
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
904
|
-
filter_path=None,
|
|
905
|
-
display_name: collections.abc.Callable | None = None,
|
|
906
|
-
add_operator=None,
|
|
907
|
-
add_operator_props=None,
|
|
908
|
-
):
|
|
909
|
-
"""Populate a menu from a list of paths.
|
|
910
|
-
|
|
911
|
-
:param searchpaths: Paths to scan.
|
|
912
|
-
:type searchpaths: list[str]
|
|
913
|
-
:param operator: The operator id to use with each file.
|
|
914
|
-
:type operator: str
|
|
915
|
-
:param props_default: Properties to assign to each operator.
|
|
916
|
-
:type props_default: dict
|
|
917
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
918
|
-
:type prop_filepath: str | None
|
|
919
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
920
|
-
|
|
921
|
-
Returning false excludes the file from the list.
|
|
922
|
-
:type filter_ext: collections.abc.Callable | None
|
|
923
|
-
:param filter_path:
|
|
924
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
925
|
-
:type display_name: collections.abc.Callable | None
|
|
926
|
-
:param add_operator:
|
|
927
|
-
:param add_operator_props:
|
|
928
|
-
"""
|
|
929
|
-
...
|
|
930
|
-
|
|
931
|
-
def path_resolve(self):
|
|
932
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
933
|
-
...
|
|
934
|
-
|
|
935
|
-
@classmethod
|
|
936
|
-
def poll(cls, context):
|
|
937
|
-
"""
|
|
938
|
-
|
|
939
|
-
:param context:
|
|
940
|
-
"""
|
|
941
|
-
...
|
|
942
|
-
|
|
943
|
-
def pop(self):
|
|
944
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
945
|
-
when not found (matches Python's dictionary function of the same name).
|
|
946
|
-
|
|
947
|
-
"""
|
|
948
|
-
...
|
|
949
|
-
|
|
950
|
-
def prepend(self, draw_func):
|
|
951
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
952
|
-
the menus draw function
|
|
953
|
-
|
|
954
|
-
:param draw_func:
|
|
955
|
-
"""
|
|
956
|
-
...
|
|
957
|
-
|
|
958
|
-
def property_overridable_library_set(self) -> bool:
|
|
959
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
960
|
-
|
|
961
|
-
:return: True when the overridable status of the property was successfully set.
|
|
962
|
-
:rtype: bool
|
|
963
|
-
"""
|
|
964
|
-
...
|
|
965
|
-
|
|
966
|
-
def property_unset(self):
|
|
967
|
-
"""Unset a property, will use default value afterward."""
|
|
968
|
-
...
|
|
969
|
-
|
|
970
|
-
def remove(self, draw_func):
|
|
971
|
-
"""Remove a draw function that has been added to this menu
|
|
972
|
-
|
|
973
|
-
:param draw_func:
|
|
974
|
-
"""
|
|
975
|
-
...
|
|
976
|
-
|
|
977
|
-
def type_recast(self):
|
|
978
|
-
"""Return a new instance, this is needed because types
|
|
979
|
-
such as textures can be changed at runtime.
|
|
980
|
-
|
|
981
|
-
:return: a new instance of this object with the type initialized again.
|
|
982
|
-
"""
|
|
983
|
-
...
|
|
984
|
-
|
|
985
|
-
def values(self):
|
|
986
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
987
|
-
dictionary function of the same name).
|
|
988
|
-
|
|
989
|
-
:return: custom property values.
|
|
990
|
-
"""
|
|
991
|
-
...
|
|
992
|
-
|
|
993
|
-
class TEXT_MT_edit_to3d(bpy_types._GenericUI):
|
|
994
|
-
bl_label: typing.Any
|
|
995
|
-
bl_rna: typing.Any
|
|
996
|
-
id_data: typing.Any
|
|
997
|
-
|
|
998
|
-
def append(self, draw_func):
|
|
999
|
-
"""Append a draw function to this menu,
|
|
1000
|
-
takes the same arguments as the menus draw function
|
|
1001
|
-
|
|
1002
|
-
:param draw_func:
|
|
1003
|
-
"""
|
|
1004
|
-
...
|
|
1005
|
-
|
|
1006
|
-
def as_pointer(self) -> int:
|
|
1007
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1008
|
-
|
|
1009
|
-
:return: int (memory address).
|
|
1010
|
-
:rtype: int
|
|
1011
|
-
"""
|
|
1012
|
-
...
|
|
1013
|
-
|
|
1014
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1015
|
-
"""
|
|
1016
|
-
|
|
1017
|
-
:return: The RNA type or default when not found.
|
|
1018
|
-
:rtype: bpy.types.Struct
|
|
1019
|
-
"""
|
|
1020
|
-
...
|
|
1021
|
-
|
|
1022
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1023
|
-
"""
|
|
1024
|
-
|
|
1025
|
-
:return: The class or default when not found.
|
|
1026
|
-
:rtype: typing.Any
|
|
1027
|
-
"""
|
|
1028
|
-
...
|
|
1029
|
-
|
|
1030
|
-
def draw(self, _context):
|
|
1031
|
-
"""
|
|
1032
|
-
|
|
1033
|
-
:param _context:
|
|
1034
|
-
"""
|
|
1035
|
-
...
|
|
1036
|
-
|
|
1037
|
-
def draw_collapsible(self, context, layout):
|
|
1038
|
-
"""
|
|
1039
|
-
|
|
1040
|
-
:param context:
|
|
1041
|
-
:param layout:
|
|
1042
|
-
"""
|
|
1043
|
-
...
|
|
1044
|
-
|
|
1045
|
-
def draw_preset(self, _context):
|
|
1046
|
-
"""Define these on the subclass:
|
|
1047
|
-
- preset_operator (string)
|
|
1048
|
-
- preset_subdir (string)Optionally:
|
|
1049
|
-
- preset_add_operator (string)
|
|
1050
|
-
- preset_extensions (set of strings)
|
|
1051
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1052
|
-
|
|
1053
|
-
:param _context:
|
|
1054
|
-
"""
|
|
1055
|
-
...
|
|
1056
|
-
|
|
1057
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1058
|
-
"""Adds driver(s) to the given property
|
|
1059
|
-
|
|
1060
|
-
:return: The driver(s) added.
|
|
1061
|
-
:rtype: bpy.types.FCurve
|
|
1062
|
-
"""
|
|
1063
|
-
...
|
|
1064
|
-
|
|
1065
|
-
def driver_remove(self) -> bool:
|
|
1066
|
-
"""Remove driver(s) from the given property
|
|
1067
|
-
|
|
1068
|
-
:return: Success of driver removal.
|
|
1069
|
-
:rtype: bool
|
|
1070
|
-
"""
|
|
1071
|
-
...
|
|
1072
|
-
|
|
1073
|
-
def get(self):
|
|
1074
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1075
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1076
|
-
|
|
1077
|
-
"""
|
|
1078
|
-
...
|
|
1079
|
-
|
|
1080
|
-
def id_properties_clear(self):
|
|
1081
|
-
"""
|
|
1082
|
-
|
|
1083
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1084
|
-
"""
|
|
1085
|
-
...
|
|
1086
|
-
|
|
1087
|
-
def id_properties_ensure(self):
|
|
1088
|
-
"""
|
|
1089
|
-
|
|
1090
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1091
|
-
"""
|
|
1092
|
-
...
|
|
1093
|
-
|
|
1094
|
-
def id_properties_ui(self):
|
|
1095
|
-
"""
|
|
1096
|
-
|
|
1097
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1098
|
-
"""
|
|
1099
|
-
...
|
|
1100
|
-
|
|
1101
|
-
def is_extended(self): ...
|
|
1102
|
-
def is_property_hidden(self) -> bool:
|
|
1103
|
-
"""Check if a property is hidden.
|
|
1104
|
-
|
|
1105
|
-
:return: True when the property is hidden.
|
|
1106
|
-
:rtype: bool
|
|
1107
|
-
"""
|
|
1108
|
-
...
|
|
1109
|
-
|
|
1110
|
-
def is_property_overridable_library(self) -> bool:
|
|
1111
|
-
"""Check if a property is overridable.
|
|
1112
|
-
|
|
1113
|
-
:return: True when the property is overridable.
|
|
1114
|
-
:rtype: bool
|
|
1115
|
-
"""
|
|
1116
|
-
...
|
|
1117
|
-
|
|
1118
|
-
def is_property_readonly(self) -> bool:
|
|
1119
|
-
"""Check if a property is readonly.
|
|
1120
|
-
|
|
1121
|
-
:return: True when the property is readonly (not writable).
|
|
1122
|
-
:rtype: bool
|
|
1123
|
-
"""
|
|
1124
|
-
...
|
|
1125
|
-
|
|
1126
|
-
def is_property_set(self) -> bool:
|
|
1127
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1128
|
-
|
|
1129
|
-
:return: True when the property has been set.
|
|
1130
|
-
:rtype: bool
|
|
1131
|
-
"""
|
|
1132
|
-
...
|
|
1133
|
-
|
|
1134
|
-
def items(self):
|
|
1135
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1136
|
-
dictionary function of the same name).
|
|
1137
|
-
|
|
1138
|
-
:return: custom property key, value pairs.
|
|
1139
|
-
"""
|
|
1140
|
-
...
|
|
1141
|
-
|
|
1142
|
-
def keyframe_delete(self) -> bool:
|
|
1143
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1144
|
-
|
|
1145
|
-
:return: Success of keyframe deletion.
|
|
1146
|
-
:rtype: bool
|
|
1147
|
-
"""
|
|
1148
|
-
...
|
|
1149
|
-
|
|
1150
|
-
def keyframe_insert(self) -> bool:
|
|
1151
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1152
|
-
|
|
1153
|
-
:return: Success of keyframe insertion.
|
|
1154
|
-
:rtype: bool
|
|
1155
|
-
"""
|
|
1156
|
-
...
|
|
1157
|
-
|
|
1158
|
-
def keys(self):
|
|
1159
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1160
|
-
dictionary function of the same name).
|
|
1161
|
-
|
|
1162
|
-
:return: custom property keys.
|
|
1163
|
-
"""
|
|
1164
|
-
...
|
|
1165
|
-
|
|
1166
|
-
def path_from_id(self) -> str:
|
|
1167
|
-
"""Returns the data path from the ID to this object (string).
|
|
1168
|
-
|
|
1169
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1170
|
-
to this struct and property (when given).
|
|
1171
|
-
:rtype: str
|
|
1172
|
-
"""
|
|
1173
|
-
...
|
|
1174
|
-
|
|
1175
|
-
def path_menu(
|
|
1176
|
-
self,
|
|
1177
|
-
searchpaths: list[str],
|
|
1178
|
-
operator: str,
|
|
1179
|
-
*,
|
|
1180
|
-
props_default: dict = None,
|
|
1181
|
-
prop_filepath: str | None = "filepath",
|
|
1182
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1183
|
-
filter_path=None,
|
|
1184
|
-
display_name: collections.abc.Callable | None = None,
|
|
1185
|
-
add_operator=None,
|
|
1186
|
-
add_operator_props=None,
|
|
1187
|
-
):
|
|
1188
|
-
"""Populate a menu from a list of paths.
|
|
1189
|
-
|
|
1190
|
-
:param searchpaths: Paths to scan.
|
|
1191
|
-
:type searchpaths: list[str]
|
|
1192
|
-
:param operator: The operator id to use with each file.
|
|
1193
|
-
:type operator: str
|
|
1194
|
-
:param props_default: Properties to assign to each operator.
|
|
1195
|
-
:type props_default: dict
|
|
1196
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1197
|
-
:type prop_filepath: str | None
|
|
1198
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1199
|
-
|
|
1200
|
-
Returning false excludes the file from the list.
|
|
1201
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1202
|
-
:param filter_path:
|
|
1203
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1204
|
-
:type display_name: collections.abc.Callable | None
|
|
1205
|
-
:param add_operator:
|
|
1206
|
-
:param add_operator_props:
|
|
1207
|
-
"""
|
|
1208
|
-
...
|
|
1209
|
-
|
|
1210
|
-
def path_resolve(self):
|
|
1211
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1212
|
-
...
|
|
1213
|
-
|
|
1214
|
-
def pop(self):
|
|
1215
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1216
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1217
|
-
|
|
1218
|
-
"""
|
|
1219
|
-
...
|
|
1220
|
-
|
|
1221
|
-
def prepend(self, draw_func):
|
|
1222
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1223
|
-
the menus draw function
|
|
1224
|
-
|
|
1225
|
-
:param draw_func:
|
|
1226
|
-
"""
|
|
1227
|
-
...
|
|
1228
|
-
|
|
1229
|
-
def property_overridable_library_set(self) -> bool:
|
|
1230
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1231
|
-
|
|
1232
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1233
|
-
:rtype: bool
|
|
1234
|
-
"""
|
|
1235
|
-
...
|
|
1236
|
-
|
|
1237
|
-
def property_unset(self):
|
|
1238
|
-
"""Unset a property, will use default value afterward."""
|
|
1239
|
-
...
|
|
1240
|
-
|
|
1241
|
-
def remove(self, draw_func):
|
|
1242
|
-
"""Remove a draw function that has been added to this menu
|
|
1243
|
-
|
|
1244
|
-
:param draw_func:
|
|
1245
|
-
"""
|
|
1246
|
-
...
|
|
1247
|
-
|
|
1248
|
-
def type_recast(self):
|
|
1249
|
-
"""Return a new instance, this is needed because types
|
|
1250
|
-
such as textures can be changed at runtime.
|
|
1251
|
-
|
|
1252
|
-
:return: a new instance of this object with the type initialized again.
|
|
1253
|
-
"""
|
|
1254
|
-
...
|
|
1255
|
-
|
|
1256
|
-
def values(self):
|
|
1257
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1258
|
-
dictionary function of the same name).
|
|
1259
|
-
|
|
1260
|
-
:return: custom property values.
|
|
1261
|
-
"""
|
|
1262
|
-
...
|
|
1263
|
-
|
|
1264
|
-
class TEXT_MT_editor_menus(bpy_types._GenericUI):
|
|
1265
|
-
bl_idname: typing.Any
|
|
1266
|
-
bl_label: typing.Any
|
|
1267
|
-
bl_rna: typing.Any
|
|
1268
|
-
id_data: typing.Any
|
|
1269
|
-
|
|
1270
|
-
def append(self, draw_func):
|
|
1271
|
-
"""Append a draw function to this menu,
|
|
1272
|
-
takes the same arguments as the menus draw function
|
|
1273
|
-
|
|
1274
|
-
:param draw_func:
|
|
1275
|
-
"""
|
|
1276
|
-
...
|
|
1277
|
-
|
|
1278
|
-
def as_pointer(self) -> int:
|
|
1279
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1280
|
-
|
|
1281
|
-
:return: int (memory address).
|
|
1282
|
-
:rtype: int
|
|
1283
|
-
"""
|
|
1284
|
-
...
|
|
1285
|
-
|
|
1286
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1287
|
-
"""
|
|
1288
|
-
|
|
1289
|
-
:return: The RNA type or default when not found.
|
|
1290
|
-
:rtype: bpy.types.Struct
|
|
1291
|
-
"""
|
|
1292
|
-
...
|
|
1293
|
-
|
|
1294
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1295
|
-
"""
|
|
1296
|
-
|
|
1297
|
-
:return: The class or default when not found.
|
|
1298
|
-
:rtype: typing.Any
|
|
1299
|
-
"""
|
|
1300
|
-
...
|
|
1301
|
-
|
|
1302
|
-
def draw(self, context):
|
|
1303
|
-
"""
|
|
1304
|
-
|
|
1305
|
-
:param context:
|
|
1306
|
-
"""
|
|
1307
|
-
...
|
|
1308
|
-
|
|
1309
|
-
def draw_collapsible(self, context, layout):
|
|
1310
|
-
"""
|
|
1311
|
-
|
|
1312
|
-
:param context:
|
|
1313
|
-
:param layout:
|
|
1314
|
-
"""
|
|
1315
|
-
...
|
|
1316
|
-
|
|
1317
|
-
def draw_preset(self, _context):
|
|
1318
|
-
"""Define these on the subclass:
|
|
1319
|
-
- preset_operator (string)
|
|
1320
|
-
- preset_subdir (string)Optionally:
|
|
1321
|
-
- preset_add_operator (string)
|
|
1322
|
-
- preset_extensions (set of strings)
|
|
1323
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1324
|
-
|
|
1325
|
-
:param _context:
|
|
1326
|
-
"""
|
|
1327
|
-
...
|
|
1328
|
-
|
|
1329
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1330
|
-
"""Adds driver(s) to the given property
|
|
1331
|
-
|
|
1332
|
-
:return: The driver(s) added.
|
|
1333
|
-
:rtype: bpy.types.FCurve
|
|
1334
|
-
"""
|
|
1335
|
-
...
|
|
1336
|
-
|
|
1337
|
-
def driver_remove(self) -> bool:
|
|
1338
|
-
"""Remove driver(s) from the given property
|
|
1339
|
-
|
|
1340
|
-
:return: Success of driver removal.
|
|
1341
|
-
:rtype: bool
|
|
1342
|
-
"""
|
|
1343
|
-
...
|
|
1344
|
-
|
|
1345
|
-
def get(self):
|
|
1346
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1347
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1348
|
-
|
|
1349
|
-
"""
|
|
1350
|
-
...
|
|
1351
|
-
|
|
1352
|
-
def id_properties_clear(self):
|
|
1353
|
-
"""
|
|
1354
|
-
|
|
1355
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1356
|
-
"""
|
|
1357
|
-
...
|
|
1358
|
-
|
|
1359
|
-
def id_properties_ensure(self):
|
|
1360
|
-
"""
|
|
1361
|
-
|
|
1362
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1363
|
-
"""
|
|
1364
|
-
...
|
|
1365
|
-
|
|
1366
|
-
def id_properties_ui(self):
|
|
1367
|
-
"""
|
|
1368
|
-
|
|
1369
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1370
|
-
"""
|
|
1371
|
-
...
|
|
1372
|
-
|
|
1373
|
-
def is_extended(self): ...
|
|
1374
|
-
def is_property_hidden(self) -> bool:
|
|
1375
|
-
"""Check if a property is hidden.
|
|
1376
|
-
|
|
1377
|
-
:return: True when the property is hidden.
|
|
1378
|
-
:rtype: bool
|
|
1379
|
-
"""
|
|
1380
|
-
...
|
|
1381
|
-
|
|
1382
|
-
def is_property_overridable_library(self) -> bool:
|
|
1383
|
-
"""Check if a property is overridable.
|
|
1384
|
-
|
|
1385
|
-
:return: True when the property is overridable.
|
|
1386
|
-
:rtype: bool
|
|
1387
|
-
"""
|
|
1388
|
-
...
|
|
1389
|
-
|
|
1390
|
-
def is_property_readonly(self) -> bool:
|
|
1391
|
-
"""Check if a property is readonly.
|
|
1392
|
-
|
|
1393
|
-
:return: True when the property is readonly (not writable).
|
|
1394
|
-
:rtype: bool
|
|
1395
|
-
"""
|
|
1396
|
-
...
|
|
1397
|
-
|
|
1398
|
-
def is_property_set(self) -> bool:
|
|
1399
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1400
|
-
|
|
1401
|
-
:return: True when the property has been set.
|
|
1402
|
-
:rtype: bool
|
|
1403
|
-
"""
|
|
1404
|
-
...
|
|
1405
|
-
|
|
1406
|
-
def items(self):
|
|
1407
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1408
|
-
dictionary function of the same name).
|
|
1409
|
-
|
|
1410
|
-
:return: custom property key, value pairs.
|
|
1411
|
-
"""
|
|
1412
|
-
...
|
|
1413
|
-
|
|
1414
|
-
def keyframe_delete(self) -> bool:
|
|
1415
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1416
|
-
|
|
1417
|
-
:return: Success of keyframe deletion.
|
|
1418
|
-
:rtype: bool
|
|
1419
|
-
"""
|
|
1420
|
-
...
|
|
1421
|
-
|
|
1422
|
-
def keyframe_insert(self) -> bool:
|
|
1423
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1424
|
-
|
|
1425
|
-
:return: Success of keyframe insertion.
|
|
1426
|
-
:rtype: bool
|
|
1427
|
-
"""
|
|
1428
|
-
...
|
|
1429
|
-
|
|
1430
|
-
def keys(self):
|
|
1431
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1432
|
-
dictionary function of the same name).
|
|
1433
|
-
|
|
1434
|
-
:return: custom property keys.
|
|
1435
|
-
"""
|
|
1436
|
-
...
|
|
1437
|
-
|
|
1438
|
-
def path_from_id(self) -> str:
|
|
1439
|
-
"""Returns the data path from the ID to this object (string).
|
|
1440
|
-
|
|
1441
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1442
|
-
to this struct and property (when given).
|
|
1443
|
-
:rtype: str
|
|
1444
|
-
"""
|
|
1445
|
-
...
|
|
1446
|
-
|
|
1447
|
-
def path_menu(
|
|
1448
|
-
self,
|
|
1449
|
-
searchpaths: list[str],
|
|
1450
|
-
operator: str,
|
|
1451
|
-
*,
|
|
1452
|
-
props_default: dict = None,
|
|
1453
|
-
prop_filepath: str | None = "filepath",
|
|
1454
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1455
|
-
filter_path=None,
|
|
1456
|
-
display_name: collections.abc.Callable | None = None,
|
|
1457
|
-
add_operator=None,
|
|
1458
|
-
add_operator_props=None,
|
|
1459
|
-
):
|
|
1460
|
-
"""Populate a menu from a list of paths.
|
|
1461
|
-
|
|
1462
|
-
:param searchpaths: Paths to scan.
|
|
1463
|
-
:type searchpaths: list[str]
|
|
1464
|
-
:param operator: The operator id to use with each file.
|
|
1465
|
-
:type operator: str
|
|
1466
|
-
:param props_default: Properties to assign to each operator.
|
|
1467
|
-
:type props_default: dict
|
|
1468
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1469
|
-
:type prop_filepath: str | None
|
|
1470
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1471
|
-
|
|
1472
|
-
Returning false excludes the file from the list.
|
|
1473
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1474
|
-
:param filter_path:
|
|
1475
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1476
|
-
:type display_name: collections.abc.Callable | None
|
|
1477
|
-
:param add_operator:
|
|
1478
|
-
:param add_operator_props:
|
|
1479
|
-
"""
|
|
1480
|
-
...
|
|
1481
|
-
|
|
1482
|
-
def path_resolve(self):
|
|
1483
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1484
|
-
...
|
|
1485
|
-
|
|
1486
|
-
def pop(self):
|
|
1487
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1488
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1489
|
-
|
|
1490
|
-
"""
|
|
1491
|
-
...
|
|
1492
|
-
|
|
1493
|
-
def prepend(self, draw_func):
|
|
1494
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1495
|
-
the menus draw function
|
|
1496
|
-
|
|
1497
|
-
:param draw_func:
|
|
1498
|
-
"""
|
|
1499
|
-
...
|
|
1500
|
-
|
|
1501
|
-
def property_overridable_library_set(self) -> bool:
|
|
1502
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1503
|
-
|
|
1504
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1505
|
-
:rtype: bool
|
|
1506
|
-
"""
|
|
1507
|
-
...
|
|
1508
|
-
|
|
1509
|
-
def property_unset(self):
|
|
1510
|
-
"""Unset a property, will use default value afterward."""
|
|
1511
|
-
...
|
|
1512
|
-
|
|
1513
|
-
def remove(self, draw_func):
|
|
1514
|
-
"""Remove a draw function that has been added to this menu
|
|
1515
|
-
|
|
1516
|
-
:param draw_func:
|
|
1517
|
-
"""
|
|
1518
|
-
...
|
|
1519
|
-
|
|
1520
|
-
def type_recast(self):
|
|
1521
|
-
"""Return a new instance, this is needed because types
|
|
1522
|
-
such as textures can be changed at runtime.
|
|
1523
|
-
|
|
1524
|
-
:return: a new instance of this object with the type initialized again.
|
|
1525
|
-
"""
|
|
1526
|
-
...
|
|
1527
|
-
|
|
1528
|
-
def values(self):
|
|
1529
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1530
|
-
dictionary function of the same name).
|
|
1531
|
-
|
|
1532
|
-
:return: custom property values.
|
|
1533
|
-
"""
|
|
1534
|
-
...
|
|
1535
|
-
|
|
1536
|
-
class TEXT_MT_format(bpy_types._GenericUI):
|
|
1537
|
-
bl_label: typing.Any
|
|
1538
|
-
bl_rna: typing.Any
|
|
1539
|
-
id_data: typing.Any
|
|
1540
|
-
|
|
1541
|
-
def append(self, draw_func):
|
|
1542
|
-
"""Append a draw function to this menu,
|
|
1543
|
-
takes the same arguments as the menus draw function
|
|
1544
|
-
|
|
1545
|
-
:param draw_func:
|
|
1546
|
-
"""
|
|
1547
|
-
...
|
|
1548
|
-
|
|
1549
|
-
def as_pointer(self) -> int:
|
|
1550
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1551
|
-
|
|
1552
|
-
:return: int (memory address).
|
|
1553
|
-
:rtype: int
|
|
1554
|
-
"""
|
|
1555
|
-
...
|
|
1556
|
-
|
|
1557
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1558
|
-
"""
|
|
1559
|
-
|
|
1560
|
-
:return: The RNA type or default when not found.
|
|
1561
|
-
:rtype: bpy.types.Struct
|
|
1562
|
-
"""
|
|
1563
|
-
...
|
|
1564
|
-
|
|
1565
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1566
|
-
"""
|
|
1567
|
-
|
|
1568
|
-
:return: The class or default when not found.
|
|
1569
|
-
:rtype: typing.Any
|
|
1570
|
-
"""
|
|
1571
|
-
...
|
|
1572
|
-
|
|
1573
|
-
def draw(self, _context):
|
|
1574
|
-
"""
|
|
1575
|
-
|
|
1576
|
-
:param _context:
|
|
1577
|
-
"""
|
|
1578
|
-
...
|
|
1579
|
-
|
|
1580
|
-
def draw_collapsible(self, context, layout):
|
|
1581
|
-
"""
|
|
1582
|
-
|
|
1583
|
-
:param context:
|
|
1584
|
-
:param layout:
|
|
1585
|
-
"""
|
|
1586
|
-
...
|
|
1587
|
-
|
|
1588
|
-
def draw_preset(self, _context):
|
|
1589
|
-
"""Define these on the subclass:
|
|
1590
|
-
- preset_operator (string)
|
|
1591
|
-
- preset_subdir (string)Optionally:
|
|
1592
|
-
- preset_add_operator (string)
|
|
1593
|
-
- preset_extensions (set of strings)
|
|
1594
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1595
|
-
|
|
1596
|
-
:param _context:
|
|
1597
|
-
"""
|
|
1598
|
-
...
|
|
1599
|
-
|
|
1600
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1601
|
-
"""Adds driver(s) to the given property
|
|
1602
|
-
|
|
1603
|
-
:return: The driver(s) added.
|
|
1604
|
-
:rtype: bpy.types.FCurve
|
|
1605
|
-
"""
|
|
1606
|
-
...
|
|
1607
|
-
|
|
1608
|
-
def driver_remove(self) -> bool:
|
|
1609
|
-
"""Remove driver(s) from the given property
|
|
1610
|
-
|
|
1611
|
-
:return: Success of driver removal.
|
|
1612
|
-
:rtype: bool
|
|
1613
|
-
"""
|
|
1614
|
-
...
|
|
1615
|
-
|
|
1616
|
-
def get(self):
|
|
1617
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1618
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1619
|
-
|
|
1620
|
-
"""
|
|
1621
|
-
...
|
|
1622
|
-
|
|
1623
|
-
def id_properties_clear(self):
|
|
1624
|
-
"""
|
|
1625
|
-
|
|
1626
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1627
|
-
"""
|
|
1628
|
-
...
|
|
1629
|
-
|
|
1630
|
-
def id_properties_ensure(self):
|
|
1631
|
-
"""
|
|
1632
|
-
|
|
1633
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1634
|
-
"""
|
|
1635
|
-
...
|
|
1636
|
-
|
|
1637
|
-
def id_properties_ui(self):
|
|
1638
|
-
"""
|
|
1639
|
-
|
|
1640
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1641
|
-
"""
|
|
1642
|
-
...
|
|
1643
|
-
|
|
1644
|
-
def is_extended(self): ...
|
|
1645
|
-
def is_property_hidden(self) -> bool:
|
|
1646
|
-
"""Check if a property is hidden.
|
|
1647
|
-
|
|
1648
|
-
:return: True when the property is hidden.
|
|
1649
|
-
:rtype: bool
|
|
1650
|
-
"""
|
|
1651
|
-
...
|
|
1652
|
-
|
|
1653
|
-
def is_property_overridable_library(self) -> bool:
|
|
1654
|
-
"""Check if a property is overridable.
|
|
1655
|
-
|
|
1656
|
-
:return: True when the property is overridable.
|
|
1657
|
-
:rtype: bool
|
|
1658
|
-
"""
|
|
1659
|
-
...
|
|
1660
|
-
|
|
1661
|
-
def is_property_readonly(self) -> bool:
|
|
1662
|
-
"""Check if a property is readonly.
|
|
1663
|
-
|
|
1664
|
-
:return: True when the property is readonly (not writable).
|
|
1665
|
-
:rtype: bool
|
|
1666
|
-
"""
|
|
1667
|
-
...
|
|
1668
|
-
|
|
1669
|
-
def is_property_set(self) -> bool:
|
|
1670
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1671
|
-
|
|
1672
|
-
:return: True when the property has been set.
|
|
1673
|
-
:rtype: bool
|
|
1674
|
-
"""
|
|
1675
|
-
...
|
|
1676
|
-
|
|
1677
|
-
def items(self):
|
|
1678
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1679
|
-
dictionary function of the same name).
|
|
1680
|
-
|
|
1681
|
-
:return: custom property key, value pairs.
|
|
1682
|
-
"""
|
|
1683
|
-
...
|
|
1684
|
-
|
|
1685
|
-
def keyframe_delete(self) -> bool:
|
|
1686
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1687
|
-
|
|
1688
|
-
:return: Success of keyframe deletion.
|
|
1689
|
-
:rtype: bool
|
|
1690
|
-
"""
|
|
1691
|
-
...
|
|
1692
|
-
|
|
1693
|
-
def keyframe_insert(self) -> bool:
|
|
1694
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1695
|
-
|
|
1696
|
-
:return: Success of keyframe insertion.
|
|
1697
|
-
:rtype: bool
|
|
1698
|
-
"""
|
|
1699
|
-
...
|
|
1700
|
-
|
|
1701
|
-
def keys(self):
|
|
1702
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1703
|
-
dictionary function of the same name).
|
|
1704
|
-
|
|
1705
|
-
:return: custom property keys.
|
|
1706
|
-
"""
|
|
1707
|
-
...
|
|
1708
|
-
|
|
1709
|
-
def path_from_id(self) -> str:
|
|
1710
|
-
"""Returns the data path from the ID to this object (string).
|
|
1711
|
-
|
|
1712
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1713
|
-
to this struct and property (when given).
|
|
1714
|
-
:rtype: str
|
|
1715
|
-
"""
|
|
1716
|
-
...
|
|
1717
|
-
|
|
1718
|
-
def path_menu(
|
|
1719
|
-
self,
|
|
1720
|
-
searchpaths: list[str],
|
|
1721
|
-
operator: str,
|
|
1722
|
-
*,
|
|
1723
|
-
props_default: dict = None,
|
|
1724
|
-
prop_filepath: str | None = "filepath",
|
|
1725
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1726
|
-
filter_path=None,
|
|
1727
|
-
display_name: collections.abc.Callable | None = None,
|
|
1728
|
-
add_operator=None,
|
|
1729
|
-
add_operator_props=None,
|
|
1730
|
-
):
|
|
1731
|
-
"""Populate a menu from a list of paths.
|
|
1732
|
-
|
|
1733
|
-
:param searchpaths: Paths to scan.
|
|
1734
|
-
:type searchpaths: list[str]
|
|
1735
|
-
:param operator: The operator id to use with each file.
|
|
1736
|
-
:type operator: str
|
|
1737
|
-
:param props_default: Properties to assign to each operator.
|
|
1738
|
-
:type props_default: dict
|
|
1739
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1740
|
-
:type prop_filepath: str | None
|
|
1741
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1742
|
-
|
|
1743
|
-
Returning false excludes the file from the list.
|
|
1744
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1745
|
-
:param filter_path:
|
|
1746
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1747
|
-
:type display_name: collections.abc.Callable | None
|
|
1748
|
-
:param add_operator:
|
|
1749
|
-
:param add_operator_props:
|
|
1750
|
-
"""
|
|
1751
|
-
...
|
|
1752
|
-
|
|
1753
|
-
def path_resolve(self):
|
|
1754
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1755
|
-
...
|
|
1756
|
-
|
|
1757
|
-
def pop(self):
|
|
1758
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1759
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1760
|
-
|
|
1761
|
-
"""
|
|
1762
|
-
...
|
|
1763
|
-
|
|
1764
|
-
def prepend(self, draw_func):
|
|
1765
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1766
|
-
the menus draw function
|
|
1767
|
-
|
|
1768
|
-
:param draw_func:
|
|
1769
|
-
"""
|
|
1770
|
-
...
|
|
1771
|
-
|
|
1772
|
-
def property_overridable_library_set(self) -> bool:
|
|
1773
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1774
|
-
|
|
1775
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1776
|
-
:rtype: bool
|
|
1777
|
-
"""
|
|
1778
|
-
...
|
|
1779
|
-
|
|
1780
|
-
def property_unset(self):
|
|
1781
|
-
"""Unset a property, will use default value afterward."""
|
|
1782
|
-
...
|
|
1783
|
-
|
|
1784
|
-
def remove(self, draw_func):
|
|
1785
|
-
"""Remove a draw function that has been added to this menu
|
|
1786
|
-
|
|
1787
|
-
:param draw_func:
|
|
1788
|
-
"""
|
|
1789
|
-
...
|
|
1790
|
-
|
|
1791
|
-
def type_recast(self):
|
|
1792
|
-
"""Return a new instance, this is needed because types
|
|
1793
|
-
such as textures can be changed at runtime.
|
|
1794
|
-
|
|
1795
|
-
:return: a new instance of this object with the type initialized again.
|
|
1796
|
-
"""
|
|
1797
|
-
...
|
|
1798
|
-
|
|
1799
|
-
def values(self):
|
|
1800
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1801
|
-
dictionary function of the same name).
|
|
1802
|
-
|
|
1803
|
-
:return: custom property values.
|
|
1804
|
-
"""
|
|
1805
|
-
...
|
|
1806
|
-
|
|
1807
|
-
class TEXT_MT_select(bpy_types._GenericUI):
|
|
1808
|
-
bl_label: typing.Any
|
|
1809
|
-
bl_rna: typing.Any
|
|
1810
|
-
id_data: typing.Any
|
|
1811
|
-
|
|
1812
|
-
def append(self, draw_func):
|
|
1813
|
-
"""Append a draw function to this menu,
|
|
1814
|
-
takes the same arguments as the menus draw function
|
|
1815
|
-
|
|
1816
|
-
:param draw_func:
|
|
1817
|
-
"""
|
|
1818
|
-
...
|
|
1819
|
-
|
|
1820
|
-
def as_pointer(self) -> int:
|
|
1821
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1822
|
-
|
|
1823
|
-
:return: int (memory address).
|
|
1824
|
-
:rtype: int
|
|
1825
|
-
"""
|
|
1826
|
-
...
|
|
1827
|
-
|
|
1828
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1829
|
-
"""
|
|
1830
|
-
|
|
1831
|
-
:return: The RNA type or default when not found.
|
|
1832
|
-
:rtype: bpy.types.Struct
|
|
1833
|
-
"""
|
|
1834
|
-
...
|
|
1835
|
-
|
|
1836
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1837
|
-
"""
|
|
1838
|
-
|
|
1839
|
-
:return: The class or default when not found.
|
|
1840
|
-
:rtype: typing.Any
|
|
1841
|
-
"""
|
|
1842
|
-
...
|
|
1843
|
-
|
|
1844
|
-
def draw(self, _context):
|
|
1845
|
-
"""
|
|
1846
|
-
|
|
1847
|
-
:param _context:
|
|
1848
|
-
"""
|
|
1849
|
-
...
|
|
1850
|
-
|
|
1851
|
-
def draw_collapsible(self, context, layout):
|
|
1852
|
-
"""
|
|
1853
|
-
|
|
1854
|
-
:param context:
|
|
1855
|
-
:param layout:
|
|
1856
|
-
"""
|
|
1857
|
-
...
|
|
1858
|
-
|
|
1859
|
-
def draw_preset(self, _context):
|
|
1860
|
-
"""Define these on the subclass:
|
|
1861
|
-
- preset_operator (string)
|
|
1862
|
-
- preset_subdir (string)Optionally:
|
|
1863
|
-
- preset_add_operator (string)
|
|
1864
|
-
- preset_extensions (set of strings)
|
|
1865
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1866
|
-
|
|
1867
|
-
:param _context:
|
|
1868
|
-
"""
|
|
1869
|
-
...
|
|
1870
|
-
|
|
1871
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1872
|
-
"""Adds driver(s) to the given property
|
|
1873
|
-
|
|
1874
|
-
:return: The driver(s) added.
|
|
1875
|
-
:rtype: bpy.types.FCurve
|
|
1876
|
-
"""
|
|
1877
|
-
...
|
|
1878
|
-
|
|
1879
|
-
def driver_remove(self) -> bool:
|
|
1880
|
-
"""Remove driver(s) from the given property
|
|
1881
|
-
|
|
1882
|
-
:return: Success of driver removal.
|
|
1883
|
-
:rtype: bool
|
|
1884
|
-
"""
|
|
1885
|
-
...
|
|
1886
|
-
|
|
1887
|
-
def get(self):
|
|
1888
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1889
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1890
|
-
|
|
1891
|
-
"""
|
|
1892
|
-
...
|
|
1893
|
-
|
|
1894
|
-
def id_properties_clear(self):
|
|
1895
|
-
"""
|
|
1896
|
-
|
|
1897
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1898
|
-
"""
|
|
1899
|
-
...
|
|
1900
|
-
|
|
1901
|
-
def id_properties_ensure(self):
|
|
1902
|
-
"""
|
|
1903
|
-
|
|
1904
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1905
|
-
"""
|
|
1906
|
-
...
|
|
1907
|
-
|
|
1908
|
-
def id_properties_ui(self):
|
|
1909
|
-
"""
|
|
1910
|
-
|
|
1911
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1912
|
-
"""
|
|
1913
|
-
...
|
|
1914
|
-
|
|
1915
|
-
def is_extended(self): ...
|
|
1916
|
-
def is_property_hidden(self) -> bool:
|
|
1917
|
-
"""Check if a property is hidden.
|
|
1918
|
-
|
|
1919
|
-
:return: True when the property is hidden.
|
|
1920
|
-
:rtype: bool
|
|
1921
|
-
"""
|
|
1922
|
-
...
|
|
1923
|
-
|
|
1924
|
-
def is_property_overridable_library(self) -> bool:
|
|
1925
|
-
"""Check if a property is overridable.
|
|
1926
|
-
|
|
1927
|
-
:return: True when the property is overridable.
|
|
1928
|
-
:rtype: bool
|
|
1929
|
-
"""
|
|
1930
|
-
...
|
|
1931
|
-
|
|
1932
|
-
def is_property_readonly(self) -> bool:
|
|
1933
|
-
"""Check if a property is readonly.
|
|
1934
|
-
|
|
1935
|
-
:return: True when the property is readonly (not writable).
|
|
1936
|
-
:rtype: bool
|
|
1937
|
-
"""
|
|
1938
|
-
...
|
|
1939
|
-
|
|
1940
|
-
def is_property_set(self) -> bool:
|
|
1941
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1942
|
-
|
|
1943
|
-
:return: True when the property has been set.
|
|
1944
|
-
:rtype: bool
|
|
1945
|
-
"""
|
|
1946
|
-
...
|
|
1947
|
-
|
|
1948
|
-
def items(self):
|
|
1949
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1950
|
-
dictionary function of the same name).
|
|
1951
|
-
|
|
1952
|
-
:return: custom property key, value pairs.
|
|
1953
|
-
"""
|
|
1954
|
-
...
|
|
1955
|
-
|
|
1956
|
-
def keyframe_delete(self) -> bool:
|
|
1957
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1958
|
-
|
|
1959
|
-
:return: Success of keyframe deletion.
|
|
1960
|
-
:rtype: bool
|
|
1961
|
-
"""
|
|
1962
|
-
...
|
|
1963
|
-
|
|
1964
|
-
def keyframe_insert(self) -> bool:
|
|
1965
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1966
|
-
|
|
1967
|
-
:return: Success of keyframe insertion.
|
|
1968
|
-
:rtype: bool
|
|
1969
|
-
"""
|
|
1970
|
-
...
|
|
1971
|
-
|
|
1972
|
-
def keys(self):
|
|
1973
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1974
|
-
dictionary function of the same name).
|
|
1975
|
-
|
|
1976
|
-
:return: custom property keys.
|
|
1977
|
-
"""
|
|
1978
|
-
...
|
|
1979
|
-
|
|
1980
|
-
def path_from_id(self) -> str:
|
|
1981
|
-
"""Returns the data path from the ID to this object (string).
|
|
1982
|
-
|
|
1983
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1984
|
-
to this struct and property (when given).
|
|
1985
|
-
:rtype: str
|
|
1986
|
-
"""
|
|
1987
|
-
...
|
|
1988
|
-
|
|
1989
|
-
def path_menu(
|
|
1990
|
-
self,
|
|
1991
|
-
searchpaths: list[str],
|
|
1992
|
-
operator: str,
|
|
1993
|
-
*,
|
|
1994
|
-
props_default: dict = None,
|
|
1995
|
-
prop_filepath: str | None = "filepath",
|
|
1996
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1997
|
-
filter_path=None,
|
|
1998
|
-
display_name: collections.abc.Callable | None = None,
|
|
1999
|
-
add_operator=None,
|
|
2000
|
-
add_operator_props=None,
|
|
2001
|
-
):
|
|
2002
|
-
"""Populate a menu from a list of paths.
|
|
2003
|
-
|
|
2004
|
-
:param searchpaths: Paths to scan.
|
|
2005
|
-
:type searchpaths: list[str]
|
|
2006
|
-
:param operator: The operator id to use with each file.
|
|
2007
|
-
:type operator: str
|
|
2008
|
-
:param props_default: Properties to assign to each operator.
|
|
2009
|
-
:type props_default: dict
|
|
2010
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2011
|
-
:type prop_filepath: str | None
|
|
2012
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2013
|
-
|
|
2014
|
-
Returning false excludes the file from the list.
|
|
2015
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2016
|
-
:param filter_path:
|
|
2017
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2018
|
-
:type display_name: collections.abc.Callable | None
|
|
2019
|
-
:param add_operator:
|
|
2020
|
-
:param add_operator_props:
|
|
2021
|
-
"""
|
|
2022
|
-
...
|
|
2023
|
-
|
|
2024
|
-
def path_resolve(self):
|
|
2025
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2026
|
-
...
|
|
2027
|
-
|
|
2028
|
-
def pop(self):
|
|
2029
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2030
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2031
|
-
|
|
2032
|
-
"""
|
|
2033
|
-
...
|
|
2034
|
-
|
|
2035
|
-
def prepend(self, draw_func):
|
|
2036
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2037
|
-
the menus draw function
|
|
2038
|
-
|
|
2039
|
-
:param draw_func:
|
|
2040
|
-
"""
|
|
2041
|
-
...
|
|
2042
|
-
|
|
2043
|
-
def property_overridable_library_set(self) -> bool:
|
|
2044
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2045
|
-
|
|
2046
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2047
|
-
:rtype: bool
|
|
2048
|
-
"""
|
|
2049
|
-
...
|
|
2050
|
-
|
|
2051
|
-
def property_unset(self):
|
|
2052
|
-
"""Unset a property, will use default value afterward."""
|
|
2053
|
-
...
|
|
2054
|
-
|
|
2055
|
-
def remove(self, draw_func):
|
|
2056
|
-
"""Remove a draw function that has been added to this menu
|
|
2057
|
-
|
|
2058
|
-
:param draw_func:
|
|
2059
|
-
"""
|
|
2060
|
-
...
|
|
2061
|
-
|
|
2062
|
-
def type_recast(self):
|
|
2063
|
-
"""Return a new instance, this is needed because types
|
|
2064
|
-
such as textures can be changed at runtime.
|
|
2065
|
-
|
|
2066
|
-
:return: a new instance of this object with the type initialized again.
|
|
2067
|
-
"""
|
|
2068
|
-
...
|
|
2069
|
-
|
|
2070
|
-
def values(self):
|
|
2071
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2072
|
-
dictionary function of the same name).
|
|
2073
|
-
|
|
2074
|
-
:return: custom property values.
|
|
2075
|
-
"""
|
|
2076
|
-
...
|
|
2077
|
-
|
|
2078
|
-
class TEXT_MT_templates(bpy_types._GenericUI):
|
|
2079
|
-
bl_label: typing.Any
|
|
2080
|
-
bl_rna: typing.Any
|
|
2081
|
-
id_data: typing.Any
|
|
2082
|
-
|
|
2083
|
-
def append(self, draw_func):
|
|
2084
|
-
"""Append a draw function to this menu,
|
|
2085
|
-
takes the same arguments as the menus draw function
|
|
2086
|
-
|
|
2087
|
-
:param draw_func:
|
|
2088
|
-
"""
|
|
2089
|
-
...
|
|
2090
|
-
|
|
2091
|
-
def as_pointer(self) -> int:
|
|
2092
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2093
|
-
|
|
2094
|
-
:return: int (memory address).
|
|
2095
|
-
:rtype: int
|
|
2096
|
-
"""
|
|
2097
|
-
...
|
|
2098
|
-
|
|
2099
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2100
|
-
"""
|
|
2101
|
-
|
|
2102
|
-
:return: The RNA type or default when not found.
|
|
2103
|
-
:rtype: bpy.types.Struct
|
|
2104
|
-
"""
|
|
2105
|
-
...
|
|
2106
|
-
|
|
2107
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2108
|
-
"""
|
|
2109
|
-
|
|
2110
|
-
:return: The class or default when not found.
|
|
2111
|
-
:rtype: typing.Any
|
|
2112
|
-
"""
|
|
2113
|
-
...
|
|
2114
|
-
|
|
2115
|
-
def draw(self, _context):
|
|
2116
|
-
"""
|
|
2117
|
-
|
|
2118
|
-
:param _context:
|
|
2119
|
-
"""
|
|
2120
|
-
...
|
|
2121
|
-
|
|
2122
|
-
def draw_collapsible(self, context, layout):
|
|
2123
|
-
"""
|
|
2124
|
-
|
|
2125
|
-
:param context:
|
|
2126
|
-
:param layout:
|
|
2127
|
-
"""
|
|
2128
|
-
...
|
|
2129
|
-
|
|
2130
|
-
def draw_preset(self, _context):
|
|
2131
|
-
"""Define these on the subclass:
|
|
2132
|
-
- preset_operator (string)
|
|
2133
|
-
- preset_subdir (string)Optionally:
|
|
2134
|
-
- preset_add_operator (string)
|
|
2135
|
-
- preset_extensions (set of strings)
|
|
2136
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2137
|
-
|
|
2138
|
-
:param _context:
|
|
2139
|
-
"""
|
|
2140
|
-
...
|
|
2141
|
-
|
|
2142
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2143
|
-
"""Adds driver(s) to the given property
|
|
2144
|
-
|
|
2145
|
-
:return: The driver(s) added.
|
|
2146
|
-
:rtype: bpy.types.FCurve
|
|
2147
|
-
"""
|
|
2148
|
-
...
|
|
2149
|
-
|
|
2150
|
-
def driver_remove(self) -> bool:
|
|
2151
|
-
"""Remove driver(s) from the given property
|
|
2152
|
-
|
|
2153
|
-
:return: Success of driver removal.
|
|
2154
|
-
:rtype: bool
|
|
2155
|
-
"""
|
|
2156
|
-
...
|
|
2157
|
-
|
|
2158
|
-
def get(self):
|
|
2159
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2160
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2161
|
-
|
|
2162
|
-
"""
|
|
2163
|
-
...
|
|
2164
|
-
|
|
2165
|
-
def id_properties_clear(self):
|
|
2166
|
-
"""
|
|
2167
|
-
|
|
2168
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2169
|
-
"""
|
|
2170
|
-
...
|
|
2171
|
-
|
|
2172
|
-
def id_properties_ensure(self):
|
|
2173
|
-
"""
|
|
2174
|
-
|
|
2175
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2176
|
-
"""
|
|
2177
|
-
...
|
|
2178
|
-
|
|
2179
|
-
def id_properties_ui(self):
|
|
2180
|
-
"""
|
|
2181
|
-
|
|
2182
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2183
|
-
"""
|
|
2184
|
-
...
|
|
2185
|
-
|
|
2186
|
-
def is_extended(self): ...
|
|
2187
|
-
def is_property_hidden(self) -> bool:
|
|
2188
|
-
"""Check if a property is hidden.
|
|
2189
|
-
|
|
2190
|
-
:return: True when the property is hidden.
|
|
2191
|
-
:rtype: bool
|
|
2192
|
-
"""
|
|
2193
|
-
...
|
|
2194
|
-
|
|
2195
|
-
def is_property_overridable_library(self) -> bool:
|
|
2196
|
-
"""Check if a property is overridable.
|
|
2197
|
-
|
|
2198
|
-
:return: True when the property is overridable.
|
|
2199
|
-
:rtype: bool
|
|
2200
|
-
"""
|
|
2201
|
-
...
|
|
2202
|
-
|
|
2203
|
-
def is_property_readonly(self) -> bool:
|
|
2204
|
-
"""Check if a property is readonly.
|
|
2205
|
-
|
|
2206
|
-
:return: True when the property is readonly (not writable).
|
|
2207
|
-
:rtype: bool
|
|
2208
|
-
"""
|
|
2209
|
-
...
|
|
2210
|
-
|
|
2211
|
-
def is_property_set(self) -> bool:
|
|
2212
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2213
|
-
|
|
2214
|
-
:return: True when the property has been set.
|
|
2215
|
-
:rtype: bool
|
|
2216
|
-
"""
|
|
2217
|
-
...
|
|
2218
|
-
|
|
2219
|
-
def items(self):
|
|
2220
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2221
|
-
dictionary function of the same name).
|
|
2222
|
-
|
|
2223
|
-
:return: custom property key, value pairs.
|
|
2224
|
-
"""
|
|
2225
|
-
...
|
|
2226
|
-
|
|
2227
|
-
def keyframe_delete(self) -> bool:
|
|
2228
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2229
|
-
|
|
2230
|
-
:return: Success of keyframe deletion.
|
|
2231
|
-
:rtype: bool
|
|
2232
|
-
"""
|
|
2233
|
-
...
|
|
2234
|
-
|
|
2235
|
-
def keyframe_insert(self) -> bool:
|
|
2236
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2237
|
-
|
|
2238
|
-
:return: Success of keyframe insertion.
|
|
2239
|
-
:rtype: bool
|
|
2240
|
-
"""
|
|
2241
|
-
...
|
|
2242
|
-
|
|
2243
|
-
def keys(self):
|
|
2244
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2245
|
-
dictionary function of the same name).
|
|
2246
|
-
|
|
2247
|
-
:return: custom property keys.
|
|
2248
|
-
"""
|
|
2249
|
-
...
|
|
2250
|
-
|
|
2251
|
-
def path_from_id(self) -> str:
|
|
2252
|
-
"""Returns the data path from the ID to this object (string).
|
|
2253
|
-
|
|
2254
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2255
|
-
to this struct and property (when given).
|
|
2256
|
-
:rtype: str
|
|
2257
|
-
"""
|
|
2258
|
-
...
|
|
2259
|
-
|
|
2260
|
-
def path_menu(
|
|
2261
|
-
self,
|
|
2262
|
-
searchpaths: list[str],
|
|
2263
|
-
operator: str,
|
|
2264
|
-
*,
|
|
2265
|
-
props_default: dict = None,
|
|
2266
|
-
prop_filepath: str | None = "filepath",
|
|
2267
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2268
|
-
filter_path=None,
|
|
2269
|
-
display_name: collections.abc.Callable | None = None,
|
|
2270
|
-
add_operator=None,
|
|
2271
|
-
add_operator_props=None,
|
|
2272
|
-
):
|
|
2273
|
-
"""Populate a menu from a list of paths.
|
|
2274
|
-
|
|
2275
|
-
:param searchpaths: Paths to scan.
|
|
2276
|
-
:type searchpaths: list[str]
|
|
2277
|
-
:param operator: The operator id to use with each file.
|
|
2278
|
-
:type operator: str
|
|
2279
|
-
:param props_default: Properties to assign to each operator.
|
|
2280
|
-
:type props_default: dict
|
|
2281
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2282
|
-
:type prop_filepath: str | None
|
|
2283
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2284
|
-
|
|
2285
|
-
Returning false excludes the file from the list.
|
|
2286
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2287
|
-
:param filter_path:
|
|
2288
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2289
|
-
:type display_name: collections.abc.Callable | None
|
|
2290
|
-
:param add_operator:
|
|
2291
|
-
:param add_operator_props:
|
|
2292
|
-
"""
|
|
2293
|
-
...
|
|
2294
|
-
|
|
2295
|
-
def path_resolve(self):
|
|
2296
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2297
|
-
...
|
|
2298
|
-
|
|
2299
|
-
def pop(self):
|
|
2300
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2301
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2302
|
-
|
|
2303
|
-
"""
|
|
2304
|
-
...
|
|
2305
|
-
|
|
2306
|
-
def prepend(self, draw_func):
|
|
2307
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2308
|
-
the menus draw function
|
|
2309
|
-
|
|
2310
|
-
:param draw_func:
|
|
2311
|
-
"""
|
|
2312
|
-
...
|
|
2313
|
-
|
|
2314
|
-
def property_overridable_library_set(self) -> bool:
|
|
2315
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2316
|
-
|
|
2317
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2318
|
-
:rtype: bool
|
|
2319
|
-
"""
|
|
2320
|
-
...
|
|
2321
|
-
|
|
2322
|
-
def property_unset(self):
|
|
2323
|
-
"""Unset a property, will use default value afterward."""
|
|
2324
|
-
...
|
|
2325
|
-
|
|
2326
|
-
def remove(self, draw_func):
|
|
2327
|
-
"""Remove a draw function that has been added to this menu
|
|
2328
|
-
|
|
2329
|
-
:param draw_func:
|
|
2330
|
-
"""
|
|
2331
|
-
...
|
|
2332
|
-
|
|
2333
|
-
def type_recast(self):
|
|
2334
|
-
"""Return a new instance, this is needed because types
|
|
2335
|
-
such as textures can be changed at runtime.
|
|
2336
|
-
|
|
2337
|
-
:return: a new instance of this object with the type initialized again.
|
|
2338
|
-
"""
|
|
2339
|
-
...
|
|
2340
|
-
|
|
2341
|
-
def values(self):
|
|
2342
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2343
|
-
dictionary function of the same name).
|
|
2344
|
-
|
|
2345
|
-
:return: custom property values.
|
|
2346
|
-
"""
|
|
2347
|
-
...
|
|
2348
|
-
|
|
2349
|
-
class TEXT_MT_templates_osl(bpy_types._GenericUI):
|
|
2350
|
-
bl_label: typing.Any
|
|
2351
|
-
bl_rna: typing.Any
|
|
2352
|
-
id_data: typing.Any
|
|
2353
|
-
|
|
2354
|
-
def append(self, draw_func):
|
|
2355
|
-
"""Append a draw function to this menu,
|
|
2356
|
-
takes the same arguments as the menus draw function
|
|
2357
|
-
|
|
2358
|
-
:param draw_func:
|
|
2359
|
-
"""
|
|
2360
|
-
...
|
|
2361
|
-
|
|
2362
|
-
def as_pointer(self) -> int:
|
|
2363
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2364
|
-
|
|
2365
|
-
:return: int (memory address).
|
|
2366
|
-
:rtype: int
|
|
2367
|
-
"""
|
|
2368
|
-
...
|
|
2369
|
-
|
|
2370
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2371
|
-
"""
|
|
2372
|
-
|
|
2373
|
-
:return: The RNA type or default when not found.
|
|
2374
|
-
:rtype: bpy.types.Struct
|
|
2375
|
-
"""
|
|
2376
|
-
...
|
|
2377
|
-
|
|
2378
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2379
|
-
"""
|
|
2380
|
-
|
|
2381
|
-
:return: The class or default when not found.
|
|
2382
|
-
:rtype: typing.Any
|
|
2383
|
-
"""
|
|
2384
|
-
...
|
|
2385
|
-
|
|
2386
|
-
def draw(self, _context):
|
|
2387
|
-
"""
|
|
2388
|
-
|
|
2389
|
-
:param _context:
|
|
2390
|
-
"""
|
|
2391
|
-
...
|
|
2392
|
-
|
|
2393
|
-
def draw_collapsible(self, context, layout):
|
|
2394
|
-
"""
|
|
2395
|
-
|
|
2396
|
-
:param context:
|
|
2397
|
-
:param layout:
|
|
2398
|
-
"""
|
|
2399
|
-
...
|
|
2400
|
-
|
|
2401
|
-
def draw_preset(self, _context):
|
|
2402
|
-
"""Define these on the subclass:
|
|
2403
|
-
- preset_operator (string)
|
|
2404
|
-
- preset_subdir (string)Optionally:
|
|
2405
|
-
- preset_add_operator (string)
|
|
2406
|
-
- preset_extensions (set of strings)
|
|
2407
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2408
|
-
|
|
2409
|
-
:param _context:
|
|
2410
|
-
"""
|
|
2411
|
-
...
|
|
2412
|
-
|
|
2413
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2414
|
-
"""Adds driver(s) to the given property
|
|
2415
|
-
|
|
2416
|
-
:return: The driver(s) added.
|
|
2417
|
-
:rtype: bpy.types.FCurve
|
|
2418
|
-
"""
|
|
2419
|
-
...
|
|
2420
|
-
|
|
2421
|
-
def driver_remove(self) -> bool:
|
|
2422
|
-
"""Remove driver(s) from the given property
|
|
2423
|
-
|
|
2424
|
-
:return: Success of driver removal.
|
|
2425
|
-
:rtype: bool
|
|
2426
|
-
"""
|
|
2427
|
-
...
|
|
2428
|
-
|
|
2429
|
-
def get(self):
|
|
2430
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2431
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2432
|
-
|
|
2433
|
-
"""
|
|
2434
|
-
...
|
|
2435
|
-
|
|
2436
|
-
def id_properties_clear(self):
|
|
2437
|
-
"""
|
|
2438
|
-
|
|
2439
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2440
|
-
"""
|
|
2441
|
-
...
|
|
2442
|
-
|
|
2443
|
-
def id_properties_ensure(self):
|
|
2444
|
-
"""
|
|
2445
|
-
|
|
2446
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2447
|
-
"""
|
|
2448
|
-
...
|
|
2449
|
-
|
|
2450
|
-
def id_properties_ui(self):
|
|
2451
|
-
"""
|
|
2452
|
-
|
|
2453
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2454
|
-
"""
|
|
2455
|
-
...
|
|
2456
|
-
|
|
2457
|
-
def is_extended(self): ...
|
|
2458
|
-
def is_property_hidden(self) -> bool:
|
|
2459
|
-
"""Check if a property is hidden.
|
|
2460
|
-
|
|
2461
|
-
:return: True when the property is hidden.
|
|
2462
|
-
:rtype: bool
|
|
2463
|
-
"""
|
|
2464
|
-
...
|
|
2465
|
-
|
|
2466
|
-
def is_property_overridable_library(self) -> bool:
|
|
2467
|
-
"""Check if a property is overridable.
|
|
2468
|
-
|
|
2469
|
-
:return: True when the property is overridable.
|
|
2470
|
-
:rtype: bool
|
|
2471
|
-
"""
|
|
2472
|
-
...
|
|
2473
|
-
|
|
2474
|
-
def is_property_readonly(self) -> bool:
|
|
2475
|
-
"""Check if a property is readonly.
|
|
2476
|
-
|
|
2477
|
-
:return: True when the property is readonly (not writable).
|
|
2478
|
-
:rtype: bool
|
|
2479
|
-
"""
|
|
2480
|
-
...
|
|
2481
|
-
|
|
2482
|
-
def is_property_set(self) -> bool:
|
|
2483
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2484
|
-
|
|
2485
|
-
:return: True when the property has been set.
|
|
2486
|
-
:rtype: bool
|
|
2487
|
-
"""
|
|
2488
|
-
...
|
|
2489
|
-
|
|
2490
|
-
def items(self):
|
|
2491
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2492
|
-
dictionary function of the same name).
|
|
2493
|
-
|
|
2494
|
-
:return: custom property key, value pairs.
|
|
2495
|
-
"""
|
|
2496
|
-
...
|
|
2497
|
-
|
|
2498
|
-
def keyframe_delete(self) -> bool:
|
|
2499
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2500
|
-
|
|
2501
|
-
:return: Success of keyframe deletion.
|
|
2502
|
-
:rtype: bool
|
|
2503
|
-
"""
|
|
2504
|
-
...
|
|
2505
|
-
|
|
2506
|
-
def keyframe_insert(self) -> bool:
|
|
2507
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2508
|
-
|
|
2509
|
-
:return: Success of keyframe insertion.
|
|
2510
|
-
:rtype: bool
|
|
2511
|
-
"""
|
|
2512
|
-
...
|
|
2513
|
-
|
|
2514
|
-
def keys(self):
|
|
2515
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2516
|
-
dictionary function of the same name).
|
|
2517
|
-
|
|
2518
|
-
:return: custom property keys.
|
|
2519
|
-
"""
|
|
2520
|
-
...
|
|
2521
|
-
|
|
2522
|
-
def path_from_id(self) -> str:
|
|
2523
|
-
"""Returns the data path from the ID to this object (string).
|
|
2524
|
-
|
|
2525
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2526
|
-
to this struct and property (when given).
|
|
2527
|
-
:rtype: str
|
|
2528
|
-
"""
|
|
2529
|
-
...
|
|
2530
|
-
|
|
2531
|
-
def path_menu(
|
|
2532
|
-
self,
|
|
2533
|
-
searchpaths: list[str],
|
|
2534
|
-
operator: str,
|
|
2535
|
-
*,
|
|
2536
|
-
props_default: dict = None,
|
|
2537
|
-
prop_filepath: str | None = "filepath",
|
|
2538
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2539
|
-
filter_path=None,
|
|
2540
|
-
display_name: collections.abc.Callable | None = None,
|
|
2541
|
-
add_operator=None,
|
|
2542
|
-
add_operator_props=None,
|
|
2543
|
-
):
|
|
2544
|
-
"""Populate a menu from a list of paths.
|
|
2545
|
-
|
|
2546
|
-
:param searchpaths: Paths to scan.
|
|
2547
|
-
:type searchpaths: list[str]
|
|
2548
|
-
:param operator: The operator id to use with each file.
|
|
2549
|
-
:type operator: str
|
|
2550
|
-
:param props_default: Properties to assign to each operator.
|
|
2551
|
-
:type props_default: dict
|
|
2552
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2553
|
-
:type prop_filepath: str | None
|
|
2554
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2555
|
-
|
|
2556
|
-
Returning false excludes the file from the list.
|
|
2557
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2558
|
-
:param filter_path:
|
|
2559
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2560
|
-
:type display_name: collections.abc.Callable | None
|
|
2561
|
-
:param add_operator:
|
|
2562
|
-
:param add_operator_props:
|
|
2563
|
-
"""
|
|
2564
|
-
...
|
|
2565
|
-
|
|
2566
|
-
def path_resolve(self):
|
|
2567
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2568
|
-
...
|
|
2569
|
-
|
|
2570
|
-
def pop(self):
|
|
2571
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2572
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2573
|
-
|
|
2574
|
-
"""
|
|
2575
|
-
...
|
|
2576
|
-
|
|
2577
|
-
def prepend(self, draw_func):
|
|
2578
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2579
|
-
the menus draw function
|
|
2580
|
-
|
|
2581
|
-
:param draw_func:
|
|
2582
|
-
"""
|
|
2583
|
-
...
|
|
2584
|
-
|
|
2585
|
-
def property_overridable_library_set(self) -> bool:
|
|
2586
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2587
|
-
|
|
2588
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2589
|
-
:rtype: bool
|
|
2590
|
-
"""
|
|
2591
|
-
...
|
|
2592
|
-
|
|
2593
|
-
def property_unset(self):
|
|
2594
|
-
"""Unset a property, will use default value afterward."""
|
|
2595
|
-
...
|
|
2596
|
-
|
|
2597
|
-
def remove(self, draw_func):
|
|
2598
|
-
"""Remove a draw function that has been added to this menu
|
|
2599
|
-
|
|
2600
|
-
:param draw_func:
|
|
2601
|
-
"""
|
|
2602
|
-
...
|
|
2603
|
-
|
|
2604
|
-
def type_recast(self):
|
|
2605
|
-
"""Return a new instance, this is needed because types
|
|
2606
|
-
such as textures can be changed at runtime.
|
|
2607
|
-
|
|
2608
|
-
:return: a new instance of this object with the type initialized again.
|
|
2609
|
-
"""
|
|
2610
|
-
...
|
|
2611
|
-
|
|
2612
|
-
def values(self):
|
|
2613
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2614
|
-
dictionary function of the same name).
|
|
2615
|
-
|
|
2616
|
-
:return: custom property values.
|
|
2617
|
-
"""
|
|
2618
|
-
...
|
|
2619
|
-
|
|
2620
|
-
class TEXT_MT_templates_py(bpy_types._GenericUI):
|
|
2621
|
-
bl_label: typing.Any
|
|
2622
|
-
bl_rna: typing.Any
|
|
2623
|
-
id_data: typing.Any
|
|
2624
|
-
|
|
2625
|
-
def append(self, draw_func):
|
|
2626
|
-
"""Append a draw function to this menu,
|
|
2627
|
-
takes the same arguments as the menus draw function
|
|
2628
|
-
|
|
2629
|
-
:param draw_func:
|
|
2630
|
-
"""
|
|
2631
|
-
...
|
|
2632
|
-
|
|
2633
|
-
def as_pointer(self) -> int:
|
|
2634
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2635
|
-
|
|
2636
|
-
:return: int (memory address).
|
|
2637
|
-
:rtype: int
|
|
2638
|
-
"""
|
|
2639
|
-
...
|
|
2640
|
-
|
|
2641
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2642
|
-
"""
|
|
2643
|
-
|
|
2644
|
-
:return: The RNA type or default when not found.
|
|
2645
|
-
:rtype: bpy.types.Struct
|
|
2646
|
-
"""
|
|
2647
|
-
...
|
|
2648
|
-
|
|
2649
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2650
|
-
"""
|
|
2651
|
-
|
|
2652
|
-
:return: The class or default when not found.
|
|
2653
|
-
:rtype: typing.Any
|
|
2654
|
-
"""
|
|
2655
|
-
...
|
|
2656
|
-
|
|
2657
|
-
def draw(self, _context):
|
|
2658
|
-
"""
|
|
2659
|
-
|
|
2660
|
-
:param _context:
|
|
2661
|
-
"""
|
|
2662
|
-
...
|
|
2663
|
-
|
|
2664
|
-
def draw_collapsible(self, context, layout):
|
|
2665
|
-
"""
|
|
2666
|
-
|
|
2667
|
-
:param context:
|
|
2668
|
-
:param layout:
|
|
2669
|
-
"""
|
|
2670
|
-
...
|
|
2671
|
-
|
|
2672
|
-
def draw_preset(self, _context):
|
|
2673
|
-
"""Define these on the subclass:
|
|
2674
|
-
- preset_operator (string)
|
|
2675
|
-
- preset_subdir (string)Optionally:
|
|
2676
|
-
- preset_add_operator (string)
|
|
2677
|
-
- preset_extensions (set of strings)
|
|
2678
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2679
|
-
|
|
2680
|
-
:param _context:
|
|
2681
|
-
"""
|
|
2682
|
-
...
|
|
2683
|
-
|
|
2684
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2685
|
-
"""Adds driver(s) to the given property
|
|
2686
|
-
|
|
2687
|
-
:return: The driver(s) added.
|
|
2688
|
-
:rtype: bpy.types.FCurve
|
|
2689
|
-
"""
|
|
2690
|
-
...
|
|
2691
|
-
|
|
2692
|
-
def driver_remove(self) -> bool:
|
|
2693
|
-
"""Remove driver(s) from the given property
|
|
2694
|
-
|
|
2695
|
-
:return: Success of driver removal.
|
|
2696
|
-
:rtype: bool
|
|
2697
|
-
"""
|
|
2698
|
-
...
|
|
2699
|
-
|
|
2700
|
-
def get(self):
|
|
2701
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2702
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2703
|
-
|
|
2704
|
-
"""
|
|
2705
|
-
...
|
|
2706
|
-
|
|
2707
|
-
def id_properties_clear(self):
|
|
2708
|
-
"""
|
|
2709
|
-
|
|
2710
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2711
|
-
"""
|
|
2712
|
-
...
|
|
2713
|
-
|
|
2714
|
-
def id_properties_ensure(self):
|
|
2715
|
-
"""
|
|
2716
|
-
|
|
2717
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2718
|
-
"""
|
|
2719
|
-
...
|
|
2720
|
-
|
|
2721
|
-
def id_properties_ui(self):
|
|
2722
|
-
"""
|
|
2723
|
-
|
|
2724
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2725
|
-
"""
|
|
2726
|
-
...
|
|
2727
|
-
|
|
2728
|
-
def is_extended(self): ...
|
|
2729
|
-
def is_property_hidden(self) -> bool:
|
|
2730
|
-
"""Check if a property is hidden.
|
|
2731
|
-
|
|
2732
|
-
:return: True when the property is hidden.
|
|
2733
|
-
:rtype: bool
|
|
2734
|
-
"""
|
|
2735
|
-
...
|
|
2736
|
-
|
|
2737
|
-
def is_property_overridable_library(self) -> bool:
|
|
2738
|
-
"""Check if a property is overridable.
|
|
2739
|
-
|
|
2740
|
-
:return: True when the property is overridable.
|
|
2741
|
-
:rtype: bool
|
|
2742
|
-
"""
|
|
2743
|
-
...
|
|
2744
|
-
|
|
2745
|
-
def is_property_readonly(self) -> bool:
|
|
2746
|
-
"""Check if a property is readonly.
|
|
2747
|
-
|
|
2748
|
-
:return: True when the property is readonly (not writable).
|
|
2749
|
-
:rtype: bool
|
|
2750
|
-
"""
|
|
2751
|
-
...
|
|
2752
|
-
|
|
2753
|
-
def is_property_set(self) -> bool:
|
|
2754
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2755
|
-
|
|
2756
|
-
:return: True when the property has been set.
|
|
2757
|
-
:rtype: bool
|
|
2758
|
-
"""
|
|
2759
|
-
...
|
|
2760
|
-
|
|
2761
|
-
def items(self):
|
|
2762
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2763
|
-
dictionary function of the same name).
|
|
2764
|
-
|
|
2765
|
-
:return: custom property key, value pairs.
|
|
2766
|
-
"""
|
|
2767
|
-
...
|
|
2768
|
-
|
|
2769
|
-
def keyframe_delete(self) -> bool:
|
|
2770
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2771
|
-
|
|
2772
|
-
:return: Success of keyframe deletion.
|
|
2773
|
-
:rtype: bool
|
|
2774
|
-
"""
|
|
2775
|
-
...
|
|
2776
|
-
|
|
2777
|
-
def keyframe_insert(self) -> bool:
|
|
2778
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2779
|
-
|
|
2780
|
-
:return: Success of keyframe insertion.
|
|
2781
|
-
:rtype: bool
|
|
2782
|
-
"""
|
|
2783
|
-
...
|
|
2784
|
-
|
|
2785
|
-
def keys(self):
|
|
2786
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2787
|
-
dictionary function of the same name).
|
|
2788
|
-
|
|
2789
|
-
:return: custom property keys.
|
|
2790
|
-
"""
|
|
2791
|
-
...
|
|
2792
|
-
|
|
2793
|
-
def path_from_id(self) -> str:
|
|
2794
|
-
"""Returns the data path from the ID to this object (string).
|
|
2795
|
-
|
|
2796
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2797
|
-
to this struct and property (when given).
|
|
2798
|
-
:rtype: str
|
|
2799
|
-
"""
|
|
2800
|
-
...
|
|
2801
|
-
|
|
2802
|
-
def path_menu(
|
|
2803
|
-
self,
|
|
2804
|
-
searchpaths: list[str],
|
|
2805
|
-
operator: str,
|
|
2806
|
-
*,
|
|
2807
|
-
props_default: dict = None,
|
|
2808
|
-
prop_filepath: str | None = "filepath",
|
|
2809
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2810
|
-
filter_path=None,
|
|
2811
|
-
display_name: collections.abc.Callable | None = None,
|
|
2812
|
-
add_operator=None,
|
|
2813
|
-
add_operator_props=None,
|
|
2814
|
-
):
|
|
2815
|
-
"""Populate a menu from a list of paths.
|
|
2816
|
-
|
|
2817
|
-
:param searchpaths: Paths to scan.
|
|
2818
|
-
:type searchpaths: list[str]
|
|
2819
|
-
:param operator: The operator id to use with each file.
|
|
2820
|
-
:type operator: str
|
|
2821
|
-
:param props_default: Properties to assign to each operator.
|
|
2822
|
-
:type props_default: dict
|
|
2823
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2824
|
-
:type prop_filepath: str | None
|
|
2825
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2826
|
-
|
|
2827
|
-
Returning false excludes the file from the list.
|
|
2828
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2829
|
-
:param filter_path:
|
|
2830
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2831
|
-
:type display_name: collections.abc.Callable | None
|
|
2832
|
-
:param add_operator:
|
|
2833
|
-
:param add_operator_props:
|
|
2834
|
-
"""
|
|
2835
|
-
...
|
|
2836
|
-
|
|
2837
|
-
def path_resolve(self):
|
|
2838
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2839
|
-
...
|
|
2840
|
-
|
|
2841
|
-
def pop(self):
|
|
2842
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2843
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2844
|
-
|
|
2845
|
-
"""
|
|
2846
|
-
...
|
|
2847
|
-
|
|
2848
|
-
def prepend(self, draw_func):
|
|
2849
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2850
|
-
the menus draw function
|
|
2851
|
-
|
|
2852
|
-
:param draw_func:
|
|
2853
|
-
"""
|
|
2854
|
-
...
|
|
2855
|
-
|
|
2856
|
-
def property_overridable_library_set(self) -> bool:
|
|
2857
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2858
|
-
|
|
2859
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2860
|
-
:rtype: bool
|
|
2861
|
-
"""
|
|
2862
|
-
...
|
|
2863
|
-
|
|
2864
|
-
def property_unset(self):
|
|
2865
|
-
"""Unset a property, will use default value afterward."""
|
|
2866
|
-
...
|
|
2867
|
-
|
|
2868
|
-
def remove(self, draw_func):
|
|
2869
|
-
"""Remove a draw function that has been added to this menu
|
|
2870
|
-
|
|
2871
|
-
:param draw_func:
|
|
2872
|
-
"""
|
|
2873
|
-
...
|
|
2874
|
-
|
|
2875
|
-
def type_recast(self):
|
|
2876
|
-
"""Return a new instance, this is needed because types
|
|
2877
|
-
such as textures can be changed at runtime.
|
|
2878
|
-
|
|
2879
|
-
:return: a new instance of this object with the type initialized again.
|
|
2880
|
-
"""
|
|
2881
|
-
...
|
|
2882
|
-
|
|
2883
|
-
def values(self):
|
|
2884
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2885
|
-
dictionary function of the same name).
|
|
2886
|
-
|
|
2887
|
-
:return: custom property values.
|
|
2888
|
-
"""
|
|
2889
|
-
...
|
|
2890
|
-
|
|
2891
|
-
class TEXT_MT_text(bpy_types._GenericUI):
|
|
2892
|
-
bl_label: typing.Any
|
|
2893
|
-
bl_rna: typing.Any
|
|
2894
|
-
id_data: typing.Any
|
|
2895
|
-
|
|
2896
|
-
def append(self, draw_func):
|
|
2897
|
-
"""Append a draw function to this menu,
|
|
2898
|
-
takes the same arguments as the menus draw function
|
|
2899
|
-
|
|
2900
|
-
:param draw_func:
|
|
2901
|
-
"""
|
|
2902
|
-
...
|
|
2903
|
-
|
|
2904
|
-
def as_pointer(self) -> int:
|
|
2905
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2906
|
-
|
|
2907
|
-
:return: int (memory address).
|
|
2908
|
-
:rtype: int
|
|
2909
|
-
"""
|
|
2910
|
-
...
|
|
2911
|
-
|
|
2912
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2913
|
-
"""
|
|
2914
|
-
|
|
2915
|
-
:return: The RNA type or default when not found.
|
|
2916
|
-
:rtype: bpy.types.Struct
|
|
2917
|
-
"""
|
|
2918
|
-
...
|
|
2919
|
-
|
|
2920
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2921
|
-
"""
|
|
2922
|
-
|
|
2923
|
-
:return: The class or default when not found.
|
|
2924
|
-
:rtype: typing.Any
|
|
2925
|
-
"""
|
|
2926
|
-
...
|
|
2927
|
-
|
|
2928
|
-
def draw(self, context):
|
|
2929
|
-
"""
|
|
2930
|
-
|
|
2931
|
-
:param context:
|
|
2932
|
-
"""
|
|
2933
|
-
...
|
|
2934
|
-
|
|
2935
|
-
def draw_collapsible(self, context, layout):
|
|
2936
|
-
"""
|
|
2937
|
-
|
|
2938
|
-
:param context:
|
|
2939
|
-
:param layout:
|
|
2940
|
-
"""
|
|
2941
|
-
...
|
|
2942
|
-
|
|
2943
|
-
def draw_preset(self, _context):
|
|
2944
|
-
"""Define these on the subclass:
|
|
2945
|
-
- preset_operator (string)
|
|
2946
|
-
- preset_subdir (string)Optionally:
|
|
2947
|
-
- preset_add_operator (string)
|
|
2948
|
-
- preset_extensions (set of strings)
|
|
2949
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2950
|
-
|
|
2951
|
-
:param _context:
|
|
2952
|
-
"""
|
|
2953
|
-
...
|
|
2954
|
-
|
|
2955
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2956
|
-
"""Adds driver(s) to the given property
|
|
2957
|
-
|
|
2958
|
-
:return: The driver(s) added.
|
|
2959
|
-
:rtype: bpy.types.FCurve
|
|
2960
|
-
"""
|
|
2961
|
-
...
|
|
2962
|
-
|
|
2963
|
-
def driver_remove(self) -> bool:
|
|
2964
|
-
"""Remove driver(s) from the given property
|
|
2965
|
-
|
|
2966
|
-
:return: Success of driver removal.
|
|
2967
|
-
:rtype: bool
|
|
2968
|
-
"""
|
|
2969
|
-
...
|
|
2970
|
-
|
|
2971
|
-
def get(self):
|
|
2972
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2973
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2974
|
-
|
|
2975
|
-
"""
|
|
2976
|
-
...
|
|
2977
|
-
|
|
2978
|
-
def id_properties_clear(self):
|
|
2979
|
-
"""
|
|
2980
|
-
|
|
2981
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2982
|
-
"""
|
|
2983
|
-
...
|
|
2984
|
-
|
|
2985
|
-
def id_properties_ensure(self):
|
|
2986
|
-
"""
|
|
2987
|
-
|
|
2988
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2989
|
-
"""
|
|
2990
|
-
...
|
|
2991
|
-
|
|
2992
|
-
def id_properties_ui(self):
|
|
2993
|
-
"""
|
|
2994
|
-
|
|
2995
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2996
|
-
"""
|
|
2997
|
-
...
|
|
2998
|
-
|
|
2999
|
-
def is_extended(self): ...
|
|
3000
|
-
def is_property_hidden(self) -> bool:
|
|
3001
|
-
"""Check if a property is hidden.
|
|
3002
|
-
|
|
3003
|
-
:return: True when the property is hidden.
|
|
3004
|
-
:rtype: bool
|
|
3005
|
-
"""
|
|
3006
|
-
...
|
|
3007
|
-
|
|
3008
|
-
def is_property_overridable_library(self) -> bool:
|
|
3009
|
-
"""Check if a property is overridable.
|
|
3010
|
-
|
|
3011
|
-
:return: True when the property is overridable.
|
|
3012
|
-
:rtype: bool
|
|
3013
|
-
"""
|
|
3014
|
-
...
|
|
3015
|
-
|
|
3016
|
-
def is_property_readonly(self) -> bool:
|
|
3017
|
-
"""Check if a property is readonly.
|
|
3018
|
-
|
|
3019
|
-
:return: True when the property is readonly (not writable).
|
|
3020
|
-
:rtype: bool
|
|
3021
|
-
"""
|
|
3022
|
-
...
|
|
3023
|
-
|
|
3024
|
-
def is_property_set(self) -> bool:
|
|
3025
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3026
|
-
|
|
3027
|
-
:return: True when the property has been set.
|
|
3028
|
-
:rtype: bool
|
|
3029
|
-
"""
|
|
3030
|
-
...
|
|
3031
|
-
|
|
3032
|
-
def items(self):
|
|
3033
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3034
|
-
dictionary function of the same name).
|
|
3035
|
-
|
|
3036
|
-
:return: custom property key, value pairs.
|
|
3037
|
-
"""
|
|
3038
|
-
...
|
|
3039
|
-
|
|
3040
|
-
def keyframe_delete(self) -> bool:
|
|
3041
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3042
|
-
|
|
3043
|
-
:return: Success of keyframe deletion.
|
|
3044
|
-
:rtype: bool
|
|
3045
|
-
"""
|
|
3046
|
-
...
|
|
3047
|
-
|
|
3048
|
-
def keyframe_insert(self) -> bool:
|
|
3049
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3050
|
-
|
|
3051
|
-
:return: Success of keyframe insertion.
|
|
3052
|
-
:rtype: bool
|
|
3053
|
-
"""
|
|
3054
|
-
...
|
|
3055
|
-
|
|
3056
|
-
def keys(self):
|
|
3057
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3058
|
-
dictionary function of the same name).
|
|
3059
|
-
|
|
3060
|
-
:return: custom property keys.
|
|
3061
|
-
"""
|
|
3062
|
-
...
|
|
3063
|
-
|
|
3064
|
-
def path_from_id(self) -> str:
|
|
3065
|
-
"""Returns the data path from the ID to this object (string).
|
|
3066
|
-
|
|
3067
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3068
|
-
to this struct and property (when given).
|
|
3069
|
-
:rtype: str
|
|
3070
|
-
"""
|
|
3071
|
-
...
|
|
3072
|
-
|
|
3073
|
-
def path_menu(
|
|
3074
|
-
self,
|
|
3075
|
-
searchpaths: list[str],
|
|
3076
|
-
operator: str,
|
|
3077
|
-
*,
|
|
3078
|
-
props_default: dict = None,
|
|
3079
|
-
prop_filepath: str | None = "filepath",
|
|
3080
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
3081
|
-
filter_path=None,
|
|
3082
|
-
display_name: collections.abc.Callable | None = None,
|
|
3083
|
-
add_operator=None,
|
|
3084
|
-
add_operator_props=None,
|
|
3085
|
-
):
|
|
3086
|
-
"""Populate a menu from a list of paths.
|
|
3087
|
-
|
|
3088
|
-
:param searchpaths: Paths to scan.
|
|
3089
|
-
:type searchpaths: list[str]
|
|
3090
|
-
:param operator: The operator id to use with each file.
|
|
3091
|
-
:type operator: str
|
|
3092
|
-
:param props_default: Properties to assign to each operator.
|
|
3093
|
-
:type props_default: dict
|
|
3094
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3095
|
-
:type prop_filepath: str | None
|
|
3096
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
3097
|
-
|
|
3098
|
-
Returning false excludes the file from the list.
|
|
3099
|
-
:type filter_ext: collections.abc.Callable | None
|
|
3100
|
-
:param filter_path:
|
|
3101
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3102
|
-
:type display_name: collections.abc.Callable | None
|
|
3103
|
-
:param add_operator:
|
|
3104
|
-
:param add_operator_props:
|
|
3105
|
-
"""
|
|
3106
|
-
...
|
|
3107
|
-
|
|
3108
|
-
def path_resolve(self):
|
|
3109
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3110
|
-
...
|
|
3111
|
-
|
|
3112
|
-
def pop(self):
|
|
3113
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3114
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3115
|
-
|
|
3116
|
-
"""
|
|
3117
|
-
...
|
|
3118
|
-
|
|
3119
|
-
def prepend(self, draw_func):
|
|
3120
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3121
|
-
the menus draw function
|
|
3122
|
-
|
|
3123
|
-
:param draw_func:
|
|
3124
|
-
"""
|
|
3125
|
-
...
|
|
3126
|
-
|
|
3127
|
-
def property_overridable_library_set(self) -> bool:
|
|
3128
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3129
|
-
|
|
3130
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3131
|
-
:rtype: bool
|
|
3132
|
-
"""
|
|
3133
|
-
...
|
|
3134
|
-
|
|
3135
|
-
def property_unset(self):
|
|
3136
|
-
"""Unset a property, will use default value afterward."""
|
|
3137
|
-
...
|
|
3138
|
-
|
|
3139
|
-
def remove(self, draw_func):
|
|
3140
|
-
"""Remove a draw function that has been added to this menu
|
|
3141
|
-
|
|
3142
|
-
:param draw_func:
|
|
3143
|
-
"""
|
|
3144
|
-
...
|
|
3145
|
-
|
|
3146
|
-
def type_recast(self):
|
|
3147
|
-
"""Return a new instance, this is needed because types
|
|
3148
|
-
such as textures can be changed at runtime.
|
|
3149
|
-
|
|
3150
|
-
:return: a new instance of this object with the type initialized again.
|
|
3151
|
-
"""
|
|
3152
|
-
...
|
|
3153
|
-
|
|
3154
|
-
def values(self):
|
|
3155
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3156
|
-
dictionary function of the same name).
|
|
3157
|
-
|
|
3158
|
-
:return: custom property values.
|
|
3159
|
-
"""
|
|
3160
|
-
...
|
|
3161
|
-
|
|
3162
|
-
class TEXT_MT_view(bpy_types._GenericUI):
|
|
3163
|
-
bl_label: typing.Any
|
|
3164
|
-
bl_rna: typing.Any
|
|
3165
|
-
id_data: typing.Any
|
|
3166
|
-
|
|
3167
|
-
def append(self, draw_func):
|
|
3168
|
-
"""Append a draw function to this menu,
|
|
3169
|
-
takes the same arguments as the menus draw function
|
|
3170
|
-
|
|
3171
|
-
:param draw_func:
|
|
3172
|
-
"""
|
|
3173
|
-
...
|
|
3174
|
-
|
|
3175
|
-
def as_pointer(self) -> int:
|
|
3176
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3177
|
-
|
|
3178
|
-
:return: int (memory address).
|
|
3179
|
-
:rtype: int
|
|
3180
|
-
"""
|
|
3181
|
-
...
|
|
3182
|
-
|
|
3183
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3184
|
-
"""
|
|
3185
|
-
|
|
3186
|
-
:return: The RNA type or default when not found.
|
|
3187
|
-
:rtype: bpy.types.Struct
|
|
3188
|
-
"""
|
|
3189
|
-
...
|
|
3190
|
-
|
|
3191
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3192
|
-
"""
|
|
3193
|
-
|
|
3194
|
-
:return: The class or default when not found.
|
|
3195
|
-
:rtype: typing.Any
|
|
3196
|
-
"""
|
|
3197
|
-
...
|
|
3198
|
-
|
|
3199
|
-
def draw(self, context):
|
|
3200
|
-
"""
|
|
3201
|
-
|
|
3202
|
-
:param context:
|
|
3203
|
-
"""
|
|
3204
|
-
...
|
|
3205
|
-
|
|
3206
|
-
def draw_collapsible(self, context, layout):
|
|
3207
|
-
"""
|
|
3208
|
-
|
|
3209
|
-
:param context:
|
|
3210
|
-
:param layout:
|
|
3211
|
-
"""
|
|
3212
|
-
...
|
|
3213
|
-
|
|
3214
|
-
def draw_preset(self, _context):
|
|
3215
|
-
"""Define these on the subclass:
|
|
3216
|
-
- preset_operator (string)
|
|
3217
|
-
- preset_subdir (string)Optionally:
|
|
3218
|
-
- preset_add_operator (string)
|
|
3219
|
-
- preset_extensions (set of strings)
|
|
3220
|
-
- preset_operator_defaults (dict of keyword args)
|
|
3221
|
-
|
|
3222
|
-
:param _context:
|
|
3223
|
-
"""
|
|
3224
|
-
...
|
|
3225
|
-
|
|
3226
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3227
|
-
"""Adds driver(s) to the given property
|
|
3228
|
-
|
|
3229
|
-
:return: The driver(s) added.
|
|
3230
|
-
:rtype: bpy.types.FCurve
|
|
3231
|
-
"""
|
|
3232
|
-
...
|
|
3233
|
-
|
|
3234
|
-
def driver_remove(self) -> bool:
|
|
3235
|
-
"""Remove driver(s) from the given property
|
|
3236
|
-
|
|
3237
|
-
:return: Success of driver removal.
|
|
3238
|
-
:rtype: bool
|
|
3239
|
-
"""
|
|
3240
|
-
...
|
|
3241
|
-
|
|
3242
|
-
def get(self):
|
|
3243
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3244
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3245
|
-
|
|
3246
|
-
"""
|
|
3247
|
-
...
|
|
3248
|
-
|
|
3249
|
-
def id_properties_clear(self):
|
|
3250
|
-
"""
|
|
3251
|
-
|
|
3252
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3253
|
-
"""
|
|
3254
|
-
...
|
|
3255
|
-
|
|
3256
|
-
def id_properties_ensure(self):
|
|
3257
|
-
"""
|
|
3258
|
-
|
|
3259
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3260
|
-
"""
|
|
3261
|
-
...
|
|
3262
|
-
|
|
3263
|
-
def id_properties_ui(self):
|
|
3264
|
-
"""
|
|
3265
|
-
|
|
3266
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3267
|
-
"""
|
|
3268
|
-
...
|
|
3269
|
-
|
|
3270
|
-
def is_extended(self): ...
|
|
3271
|
-
def is_property_hidden(self) -> bool:
|
|
3272
|
-
"""Check if a property is hidden.
|
|
3273
|
-
|
|
3274
|
-
:return: True when the property is hidden.
|
|
3275
|
-
:rtype: bool
|
|
3276
|
-
"""
|
|
3277
|
-
...
|
|
3278
|
-
|
|
3279
|
-
def is_property_overridable_library(self) -> bool:
|
|
3280
|
-
"""Check if a property is overridable.
|
|
3281
|
-
|
|
3282
|
-
:return: True when the property is overridable.
|
|
3283
|
-
:rtype: bool
|
|
3284
|
-
"""
|
|
3285
|
-
...
|
|
3286
|
-
|
|
3287
|
-
def is_property_readonly(self) -> bool:
|
|
3288
|
-
"""Check if a property is readonly.
|
|
3289
|
-
|
|
3290
|
-
:return: True when the property is readonly (not writable).
|
|
3291
|
-
:rtype: bool
|
|
3292
|
-
"""
|
|
3293
|
-
...
|
|
3294
|
-
|
|
3295
|
-
def is_property_set(self) -> bool:
|
|
3296
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3297
|
-
|
|
3298
|
-
:return: True when the property has been set.
|
|
3299
|
-
:rtype: bool
|
|
3300
|
-
"""
|
|
3301
|
-
...
|
|
3302
|
-
|
|
3303
|
-
def items(self):
|
|
3304
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3305
|
-
dictionary function of the same name).
|
|
3306
|
-
|
|
3307
|
-
:return: custom property key, value pairs.
|
|
3308
|
-
"""
|
|
3309
|
-
...
|
|
3310
|
-
|
|
3311
|
-
def keyframe_delete(self) -> bool:
|
|
3312
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3313
|
-
|
|
3314
|
-
:return: Success of keyframe deletion.
|
|
3315
|
-
:rtype: bool
|
|
3316
|
-
"""
|
|
3317
|
-
...
|
|
3318
|
-
|
|
3319
|
-
def keyframe_insert(self) -> bool:
|
|
3320
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3321
|
-
|
|
3322
|
-
:return: Success of keyframe insertion.
|
|
3323
|
-
:rtype: bool
|
|
3324
|
-
"""
|
|
3325
|
-
...
|
|
3326
|
-
|
|
3327
|
-
def keys(self):
|
|
3328
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3329
|
-
dictionary function of the same name).
|
|
3330
|
-
|
|
3331
|
-
:return: custom property keys.
|
|
3332
|
-
"""
|
|
3333
|
-
...
|
|
3334
|
-
|
|
3335
|
-
def path_from_id(self) -> str:
|
|
3336
|
-
"""Returns the data path from the ID to this object (string).
|
|
3337
|
-
|
|
3338
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3339
|
-
to this struct and property (when given).
|
|
3340
|
-
:rtype: str
|
|
3341
|
-
"""
|
|
3342
|
-
...
|
|
3343
|
-
|
|
3344
|
-
def path_menu(
|
|
3345
|
-
self,
|
|
3346
|
-
searchpaths: list[str],
|
|
3347
|
-
operator: str,
|
|
3348
|
-
*,
|
|
3349
|
-
props_default: dict = None,
|
|
3350
|
-
prop_filepath: str | None = "filepath",
|
|
3351
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
3352
|
-
filter_path=None,
|
|
3353
|
-
display_name: collections.abc.Callable | None = None,
|
|
3354
|
-
add_operator=None,
|
|
3355
|
-
add_operator_props=None,
|
|
3356
|
-
):
|
|
3357
|
-
"""Populate a menu from a list of paths.
|
|
3358
|
-
|
|
3359
|
-
:param searchpaths: Paths to scan.
|
|
3360
|
-
:type searchpaths: list[str]
|
|
3361
|
-
:param operator: The operator id to use with each file.
|
|
3362
|
-
:type operator: str
|
|
3363
|
-
:param props_default: Properties to assign to each operator.
|
|
3364
|
-
:type props_default: dict
|
|
3365
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3366
|
-
:type prop_filepath: str | None
|
|
3367
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
3368
|
-
|
|
3369
|
-
Returning false excludes the file from the list.
|
|
3370
|
-
:type filter_ext: collections.abc.Callable | None
|
|
3371
|
-
:param filter_path:
|
|
3372
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3373
|
-
:type display_name: collections.abc.Callable | None
|
|
3374
|
-
:param add_operator:
|
|
3375
|
-
:param add_operator_props:
|
|
3376
|
-
"""
|
|
3377
|
-
...
|
|
3378
|
-
|
|
3379
|
-
def path_resolve(self):
|
|
3380
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3381
|
-
...
|
|
3382
|
-
|
|
3383
|
-
def pop(self):
|
|
3384
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3385
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3386
|
-
|
|
3387
|
-
"""
|
|
3388
|
-
...
|
|
3389
|
-
|
|
3390
|
-
def prepend(self, draw_func):
|
|
3391
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3392
|
-
the menus draw function
|
|
3393
|
-
|
|
3394
|
-
:param draw_func:
|
|
3395
|
-
"""
|
|
3396
|
-
...
|
|
3397
|
-
|
|
3398
|
-
def property_overridable_library_set(self) -> bool:
|
|
3399
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3400
|
-
|
|
3401
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3402
|
-
:rtype: bool
|
|
3403
|
-
"""
|
|
3404
|
-
...
|
|
3405
|
-
|
|
3406
|
-
def property_unset(self):
|
|
3407
|
-
"""Unset a property, will use default value afterward."""
|
|
3408
|
-
...
|
|
3409
|
-
|
|
3410
|
-
def remove(self, draw_func):
|
|
3411
|
-
"""Remove a draw function that has been added to this menu
|
|
3412
|
-
|
|
3413
|
-
:param draw_func:
|
|
3414
|
-
"""
|
|
3415
|
-
...
|
|
3416
|
-
|
|
3417
|
-
def type_recast(self):
|
|
3418
|
-
"""Return a new instance, this is needed because types
|
|
3419
|
-
such as textures can be changed at runtime.
|
|
3420
|
-
|
|
3421
|
-
:return: a new instance of this object with the type initialized again.
|
|
3422
|
-
"""
|
|
3423
|
-
...
|
|
3424
|
-
|
|
3425
|
-
def values(self):
|
|
3426
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3427
|
-
dictionary function of the same name).
|
|
3428
|
-
|
|
3429
|
-
:return: custom property values.
|
|
3430
|
-
"""
|
|
3431
|
-
...
|
|
3432
|
-
|
|
3433
|
-
class TEXT_MT_view_navigation(bpy_types._GenericUI):
|
|
3434
|
-
bl_label: typing.Any
|
|
3435
|
-
bl_rna: typing.Any
|
|
3436
|
-
id_data: typing.Any
|
|
3437
|
-
|
|
3438
|
-
def append(self, draw_func):
|
|
3439
|
-
"""Append a draw function to this menu,
|
|
3440
|
-
takes the same arguments as the menus draw function
|
|
3441
|
-
|
|
3442
|
-
:param draw_func:
|
|
3443
|
-
"""
|
|
3444
|
-
...
|
|
3445
|
-
|
|
3446
|
-
def as_pointer(self) -> int:
|
|
3447
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3448
|
-
|
|
3449
|
-
:return: int (memory address).
|
|
3450
|
-
:rtype: int
|
|
3451
|
-
"""
|
|
3452
|
-
...
|
|
3453
|
-
|
|
3454
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3455
|
-
"""
|
|
3456
|
-
|
|
3457
|
-
:return: The RNA type or default when not found.
|
|
3458
|
-
:rtype: bpy.types.Struct
|
|
3459
|
-
"""
|
|
3460
|
-
...
|
|
3461
|
-
|
|
3462
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3463
|
-
"""
|
|
3464
|
-
|
|
3465
|
-
:return: The class or default when not found.
|
|
3466
|
-
:rtype: typing.Any
|
|
3467
|
-
"""
|
|
3468
|
-
...
|
|
3469
|
-
|
|
3470
|
-
def draw(self, _context):
|
|
3471
|
-
"""
|
|
3472
|
-
|
|
3473
|
-
:param _context:
|
|
3474
|
-
"""
|
|
3475
|
-
...
|
|
3476
|
-
|
|
3477
|
-
def draw_collapsible(self, context, layout):
|
|
3478
|
-
"""
|
|
3479
|
-
|
|
3480
|
-
:param context:
|
|
3481
|
-
:param layout:
|
|
3482
|
-
"""
|
|
3483
|
-
...
|
|
3484
|
-
|
|
3485
|
-
def draw_preset(self, _context):
|
|
3486
|
-
"""Define these on the subclass:
|
|
3487
|
-
- preset_operator (string)
|
|
3488
|
-
- preset_subdir (string)Optionally:
|
|
3489
|
-
- preset_add_operator (string)
|
|
3490
|
-
- preset_extensions (set of strings)
|
|
3491
|
-
- preset_operator_defaults (dict of keyword args)
|
|
3492
|
-
|
|
3493
|
-
:param _context:
|
|
3494
|
-
"""
|
|
3495
|
-
...
|
|
3496
|
-
|
|
3497
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3498
|
-
"""Adds driver(s) to the given property
|
|
3499
|
-
|
|
3500
|
-
:return: The driver(s) added.
|
|
3501
|
-
:rtype: bpy.types.FCurve
|
|
3502
|
-
"""
|
|
3503
|
-
...
|
|
3504
|
-
|
|
3505
|
-
def driver_remove(self) -> bool:
|
|
3506
|
-
"""Remove driver(s) from the given property
|
|
3507
|
-
|
|
3508
|
-
:return: Success of driver removal.
|
|
3509
|
-
:rtype: bool
|
|
3510
|
-
"""
|
|
3511
|
-
...
|
|
3512
|
-
|
|
3513
|
-
def get(self):
|
|
3514
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3515
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3516
|
-
|
|
3517
|
-
"""
|
|
3518
|
-
...
|
|
3519
|
-
|
|
3520
|
-
def id_properties_clear(self):
|
|
3521
|
-
"""
|
|
3522
|
-
|
|
3523
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3524
|
-
"""
|
|
3525
|
-
...
|
|
3526
|
-
|
|
3527
|
-
def id_properties_ensure(self):
|
|
3528
|
-
"""
|
|
3529
|
-
|
|
3530
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3531
|
-
"""
|
|
3532
|
-
...
|
|
3533
|
-
|
|
3534
|
-
def id_properties_ui(self):
|
|
3535
|
-
"""
|
|
3536
|
-
|
|
3537
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3538
|
-
"""
|
|
3539
|
-
...
|
|
3540
|
-
|
|
3541
|
-
def is_extended(self): ...
|
|
3542
|
-
def is_property_hidden(self) -> bool:
|
|
3543
|
-
"""Check if a property is hidden.
|
|
3544
|
-
|
|
3545
|
-
:return: True when the property is hidden.
|
|
3546
|
-
:rtype: bool
|
|
3547
|
-
"""
|
|
3548
|
-
...
|
|
3549
|
-
|
|
3550
|
-
def is_property_overridable_library(self) -> bool:
|
|
3551
|
-
"""Check if a property is overridable.
|
|
3552
|
-
|
|
3553
|
-
:return: True when the property is overridable.
|
|
3554
|
-
:rtype: bool
|
|
3555
|
-
"""
|
|
3556
|
-
...
|
|
3557
|
-
|
|
3558
|
-
def is_property_readonly(self) -> bool:
|
|
3559
|
-
"""Check if a property is readonly.
|
|
3560
|
-
|
|
3561
|
-
:return: True when the property is readonly (not writable).
|
|
3562
|
-
:rtype: bool
|
|
3563
|
-
"""
|
|
3564
|
-
...
|
|
3565
|
-
|
|
3566
|
-
def is_property_set(self) -> bool:
|
|
3567
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3568
|
-
|
|
3569
|
-
:return: True when the property has been set.
|
|
3570
|
-
:rtype: bool
|
|
3571
|
-
"""
|
|
3572
|
-
...
|
|
3573
|
-
|
|
3574
|
-
def items(self):
|
|
3575
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3576
|
-
dictionary function of the same name).
|
|
3577
|
-
|
|
3578
|
-
:return: custom property key, value pairs.
|
|
3579
|
-
"""
|
|
3580
|
-
...
|
|
3581
|
-
|
|
3582
|
-
def keyframe_delete(self) -> bool:
|
|
3583
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3584
|
-
|
|
3585
|
-
:return: Success of keyframe deletion.
|
|
3586
|
-
:rtype: bool
|
|
3587
|
-
"""
|
|
3588
|
-
...
|
|
3589
|
-
|
|
3590
|
-
def keyframe_insert(self) -> bool:
|
|
3591
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3592
|
-
|
|
3593
|
-
:return: Success of keyframe insertion.
|
|
3594
|
-
:rtype: bool
|
|
3595
|
-
"""
|
|
3596
|
-
...
|
|
3597
|
-
|
|
3598
|
-
def keys(self):
|
|
3599
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3600
|
-
dictionary function of the same name).
|
|
3601
|
-
|
|
3602
|
-
:return: custom property keys.
|
|
3603
|
-
"""
|
|
3604
|
-
...
|
|
3605
|
-
|
|
3606
|
-
def path_from_id(self) -> str:
|
|
3607
|
-
"""Returns the data path from the ID to this object (string).
|
|
3608
|
-
|
|
3609
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3610
|
-
to this struct and property (when given).
|
|
3611
|
-
:rtype: str
|
|
3612
|
-
"""
|
|
3613
|
-
...
|
|
3614
|
-
|
|
3615
|
-
def path_menu(
|
|
3616
|
-
self,
|
|
3617
|
-
searchpaths: list[str],
|
|
3618
|
-
operator: str,
|
|
3619
|
-
*,
|
|
3620
|
-
props_default: dict = None,
|
|
3621
|
-
prop_filepath: str | None = "filepath",
|
|
3622
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
3623
|
-
filter_path=None,
|
|
3624
|
-
display_name: collections.abc.Callable | None = None,
|
|
3625
|
-
add_operator=None,
|
|
3626
|
-
add_operator_props=None,
|
|
3627
|
-
):
|
|
3628
|
-
"""Populate a menu from a list of paths.
|
|
3629
|
-
|
|
3630
|
-
:param searchpaths: Paths to scan.
|
|
3631
|
-
:type searchpaths: list[str]
|
|
3632
|
-
:param operator: The operator id to use with each file.
|
|
3633
|
-
:type operator: str
|
|
3634
|
-
:param props_default: Properties to assign to each operator.
|
|
3635
|
-
:type props_default: dict
|
|
3636
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3637
|
-
:type prop_filepath: str | None
|
|
3638
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
3639
|
-
|
|
3640
|
-
Returning false excludes the file from the list.
|
|
3641
|
-
:type filter_ext: collections.abc.Callable | None
|
|
3642
|
-
:param filter_path:
|
|
3643
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3644
|
-
:type display_name: collections.abc.Callable | None
|
|
3645
|
-
:param add_operator:
|
|
3646
|
-
:param add_operator_props:
|
|
3647
|
-
"""
|
|
3648
|
-
...
|
|
3649
|
-
|
|
3650
|
-
def path_resolve(self):
|
|
3651
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3652
|
-
...
|
|
3653
|
-
|
|
3654
|
-
def pop(self):
|
|
3655
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3656
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3657
|
-
|
|
3658
|
-
"""
|
|
3659
|
-
...
|
|
3660
|
-
|
|
3661
|
-
def prepend(self, draw_func):
|
|
3662
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3663
|
-
the menus draw function
|
|
3664
|
-
|
|
3665
|
-
:param draw_func:
|
|
3666
|
-
"""
|
|
3667
|
-
...
|
|
3668
|
-
|
|
3669
|
-
def property_overridable_library_set(self) -> bool:
|
|
3670
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3671
|
-
|
|
3672
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3673
|
-
:rtype: bool
|
|
3674
|
-
"""
|
|
3675
|
-
...
|
|
3676
|
-
|
|
3677
|
-
def property_unset(self):
|
|
3678
|
-
"""Unset a property, will use default value afterward."""
|
|
3679
|
-
...
|
|
3680
|
-
|
|
3681
|
-
def remove(self, draw_func):
|
|
3682
|
-
"""Remove a draw function that has been added to this menu
|
|
3683
|
-
|
|
3684
|
-
:param draw_func:
|
|
3685
|
-
"""
|
|
3686
|
-
...
|
|
3687
|
-
|
|
3688
|
-
def type_recast(self):
|
|
3689
|
-
"""Return a new instance, this is needed because types
|
|
3690
|
-
such as textures can be changed at runtime.
|
|
3691
|
-
|
|
3692
|
-
:return: a new instance of this object with the type initialized again.
|
|
3693
|
-
"""
|
|
3694
|
-
...
|
|
3695
|
-
|
|
3696
|
-
def values(self):
|
|
3697
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3698
|
-
dictionary function of the same name).
|
|
3699
|
-
|
|
3700
|
-
:return: custom property values.
|
|
3701
|
-
"""
|
|
3702
|
-
...
|
|
3703
|
-
|
|
3704
|
-
class TEXT_PT_find(bpy_types._GenericUI):
|
|
3705
|
-
bl_category: typing.Any
|
|
3706
|
-
bl_label: typing.Any
|
|
3707
|
-
bl_region_type: typing.Any
|
|
3708
|
-
bl_rna: typing.Any
|
|
3709
|
-
bl_space_type: typing.Any
|
|
3710
|
-
id_data: typing.Any
|
|
3711
|
-
|
|
3712
|
-
def append(self, draw_func):
|
|
3713
|
-
"""Append a draw function to this menu,
|
|
3714
|
-
takes the same arguments as the menus draw function
|
|
3715
|
-
|
|
3716
|
-
:param draw_func:
|
|
3717
|
-
"""
|
|
3718
|
-
...
|
|
3719
|
-
|
|
3720
|
-
def as_pointer(self) -> int:
|
|
3721
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3722
|
-
|
|
3723
|
-
:return: int (memory address).
|
|
3724
|
-
:rtype: int
|
|
3725
|
-
"""
|
|
3726
|
-
...
|
|
3727
|
-
|
|
3728
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3729
|
-
"""
|
|
3730
|
-
|
|
3731
|
-
:return: The RNA type or default when not found.
|
|
3732
|
-
:rtype: bpy.types.Struct
|
|
3733
|
-
"""
|
|
3734
|
-
...
|
|
3735
|
-
|
|
3736
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3737
|
-
"""
|
|
3738
|
-
|
|
3739
|
-
:return: The class or default when not found.
|
|
3740
|
-
:rtype: typing.Any
|
|
3741
|
-
"""
|
|
3742
|
-
...
|
|
3743
|
-
|
|
3744
|
-
def draw(self, context):
|
|
3745
|
-
"""
|
|
3746
|
-
|
|
3747
|
-
:param context:
|
|
3748
|
-
"""
|
|
3749
|
-
...
|
|
3750
|
-
|
|
3751
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3752
|
-
"""Adds driver(s) to the given property
|
|
3753
|
-
|
|
3754
|
-
:return: The driver(s) added.
|
|
3755
|
-
:rtype: bpy.types.FCurve
|
|
3756
|
-
"""
|
|
3757
|
-
...
|
|
3758
|
-
|
|
3759
|
-
def driver_remove(self) -> bool:
|
|
3760
|
-
"""Remove driver(s) from the given property
|
|
3761
|
-
|
|
3762
|
-
:return: Success of driver removal.
|
|
3763
|
-
:rtype: bool
|
|
3764
|
-
"""
|
|
3765
|
-
...
|
|
3766
|
-
|
|
3767
|
-
def get(self):
|
|
3768
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3769
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3770
|
-
|
|
3771
|
-
"""
|
|
3772
|
-
...
|
|
3773
|
-
|
|
3774
|
-
def id_properties_clear(self):
|
|
3775
|
-
"""
|
|
3776
|
-
|
|
3777
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3778
|
-
"""
|
|
3779
|
-
...
|
|
3780
|
-
|
|
3781
|
-
def id_properties_ensure(self):
|
|
3782
|
-
"""
|
|
3783
|
-
|
|
3784
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3785
|
-
"""
|
|
3786
|
-
...
|
|
3787
|
-
|
|
3788
|
-
def id_properties_ui(self):
|
|
3789
|
-
"""
|
|
3790
|
-
|
|
3791
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3792
|
-
"""
|
|
3793
|
-
...
|
|
3794
|
-
|
|
3795
|
-
def is_extended(self): ...
|
|
3796
|
-
def is_property_hidden(self) -> bool:
|
|
3797
|
-
"""Check if a property is hidden.
|
|
3798
|
-
|
|
3799
|
-
:return: True when the property is hidden.
|
|
3800
|
-
:rtype: bool
|
|
3801
|
-
"""
|
|
3802
|
-
...
|
|
3803
|
-
|
|
3804
|
-
def is_property_overridable_library(self) -> bool:
|
|
3805
|
-
"""Check if a property is overridable.
|
|
3806
|
-
|
|
3807
|
-
:return: True when the property is overridable.
|
|
3808
|
-
:rtype: bool
|
|
3809
|
-
"""
|
|
3810
|
-
...
|
|
3811
|
-
|
|
3812
|
-
def is_property_readonly(self) -> bool:
|
|
3813
|
-
"""Check if a property is readonly.
|
|
3814
|
-
|
|
3815
|
-
:return: True when the property is readonly (not writable).
|
|
3816
|
-
:rtype: bool
|
|
3817
|
-
"""
|
|
3818
|
-
...
|
|
3819
|
-
|
|
3820
|
-
def is_property_set(self) -> bool:
|
|
3821
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3822
|
-
|
|
3823
|
-
:return: True when the property has been set.
|
|
3824
|
-
:rtype: bool
|
|
3825
|
-
"""
|
|
3826
|
-
...
|
|
3827
|
-
|
|
3828
|
-
def items(self):
|
|
3829
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3830
|
-
dictionary function of the same name).
|
|
3831
|
-
|
|
3832
|
-
:return: custom property key, value pairs.
|
|
3833
|
-
"""
|
|
3834
|
-
...
|
|
3835
|
-
|
|
3836
|
-
def keyframe_delete(self) -> bool:
|
|
3837
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3838
|
-
|
|
3839
|
-
:return: Success of keyframe deletion.
|
|
3840
|
-
:rtype: bool
|
|
3841
|
-
"""
|
|
3842
|
-
...
|
|
3843
|
-
|
|
3844
|
-
def keyframe_insert(self) -> bool:
|
|
3845
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3846
|
-
|
|
3847
|
-
:return: Success of keyframe insertion.
|
|
3848
|
-
:rtype: bool
|
|
3849
|
-
"""
|
|
3850
|
-
...
|
|
3851
|
-
|
|
3852
|
-
def keys(self):
|
|
3853
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3854
|
-
dictionary function of the same name).
|
|
3855
|
-
|
|
3856
|
-
:return: custom property keys.
|
|
3857
|
-
"""
|
|
3858
|
-
...
|
|
3859
|
-
|
|
3860
|
-
def path_from_id(self) -> str:
|
|
3861
|
-
"""Returns the data path from the ID to this object (string).
|
|
3862
|
-
|
|
3863
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3864
|
-
to this struct and property (when given).
|
|
3865
|
-
:rtype: str
|
|
3866
|
-
"""
|
|
3867
|
-
...
|
|
3868
|
-
|
|
3869
|
-
def path_resolve(self):
|
|
3870
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3871
|
-
...
|
|
3872
|
-
|
|
3873
|
-
def pop(self):
|
|
3874
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3875
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3876
|
-
|
|
3877
|
-
"""
|
|
3878
|
-
...
|
|
3879
|
-
|
|
3880
|
-
def prepend(self, draw_func):
|
|
3881
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3882
|
-
the menus draw function
|
|
3883
|
-
|
|
3884
|
-
:param draw_func:
|
|
3885
|
-
"""
|
|
3886
|
-
...
|
|
3887
|
-
|
|
3888
|
-
def property_overridable_library_set(self) -> bool:
|
|
3889
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3890
|
-
|
|
3891
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3892
|
-
:rtype: bool
|
|
3893
|
-
"""
|
|
3894
|
-
...
|
|
3895
|
-
|
|
3896
|
-
def property_unset(self):
|
|
3897
|
-
"""Unset a property, will use default value afterward."""
|
|
3898
|
-
...
|
|
3899
|
-
|
|
3900
|
-
def remove(self, draw_func):
|
|
3901
|
-
"""Remove a draw function that has been added to this menu
|
|
3902
|
-
|
|
3903
|
-
:param draw_func:
|
|
3904
|
-
"""
|
|
3905
|
-
...
|
|
3906
|
-
|
|
3907
|
-
def type_recast(self):
|
|
3908
|
-
"""Return a new instance, this is needed because types
|
|
3909
|
-
such as textures can be changed at runtime.
|
|
3910
|
-
|
|
3911
|
-
:return: a new instance of this object with the type initialized again.
|
|
3912
|
-
"""
|
|
3913
|
-
...
|
|
3914
|
-
|
|
3915
|
-
def values(self):
|
|
3916
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3917
|
-
dictionary function of the same name).
|
|
3918
|
-
|
|
3919
|
-
:return: custom property values.
|
|
3920
|
-
"""
|
|
3921
|
-
...
|
|
3922
|
-
|
|
3923
|
-
class TEXT_PT_properties(bpy_types._GenericUI):
|
|
3924
|
-
bl_category: typing.Any
|
|
3925
|
-
bl_label: typing.Any
|
|
3926
|
-
bl_region_type: typing.Any
|
|
3927
|
-
bl_rna: typing.Any
|
|
3928
|
-
bl_space_type: typing.Any
|
|
3929
|
-
id_data: typing.Any
|
|
3930
|
-
|
|
3931
|
-
def append(self, draw_func):
|
|
3932
|
-
"""Append a draw function to this menu,
|
|
3933
|
-
takes the same arguments as the menus draw function
|
|
3934
|
-
|
|
3935
|
-
:param draw_func:
|
|
3936
|
-
"""
|
|
3937
|
-
...
|
|
3938
|
-
|
|
3939
|
-
def as_pointer(self) -> int:
|
|
3940
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3941
|
-
|
|
3942
|
-
:return: int (memory address).
|
|
3943
|
-
:rtype: int
|
|
3944
|
-
"""
|
|
3945
|
-
...
|
|
3946
|
-
|
|
3947
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3948
|
-
"""
|
|
3949
|
-
|
|
3950
|
-
:return: The RNA type or default when not found.
|
|
3951
|
-
:rtype: bpy.types.Struct
|
|
3952
|
-
"""
|
|
3953
|
-
...
|
|
3954
|
-
|
|
3955
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3956
|
-
"""
|
|
3957
|
-
|
|
3958
|
-
:return: The class or default when not found.
|
|
3959
|
-
:rtype: typing.Any
|
|
3960
|
-
"""
|
|
3961
|
-
...
|
|
3962
|
-
|
|
3963
|
-
def draw(self, context):
|
|
467
|
+
def draw(self, context):
|
|
3964
468
|
"""
|
|
3965
469
|
|
|
3966
470
|
:param context:
|
|
3967
471
|
"""
|
|
3968
472
|
...
|
|
3969
|
-
|
|
3970
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3971
|
-
"""Adds driver(s) to the given property
|
|
3972
|
-
|
|
3973
|
-
:return: The driver(s) added.
|
|
3974
|
-
:rtype: bpy.types.FCurve
|
|
3975
|
-
"""
|
|
3976
|
-
...
|
|
3977
|
-
|
|
3978
|
-
def driver_remove(self) -> bool:
|
|
3979
|
-
"""Remove driver(s) from the given property
|
|
3980
|
-
|
|
3981
|
-
:return: Success of driver removal.
|
|
3982
|
-
:rtype: bool
|
|
3983
|
-
"""
|
|
3984
|
-
...
|
|
3985
|
-
|
|
3986
|
-
def get(self):
|
|
3987
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3988
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3989
|
-
|
|
3990
|
-
"""
|
|
3991
|
-
...
|
|
3992
|
-
|
|
3993
|
-
def id_properties_clear(self):
|
|
3994
|
-
"""
|
|
3995
|
-
|
|
3996
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3997
|
-
"""
|
|
3998
|
-
...
|
|
3999
|
-
|
|
4000
|
-
def id_properties_ensure(self):
|
|
4001
|
-
"""
|
|
4002
|
-
|
|
4003
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
4004
|
-
"""
|
|
4005
|
-
...
|
|
4006
|
-
|
|
4007
|
-
def id_properties_ui(self):
|
|
4008
|
-
"""
|
|
4009
|
-
|
|
4010
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
4011
|
-
"""
|
|
4012
|
-
...
|
|
4013
|
-
|
|
4014
|
-
def is_extended(self): ...
|
|
4015
|
-
def is_property_hidden(self) -> bool:
|
|
4016
|
-
"""Check if a property is hidden.
|
|
4017
|
-
|
|
4018
|
-
:return: True when the property is hidden.
|
|
4019
|
-
:rtype: bool
|
|
4020
|
-
"""
|
|
4021
|
-
...
|
|
4022
|
-
|
|
4023
|
-
def is_property_overridable_library(self) -> bool:
|
|
4024
|
-
"""Check if a property is overridable.
|
|
4025
|
-
|
|
4026
|
-
:return: True when the property is overridable.
|
|
4027
|
-
:rtype: bool
|
|
4028
|
-
"""
|
|
4029
|
-
...
|
|
4030
|
-
|
|
4031
|
-
def is_property_readonly(self) -> bool:
|
|
4032
|
-
"""Check if a property is readonly.
|
|
4033
|
-
|
|
4034
|
-
:return: True when the property is readonly (not writable).
|
|
4035
|
-
:rtype: bool
|
|
4036
|
-
"""
|
|
4037
|
-
...
|
|
4038
|
-
|
|
4039
|
-
def is_property_set(self) -> bool:
|
|
4040
|
-
"""Check if a property is set, use for testing operator properties.
|
|
4041
|
-
|
|
4042
|
-
:return: True when the property has been set.
|
|
4043
|
-
:rtype: bool
|
|
4044
|
-
"""
|
|
4045
|
-
...
|
|
4046
|
-
|
|
4047
|
-
def items(self):
|
|
4048
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
4049
|
-
dictionary function of the same name).
|
|
4050
|
-
|
|
4051
|
-
:return: custom property key, value pairs.
|
|
4052
|
-
"""
|
|
4053
|
-
...
|
|
4054
|
-
|
|
4055
|
-
def keyframe_delete(self) -> bool:
|
|
4056
|
-
"""Remove a keyframe from this properties fcurve.
|
|
4057
|
-
|
|
4058
|
-
:return: Success of keyframe deletion.
|
|
4059
|
-
:rtype: bool
|
|
4060
|
-
"""
|
|
4061
|
-
...
|
|
4062
|
-
|
|
4063
|
-
def keyframe_insert(self) -> bool:
|
|
4064
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
4065
|
-
|
|
4066
|
-
:return: Success of keyframe insertion.
|
|
4067
|
-
:rtype: bool
|
|
4068
|
-
"""
|
|
4069
|
-
...
|
|
4070
|
-
|
|
4071
|
-
def keys(self):
|
|
4072
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
4073
|
-
dictionary function of the same name).
|
|
4074
|
-
|
|
4075
|
-
:return: custom property keys.
|
|
4076
|
-
"""
|
|
4077
|
-
...
|
|
4078
|
-
|
|
4079
|
-
def path_from_id(self) -> str:
|
|
4080
|
-
"""Returns the data path from the ID to this object (string).
|
|
4081
|
-
|
|
4082
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
4083
|
-
to this struct and property (when given).
|
|
4084
|
-
:rtype: str
|
|
4085
|
-
"""
|
|
4086
|
-
...
|
|
4087
|
-
|
|
4088
|
-
def path_resolve(self):
|
|
4089
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
4090
|
-
...
|
|
4091
|
-
|
|
4092
|
-
def pop(self):
|
|
4093
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
4094
|
-
when not found (matches Python's dictionary function of the same name).
|
|
4095
|
-
|
|
4096
|
-
"""
|
|
4097
|
-
...
|
|
4098
|
-
|
|
4099
|
-
def prepend(self, draw_func):
|
|
4100
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
4101
|
-
the menus draw function
|
|
4102
|
-
|
|
4103
|
-
:param draw_func:
|
|
4104
|
-
"""
|
|
4105
|
-
...
|
|
4106
|
-
|
|
4107
|
-
def property_overridable_library_set(self) -> bool:
|
|
4108
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
4109
|
-
|
|
4110
|
-
:return: True when the overridable status of the property was successfully set.
|
|
4111
|
-
:rtype: bool
|
|
4112
|
-
"""
|
|
4113
|
-
...
|
|
4114
|
-
|
|
4115
|
-
def property_unset(self):
|
|
4116
|
-
"""Unset a property, will use default value afterward."""
|
|
4117
|
-
...
|
|
4118
|
-
|
|
4119
|
-
def remove(self, draw_func):
|
|
4120
|
-
"""Remove a draw function that has been added to this menu
|
|
4121
|
-
|
|
4122
|
-
:param draw_func:
|
|
4123
|
-
"""
|
|
4124
|
-
...
|
|
4125
|
-
|
|
4126
|
-
def type_recast(self):
|
|
4127
|
-
"""Return a new instance, this is needed because types
|
|
4128
|
-
such as textures can be changed at runtime.
|
|
4129
|
-
|
|
4130
|
-
:return: a new instance of this object with the type initialized again.
|
|
4131
|
-
"""
|
|
4132
|
-
...
|
|
4133
|
-
|
|
4134
|
-
def values(self):
|
|
4135
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
4136
|
-
dictionary function of the same name).
|
|
4137
|
-
|
|
4138
|
-
:return: custom property values.
|
|
4139
|
-
"""
|
|
4140
|
-
...
|