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.

Files changed (120) hide show
  1. bl_operators/add_mesh_torus/__init__.pyi +1 -190
  2. bl_operators/anim/__init__.pyi +104 -1504
  3. bl_operators/assets/__init__.pyi +3 -535
  4. bl_operators/bone_selection_sets/__init__.pyi +187 -2680
  5. bl_operators/clip/__init__.pyi +144 -1894
  6. bl_operators/connect_to_output/__init__.pyi +3 -176
  7. bl_operators/console/__init__.pyi +5 -880
  8. bl_operators/constraint/__init__.pyi +4 -704
  9. bl_operators/file/__init__.pyi +3 -528
  10. bl_operators/freestyle/__init__.pyi +4 -704
  11. bl_operators/geometry_nodes/__init__.pyi +4 -704
  12. bl_operators/image/__init__.pyi +5 -869
  13. bl_operators/image_as_planes/__init__.pyi +4 -424
  14. bl_operators/mesh/__init__.pyi +3 -528
  15. bl_operators/node/__init__.pyi +159 -2065
  16. bl_operators/object/__init__.pyi +217 -2842
  17. bl_operators/object_align/__init__.pyi +1 -176
  18. bl_operators/object_quick_effects/__init__.pyi +4 -725
  19. bl_operators/object_randomize_transform/__init__.pyi +1 -176
  20. bl_operators/presets/__init__.pyi +405 -5487
  21. bl_operators/rigidbody/__init__.pyi +3 -528
  22. bl_operators/screen_play_rendered_anim/__init__.pyi +1 -176
  23. bl_operators/sequencer/__init__.pyi +119 -1507
  24. bl_operators/spreadsheet/__init__.pyi +1 -176
  25. bl_operators/userpref/__init__.pyi +383 -4757
  26. bl_operators/uvcalc_follow_active/__init__.pyi +1 -176
  27. bl_operators/uvcalc_lightmap/__init__.pyi +1 -176
  28. bl_operators/uvcalc_transform/__init__.pyi +2 -352
  29. bl_operators/vertexpaint_dirt/__init__.pyi +1 -176
  30. bl_operators/view3d/__init__.pyi +101 -1468
  31. bl_operators/wm/__init__.pyi +723 -8894
  32. bl_operators/world/__init__.pyi +1 -176
  33. bl_ui/__init__.pyi +3 -534
  34. bl_ui/anim/__init__.pyi +1 -244
  35. bl_ui/asset_shelf/__init__.pyi +1 -189
  36. bl_ui/generic_ui_list/__init__.pyi +3 -594
  37. bl_ui/node_add_menu/__init__.pyi +1 -244
  38. bl_ui/node_add_menu_compositor/__init__.pyi +226 -4600
  39. bl_ui/node_add_menu_geometry/__init__.pyi +654 -12802
  40. bl_ui/node_add_menu_shader/__init__.pyi +94 -2531
  41. bl_ui/node_add_menu_texture/__init__.pyi +81 -2268
  42. bl_ui/properties_collection/__init__.pyi +58 -1272
  43. bl_ui/properties_constraint/__init__.pyi +1508 -32656
  44. bl_ui/properties_data_armature/__init__.pyi +278 -3804
  45. bl_ui/properties_data_bone/__init__.pyi +151 -2062
  46. bl_ui/properties_data_camera/__init__.pyi +216 -3034
  47. bl_ui/properties_data_curve/__init__.pyi +214 -3117
  48. bl_ui/properties_data_curves/__init__.pyi +57 -1273
  49. bl_ui/properties_data_empty/__init__.pyi +2 -385
  50. bl_ui/properties_data_gpencil/__init__.pyi +285 -3922
  51. bl_ui/properties_data_grease_pencil/__init__.pyi +198 -3081
  52. bl_ui/properties_data_lattice/__init__.pyi +3 -595
  53. bl_ui/properties_data_light/__init__.pyi +200 -2502
  54. bl_ui/properties_data_lightprobe/__init__.pyi +212 -2704
  55. bl_ui/properties_data_mesh/__init__.pyi +323 -4380
  56. bl_ui/properties_data_metaball/__init__.pyi +38 -1011
  57. bl_ui/properties_data_modifier/__init__.pyi +157 -2451
  58. bl_ui/properties_data_pointcloud/__init__.pyi +68 -1087
  59. bl_ui/properties_data_shaderfx/__init__.pyi +1 -189
  60. bl_ui/properties_data_speaker/__init__.pyi +36 -1018
  61. bl_ui/properties_data_volume/__init__.pyi +104 -1660
  62. bl_ui/properties_freestyle/__init__.pyi +438 -5136
  63. bl_ui/properties_grease_pencil_common/__init__.pyi +197 -3852
  64. bl_ui/properties_mask_common/__init__.pyi +59 -1705
  65. bl_ui/properties_material/__init__.pyi +227 -3334
  66. bl_ui/properties_material_gpencil/__init__.pyi +187 -2221
  67. bl_ui/properties_object/__init__.pyi +197 -2908
  68. bl_ui/properties_output/__init__.pyi +286 -3895
  69. bl_ui/properties_paint_common/__init__.pyi +40 -923
  70. bl_ui/properties_particle/__init__.pyi +954 -10839
  71. bl_ui/properties_physics_cloth/__init__.pyi +219 -2979
  72. bl_ui/properties_physics_common/__init__.pyi +1 -196
  73. bl_ui/properties_physics_dynamicpaint/__init__.pyi +429 -5411
  74. bl_ui/properties_physics_field/__init__.pyi +160 -2166
  75. bl_ui/properties_physics_fluid/__init__.pyi +541 -7352
  76. bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -189
  77. bl_ui/properties_physics_rigidbody/__init__.pyi +125 -1623
  78. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +196 -2640
  79. bl_ui/properties_physics_softbody/__init__.pyi +238 -3135
  80. bl_ui/properties_render/__init__.pyi +1065 -11565
  81. bl_ui/properties_scene/__init__.pyi +209 -3090
  82. bl_ui/properties_texture/__init__.pyi +426 -5475
  83. bl_ui/properties_view_layer/__init__.pyi +264 -3827
  84. bl_ui/properties_workspace/__init__.pyi +7 -770
  85. bl_ui/properties_world/__init__.pyi +147 -2056
  86. bl_ui/space_clip/__init__.pyi +1013 -16279
  87. bl_ui/space_console/__init__.pyi +39 -1442
  88. bl_ui/space_dopesheet/__init__.pyi +450 -7213
  89. bl_ui/space_filebrowser/__init__.pyi +406 -6708
  90. bl_ui/space_graph/__init__.pyi +223 -4886
  91. bl_ui/space_image/__init__.pyi +1091 -16394
  92. bl_ui/space_info/__init__.pyi +39 -1442
  93. bl_ui/space_nla/__init__.pyi +216 -4157
  94. bl_ui/space_node/__init__.pyi +394 -6344
  95. bl_ui/space_outliner/__init__.pyi +156 -3448
  96. bl_ui/space_properties/__init__.pyi +3 -567
  97. bl_ui/space_sequencer/__init__.pyi +1224 -18036
  98. bl_ui/space_spreadsheet/__init__.pyi +1 -189
  99. bl_ui/space_statusbar/__init__.pyi +1 -189
  100. bl_ui/space_text/__init__.pyi +183 -3851
  101. bl_ui/space_time/__init__.pyi +69 -1622
  102. bl_ui/space_toolsystem_common/__init__.pyi +2 -118
  103. bl_ui/space_toolsystem_toolbar/__init__.pyi +13 -476
  104. bl_ui/space_topbar/__init__.pyi +322 -6269
  105. bl_ui/space_userpref/__init__.pyi +1758 -19735
  106. bl_ui/space_view3d/__init__.pyi +3853 -67593
  107. bl_ui/space_view3d_toolbar/__init__.pyi +1948 -23558
  108. bl_ui/temp_anim_layers/__init__.pyi +1 -189
  109. bl_ui/utils/__init__.pyi +0 -35
  110. bpy/ops/outliner/__init__.pyi +0 -1
  111. bpy/ops/sound/__init__.pyi +37 -7
  112. bpy/types/__init__.pyi +65 -8
  113. bpy_extras/node_shader_utils/__init__.pyi +0 -8
  114. {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/METADATA +1 -1
  115. {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/RECORD +120 -120
  116. {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/WHEEL +1 -1
  117. freestyle/utils/__init__.pyi +1 -1
  118. keyingsets_builtins/__init__.pyi +268 -4448
  119. nodeitems_builtins/__init__.pyi +1 -7
  120. {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/top_level.txt +0 -0
@@ -7,27 +7,11 @@ import bpy_types
7
7
  GenericType1 = typing.TypeVar("GenericType1")
8
8
  GenericType2 = typing.TypeVar("GenericType2")
9
9
 
10
- class CONSOLE_HT_header(bpy_types._GenericUI):
10
+ class CONSOLE_HT_header(bpy.types.Header, bpy_types._GenericUI):
11
11
  bl_rna: typing.Any
12
12
  bl_space_type: typing.Any
13
13
  id_data: typing.Any
14
14
 
15
- def append(self, draw_func):
16
- """Append a draw function to this menu,
17
- takes the same arguments as the menus draw function
18
-
19
- :param draw_func:
20
- """
21
- ...
22
-
23
- def as_pointer(self) -> int:
24
- """Returns the memory address which holds a pointer to Blender's internal data
25
-
26
- :return: int (memory address).
27
- :rtype: int
28
- """
29
- ...
30
-
31
15
  def bl_rna_get_subclass(self) -> bpy.types.Struct:
32
16
  """
33
17
 
@@ -51,199 +35,11 @@ class CONSOLE_HT_header(bpy_types._GenericUI):
51
35
  """
52
36
  ...
53
37
 
54
- def driver_add(self) -> bpy.types.FCurve:
55
- """Adds driver(s) to the given property
56
-
57
- :return: The driver(s) added.
58
- :rtype: bpy.types.FCurve
59
- """
60
- ...
61
-
62
- def driver_remove(self) -> bool:
63
- """Remove driver(s) from the given property
64
-
65
- :return: Success of driver removal.
66
- :rtype: bool
67
- """
68
- ...
69
-
70
- def get(self):
71
- """Returns the value of the custom property assigned to key or default
72
- when not found (matches Python's dictionary function of the same name).
73
-
74
- """
75
- ...
76
-
77
- def id_properties_clear(self):
78
- """
79
-
80
- :return: Remove the parent group for an RNA struct's custom IDProperties.
81
- """
82
- ...
83
-
84
- def id_properties_ensure(self):
85
- """
86
-
87
- :return: the parent group for an RNA struct's custom IDProperties.
88
- """
89
- ...
90
-
91
- def id_properties_ui(self):
92
- """
93
-
94
- :return: Return an object used to manage an IDProperty's UI data.
95
- """
96
- ...
97
-
98
- def is_extended(self): ...
99
- def is_property_hidden(self) -> bool:
100
- """Check if a property is hidden.
101
-
102
- :return: True when the property is hidden.
103
- :rtype: bool
104
- """
105
- ...
106
-
107
- def is_property_overridable_library(self) -> bool:
108
- """Check if a property is overridable.
109
-
110
- :return: True when the property is overridable.
111
- :rtype: bool
112
- """
113
- ...
114
-
115
- def is_property_readonly(self) -> bool:
116
- """Check if a property is readonly.
117
-
118
- :return: True when the property is readonly (not writable).
119
- :rtype: bool
120
- """
121
- ...
122
-
123
- def is_property_set(self) -> bool:
124
- """Check if a property is set, use for testing operator properties.
125
-
126
- :return: True when the property has been set.
127
- :rtype: bool
128
- """
129
- ...
130
-
131
- def items(self):
132
- """Returns the items of this objects custom properties (matches Python's
133
- dictionary function of the same name).
134
-
135
- :return: custom property key, value pairs.
136
- """
137
- ...
138
-
139
- def keyframe_delete(self) -> bool:
140
- """Remove a keyframe from this properties fcurve.
141
-
142
- :return: Success of keyframe deletion.
143
- :rtype: bool
144
- """
145
- ...
146
-
147
- def keyframe_insert(self) -> bool:
148
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
149
-
150
- :return: Success of keyframe insertion.
151
- :rtype: bool
152
- """
153
- ...
154
-
155
- def keys(self):
156
- """Returns the keys of this objects custom properties (matches Python's
157
- dictionary function of the same name).
158
-
159
- :return: custom property keys.
160
- """
161
- ...
162
-
163
- def path_from_id(self) -> str:
164
- """Returns the data path from the ID to this object (string).
165
-
166
- :return: The path from `bpy.types.bpy_struct.id_data`
167
- to this struct and property (when given).
168
- :rtype: str
169
- """
170
- ...
171
-
172
- def path_resolve(self):
173
- """Returns the property from the path, raise an exception when not found."""
174
- ...
175
-
176
- def pop(self):
177
- """Remove and return the value of the custom property assigned to key or default
178
- when not found (matches Python's dictionary function of the same name).
179
-
180
- """
181
- ...
182
-
183
- def prepend(self, draw_func):
184
- """Prepend a draw function to this menu, takes the same arguments as
185
- the menus draw function
186
-
187
- :param draw_func:
188
- """
189
- ...
190
-
191
- def property_overridable_library_set(self) -> bool:
192
- """Define a property as overridable or not (only for custom properties!).
193
-
194
- :return: True when the overridable status of the property was successfully set.
195
- :rtype: bool
196
- """
197
- ...
198
-
199
- def property_unset(self):
200
- """Unset a property, will use default value afterward."""
201
- ...
202
-
203
- def remove(self, draw_func):
204
- """Remove a draw function that has been added to this menu
205
-
206
- :param draw_func:
207
- """
208
- ...
209
-
210
- def type_recast(self):
211
- """Return a new instance, this is needed because types
212
- such as textures can be changed at runtime.
213
-
214
- :return: a new instance of this object with the type initialized again.
215
- """
216
- ...
217
-
218
- def values(self):
219
- """Returns the values of this objects custom properties (matches Python's
220
- dictionary function of the same name).
221
-
222
- :return: custom property values.
223
- """
224
- ...
225
-
226
- class CONSOLE_MT_console(bpy_types._GenericUI):
38
+ class CONSOLE_MT_console(bpy.types.Menu, bpy_types._GenericUI):
227
39
  bl_label: typing.Any
228
40
  bl_rna: typing.Any
229
41
  id_data: typing.Any
230
42
 
231
- def append(self, draw_func):
232
- """Append a draw function to this menu,
233
- takes the same arguments as the menus draw function
234
-
235
- :param draw_func:
236
- """
237
- ...
238
-
239
- def as_pointer(self) -> int:
240
- """Returns the memory address which holds a pointer to Blender's internal data
241
-
242
- :return: int (memory address).
243
- :rtype: int
244
- """
245
- ...
246
-
247
43
  def bl_rna_get_subclass(self) -> bpy.types.Struct:
248
44
  """
249
45
 
@@ -267,254 +63,68 @@ class CONSOLE_MT_console(bpy_types._GenericUI):
267
63
  """
268
64
  ...
269
65
 
270
- def draw_collapsible(self, context, layout):
271
- """
272
-
273
- :param context:
274
- :param layout:
275
- """
276
- ...
277
-
278
- def draw_preset(self, _context):
279
- """Define these on the subclass:
280
- - preset_operator (string)
281
- - preset_subdir (string)Optionally:
282
- - preset_add_operator (string)
283
- - preset_extensions (set of strings)
284
- - preset_operator_defaults (dict of keyword args)
285
-
286
- :param _context:
287
- """
288
- ...
289
-
290
- def driver_add(self) -> bpy.types.FCurve:
291
- """Adds driver(s) to the given property
292
-
293
- :return: The driver(s) added.
294
- :rtype: bpy.types.FCurve
295
- """
296
- ...
297
-
298
- def driver_remove(self) -> bool:
299
- """Remove driver(s) from the given property
300
-
301
- :return: Success of driver removal.
302
- :rtype: bool
303
- """
304
- ...
305
-
306
- def get(self):
307
- """Returns the value of the custom property assigned to key or default
308
- when not found (matches Python's dictionary function of the same name).
309
-
310
- """
311
- ...
312
-
313
- def id_properties_clear(self):
314
- """
315
-
316
- :return: Remove the parent group for an RNA struct's custom IDProperties.
317
- """
318
- ...
319
-
320
- def id_properties_ensure(self):
321
- """
322
-
323
- :return: the parent group for an RNA struct's custom IDProperties.
324
- """
325
- ...
326
-
327
- def id_properties_ui(self):
328
- """
329
-
330
- :return: Return an object used to manage an IDProperty's UI data.
331
- """
332
- ...
333
-
334
- def is_extended(self): ...
335
- def is_property_hidden(self) -> bool:
336
- """Check if a property is hidden.
337
-
338
- :return: True when the property is hidden.
339
- :rtype: bool
340
- """
341
- ...
342
-
343
- def is_property_overridable_library(self) -> bool:
344
- """Check if a property is overridable.
345
-
346
- :return: True when the property is overridable.
347
- :rtype: bool
348
- """
349
- ...
350
-
351
- def is_property_readonly(self) -> bool:
352
- """Check if a property is readonly.
353
-
354
- :return: True when the property is readonly (not writable).
355
- :rtype: bool
356
- """
357
- ...
358
-
359
- def is_property_set(self) -> bool:
360
- """Check if a property is set, use for testing operator properties.
361
-
362
- :return: True when the property has been set.
363
- :rtype: bool
364
- """
365
- ...
366
-
367
- def items(self):
368
- """Returns the items of this objects custom properties (matches Python's
369
- dictionary function of the same name).
66
+ class CONSOLE_MT_context_menu(bpy.types.Menu, bpy_types._GenericUI):
67
+ bl_label: typing.Any
68
+ bl_rna: typing.Any
69
+ id_data: typing.Any
370
70
 
371
- :return: custom property key, value pairs.
71
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
372
72
  """
373
- ...
374
-
375
- def keyframe_delete(self) -> bool:
376
- """Remove a keyframe from this properties fcurve.
377
73
 
378
- :return: Success of keyframe deletion.
379
- :rtype: bool
74
+ :return: The RNA type or default when not found.
75
+ :rtype: bpy.types.Struct
380
76
  """
381
77
  ...
382
78
 
383
- def keyframe_insert(self) -> bool:
384
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
385
-
386
- :return: Success of keyframe insertion.
387
- :rtype: bool
79
+ def bl_rna_get_subclass_py(self) -> typing.Any:
388
80
  """
389
- ...
390
-
391
- def keys(self):
392
- """Returns the keys of this objects custom properties (matches Python's
393
- dictionary function of the same name).
394
81
 
395
- :return: custom property keys.
82
+ :return: The class or default when not found.
83
+ :rtype: typing.Any
396
84
  """
397
85
  ...
398
86
 
399
- def path_from_id(self) -> str:
400
- """Returns the data path from the ID to this object (string).
401
-
402
- :return: The path from `bpy.types.bpy_struct.id_data`
403
- to this struct and property (when given).
404
- :rtype: str
87
+ def draw(self, _context):
405
88
  """
406
- ...
407
-
408
- def path_menu(
409
- self,
410
- searchpaths: list[str],
411
- operator: str,
412
- *,
413
- props_default: dict = None,
414
- prop_filepath: str | None = "filepath",
415
- filter_ext: collections.abc.Callable | None = None,
416
- filter_path=None,
417
- display_name: collections.abc.Callable | None = None,
418
- add_operator=None,
419
- add_operator_props=None,
420
- ):
421
- """Populate a menu from a list of paths.
422
89
 
423
- :param searchpaths: Paths to scan.
424
- :type searchpaths: list[str]
425
- :param operator: The operator id to use with each file.
426
- :type operator: str
427
- :param props_default: Properties to assign to each operator.
428
- :type props_default: dict
429
- :param prop_filepath: Optional operator filepath property (defaults to "filepath").
430
- :type prop_filepath: str | None
431
- :param filter_ext: Optional callback that takes the file extensions.
432
-
433
- Returning false excludes the file from the list.
434
- :type filter_ext: collections.abc.Callable | None
435
- :param filter_path:
436
- :param display_name: Optional callback that takes the full path, returns the name to display.
437
- :type display_name: collections.abc.Callable | None
438
- :param add_operator:
439
- :param add_operator_props:
90
+ :param _context:
440
91
  """
441
92
  ...
442
93
 
443
- def path_resolve(self):
444
- """Returns the property from the path, raise an exception when not found."""
445
- ...
446
-
447
- def pop(self):
448
- """Remove and return the value of the custom property assigned to key or default
449
- when not found (matches Python's dictionary function of the same name).
94
+ class CONSOLE_MT_editor_menus(bpy.types.Menu, bpy_types._GenericUI):
95
+ bl_idname: typing.Any
96
+ bl_label: typing.Any
97
+ bl_rna: typing.Any
98
+ id_data: typing.Any
450
99
 
100
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
451
101
  """
452
- ...
453
102
 
454
- def prepend(self, draw_func):
455
- """Prepend a draw function to this menu, takes the same arguments as
456
- the menus draw function
457
-
458
- :param draw_func:
103
+ :return: The RNA type or default when not found.
104
+ :rtype: bpy.types.Struct
459
105
  """
460
106
  ...
461
107
 
462
- def property_overridable_library_set(self) -> bool:
463
- """Define a property as overridable or not (only for custom properties!).
464
-
465
- :return: True when the overridable status of the property was successfully set.
466
- :rtype: bool
108
+ def bl_rna_get_subclass_py(self) -> typing.Any:
467
109
  """
468
- ...
469
-
470
- def property_unset(self):
471
- """Unset a property, will use default value afterward."""
472
- ...
473
110
 
474
- def remove(self, draw_func):
475
- """Remove a draw function that has been added to this menu
476
-
477
- :param draw_func:
111
+ :return: The class or default when not found.
112
+ :rtype: typing.Any
478
113
  """
479
114
  ...
480
115
 
481
- def type_recast(self):
482
- """Return a new instance, this is needed because types
483
- such as textures can be changed at runtime.
484
-
485
- :return: a new instance of this object with the type initialized again.
116
+ def draw(self, _context):
486
117
  """
487
- ...
488
118
 
489
- def values(self):
490
- """Returns the values of this objects custom properties (matches Python's
491
- dictionary function of the same name).
492
-
493
- :return: custom property values.
119
+ :param _context:
494
120
  """
495
121
  ...
496
122
 
497
- class CONSOLE_MT_context_menu(bpy_types._GenericUI):
123
+ class CONSOLE_MT_language(bpy.types.Menu, bpy_types._GenericUI):
498
124
  bl_label: typing.Any
499
125
  bl_rna: typing.Any
500
126
  id_data: typing.Any
501
127
 
502
- def append(self, draw_func):
503
- """Append a draw function to this menu,
504
- takes the same arguments as the menus draw function
505
-
506
- :param draw_func:
507
- """
508
- ...
509
-
510
- def as_pointer(self) -> int:
511
- """Returns the memory address which holds a pointer to Blender's internal data
512
-
513
- :return: int (memory address).
514
- :rtype: int
515
- """
516
- ...
517
-
518
128
  def bl_rna_get_subclass(self) -> bpy.types.Struct:
519
129
  """
520
130
 
@@ -538,1045 +148,32 @@ class CONSOLE_MT_context_menu(bpy_types._GenericUI):
538
148
  """
539
149
  ...
540
150
 
541
- def draw_collapsible(self, context, layout):
542
- """
543
-
544
- :param context:
545
- :param layout:
546
- """
547
- ...
548
-
549
- def draw_preset(self, _context):
550
- """Define these on the subclass:
551
- - preset_operator (string)
552
- - preset_subdir (string)Optionally:
553
- - preset_add_operator (string)
554
- - preset_extensions (set of strings)
555
- - preset_operator_defaults (dict of keyword args)
556
-
557
- :param _context:
558
- """
559
- ...
560
-
561
- def driver_add(self) -> bpy.types.FCurve:
562
- """Adds driver(s) to the given property
563
-
564
- :return: The driver(s) added.
565
- :rtype: bpy.types.FCurve
566
- """
567
- ...
568
-
569
- def driver_remove(self) -> bool:
570
- """Remove driver(s) from the given property
571
-
572
- :return: Success of driver removal.
573
- :rtype: bool
574
- """
575
- ...
576
-
577
- def get(self):
578
- """Returns the value of the custom property assigned to key or default
579
- when not found (matches Python's dictionary function of the same name).
580
-
581
- """
582
- ...
583
-
584
- def id_properties_clear(self):
585
- """
586
-
587
- :return: Remove the parent group for an RNA struct's custom IDProperties.
588
- """
589
- ...
151
+ class CONSOLE_MT_view(bpy.types.Menu, bpy_types._GenericUI):
152
+ bl_label: typing.Any
153
+ bl_rna: typing.Any
154
+ id_data: typing.Any
590
155
 
591
- def id_properties_ensure(self):
156
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
592
157
  """
593
158
 
594
- :return: the parent group for an RNA struct's custom IDProperties.
159
+ :return: The RNA type or default when not found.
160
+ :rtype: bpy.types.Struct
595
161
  """
596
162
  ...
597
163
 
598
- def id_properties_ui(self):
599
- """
600
-
601
- :return: Return an object used to manage an IDProperty's UI data.
164
+ def bl_rna_get_subclass_py(self) -> typing.Any:
602
165
  """
603
- ...
604
166
 
605
- def is_extended(self): ...
606
- def is_property_hidden(self) -> bool:
607
- """Check if a property is hidden.
608
-
609
- :return: True when the property is hidden.
610
- :rtype: bool
167
+ :return: The class or default when not found.
168
+ :rtype: typing.Any
611
169
  """
612
170
  ...
613
171
 
614
- def is_property_overridable_library(self) -> bool:
615
- """Check if a property is overridable.
616
-
617
- :return: True when the property is overridable.
618
- :rtype: bool
619
- """
620
- ...
621
-
622
- def is_property_readonly(self) -> bool:
623
- """Check if a property is readonly.
624
-
625
- :return: True when the property is readonly (not writable).
626
- :rtype: bool
627
- """
628
- ...
629
-
630
- def is_property_set(self) -> bool:
631
- """Check if a property is set, use for testing operator properties.
632
-
633
- :return: True when the property has been set.
634
- :rtype: bool
635
- """
636
- ...
637
-
638
- def items(self):
639
- """Returns the items of this objects custom properties (matches Python's
640
- dictionary function of the same name).
641
-
642
- :return: custom property key, value pairs.
643
- """
644
- ...
645
-
646
- def keyframe_delete(self) -> bool:
647
- """Remove a keyframe from this properties fcurve.
648
-
649
- :return: Success of keyframe deletion.
650
- :rtype: bool
651
- """
652
- ...
653
-
654
- def keyframe_insert(self) -> bool:
655
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
656
-
657
- :return: Success of keyframe insertion.
658
- :rtype: bool
659
- """
660
- ...
661
-
662
- def keys(self):
663
- """Returns the keys of this objects custom properties (matches Python's
664
- dictionary function of the same name).
665
-
666
- :return: custom property keys.
667
- """
668
- ...
669
-
670
- def path_from_id(self) -> str:
671
- """Returns the data path from the ID to this object (string).
672
-
673
- :return: The path from `bpy.types.bpy_struct.id_data`
674
- to this struct and property (when given).
675
- :rtype: str
676
- """
677
- ...
678
-
679
- def path_menu(
680
- self,
681
- searchpaths: list[str],
682
- operator: str,
683
- *,
684
- props_default: dict = None,
685
- prop_filepath: str | None = "filepath",
686
- filter_ext: collections.abc.Callable | None = None,
687
- filter_path=None,
688
- display_name: collections.abc.Callable | None = None,
689
- add_operator=None,
690
- add_operator_props=None,
691
- ):
692
- """Populate a menu from a list of paths.
693
-
694
- :param searchpaths: Paths to scan.
695
- :type searchpaths: list[str]
696
- :param operator: The operator id to use with each file.
697
- :type operator: str
698
- :param props_default: Properties to assign to each operator.
699
- :type props_default: dict
700
- :param prop_filepath: Optional operator filepath property (defaults to "filepath").
701
- :type prop_filepath: str | None
702
- :param filter_ext: Optional callback that takes the file extensions.
703
-
704
- Returning false excludes the file from the list.
705
- :type filter_ext: collections.abc.Callable | None
706
- :param filter_path:
707
- :param display_name: Optional callback that takes the full path, returns the name to display.
708
- :type display_name: collections.abc.Callable | None
709
- :param add_operator:
710
- :param add_operator_props:
711
- """
712
- ...
713
-
714
- def path_resolve(self):
715
- """Returns the property from the path, raise an exception when not found."""
716
- ...
717
-
718
- def pop(self):
719
- """Remove and return the value of the custom property assigned to key or default
720
- when not found (matches Python's dictionary function of the same name).
721
-
722
- """
723
- ...
724
-
725
- def prepend(self, draw_func):
726
- """Prepend a draw function to this menu, takes the same arguments as
727
- the menus draw function
728
-
729
- :param draw_func:
730
- """
731
- ...
732
-
733
- def property_overridable_library_set(self) -> bool:
734
- """Define a property as overridable or not (only for custom properties!).
735
-
736
- :return: True when the overridable status of the property was successfully set.
737
- :rtype: bool
738
- """
739
- ...
740
-
741
- def property_unset(self):
742
- """Unset a property, will use default value afterward."""
743
- ...
744
-
745
- def remove(self, draw_func):
746
- """Remove a draw function that has been added to this menu
747
-
748
- :param draw_func:
749
- """
750
- ...
751
-
752
- def type_recast(self):
753
- """Return a new instance, this is needed because types
754
- such as textures can be changed at runtime.
755
-
756
- :return: a new instance of this object with the type initialized again.
757
- """
758
- ...
759
-
760
- def values(self):
761
- """Returns the values of this objects custom properties (matches Python's
762
- dictionary function of the same name).
763
-
764
- :return: custom property values.
765
- """
766
- ...
767
-
768
- class CONSOLE_MT_editor_menus(bpy_types._GenericUI):
769
- bl_idname: typing.Any
770
- bl_label: typing.Any
771
- bl_rna: typing.Any
772
- id_data: typing.Any
773
-
774
- def append(self, draw_func):
775
- """Append a draw function to this menu,
776
- takes the same arguments as the menus draw function
777
-
778
- :param draw_func:
779
- """
780
- ...
781
-
782
- def as_pointer(self) -> int:
783
- """Returns the memory address which holds a pointer to Blender's internal data
784
-
785
- :return: int (memory address).
786
- :rtype: int
787
- """
788
- ...
789
-
790
- def bl_rna_get_subclass(self) -> bpy.types.Struct:
791
- """
792
-
793
- :return: The RNA type or default when not found.
794
- :rtype: bpy.types.Struct
795
- """
796
- ...
797
-
798
- def bl_rna_get_subclass_py(self) -> typing.Any:
799
- """
800
-
801
- :return: The class or default when not found.
802
- :rtype: typing.Any
803
- """
804
- ...
805
-
806
- def draw(self, _context):
807
- """
808
-
809
- :param _context:
810
- """
811
- ...
812
-
813
- def draw_collapsible(self, context, layout):
814
- """
815
-
816
- :param context:
817
- :param layout:
818
- """
819
- ...
820
-
821
- def draw_preset(self, _context):
822
- """Define these on the subclass:
823
- - preset_operator (string)
824
- - preset_subdir (string)Optionally:
825
- - preset_add_operator (string)
826
- - preset_extensions (set of strings)
827
- - preset_operator_defaults (dict of keyword args)
828
-
829
- :param _context:
830
- """
831
- ...
832
-
833
- def driver_add(self) -> bpy.types.FCurve:
834
- """Adds driver(s) to the given property
835
-
836
- :return: The driver(s) added.
837
- :rtype: bpy.types.FCurve
838
- """
839
- ...
840
-
841
- def driver_remove(self) -> bool:
842
- """Remove driver(s) from the given property
843
-
844
- :return: Success of driver removal.
845
- :rtype: bool
846
- """
847
- ...
848
-
849
- def get(self):
850
- """Returns the value of the custom property assigned to key or default
851
- when not found (matches Python's dictionary function of the same name).
852
-
853
- """
854
- ...
855
-
856
- def id_properties_clear(self):
857
- """
858
-
859
- :return: Remove the parent group for an RNA struct's custom IDProperties.
860
- """
861
- ...
862
-
863
- def id_properties_ensure(self):
864
- """
865
-
866
- :return: the parent group for an RNA struct's custom IDProperties.
867
- """
868
- ...
869
-
870
- def id_properties_ui(self):
871
- """
872
-
873
- :return: Return an object used to manage an IDProperty's UI data.
874
- """
875
- ...
876
-
877
- def is_extended(self): ...
878
- def is_property_hidden(self) -> bool:
879
- """Check if a property is hidden.
880
-
881
- :return: True when the property is hidden.
882
- :rtype: bool
883
- """
884
- ...
885
-
886
- def is_property_overridable_library(self) -> bool:
887
- """Check if a property is overridable.
888
-
889
- :return: True when the property is overridable.
890
- :rtype: bool
891
- """
892
- ...
893
-
894
- def is_property_readonly(self) -> bool:
895
- """Check if a property is readonly.
896
-
897
- :return: True when the property is readonly (not writable).
898
- :rtype: bool
899
- """
900
- ...
901
-
902
- def is_property_set(self) -> bool:
903
- """Check if a property is set, use for testing operator properties.
904
-
905
- :return: True when the property has been set.
906
- :rtype: bool
907
- """
908
- ...
909
-
910
- def items(self):
911
- """Returns the items of this objects custom properties (matches Python's
912
- dictionary function of the same name).
913
-
914
- :return: custom property key, value pairs.
915
- """
916
- ...
917
-
918
- def keyframe_delete(self) -> bool:
919
- """Remove a keyframe from this properties fcurve.
920
-
921
- :return: Success of keyframe deletion.
922
- :rtype: bool
923
- """
924
- ...
925
-
926
- def keyframe_insert(self) -> bool:
927
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
928
-
929
- :return: Success of keyframe insertion.
930
- :rtype: bool
931
- """
932
- ...
933
-
934
- def keys(self):
935
- """Returns the keys of this objects custom properties (matches Python's
936
- dictionary function of the same name).
937
-
938
- :return: custom property keys.
939
- """
940
- ...
941
-
942
- def path_from_id(self) -> str:
943
- """Returns the data path from the ID to this object (string).
944
-
945
- :return: The path from `bpy.types.bpy_struct.id_data`
946
- to this struct and property (when given).
947
- :rtype: str
948
- """
949
- ...
950
-
951
- def path_menu(
952
- self,
953
- searchpaths: list[str],
954
- operator: str,
955
- *,
956
- props_default: dict = None,
957
- prop_filepath: str | None = "filepath",
958
- filter_ext: collections.abc.Callable | None = None,
959
- filter_path=None,
960
- display_name: collections.abc.Callable | None = None,
961
- add_operator=None,
962
- add_operator_props=None,
963
- ):
964
- """Populate a menu from a list of paths.
965
-
966
- :param searchpaths: Paths to scan.
967
- :type searchpaths: list[str]
968
- :param operator: The operator id to use with each file.
969
- :type operator: str
970
- :param props_default: Properties to assign to each operator.
971
- :type props_default: dict
972
- :param prop_filepath: Optional operator filepath property (defaults to "filepath").
973
- :type prop_filepath: str | None
974
- :param filter_ext: Optional callback that takes the file extensions.
975
-
976
- Returning false excludes the file from the list.
977
- :type filter_ext: collections.abc.Callable | None
978
- :param filter_path:
979
- :param display_name: Optional callback that takes the full path, returns the name to display.
980
- :type display_name: collections.abc.Callable | None
981
- :param add_operator:
982
- :param add_operator_props:
983
- """
984
- ...
985
-
986
- def path_resolve(self):
987
- """Returns the property from the path, raise an exception when not found."""
988
- ...
989
-
990
- def pop(self):
991
- """Remove and return the value of the custom property assigned to key or default
992
- when not found (matches Python's dictionary function of the same name).
993
-
994
- """
995
- ...
996
-
997
- def prepend(self, draw_func):
998
- """Prepend a draw function to this menu, takes the same arguments as
999
- the menus draw function
1000
-
1001
- :param draw_func:
1002
- """
1003
- ...
1004
-
1005
- def property_overridable_library_set(self) -> bool:
1006
- """Define a property as overridable or not (only for custom properties!).
1007
-
1008
- :return: True when the overridable status of the property was successfully set.
1009
- :rtype: bool
1010
- """
1011
- ...
1012
-
1013
- def property_unset(self):
1014
- """Unset a property, will use default value afterward."""
1015
- ...
1016
-
1017
- def remove(self, draw_func):
1018
- """Remove a draw function that has been added to this menu
1019
-
1020
- :param draw_func:
1021
- """
1022
- ...
1023
-
1024
- def type_recast(self):
1025
- """Return a new instance, this is needed because types
1026
- such as textures can be changed at runtime.
1027
-
1028
- :return: a new instance of this object with the type initialized again.
1029
- """
1030
- ...
1031
-
1032
- def values(self):
1033
- """Returns the values of this objects custom properties (matches Python's
1034
- dictionary function of the same name).
1035
-
1036
- :return: custom property values.
1037
- """
1038
- ...
1039
-
1040
- class CONSOLE_MT_language(bpy_types._GenericUI):
1041
- bl_label: typing.Any
1042
- bl_rna: typing.Any
1043
- id_data: typing.Any
1044
-
1045
- def append(self, draw_func):
1046
- """Append a draw function to this menu,
1047
- takes the same arguments as the menus draw function
1048
-
1049
- :param draw_func:
1050
- """
1051
- ...
1052
-
1053
- def as_pointer(self) -> int:
1054
- """Returns the memory address which holds a pointer to Blender's internal data
1055
-
1056
- :return: int (memory address).
1057
- :rtype: int
1058
- """
1059
- ...
1060
-
1061
- def bl_rna_get_subclass(self) -> bpy.types.Struct:
1062
- """
1063
-
1064
- :return: The RNA type or default when not found.
1065
- :rtype: bpy.types.Struct
1066
- """
1067
- ...
1068
-
1069
- def bl_rna_get_subclass_py(self) -> typing.Any:
1070
- """
1071
-
1072
- :return: The class or default when not found.
1073
- :rtype: typing.Any
1074
- """
1075
- ...
1076
-
1077
- def draw(self, _context):
172
+ def draw(self, _context):
1078
173
  """
1079
174
 
1080
175
  :param _context:
1081
176
  """
1082
177
  ...
1083
178
 
1084
- def draw_collapsible(self, context, layout):
1085
- """
1086
-
1087
- :param context:
1088
- :param layout:
1089
- """
1090
- ...
1091
-
1092
- def draw_preset(self, _context):
1093
- """Define these on the subclass:
1094
- - preset_operator (string)
1095
- - preset_subdir (string)Optionally:
1096
- - preset_add_operator (string)
1097
- - preset_extensions (set of strings)
1098
- - preset_operator_defaults (dict of keyword args)
1099
-
1100
- :param _context:
1101
- """
1102
- ...
1103
-
1104
- def driver_add(self) -> bpy.types.FCurve:
1105
- """Adds driver(s) to the given property
1106
-
1107
- :return: The driver(s) added.
1108
- :rtype: bpy.types.FCurve
1109
- """
1110
- ...
1111
-
1112
- def driver_remove(self) -> bool:
1113
- """Remove driver(s) from the given property
1114
-
1115
- :return: Success of driver removal.
1116
- :rtype: bool
1117
- """
1118
- ...
1119
-
1120
- def get(self):
1121
- """Returns the value of the custom property assigned to key or default
1122
- when not found (matches Python's dictionary function of the same name).
1123
-
1124
- """
1125
- ...
1126
-
1127
- def id_properties_clear(self):
1128
- """
1129
-
1130
- :return: Remove the parent group for an RNA struct's custom IDProperties.
1131
- """
1132
- ...
1133
-
1134
- def id_properties_ensure(self):
1135
- """
1136
-
1137
- :return: the parent group for an RNA struct's custom IDProperties.
1138
- """
1139
- ...
1140
-
1141
- def id_properties_ui(self):
1142
- """
1143
-
1144
- :return: Return an object used to manage an IDProperty's UI data.
1145
- """
1146
- ...
1147
-
1148
- def is_extended(self): ...
1149
- def is_property_hidden(self) -> bool:
1150
- """Check if a property is hidden.
1151
-
1152
- :return: True when the property is hidden.
1153
- :rtype: bool
1154
- """
1155
- ...
1156
-
1157
- def is_property_overridable_library(self) -> bool:
1158
- """Check if a property is overridable.
1159
-
1160
- :return: True when the property is overridable.
1161
- :rtype: bool
1162
- """
1163
- ...
1164
-
1165
- def is_property_readonly(self) -> bool:
1166
- """Check if a property is readonly.
1167
-
1168
- :return: True when the property is readonly (not writable).
1169
- :rtype: bool
1170
- """
1171
- ...
1172
-
1173
- def is_property_set(self) -> bool:
1174
- """Check if a property is set, use for testing operator properties.
1175
-
1176
- :return: True when the property has been set.
1177
- :rtype: bool
1178
- """
1179
- ...
1180
-
1181
- def items(self):
1182
- """Returns the items of this objects custom properties (matches Python's
1183
- dictionary function of the same name).
1184
-
1185
- :return: custom property key, value pairs.
1186
- """
1187
- ...
1188
-
1189
- def keyframe_delete(self) -> bool:
1190
- """Remove a keyframe from this properties fcurve.
1191
-
1192
- :return: Success of keyframe deletion.
1193
- :rtype: bool
1194
- """
1195
- ...
1196
-
1197
- def keyframe_insert(self) -> bool:
1198
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1199
-
1200
- :return: Success of keyframe insertion.
1201
- :rtype: bool
1202
- """
1203
- ...
1204
-
1205
- def keys(self):
1206
- """Returns the keys of this objects custom properties (matches Python's
1207
- dictionary function of the same name).
1208
-
1209
- :return: custom property keys.
1210
- """
1211
- ...
1212
-
1213
- def path_from_id(self) -> str:
1214
- """Returns the data path from the ID to this object (string).
1215
-
1216
- :return: The path from `bpy.types.bpy_struct.id_data`
1217
- to this struct and property (when given).
1218
- :rtype: str
1219
- """
1220
- ...
1221
-
1222
- def path_menu(
1223
- self,
1224
- searchpaths: list[str],
1225
- operator: str,
1226
- *,
1227
- props_default: dict = None,
1228
- prop_filepath: str | None = "filepath",
1229
- filter_ext: collections.abc.Callable | None = None,
1230
- filter_path=None,
1231
- display_name: collections.abc.Callable | None = None,
1232
- add_operator=None,
1233
- add_operator_props=None,
1234
- ):
1235
- """Populate a menu from a list of paths.
1236
-
1237
- :param searchpaths: Paths to scan.
1238
- :type searchpaths: list[str]
1239
- :param operator: The operator id to use with each file.
1240
- :type operator: str
1241
- :param props_default: Properties to assign to each operator.
1242
- :type props_default: dict
1243
- :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1244
- :type prop_filepath: str | None
1245
- :param filter_ext: Optional callback that takes the file extensions.
1246
-
1247
- Returning false excludes the file from the list.
1248
- :type filter_ext: collections.abc.Callable | None
1249
- :param filter_path:
1250
- :param display_name: Optional callback that takes the full path, returns the name to display.
1251
- :type display_name: collections.abc.Callable | None
1252
- :param add_operator:
1253
- :param add_operator_props:
1254
- """
1255
- ...
1256
-
1257
- def path_resolve(self):
1258
- """Returns the property from the path, raise an exception when not found."""
1259
- ...
1260
-
1261
- def pop(self):
1262
- """Remove and return the value of the custom property assigned to key or default
1263
- when not found (matches Python's dictionary function of the same name).
1264
-
1265
- """
1266
- ...
1267
-
1268
- def prepend(self, draw_func):
1269
- """Prepend a draw function to this menu, takes the same arguments as
1270
- the menus draw function
1271
-
1272
- :param draw_func:
1273
- """
1274
- ...
1275
-
1276
- def property_overridable_library_set(self) -> bool:
1277
- """Define a property as overridable or not (only for custom properties!).
1278
-
1279
- :return: True when the overridable status of the property was successfully set.
1280
- :rtype: bool
1281
- """
1282
- ...
1283
-
1284
- def property_unset(self):
1285
- """Unset a property, will use default value afterward."""
1286
- ...
1287
-
1288
- def remove(self, draw_func):
1289
- """Remove a draw function that has been added to this menu
1290
-
1291
- :param draw_func:
1292
- """
1293
- ...
1294
-
1295
- def type_recast(self):
1296
- """Return a new instance, this is needed because types
1297
- such as textures can be changed at runtime.
1298
-
1299
- :return: a new instance of this object with the type initialized again.
1300
- """
1301
- ...
1302
-
1303
- def values(self):
1304
- """Returns the values of this objects custom properties (matches Python's
1305
- dictionary function of the same name).
1306
-
1307
- :return: custom property values.
1308
- """
1309
- ...
1310
-
1311
- class CONSOLE_MT_view(bpy_types._GenericUI):
1312
- bl_label: typing.Any
1313
- bl_rna: typing.Any
1314
- id_data: typing.Any
1315
-
1316
- def append(self, draw_func):
1317
- """Append a draw function to this menu,
1318
- takes the same arguments as the menus draw function
1319
-
1320
- :param draw_func:
1321
- """
1322
- ...
1323
-
1324
- def as_pointer(self) -> int:
1325
- """Returns the memory address which holds a pointer to Blender's internal data
1326
-
1327
- :return: int (memory address).
1328
- :rtype: int
1329
- """
1330
- ...
1331
-
1332
- def bl_rna_get_subclass(self) -> bpy.types.Struct:
1333
- """
1334
-
1335
- :return: The RNA type or default when not found.
1336
- :rtype: bpy.types.Struct
1337
- """
1338
- ...
1339
-
1340
- def bl_rna_get_subclass_py(self) -> typing.Any:
1341
- """
1342
-
1343
- :return: The class or default when not found.
1344
- :rtype: typing.Any
1345
- """
1346
- ...
1347
-
1348
- def draw(self, _context):
1349
- """
1350
-
1351
- :param _context:
1352
- """
1353
- ...
1354
-
1355
- def draw_collapsible(self, context, layout):
1356
- """
1357
-
1358
- :param context:
1359
- :param layout:
1360
- """
1361
- ...
1362
-
1363
- def draw_preset(self, _context):
1364
- """Define these on the subclass:
1365
- - preset_operator (string)
1366
- - preset_subdir (string)Optionally:
1367
- - preset_add_operator (string)
1368
- - preset_extensions (set of strings)
1369
- - preset_operator_defaults (dict of keyword args)
1370
-
1371
- :param _context:
1372
- """
1373
- ...
1374
-
1375
- def driver_add(self) -> bpy.types.FCurve:
1376
- """Adds driver(s) to the given property
1377
-
1378
- :return: The driver(s) added.
1379
- :rtype: bpy.types.FCurve
1380
- """
1381
- ...
1382
-
1383
- def driver_remove(self) -> bool:
1384
- """Remove driver(s) from the given property
1385
-
1386
- :return: Success of driver removal.
1387
- :rtype: bool
1388
- """
1389
- ...
1390
-
1391
- def get(self):
1392
- """Returns the value of the custom property assigned to key or default
1393
- when not found (matches Python's dictionary function of the same name).
1394
-
1395
- """
1396
- ...
1397
-
1398
- def id_properties_clear(self):
1399
- """
1400
-
1401
- :return: Remove the parent group for an RNA struct's custom IDProperties.
1402
- """
1403
- ...
1404
-
1405
- def id_properties_ensure(self):
1406
- """
1407
-
1408
- :return: the parent group for an RNA struct's custom IDProperties.
1409
- """
1410
- ...
1411
-
1412
- def id_properties_ui(self):
1413
- """
1414
-
1415
- :return: Return an object used to manage an IDProperty's UI data.
1416
- """
1417
- ...
1418
-
1419
- def is_extended(self): ...
1420
- def is_property_hidden(self) -> bool:
1421
- """Check if a property is hidden.
1422
-
1423
- :return: True when the property is hidden.
1424
- :rtype: bool
1425
- """
1426
- ...
1427
-
1428
- def is_property_overridable_library(self) -> bool:
1429
- """Check if a property is overridable.
1430
-
1431
- :return: True when the property is overridable.
1432
- :rtype: bool
1433
- """
1434
- ...
1435
-
1436
- def is_property_readonly(self) -> bool:
1437
- """Check if a property is readonly.
1438
-
1439
- :return: True when the property is readonly (not writable).
1440
- :rtype: bool
1441
- """
1442
- ...
1443
-
1444
- def is_property_set(self) -> bool:
1445
- """Check if a property is set, use for testing operator properties.
1446
-
1447
- :return: True when the property has been set.
1448
- :rtype: bool
1449
- """
1450
- ...
1451
-
1452
- def items(self):
1453
- """Returns the items of this objects custom properties (matches Python's
1454
- dictionary function of the same name).
1455
-
1456
- :return: custom property key, value pairs.
1457
- """
1458
- ...
1459
-
1460
- def keyframe_delete(self) -> bool:
1461
- """Remove a keyframe from this properties fcurve.
1462
-
1463
- :return: Success of keyframe deletion.
1464
- :rtype: bool
1465
- """
1466
- ...
1467
-
1468
- def keyframe_insert(self) -> bool:
1469
- """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1470
-
1471
- :return: Success of keyframe insertion.
1472
- :rtype: bool
1473
- """
1474
- ...
1475
-
1476
- def keys(self):
1477
- """Returns the keys of this objects custom properties (matches Python's
1478
- dictionary function of the same name).
1479
-
1480
- :return: custom property keys.
1481
- """
1482
- ...
1483
-
1484
- def path_from_id(self) -> str:
1485
- """Returns the data path from the ID to this object (string).
1486
-
1487
- :return: The path from `bpy.types.bpy_struct.id_data`
1488
- to this struct and property (when given).
1489
- :rtype: str
1490
- """
1491
- ...
1492
-
1493
- def path_menu(
1494
- self,
1495
- searchpaths: list[str],
1496
- operator: str,
1497
- *,
1498
- props_default: dict = None,
1499
- prop_filepath: str | None = "filepath",
1500
- filter_ext: collections.abc.Callable | None = None,
1501
- filter_path=None,
1502
- display_name: collections.abc.Callable | None = None,
1503
- add_operator=None,
1504
- add_operator_props=None,
1505
- ):
1506
- """Populate a menu from a list of paths.
1507
-
1508
- :param searchpaths: Paths to scan.
1509
- :type searchpaths: list[str]
1510
- :param operator: The operator id to use with each file.
1511
- :type operator: str
1512
- :param props_default: Properties to assign to each operator.
1513
- :type props_default: dict
1514
- :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1515
- :type prop_filepath: str | None
1516
- :param filter_ext: Optional callback that takes the file extensions.
1517
-
1518
- Returning false excludes the file from the list.
1519
- :type filter_ext: collections.abc.Callable | None
1520
- :param filter_path:
1521
- :param display_name: Optional callback that takes the full path, returns the name to display.
1522
- :type display_name: collections.abc.Callable | None
1523
- :param add_operator:
1524
- :param add_operator_props:
1525
- """
1526
- ...
1527
-
1528
- def path_resolve(self):
1529
- """Returns the property from the path, raise an exception when not found."""
1530
- ...
1531
-
1532
- def pop(self):
1533
- """Remove and return the value of the custom property assigned to key or default
1534
- when not found (matches Python's dictionary function of the same name).
1535
-
1536
- """
1537
- ...
1538
-
1539
- def prepend(self, draw_func):
1540
- """Prepend a draw function to this menu, takes the same arguments as
1541
- the menus draw function
1542
-
1543
- :param draw_func:
1544
- """
1545
- ...
1546
-
1547
- def property_overridable_library_set(self) -> bool:
1548
- """Define a property as overridable or not (only for custom properties!).
1549
-
1550
- :return: True when the overridable status of the property was successfully set.
1551
- :rtype: bool
1552
- """
1553
- ...
1554
-
1555
- def property_unset(self):
1556
- """Unset a property, will use default value afterward."""
1557
- ...
1558
-
1559
- def remove(self, draw_func):
1560
- """Remove a draw function that has been added to this menu
1561
-
1562
- :param draw_func:
1563
- """
1564
- ...
1565
-
1566
- def type_recast(self):
1567
- """Return a new instance, this is needed because types
1568
- such as textures can be changed at runtime.
1569
-
1570
- :return: a new instance of this object with the type initialized again.
1571
- """
1572
- ...
1573
-
1574
- def values(self):
1575
- """Returns the values of this objects custom properties (matches Python's
1576
- dictionary function of the same name).
1577
-
1578
- :return: custom property values.
1579
- """
1580
- ...
1581
-
1582
179
  def add_scrollback(text, text_type): ...