fake-bpy-module 20241208__py3-none-any.whl → 20241209__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 (80) hide show
  1. bpy/ops/action/__init__.pyi +38 -138
  2. bpy/ops/anim/__init__.pyi +61 -179
  3. bpy/ops/armature/__init__.pyi +48 -147
  4. bpy/ops/asset/__init__.pyi +16 -71
  5. bpy/ops/boid/__init__.pyi +8 -41
  6. bpy/ops/brush/__init__.pyi +13 -39
  7. bpy/ops/buttons/__init__.pyi +6 -29
  8. bpy/ops/cachefile/__init__.pyi +5 -19
  9. bpy/ops/camera/__init__.pyi +2 -5
  10. bpy/ops/clip/__init__.pyi +92 -290
  11. bpy/ops/cloth/__init__.pyi +1 -3
  12. bpy/ops/collection/__init__.pyi +9 -25
  13. bpy/ops/console/__init__.pyi +21 -79
  14. bpy/ops/constraint/__init__.pyi +18 -45
  15. bpy/ops/curve/__init__.pyi +51 -180
  16. bpy/ops/curves/__init__.pyi +28 -100
  17. bpy/ops/cycles/__init__.pyi +3 -9
  18. bpy/ops/dpaint/__init__.pyi +5 -19
  19. bpy/ops/ed/__init__.pyi +12 -53
  20. bpy/ops/export_anim/__init__.pyi +1 -3
  21. bpy/ops/export_scene/__init__.pyi +2 -5
  22. bpy/ops/extensions/__init__.pyi +34 -110
  23. bpy/ops/file/__init__.pyi +40 -167
  24. bpy/ops/fluid/__init__.pyi +14 -77
  25. bpy/ops/font/__init__.pyi +23 -85
  26. bpy/ops/geometry/__init__.pyi +10 -27
  27. bpy/ops/gizmogroup/__init__.pyi +2 -9
  28. bpy/ops/gpencil/__init__.pyi +8 -32
  29. bpy/ops/graph/__init__.pyi +65 -184
  30. bpy/ops/grease_pencil/__init__.pyi +108 -290
  31. bpy/ops/image/__init__.pyi +49 -154
  32. bpy/ops/import_anim/__init__.pyi +1 -3
  33. bpy/ops/import_curve/__init__.pyi +1 -3
  34. bpy/ops/import_scene/__init__.pyi +2 -4
  35. bpy/ops/info/__init__.pyi +7 -29
  36. bpy/ops/lattice/__init__.pyi +8 -29
  37. bpy/ops/marker/__init__.pyi +11 -31
  38. bpy/ops/mask/__init__.pyi +39 -132
  39. bpy/ops/material/__init__.pyi +3 -19
  40. bpy/ops/mball/__init__.pyi +8 -19
  41. bpy/ops/mesh/__init__.pyi +164 -401
  42. bpy/ops/nla/__init__.pyi +39 -147
  43. bpy/ops/node/__init__.pyi +115 -390
  44. bpy/ops/object/__init__.pyi +237 -630
  45. bpy/ops/outliner/__init__.pyi +71 -263
  46. bpy/ops/paint/__init__.pyi +54 -140
  47. bpy/ops/paintcurve/__init__.pyi +8 -33
  48. bpy/ops/palette/__init__.pyi +7 -27
  49. bpy/ops/particle/__init__.pyi +36 -134
  50. bpy/ops/pose/__init__.pyi +51 -169
  51. bpy/ops/poselib/__init__.pyi +9 -33
  52. bpy/ops/preferences/__init__.pyi +35 -94
  53. bpy/ops/ptcache/__init__.pyi +7 -33
  54. bpy/ops/render/__init__.pyi +13 -37
  55. bpy/ops/rigidbody/__init__.pyi +13 -45
  56. bpy/ops/scene/__init__.pyi +37 -121
  57. bpy/ops/screen/__init__.pyi +39 -137
  58. bpy/ops/script/__init__.pyi +3 -11
  59. bpy/ops/sculpt/__init__.pyi +37 -94
  60. bpy/ops/sculpt_curves/__init__.pyi +4 -10
  61. bpy/ops/sequencer/__init__.pyi +89 -284
  62. bpy/ops/sound/__init__.pyi +7 -23
  63. bpy/ops/spreadsheet/__init__.pyi +4 -15
  64. bpy/ops/surface/__init__.pyi +6 -13
  65. bpy/ops/text/__init__.pyi +43 -175
  66. bpy/ops/text_editor/__init__.pyi +1 -3
  67. bpy/ops/texture/__init__.pyi +4 -21
  68. bpy/ops/transform/__init__.pyi +27 -61
  69. bpy/ops/ui/__init__.pyi +34 -117
  70. bpy/ops/uilist/__init__.pyi +3 -7
  71. bpy/ops/uv/__init__.pyi +49 -134
  72. bpy/ops/view2d/__init__.pyi +14 -39
  73. bpy/ops/view3d/__init__.pyi +67 -232
  74. bpy/ops/wm/__init__.pyi +114 -298
  75. bpy/ops/workspace/__init__.pyi +7 -33
  76. bpy/ops/world/__init__.pyi +2 -11
  77. {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/METADATA +1 -1
  78. {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/RECORD +80 -80
  79. {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/WHEEL +0 -0
  80. {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/top_level.txt +0 -0
bpy/ops/anim/__init__.pyi CHANGED
@@ -1,19 +1,17 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
- import bpy.types
5
4
 
6
5
  def change_frame(
7
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
8
6
  execution_context: int | str | None = None,
9
7
  undo: bool | None = None,
8
+ /,
10
9
  *,
11
10
  frame: float | None = 0.0,
12
11
  snap: bool | None = False,
13
12
  ):
14
13
  """Interactively change the current frame number
15
14
 
16
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
17
15
  :type execution_context: int | str | None
18
16
  :type undo: bool | None
19
17
  :param frame: Frame
@@ -23,15 +21,14 @@ def change_frame(
23
21
  """
24
22
 
25
23
  def channel_select_keys(
26
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
27
24
  execution_context: int | str | None = None,
28
25
  undo: bool | None = None,
26
+ /,
29
27
  *,
30
28
  extend: bool | None = False,
31
29
  ):
32
30
  """Select all keyframes of channel under mouse
33
31
 
34
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
35
32
  :type execution_context: int | str | None
36
33
  :type undo: bool | None
37
34
  :param extend: Extend, Extend selection
@@ -39,16 +36,15 @@ def channel_select_keys(
39
36
  """
40
37
 
41
38
  def channel_view_pick(
42
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
43
39
  execution_context: int | str | None = None,
44
40
  undo: bool | None = None,
41
+ /,
45
42
  *,
46
43
  include_handles: bool | None = True,
47
44
  use_preview_range: bool | None = True,
48
45
  ):
49
46
  """Reset viewable area to show the channel under the cursor
50
47
 
51
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
52
48
  :type execution_context: int | str | None
53
49
  :type undo: bool | None
54
50
  :param include_handles: Include Handles, Include handles of keyframes when calculating extents
@@ -58,9 +54,9 @@ def channel_view_pick(
58
54
  """
59
55
 
60
56
  def channels_bake(
61
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
62
57
  execution_context: int | str | None = None,
63
58
  undo: bool | None = None,
59
+ /,
64
60
  *,
65
61
  range: collections.abc.Iterable[int] | None = (0, 0),
66
62
  step: float | None = 1.0,
@@ -70,7 +66,6 @@ def channels_bake(
70
66
  ):
71
67
  """Create keyframes following the current shape of F-Curves of selected channels
72
68
 
73
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
74
69
  :type execution_context: int | str | None
75
70
  :type undo: bool | None
76
71
  :param range: Frame Range, The range in which to create new keys
@@ -95,21 +90,18 @@ def channels_bake(
95
90
  """
96
91
 
97
92
  def channels_clean_empty(
98
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
99
- execution_context: int | str | None = None,
100
- undo: bool | None = None,
93
+ execution_context: int | str | None = None, undo: bool | None = None
101
94
  ):
102
95
  """Delete all empty animation data containers from visible data-blocks
103
96
 
104
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
105
97
  :type execution_context: int | str | None
106
98
  :type undo: bool | None
107
99
  """
108
100
 
109
101
  def channels_click(
110
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
111
102
  execution_context: int | str | None = None,
112
103
  undo: bool | None = None,
104
+ /,
113
105
  *,
114
106
  extend: bool | None = False,
115
107
  extend_range: bool | None = False,
@@ -117,7 +109,6 @@ def channels_click(
117
109
  ):
118
110
  """Handle mouse clicks over animation channels
119
111
 
120
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
121
112
  :type execution_context: int | str | None
122
113
  :type undo: bool | None
123
114
  :param extend: Extend Select
@@ -129,15 +120,14 @@ def channels_click(
129
120
  """
130
121
 
131
122
  def channels_collapse(
132
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
133
123
  execution_context: int | str | None = None,
134
124
  undo: bool | None = None,
125
+ /,
135
126
  *,
136
127
  all: bool | None = True,
137
128
  ):
138
129
  """Collapse (close) all selected expandable animation channels
139
130
 
140
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
141
131
  :type execution_context: int | str | None
142
132
  :type undo: bool | None
143
133
  :param all: All, Collapse all channels (not just selected ones)
@@ -145,28 +135,24 @@ def channels_collapse(
145
135
  """
146
136
 
147
137
  def channels_delete(
148
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
149
- execution_context: int | str | None = None,
150
- undo: bool | None = None,
138
+ execution_context: int | str | None = None, undo: bool | None = None
151
139
  ):
152
140
  """Delete all selected animation channels
153
141
 
154
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
155
142
  :type execution_context: int | str | None
156
143
  :type undo: bool | None
157
144
  """
158
145
 
159
146
  def channels_editable_toggle(
160
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
161
147
  execution_context: int | str | None = None,
162
148
  undo: bool | None = None,
149
+ /,
163
150
  *,
164
151
  mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "TOGGLE",
165
152
  type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
166
153
  ):
167
154
  """Toggle editability of selected channels
168
155
 
169
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
170
156
  :type execution_context: int | str | None
171
157
  :type undo: bool | None
172
158
  :param mode: Mode
@@ -176,15 +162,14 @@ def channels_editable_toggle(
176
162
  """
177
163
 
178
164
  def channels_expand(
179
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
180
165
  execution_context: int | str | None = None,
181
166
  undo: bool | None = None,
167
+ /,
182
168
  *,
183
169
  all: bool | None = True,
184
170
  ):
185
171
  """Expand (open) all selected expandable animation channels
186
172
 
187
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
188
173
  :type execution_context: int | str | None
189
174
  :type undo: bool | None
190
175
  :param all: All, Expand all channels (not just selected ones)
@@ -192,27 +177,23 @@ def channels_expand(
192
177
  """
193
178
 
194
179
  def channels_fcurves_enable(
195
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
196
- execution_context: int | str | None = None,
197
- undo: bool | None = None,
180
+ execution_context: int | str | None = None, undo: bool | None = None
198
181
  ):
199
182
  """Clear 'disabled' tag from all F-Curves to get broken F-Curves working again
200
183
 
201
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
202
184
  :type execution_context: int | str | None
203
185
  :type undo: bool | None
204
186
  """
205
187
 
206
188
  def channels_group(
207
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
208
189
  execution_context: int | str | None = None,
209
190
  undo: bool | None = None,
191
+ /,
210
192
  *,
211
193
  name: str = "New Group",
212
194
  ):
213
195
  """Add selected F-Curves to a new group
214
196
 
215
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
216
197
  :type execution_context: int | str | None
217
198
  :type undo: bool | None
218
199
  :param name: Name, Name of newly created group
@@ -220,15 +201,14 @@ def channels_group(
220
201
  """
221
202
 
222
203
  def channels_move(
223
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
224
204
  execution_context: int | str | None = None,
225
205
  undo: bool | None = None,
206
+ /,
226
207
  *,
227
208
  direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "DOWN",
228
209
  ):
229
210
  """Rearrange selected animation channels
230
211
 
231
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
232
212
  :type execution_context: int | str | None
233
213
  :type undo: bool | None
234
214
  :param direction: Direction
@@ -236,27 +216,23 @@ def channels_move(
236
216
  """
237
217
 
238
218
  def channels_rename(
239
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
240
- execution_context: int | str | None = None,
241
- undo: bool | None = None,
219
+ execution_context: int | str | None = None, undo: bool | None = None
242
220
  ):
243
221
  """Rename animation channel under mouse
244
222
 
245
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
246
223
  :type execution_context: int | str | None
247
224
  :type undo: bool | None
248
225
  """
249
226
 
250
227
  def channels_select_all(
251
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
252
228
  execution_context: int | str | None = None,
253
229
  undo: bool | None = None,
230
+ /,
254
231
  *,
255
232
  action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
256
233
  ):
257
234
  """Toggle selection of all animation channels
258
235
 
259
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
260
236
  :type execution_context: int | str | None
261
237
  :type undo: bool | None
262
238
  :param action: Action, Selection action to execute
@@ -276,9 +252,9 @@ def channels_select_all(
276
252
  """
277
253
 
278
254
  def channels_select_box(
279
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
280
255
  execution_context: int | str | None = None,
281
256
  undo: bool | None = None,
257
+ /,
282
258
  *,
283
259
  xmin: int | None = 0,
284
260
  xmax: int | None = 0,
@@ -290,7 +266,6 @@ def channels_select_box(
290
266
  ):
291
267
  """Select all animation channels within the specified region
292
268
 
293
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
294
269
  :type execution_context: int | str | None
295
270
  :type undo: bool | None
296
271
  :param xmin: X Min
@@ -310,28 +285,24 @@ def channels_select_box(
310
285
  """
311
286
 
312
287
  def channels_select_filter(
313
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
314
- execution_context: int | str | None = None,
315
- undo: bool | None = None,
288
+ execution_context: int | str | None = None, undo: bool | None = None
316
289
  ):
317
290
  """Start entering text which filters the set of channels shown to only include those with matching names
318
291
 
319
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
320
292
  :type execution_context: int | str | None
321
293
  :type undo: bool | None
322
294
  """
323
295
 
324
296
  def channels_setting_disable(
325
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
326
297
  execution_context: int | str | None = None,
327
298
  undo: bool | None = None,
299
+ /,
328
300
  *,
329
301
  mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "DISABLE",
330
302
  type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
331
303
  ):
332
304
  """Disable specified setting on all selected animation channels
333
305
 
334
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
335
306
  :type execution_context: int | str | None
336
307
  :type undo: bool | None
337
308
  :param mode: Mode
@@ -341,16 +312,15 @@ def channels_setting_disable(
341
312
  """
342
313
 
343
314
  def channels_setting_enable(
344
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
345
315
  execution_context: int | str | None = None,
346
316
  undo: bool | None = None,
317
+ /,
347
318
  *,
348
319
  mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "ENABLE",
349
320
  type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
350
321
  ):
351
322
  """Enable specified setting on all selected animation channels
352
323
 
353
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
354
324
  :type execution_context: int | str | None
355
325
  :type undo: bool | None
356
326
  :param mode: Mode
@@ -360,16 +330,15 @@ def channels_setting_enable(
360
330
  """
361
331
 
362
332
  def channels_setting_toggle(
363
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
364
333
  execution_context: int | str | None = None,
365
334
  undo: bool | None = None,
335
+ /,
366
336
  *,
367
337
  mode: typing.Literal["TOGGLE", "DISABLE", "ENABLE", "INVERT"] | None = "TOGGLE",
368
338
  type: typing.Literal["PROTECT", "MUTE"] | None = "PROTECT",
369
339
  ):
370
340
  """Toggle specified setting on all selected animation channels
371
341
 
372
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
373
342
  :type execution_context: int | str | None
374
343
  :type undo: bool | None
375
344
  :param mode: Mode
@@ -379,28 +348,24 @@ def channels_setting_toggle(
379
348
  """
380
349
 
381
350
  def channels_ungroup(
382
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
383
- execution_context: int | str | None = None,
384
- undo: bool | None = None,
351
+ execution_context: int | str | None = None, undo: bool | None = None
385
352
  ):
386
353
  """Remove selected F-Curves from their current groups
387
354
 
388
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
389
355
  :type execution_context: int | str | None
390
356
  :type undo: bool | None
391
357
  """
392
358
 
393
359
  def channels_view_selected(
394
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
395
360
  execution_context: int | str | None = None,
396
361
  undo: bool | None = None,
362
+ /,
397
363
  *,
398
364
  include_handles: bool | None = True,
399
365
  use_preview_range: bool | None = True,
400
366
  ):
401
367
  """Reset viewable area to show the selected channels
402
368
 
403
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
404
369
  :type execution_context: int | str | None
405
370
  :type undo: bool | None
406
371
  :param include_handles: Include Handles, Include handles of keyframes when calculating extents
@@ -410,15 +375,14 @@ def channels_view_selected(
410
375
  """
411
376
 
412
377
  def clear_useless_actions(
413
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
414
378
  execution_context: int | str | None = None,
415
379
  undo: bool | None = None,
380
+ /,
416
381
  *,
417
382
  only_unused: bool | None = True,
418
383
  ):
419
384
  """Mark actions with no F-Curves for deletion after save and reload of file preserving "action libraries"
420
385
 
421
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
422
386
  :type execution_context: int | str | None
423
387
  :type undo: bool | None
424
388
  :param only_unused: Only Unused, Only unused (Fake User only) actions get considered
@@ -426,91 +390,72 @@ def clear_useless_actions(
426
390
  """
427
391
 
428
392
  def convert_legacy_action(
429
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
430
- execution_context: int | str | None = None,
431
- undo: bool | None = None,
393
+ execution_context: int | str | None = None, undo: bool | None = None
432
394
  ):
433
395
  """Convert a legacy Action to a layered Action on the active object
434
396
 
435
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
436
397
  :type execution_context: int | str | None
437
398
  :type undo: bool | None
438
399
  """
439
400
 
440
401
  def copy_driver_button(
441
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
442
- execution_context: int | str | None = None,
443
- undo: bool | None = None,
402
+ execution_context: int | str | None = None, undo: bool | None = None
444
403
  ):
445
404
  """Copy the driver for the highlighted button
446
405
 
447
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
448
406
  :type execution_context: int | str | None
449
407
  :type undo: bool | None
450
408
  """
451
409
 
452
410
  def driver_button_add(
453
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
454
- execution_context: int | str | None = None,
455
- undo: bool | None = None,
411
+ execution_context: int | str | None = None, undo: bool | None = None
456
412
  ):
457
413
  """Add driver for the property under the cursor
458
414
 
459
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
460
415
  :type execution_context: int | str | None
461
416
  :type undo: bool | None
462
417
  """
463
418
 
464
419
  def driver_button_edit(
465
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
466
- execution_context: int | str | None = None,
467
- undo: bool | None = None,
420
+ execution_context: int | str | None = None, undo: bool | None = None
468
421
  ):
469
422
  """Edit the drivers for the connected property represented by the highlighted button
470
423
 
471
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
472
424
  :type execution_context: int | str | None
473
425
  :type undo: bool | None
474
426
  """
475
427
 
476
428
  def driver_button_remove(
477
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
478
429
  execution_context: int | str | None = None,
479
430
  undo: bool | None = None,
431
+ /,
480
432
  *,
481
433
  all: bool | None = True,
482
434
  ):
483
435
  """Remove the driver(s) for the connected property(s) represented by the highlighted button
484
436
 
485
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
486
437
  :type execution_context: int | str | None
487
438
  :type undo: bool | None
488
439
  :param all: All, Delete drivers for all elements of the array
489
440
  :type all: bool | None
490
441
  """
491
442
 
492
- def end_frame_set(
493
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
494
- execution_context: int | str | None = None,
495
- undo: bool | None = None,
496
- ):
443
+ def end_frame_set(execution_context: int | str | None = None, undo: bool | None = None):
497
444
  """Set the current frame as the preview or scene end frame
498
445
 
499
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
500
446
  :type execution_context: int | str | None
501
447
  :type undo: bool | None
502
448
  """
503
449
 
504
450
  def keyframe_clear_button(
505
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
506
451
  execution_context: int | str | None = None,
507
452
  undo: bool | None = None,
453
+ /,
508
454
  *,
509
455
  all: bool | None = True,
510
456
  ):
511
457
  """Clear all keyframes on the currently active property
512
458
 
513
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
514
459
  :type execution_context: int | str | None
515
460
  :type undo: bool | None
516
461
  :param all: All, Clear keyframes from all elements of the array
@@ -518,15 +463,14 @@ def keyframe_clear_button(
518
463
  """
519
464
 
520
465
  def keyframe_clear_v3d(
521
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
522
466
  execution_context: int | str | None = None,
523
467
  undo: bool | None = None,
468
+ /,
524
469
  *,
525
470
  confirm: bool | None = True,
526
471
  ):
527
472
  """Remove all keyframe animation for selected objects
528
473
 
529
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
530
474
  :type execution_context: int | str | None
531
475
  :type undo: bool | None
532
476
  :param confirm: Confirm, Prompt for confirmation
@@ -534,15 +478,14 @@ def keyframe_clear_v3d(
534
478
  """
535
479
 
536
480
  def keyframe_delete(
537
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
538
481
  execution_context: int | str | None = None,
539
482
  undo: bool | None = None,
483
+ /,
540
484
  *,
541
485
  type: str | None = "DEFAULT",
542
486
  ):
543
487
  """Delete keyframes on the current frame for all properties in the specified Keying Set
544
488
 
545
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
546
489
  :type execution_context: int | str | None
547
490
  :type undo: bool | None
548
491
  :param type: Keying Set, The Keying Set to use
@@ -550,15 +493,14 @@ def keyframe_delete(
550
493
  """
551
494
 
552
495
  def keyframe_delete_button(
553
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
554
496
  execution_context: int | str | None = None,
555
497
  undo: bool | None = None,
498
+ /,
556
499
  *,
557
500
  all: bool | None = True,
558
501
  ):
559
502
  """Delete current keyframe of current UI-active property
560
503
 
561
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
562
504
  :type execution_context: int | str | None
563
505
  :type undo: bool | None
564
506
  :param all: All, Delete keyframes from all elements of the array
@@ -566,15 +508,14 @@ def keyframe_delete_button(
566
508
  """
567
509
 
568
510
  def keyframe_delete_by_name(
569
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
570
511
  execution_context: int | str | None = None,
571
512
  undo: bool | None = None,
513
+ /,
572
514
  *,
573
515
  type: str = "",
574
516
  ):
575
517
  """Alternate access to 'Delete Keyframe' for keymaps to use
576
518
 
577
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
578
519
  :type execution_context: int | str | None
579
520
  :type undo: bool | None
580
521
  :param type: Keying Set, The Keying Set to use
@@ -582,15 +523,14 @@ def keyframe_delete_by_name(
582
523
  """
583
524
 
584
525
  def keyframe_delete_v3d(
585
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
586
526
  execution_context: int | str | None = None,
587
527
  undo: bool | None = None,
528
+ /,
588
529
  *,
589
530
  confirm: bool | None = True,
590
531
  ):
591
532
  """Remove keyframes on current frame for selected objects and bones
592
533
 
593
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
594
534
  :type execution_context: int | str | None
595
535
  :type undo: bool | None
596
536
  :param confirm: Confirm, Prompt for confirmation
@@ -598,15 +538,14 @@ def keyframe_delete_v3d(
598
538
  """
599
539
 
600
540
  def keyframe_insert(
601
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
602
541
  execution_context: int | str | None = None,
603
542
  undo: bool | None = None,
543
+ /,
604
544
  *,
605
545
  type: str | None = "DEFAULT",
606
546
  ):
607
547
  """Insert keyframes on the current frame using either the active keying set, or the user preferences if no keying set is active
608
548
 
609
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
610
549
  :type execution_context: int | str | None
611
550
  :type undo: bool | None
612
551
  :param type: Keying Set, The Keying Set to use
@@ -614,15 +553,14 @@ def keyframe_insert(
614
553
  """
615
554
 
616
555
  def keyframe_insert_button(
617
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
618
556
  execution_context: int | str | None = None,
619
557
  undo: bool | None = None,
558
+ /,
620
559
  *,
621
560
  all: bool | None = True,
622
561
  ):
623
562
  """Insert a keyframe for current UI-active property
624
563
 
625
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
626
564
  :type execution_context: int | str | None
627
565
  :type undo: bool | None
628
566
  :param all: All, Insert a keyframe for all element of the array
@@ -630,15 +568,14 @@ def keyframe_insert_button(
630
568
  """
631
569
 
632
570
  def keyframe_insert_by_name(
633
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
634
571
  execution_context: int | str | None = None,
635
572
  undo: bool | None = None,
573
+ /,
636
574
  *,
637
575
  type: str = "",
638
576
  ):
639
577
  """Alternate access to 'Insert Keyframe' for keymaps to use
640
578
 
641
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
642
579
  :type execution_context: int | str | None
643
580
  :type undo: bool | None
644
581
  :param type: Keying Set, The Keying Set to use
@@ -646,16 +583,15 @@ def keyframe_insert_by_name(
646
583
  """
647
584
 
648
585
  def keyframe_insert_menu(
649
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
650
586
  execution_context: int | str | None = None,
651
587
  undo: bool | None = None,
588
+ /,
652
589
  *,
653
590
  type: str | None = "DEFAULT",
654
591
  always_prompt: bool | None = False,
655
592
  ):
656
593
  """Insert Keyframes for specified Keying Set, with menu of available Keying Sets if undefined
657
594
 
658
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
659
595
  :type execution_context: int | str | None
660
596
  :type undo: bool | None
661
597
  :param type: Keying Set, The Keying Set to use
@@ -665,15 +601,14 @@ def keyframe_insert_menu(
665
601
  """
666
602
 
667
603
  def keying_set_active_set(
668
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
669
604
  execution_context: int | str | None = None,
670
605
  undo: bool | None = None,
606
+ /,
671
607
  *,
672
608
  type: str | None = "DEFAULT",
673
609
  ):
674
610
  """Set a new active keying set
675
611
 
676
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
677
612
  :type execution_context: int | str | None
678
613
  :type undo: bool | None
679
614
  :param type: Keying Set, The Keying Set to use
@@ -681,21 +616,18 @@ def keying_set_active_set(
681
616
  """
682
617
 
683
618
  def keying_set_add(
684
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
685
- execution_context: int | str | None = None,
686
- undo: bool | None = None,
619
+ execution_context: int | str | None = None, undo: bool | None = None
687
620
  ):
688
621
  """Add a new (empty) keying set to the active Scene
689
622
 
690
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
691
623
  :type execution_context: int | str | None
692
624
  :type undo: bool | None
693
625
  """
694
626
 
695
627
  def keying_set_export(
696
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
697
628
  execution_context: int | str | None = None,
698
629
  undo: bool | None = None,
630
+ /,
699
631
  *,
700
632
  filepath: str = "",
701
633
  filter_folder: bool | None = True,
@@ -704,7 +636,6 @@ def keying_set_export(
704
636
  ):
705
637
  """Export Keying Set to a Python script
706
638
 
707
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
708
639
  :type execution_context: int | str | None
709
640
  :type undo: bool | None
710
641
  :param filepath: filepath
@@ -718,51 +649,41 @@ def keying_set_export(
718
649
  """
719
650
 
720
651
  def keying_set_path_add(
721
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
722
- execution_context: int | str | None = None,
723
- undo: bool | None = None,
652
+ execution_context: int | str | None = None, undo: bool | None = None
724
653
  ):
725
654
  """Add empty path to active keying set
726
655
 
727
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
728
656
  :type execution_context: int | str | None
729
657
  :type undo: bool | None
730
658
  """
731
659
 
732
660
  def keying_set_path_remove(
733
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
734
- execution_context: int | str | None = None,
735
- undo: bool | None = None,
661
+ execution_context: int | str | None = None, undo: bool | None = None
736
662
  ):
737
663
  """Remove active Path from active keying set
738
664
 
739
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
740
665
  :type execution_context: int | str | None
741
666
  :type undo: bool | None
742
667
  """
743
668
 
744
669
  def keying_set_remove(
745
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
746
- execution_context: int | str | None = None,
747
- undo: bool | None = None,
670
+ execution_context: int | str | None = None, undo: bool | None = None
748
671
  ):
749
672
  """Remove the active keying set
750
673
 
751
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
752
674
  :type execution_context: int | str | None
753
675
  :type undo: bool | None
754
676
  """
755
677
 
756
678
  def keyingset_button_add(
757
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
758
679
  execution_context: int | str | None = None,
759
680
  undo: bool | None = None,
681
+ /,
760
682
  *,
761
683
  all: bool | None = True,
762
684
  ):
763
685
  """Add current UI-active property to current keying set
764
686
 
765
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
766
687
  :type execution_context: int | str | None
767
688
  :type undo: bool | None
768
689
  :param all: All, Add all elements of the array to a Keying Set
@@ -770,57 +691,45 @@ def keyingset_button_add(
770
691
  """
771
692
 
772
693
  def keyingset_button_remove(
773
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
774
- execution_context: int | str | None = None,
775
- undo: bool | None = None,
694
+ execution_context: int | str | None = None, undo: bool | None = None
776
695
  ):
777
696
  """Remove current UI-active property from current keying set
778
697
 
779
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
780
698
  :type execution_context: int | str | None
781
699
  :type undo: bool | None
782
700
  """
783
701
 
784
702
  def merge_animation(
785
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
786
- execution_context: int | str | None = None,
787
- undo: bool | None = None,
703
+ execution_context: int | str | None = None, undo: bool | None = None
788
704
  ):
789
705
  """Merge the animation of the selected objects into the action of the active object. Actions are not deleted by this, but might end up with zero users
790
706
 
791
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
792
707
  :type execution_context: int | str | None
793
708
  :type undo: bool | None
794
709
  """
795
710
 
796
711
  def paste_driver_button(
797
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
798
- execution_context: int | str | None = None,
799
- undo: bool | None = None,
712
+ execution_context: int | str | None = None, undo: bool | None = None
800
713
  ):
801
714
  """Paste the driver in the internal clipboard to the highlighted button
802
715
 
803
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
804
716
  :type execution_context: int | str | None
805
717
  :type undo: bool | None
806
718
  """
807
719
 
808
720
  def previewrange_clear(
809
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
810
- execution_context: int | str | None = None,
811
- undo: bool | None = None,
721
+ execution_context: int | str | None = None, undo: bool | None = None
812
722
  ):
813
723
  """Clear preview range
814
724
 
815
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
816
725
  :type execution_context: int | str | None
817
726
  :type undo: bool | None
818
727
  """
819
728
 
820
729
  def previewrange_set(
821
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
822
730
  execution_context: int | str | None = None,
823
731
  undo: bool | None = None,
732
+ /,
824
733
  *,
825
734
  xmin: int | None = 0,
826
735
  xmax: int | None = 0,
@@ -830,7 +739,6 @@ def previewrange_set(
830
739
  ):
831
740
  """Interactively define frame range used for playback
832
741
 
833
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
834
742
  :type execution_context: int | str | None
835
743
  :type undo: bool | None
836
744
  :param xmin: X Min
@@ -846,111 +754,86 @@ def previewrange_set(
846
754
  """
847
755
 
848
756
  def scene_range_frame(
849
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
850
- execution_context: int | str | None = None,
851
- undo: bool | None = None,
757
+ execution_context: int | str | None = None, undo: bool | None = None
852
758
  ):
853
759
  """Reset the horizontal view to the current scene frame range, taking the preview range into account if it is active
854
760
 
855
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
856
761
  :type execution_context: int | str | None
857
762
  :type undo: bool | None
858
763
  """
859
764
 
860
765
  def separate_slots(
861
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
862
- execution_context: int | str | None = None,
863
- undo: bool | None = None,
766
+ execution_context: int | str | None = None, undo: bool | None = None
864
767
  ):
865
768
  """Move all slots of the action on the active object into newly created, separate actions. All users of those slots will be reassigned to the new actions. The current action won't be deleted but will be empty and might end up having zero users
866
769
 
867
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
868
770
  :type execution_context: int | str | None
869
771
  :type undo: bool | None
870
772
  """
871
773
 
872
774
  def slot_channels_move_to_new_action(
873
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
874
- execution_context: int | str | None = None,
875
- undo: bool | None = None,
775
+ execution_context: int | str | None = None, undo: bool | None = None
876
776
  ):
877
777
  """Move the selected slots into a newly created action
878
778
 
879
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
880
779
  :type execution_context: int | str | None
881
780
  :type undo: bool | None
882
781
  """
883
782
 
884
783
  def slot_new_for_id(
885
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
886
- execution_context: int | str | None = None,
887
- undo: bool | None = None,
784
+ execution_context: int | str | None = None, undo: bool | None = None
888
785
  ):
889
786
  """Create a new action slot for this data-block, to hold its animation
890
787
 
891
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
892
788
  :type execution_context: int | str | None
893
789
  :type undo: bool | None
894
790
  """
895
791
 
896
792
  def slot_unassign_from_constraint(
897
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
898
- execution_context: int | str | None = None,
899
- undo: bool | None = None,
793
+ execution_context: int | str | None = None, undo: bool | None = None
900
794
  ):
901
795
  """Un-assign the action slot from this constraint
902
796
 
903
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
904
797
  :type execution_context: int | str | None
905
798
  :type undo: bool | None
906
799
  """
907
800
 
908
801
  def slot_unassign_from_id(
909
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
910
- execution_context: int | str | None = None,
911
- undo: bool | None = None,
802
+ execution_context: int | str | None = None, undo: bool | None = None
912
803
  ):
913
804
  """Un-assign the action slot, effectively making this data-block non-animated
914
805
 
915
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
916
806
  :type execution_context: int | str | None
917
807
  :type undo: bool | None
918
808
  """
919
809
 
920
810
  def slot_unassign_from_nla_strip(
921
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
922
- execution_context: int | str | None = None,
923
- undo: bool | None = None,
811
+ execution_context: int | str | None = None, undo: bool | None = None
924
812
  ):
925
813
  """Un-assign the action slot from this NLA strip, effectively making it non-animated
926
814
 
927
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
928
815
  :type execution_context: int | str | None
929
816
  :type undo: bool | None
930
817
  """
931
818
 
932
819
  def start_frame_set(
933
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
934
- execution_context: int | str | None = None,
935
- undo: bool | None = None,
820
+ execution_context: int | str | None = None, undo: bool | None = None
936
821
  ):
937
822
  """Set the current frame as the preview or scene start frame
938
823
 
939
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
940
824
  :type execution_context: int | str | None
941
825
  :type undo: bool | None
942
826
  """
943
827
 
944
828
  def update_animated_transform_constraints(
945
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
946
829
  execution_context: int | str | None = None,
947
830
  undo: bool | None = None,
831
+ /,
948
832
  *,
949
833
  use_convert_to_radians: bool | None = True,
950
834
  ):
951
835
  """Update f-curves/drivers affecting Transform constraints (use it with files from 2.70 and earlier)
952
836
 
953
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
954
837
  :type execution_context: int | str | None
955
838
  :type undo: bool | None
956
839
  :param use_convert_to_radians: Convert to Radians, Convert f-curves/drivers affecting rotations to radians.Warning: Use this only once
@@ -958,16 +841,15 @@ def update_animated_transform_constraints(
958
841
  """
959
842
 
960
843
  def view_curve_in_graph_editor(
961
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
962
844
  execution_context: int | str | None = None,
963
845
  undo: bool | None = None,
846
+ /,
964
847
  *,
965
848
  all: bool | None = False,
966
849
  isolate: bool | None = False,
967
850
  ):
968
851
  """Frame the property under the cursor in the Graph Editor
969
852
 
970
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
971
853
  :type execution_context: int | str | None
972
854
  :type undo: bool | None
973
855
  :param all: Show All, Frame the whole array property instead of only the index under the cursor