fake-bpy-module 20240531__py3-none-any.whl → 20240604__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.
- aud/__init__.pyi +4 -4
- bl_console_utils/autocomplete/intellisense/__init__.pyi +2 -4
- bl_ui/space_sequencer/__init__.pyi +14 -0
- bl_ui/space_userpref/__init__.pyi +234 -0
- bl_ui/space_view3d/__init__.pyi +810 -0
- blf/__init__.pyi +4 -4
- bmesh/ops/__init__.pyi +97 -82
- bmesh/types/__init__.pyi +43 -40
- bmesh/utils/__init__.pyi +2 -4
- bpy/ops/action/__init__.pyi +152 -152
- bpy/ops/anim/__init__.pyi +216 -216
- bpy/ops/armature/__init__.pyi +192 -192
- bpy/ops/asset/__init__.pyi +64 -64
- bpy/ops/boid/__init__.pyi +32 -32
- bpy/ops/brush/__init__.pyi +36 -36
- bpy/ops/buttons/__init__.pyi +24 -24
- bpy/ops/cachefile/__init__.pyi +20 -20
- bpy/ops/camera/__init__.pyi +8 -8
- bpy/ops/clip/__init__.pyi +368 -368
- bpy/ops/cloth/__init__.pyi +4 -4
- bpy/ops/collection/__init__.pyi +36 -36
- bpy/ops/console/__init__.pyi +84 -84
- bpy/ops/constraint/__init__.pyi +72 -72
- bpy/ops/curve/__init__.pyi +204 -204
- bpy/ops/curves/__init__.pyi +108 -108
- bpy/ops/cycles/__init__.pyi +12 -12
- bpy/ops/dpaint/__init__.pyi +20 -20
- bpy/ops/ed/__init__.pyi +48 -48
- bpy/ops/export_anim/__init__.pyi +4 -4
- bpy/ops/export_scene/__init__.pyi +8 -8
- bpy/ops/extensions/__init__.pyi +130 -110
- bpy/ops/file/__init__.pyi +160 -160
- bpy/ops/fluid/__init__.pyi +56 -56
- bpy/ops/font/__init__.pyi +92 -92
- bpy/ops/geometry/__init__.pyi +40 -40
- bpy/ops/gizmogroup/__init__.pyi +8 -8
- bpy/ops/gpencil/__init__.pyi +600 -600
- bpy/ops/graph/__init__.pyi +260 -260
- bpy/ops/grease_pencil/__init__.pyi +292 -292
- bpy/ops/image/__init__.pyi +192 -192
- bpy/ops/import_anim/__init__.pyi +4 -4
- bpy/ops/import_curve/__init__.pyi +4 -4
- bpy/ops/import_scene/__init__.pyi +8 -8
- bpy/ops/info/__init__.pyi +28 -28
- bpy/ops/lattice/__init__.pyi +32 -32
- bpy/ops/marker/__init__.pyi +44 -44
- bpy/ops/mask/__init__.pyi +156 -156
- bpy/ops/material/__init__.pyi +12 -12
- bpy/ops/mball/__init__.pyi +32 -32
- bpy/ops/mesh/__init__.pyi +652 -652
- bpy/ops/nla/__init__.pyi +156 -156
- bpy/ops/node/__init__.pyi +450 -404
- bpy/ops/object/__init__.pyi +984 -987
- bpy/ops/outliner/__init__.pyi +284 -284
- bpy/ops/paint/__init__.pyi +220 -220
- bpy/ops/paintcurve/__init__.pyi +32 -32
- bpy/ops/palette/__init__.pyi +28 -28
- bpy/ops/particle/__init__.pyi +144 -144
- bpy/ops/pose/__init__.pyi +156 -156
- bpy/ops/poselib/__init__.pyi +36 -36
- bpy/ops/preferences/__init__.pyi +151 -148
- bpy/ops/ptcache/__init__.pyi +28 -28
- bpy/ops/render/__init__.pyi +48 -48
- bpy/ops/rigidbody/__init__.pyi +52 -52
- bpy/ops/scene/__init__.pyi +156 -156
- bpy/ops/screen/__init__.pyi +156 -156
- bpy/ops/script/__init__.pyi +12 -12
- bpy/ops/sculpt/__init__.pyi +144 -144
- bpy/ops/sculpt_curves/__init__.pyi +16 -16
- bpy/ops/sequencer/__init__.pyi +364 -340
- bpy/ops/sound/__init__.pyi +28 -28
- bpy/ops/spreadsheet/__init__.pyi +16 -16
- bpy/ops/surface/__init__.pyi +24 -24
- bpy/ops/text/__init__.pyi +172 -172
- bpy/ops/text_editor/__init__.pyi +4 -4
- bpy/ops/texture/__init__.pyi +16 -16
- bpy/ops/transform/__init__.pyi +111 -108
- bpy/ops/ui/__init__.pyi +132 -132
- bpy/ops/uilist/__init__.pyi +12 -12
- bpy/ops/uv/__init__.pyi +196 -196
- bpy/ops/view2d/__init__.pyi +56 -56
- bpy/ops/view3d/__init__.pyi +268 -268
- bpy/ops/wm/__init__.pyi +475 -448
- bpy/ops/workspace/__init__.pyi +28 -28
- bpy/ops/world/__init__.pyi +8 -8
- bpy/path/__init__.pyi +18 -18
- bpy/props/__init__.pyi +11 -11
- bpy/types/__init__.pyi +2136 -1798
- bpy/utils/__init__.pyi +4 -4
- bpy_extras/anim_utils/__init__.pyi +4 -4
- bpy_extras/io_utils/__init__.pyi +4 -4
- bpy_extras/mesh_utils/__init__.pyi +4 -4
- bpy_extras/view3d_utils/__init__.pyi +24 -20
- bpy_types/__init__.pyi +12 -7
- {fake_bpy_module-20240531.dist-info → fake_bpy_module-20240604.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240531.dist-info → fake_bpy_module-20240604.dist-info}/RECORD +107 -107
- freestyle/types/__init__.pyi +64 -64
- freestyle/utils/__init__.pyi +2 -2
- gpu/matrix/__init__.pyi +15 -6
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +6 -4
- gpu_extras/presets/__init__.pyi +8 -4
- imbuf/__init__.pyi +4 -4
- mathutils/__init__.pyi +292 -187
- mathutils/geometry/__init__.pyi +2 -5
- {fake_bpy_module-20240531.dist-info → fake_bpy_module-20240604.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240531.dist-info → fake_bpy_module-20240604.dist-info}/top_level.txt +0 -0
bpy/ops/wm/__init__.pyi
CHANGED
|
@@ -7,8 +7,8 @@ GenericType1 = typing.TypeVar("GenericType1")
|
|
|
7
7
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
8
8
|
|
|
9
9
|
def alembic_export(
|
|
10
|
-
override_context: dict[str, typing.Any] |
|
|
11
|
-
execution_context:
|
|
10
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
11
|
+
execution_context: int | str | None = None,
|
|
12
12
|
undo: bool | None = None,
|
|
13
13
|
*,
|
|
14
14
|
filepath: str | typing.Any = "",
|
|
@@ -67,8 +67,8 @@ def alembic_export(
|
|
|
67
67
|
):
|
|
68
68
|
"""Export current scene in an Alembic archive
|
|
69
69
|
|
|
70
|
-
:type override_context: dict[str, typing.Any] |
|
|
71
|
-
:type execution_context:
|
|
70
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
71
|
+
:type execution_context: int | str | None
|
|
72
72
|
:type undo: bool | None
|
|
73
73
|
:param filepath: File Path, Path to file
|
|
74
74
|
:type filepath: str | typing.Any
|
|
@@ -197,8 +197,8 @@ def alembic_export(
|
|
|
197
197
|
...
|
|
198
198
|
|
|
199
199
|
def alembic_import(
|
|
200
|
-
override_context: dict[str, typing.Any] |
|
|
201
|
-
execution_context:
|
|
200
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
201
|
+
execution_context: int | str | None = None,
|
|
202
202
|
undo: bool | None = None,
|
|
203
203
|
*,
|
|
204
204
|
filepath: str | typing.Any = "",
|
|
@@ -234,8 +234,8 @@ def alembic_import(
|
|
|
234
234
|
):
|
|
235
235
|
"""Load an Alembic archive
|
|
236
236
|
|
|
237
|
-
:type override_context: dict[str, typing.Any] |
|
|
238
|
-
:type execution_context:
|
|
237
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
238
|
+
:type execution_context: int | str | None
|
|
239
239
|
:type undo: bool | None
|
|
240
240
|
:param filepath: File Path, Path to file
|
|
241
241
|
:type filepath: str | typing.Any
|
|
@@ -313,8 +313,8 @@ def alembic_import(
|
|
|
313
313
|
...
|
|
314
314
|
|
|
315
315
|
def append(
|
|
316
|
-
override_context: dict[str, typing.Any] |
|
|
317
|
-
execution_context:
|
|
316
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
317
|
+
execution_context: int | str | None = None,
|
|
318
318
|
undo: bool | None = None,
|
|
319
319
|
*,
|
|
320
320
|
filepath: str | typing.Any = "",
|
|
@@ -355,8 +355,8 @@ def append(
|
|
|
355
355
|
):
|
|
356
356
|
"""Append from a Library .blend file
|
|
357
357
|
|
|
358
|
-
:type override_context: dict[str, typing.Any] |
|
|
359
|
-
:type execution_context:
|
|
358
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
359
|
+
:type execution_context: int | str | None
|
|
360
360
|
:type undo: bool | None
|
|
361
361
|
:param filepath: File Path, Path to file
|
|
362
362
|
:type filepath: str | typing.Any
|
|
@@ -443,8 +443,8 @@ def append(
|
|
|
443
443
|
...
|
|
444
444
|
|
|
445
445
|
def batch_rename(
|
|
446
|
-
override_context: dict[str, typing.Any] |
|
|
447
|
-
execution_context:
|
|
446
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
447
|
+
execution_context: int | str | None = None,
|
|
448
448
|
undo: bool | None = None,
|
|
449
449
|
*,
|
|
450
450
|
data_type: str | None = "OBJECT",
|
|
@@ -454,8 +454,8 @@ def batch_rename(
|
|
|
454
454
|
):
|
|
455
455
|
"""Rename multiple items at once
|
|
456
456
|
|
|
457
|
-
:type override_context: dict[str, typing.Any] |
|
|
458
|
-
:type execution_context:
|
|
457
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
458
|
+
:type execution_context: int | str | None
|
|
459
459
|
:type undo: bool | None
|
|
460
460
|
:param data_type: Type, Type of data to rename
|
|
461
461
|
:type data_type: str | None
|
|
@@ -468,30 +468,30 @@ def batch_rename(
|
|
|
468
468
|
...
|
|
469
469
|
|
|
470
470
|
def blend_strings_utf8_validate(
|
|
471
|
-
override_context: dict[str, typing.Any] |
|
|
472
|
-
execution_context:
|
|
471
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
472
|
+
execution_context: int | str | None = None,
|
|
473
473
|
undo: bool | None = None,
|
|
474
474
|
):
|
|
475
475
|
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
|
|
476
476
|
|
|
477
|
-
:type override_context: dict[str, typing.Any] |
|
|
478
|
-
:type execution_context:
|
|
477
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
478
|
+
:type execution_context: int | str | None
|
|
479
479
|
:type undo: bool | None
|
|
480
480
|
"""
|
|
481
481
|
|
|
482
482
|
...
|
|
483
483
|
|
|
484
484
|
def call_menu(
|
|
485
|
-
override_context: dict[str, typing.Any] |
|
|
486
|
-
execution_context:
|
|
485
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
486
|
+
execution_context: int | str | None = None,
|
|
487
487
|
undo: bool | None = None,
|
|
488
488
|
*,
|
|
489
489
|
name: str | typing.Any = "",
|
|
490
490
|
):
|
|
491
491
|
"""Open a predefined menu
|
|
492
492
|
|
|
493
|
-
:type override_context: dict[str, typing.Any] |
|
|
494
|
-
:type execution_context:
|
|
493
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
494
|
+
:type execution_context: int | str | None
|
|
495
495
|
:type undo: bool | None
|
|
496
496
|
:param name: Name, Name of the menu
|
|
497
497
|
:type name: str | typing.Any
|
|
@@ -500,16 +500,16 @@ def call_menu(
|
|
|
500
500
|
...
|
|
501
501
|
|
|
502
502
|
def call_menu_pie(
|
|
503
|
-
override_context: dict[str, typing.Any] |
|
|
504
|
-
execution_context:
|
|
503
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
504
|
+
execution_context: int | str | None = None,
|
|
505
505
|
undo: bool | None = None,
|
|
506
506
|
*,
|
|
507
507
|
name: str | typing.Any = "",
|
|
508
508
|
):
|
|
509
509
|
"""Open a predefined pie menu
|
|
510
510
|
|
|
511
|
-
:type override_context: dict[str, typing.Any] |
|
|
512
|
-
:type execution_context:
|
|
511
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
512
|
+
:type execution_context: int | str | None
|
|
513
513
|
:type undo: bool | None
|
|
514
514
|
:param name: Name, Name of the pie menu
|
|
515
515
|
:type name: str | typing.Any
|
|
@@ -518,8 +518,8 @@ def call_menu_pie(
|
|
|
518
518
|
...
|
|
519
519
|
|
|
520
520
|
def call_panel(
|
|
521
|
-
override_context: dict[str, typing.Any] |
|
|
522
|
-
execution_context:
|
|
521
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
522
|
+
execution_context: int | str | None = None,
|
|
523
523
|
undo: bool | None = None,
|
|
524
524
|
*,
|
|
525
525
|
name: str | typing.Any = "",
|
|
@@ -527,8 +527,8 @@ def call_panel(
|
|
|
527
527
|
):
|
|
528
528
|
"""Open a predefined panel
|
|
529
529
|
|
|
530
|
-
:type override_context: dict[str, typing.Any] |
|
|
531
|
-
:type execution_context:
|
|
530
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
531
|
+
:type execution_context: int | str | None
|
|
532
532
|
:type undo: bool | None
|
|
533
533
|
:param name: Name, Name of the menu
|
|
534
534
|
:type name: str | typing.Any
|
|
@@ -539,22 +539,22 @@ def call_panel(
|
|
|
539
539
|
...
|
|
540
540
|
|
|
541
541
|
def clear_recent_files(
|
|
542
|
-
override_context: dict[str, typing.Any] |
|
|
543
|
-
execution_context:
|
|
542
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
543
|
+
execution_context: int | str | None = None,
|
|
544
544
|
undo: bool | None = None,
|
|
545
545
|
):
|
|
546
546
|
"""Clear the recent files list
|
|
547
547
|
|
|
548
|
-
:type override_context: dict[str, typing.Any] |
|
|
549
|
-
:type execution_context:
|
|
548
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
549
|
+
:type execution_context: int | str | None
|
|
550
550
|
:type undo: bool | None
|
|
551
551
|
"""
|
|
552
552
|
|
|
553
553
|
...
|
|
554
554
|
|
|
555
555
|
def collada_export(
|
|
556
|
-
override_context: dict[str, typing.Any] |
|
|
557
|
-
execution_context:
|
|
556
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
557
|
+
execution_context: int | str | None = None,
|
|
558
558
|
undo: bool | None = None,
|
|
559
559
|
*,
|
|
560
560
|
filepath: str | typing.Any = "",
|
|
@@ -615,8 +615,8 @@ def collada_export(
|
|
|
615
615
|
):
|
|
616
616
|
"""Save a Collada file
|
|
617
617
|
|
|
618
|
-
:type override_context: dict[str, typing.Any] |
|
|
619
|
-
:type execution_context:
|
|
618
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
619
|
+
:type execution_context: int | str | None
|
|
620
620
|
:type undo: bool | None
|
|
621
621
|
:param filepath: File Path, Path to file
|
|
622
622
|
:type filepath: str | typing.Any
|
|
@@ -819,8 +819,8 @@ def collada_export(
|
|
|
819
819
|
...
|
|
820
820
|
|
|
821
821
|
def collada_import(
|
|
822
|
-
override_context: dict[str, typing.Any] |
|
|
823
|
-
execution_context:
|
|
822
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
823
|
+
execution_context: int | str | None = None,
|
|
824
824
|
undo: bool | None = None,
|
|
825
825
|
*,
|
|
826
826
|
filepath: str | typing.Any = "",
|
|
@@ -856,8 +856,8 @@ def collada_import(
|
|
|
856
856
|
):
|
|
857
857
|
"""Load a Collada file
|
|
858
858
|
|
|
859
|
-
:type override_context: dict[str, typing.Any] |
|
|
860
|
-
:type execution_context:
|
|
859
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
860
|
+
:type execution_context: int | str | None
|
|
861
861
|
:type undo: bool | None
|
|
862
862
|
:param filepath: File Path, Path to file
|
|
863
863
|
:type filepath: str | typing.Any
|
|
@@ -935,22 +935,22 @@ def collada_import(
|
|
|
935
935
|
...
|
|
936
936
|
|
|
937
937
|
def collection_export_all(
|
|
938
|
-
override_context: dict[str, typing.Any] |
|
|
939
|
-
execution_context:
|
|
938
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
939
|
+
execution_context: int | str | None = None,
|
|
940
940
|
undo: bool | None = None,
|
|
941
941
|
):
|
|
942
942
|
"""Invoke all configured exporters for all collections
|
|
943
943
|
|
|
944
|
-
:type override_context: dict[str, typing.Any] |
|
|
945
|
-
:type execution_context:
|
|
944
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
945
|
+
:type execution_context: int | str | None
|
|
946
946
|
:type undo: bool | None
|
|
947
947
|
"""
|
|
948
948
|
|
|
949
949
|
...
|
|
950
950
|
|
|
951
951
|
def context_collection_boolean_set(
|
|
952
|
-
override_context: dict[str, typing.Any] |
|
|
953
|
-
execution_context:
|
|
952
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
953
|
+
execution_context: int | str | None = None,
|
|
954
954
|
undo: bool | None = None,
|
|
955
955
|
*,
|
|
956
956
|
data_path_iter: str | typing.Any = "",
|
|
@@ -959,8 +959,8 @@ def context_collection_boolean_set(
|
|
|
959
959
|
):
|
|
960
960
|
"""Set boolean values for a collection of items
|
|
961
961
|
|
|
962
|
-
:type override_context: dict[str, typing.Any] |
|
|
963
|
-
:type execution_context:
|
|
962
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
963
|
+
:type execution_context: int | str | None
|
|
964
964
|
:type undo: bool | None
|
|
965
965
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
966
966
|
:type data_path_iter: str | typing.Any
|
|
@@ -973,8 +973,8 @@ def context_collection_boolean_set(
|
|
|
973
973
|
...
|
|
974
974
|
|
|
975
975
|
def context_cycle_array(
|
|
976
|
-
override_context: dict[str, typing.Any] |
|
|
977
|
-
execution_context:
|
|
976
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
977
|
+
execution_context: int | str | None = None,
|
|
978
978
|
undo: bool | None = None,
|
|
979
979
|
*,
|
|
980
980
|
data_path: str | typing.Any = "",
|
|
@@ -982,8 +982,8 @@ def context_cycle_array(
|
|
|
982
982
|
):
|
|
983
983
|
"""Set a context array value (useful for cycling the active mesh edit mode)
|
|
984
984
|
|
|
985
|
-
:type override_context: dict[str, typing.Any] |
|
|
986
|
-
:type execution_context:
|
|
985
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
986
|
+
:type execution_context: int | str | None
|
|
987
987
|
:type undo: bool | None
|
|
988
988
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
989
989
|
:type data_path: str | typing.Any
|
|
@@ -994,8 +994,8 @@ def context_cycle_array(
|
|
|
994
994
|
...
|
|
995
995
|
|
|
996
996
|
def context_cycle_enum(
|
|
997
|
-
override_context: dict[str, typing.Any] |
|
|
998
|
-
execution_context:
|
|
997
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
998
|
+
execution_context: int | str | None = None,
|
|
999
999
|
undo: bool | None = None,
|
|
1000
1000
|
*,
|
|
1001
1001
|
data_path: str | typing.Any = "",
|
|
@@ -1004,8 +1004,8 @@ def context_cycle_enum(
|
|
|
1004
1004
|
):
|
|
1005
1005
|
"""Toggle a context value
|
|
1006
1006
|
|
|
1007
|
-
:type override_context: dict[str, typing.Any] |
|
|
1008
|
-
:type execution_context:
|
|
1007
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1008
|
+
:type execution_context: int | str | None
|
|
1009
1009
|
:type undo: bool | None
|
|
1010
1010
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1011
1011
|
:type data_path: str | typing.Any
|
|
@@ -1018,8 +1018,8 @@ def context_cycle_enum(
|
|
|
1018
1018
|
...
|
|
1019
1019
|
|
|
1020
1020
|
def context_cycle_int(
|
|
1021
|
-
override_context: dict[str, typing.Any] |
|
|
1022
|
-
execution_context:
|
|
1021
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1022
|
+
execution_context: int | str | None = None,
|
|
1023
1023
|
undo: bool | None = None,
|
|
1024
1024
|
*,
|
|
1025
1025
|
data_path: str | typing.Any = "",
|
|
@@ -1028,8 +1028,8 @@ def context_cycle_int(
|
|
|
1028
1028
|
):
|
|
1029
1029
|
"""Set a context value (useful for cycling active material, shape keys, groups, etc.)
|
|
1030
1030
|
|
|
1031
|
-
:type override_context: dict[str, typing.Any] |
|
|
1032
|
-
:type execution_context:
|
|
1031
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1032
|
+
:type execution_context: int | str | None
|
|
1033
1033
|
:type undo: bool | None
|
|
1034
1034
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1035
1035
|
:type data_path: str | typing.Any
|
|
@@ -1042,16 +1042,16 @@ def context_cycle_int(
|
|
|
1042
1042
|
...
|
|
1043
1043
|
|
|
1044
1044
|
def context_menu_enum(
|
|
1045
|
-
override_context: dict[str, typing.Any] |
|
|
1046
|
-
execution_context:
|
|
1045
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1046
|
+
execution_context: int | str | None = None,
|
|
1047
1047
|
undo: bool | None = None,
|
|
1048
1048
|
*,
|
|
1049
1049
|
data_path: str | typing.Any = "",
|
|
1050
1050
|
):
|
|
1051
1051
|
"""Undocumented, consider contributing.
|
|
1052
1052
|
|
|
1053
|
-
:type override_context: dict[str, typing.Any] |
|
|
1054
|
-
:type execution_context:
|
|
1053
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1054
|
+
:type execution_context: int | str | None
|
|
1055
1055
|
:type undo: bool | None
|
|
1056
1056
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1057
1057
|
:type data_path: str | typing.Any
|
|
@@ -1060,8 +1060,8 @@ def context_menu_enum(
|
|
|
1060
1060
|
...
|
|
1061
1061
|
|
|
1062
1062
|
def context_modal_mouse(
|
|
1063
|
-
override_context: dict[str, typing.Any] |
|
|
1064
|
-
execution_context:
|
|
1063
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1064
|
+
execution_context: int | str | None = None,
|
|
1065
1065
|
undo: bool | None = None,
|
|
1066
1066
|
*,
|
|
1067
1067
|
data_path_iter: str | typing.Any = "",
|
|
@@ -1073,8 +1073,8 @@ def context_modal_mouse(
|
|
|
1073
1073
|
):
|
|
1074
1074
|
"""Adjust arbitrary values with mouse input
|
|
1075
1075
|
|
|
1076
|
-
:type override_context: dict[str, typing.Any] |
|
|
1077
|
-
:type execution_context:
|
|
1076
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1077
|
+
:type execution_context: int | str | None
|
|
1078
1078
|
:type undo: bool | None
|
|
1079
1079
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
1080
1080
|
:type data_path_iter: str | typing.Any
|
|
@@ -1093,16 +1093,16 @@ def context_modal_mouse(
|
|
|
1093
1093
|
...
|
|
1094
1094
|
|
|
1095
1095
|
def context_pie_enum(
|
|
1096
|
-
override_context: dict[str, typing.Any] |
|
|
1097
|
-
execution_context:
|
|
1096
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1097
|
+
execution_context: int | str | None = None,
|
|
1098
1098
|
undo: bool | None = None,
|
|
1099
1099
|
*,
|
|
1100
1100
|
data_path: str | typing.Any = "",
|
|
1101
1101
|
):
|
|
1102
1102
|
"""Undocumented, consider contributing.
|
|
1103
1103
|
|
|
1104
|
-
:type override_context: dict[str, typing.Any] |
|
|
1105
|
-
:type execution_context:
|
|
1104
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1105
|
+
:type execution_context: int | str | None
|
|
1106
1106
|
:type undo: bool | None
|
|
1107
1107
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1108
1108
|
:type data_path: str | typing.Any
|
|
@@ -1111,8 +1111,8 @@ def context_pie_enum(
|
|
|
1111
1111
|
...
|
|
1112
1112
|
|
|
1113
1113
|
def context_scale_float(
|
|
1114
|
-
override_context: dict[str, typing.Any] |
|
|
1115
|
-
execution_context:
|
|
1114
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1115
|
+
execution_context: int | str | None = None,
|
|
1116
1116
|
undo: bool | None = None,
|
|
1117
1117
|
*,
|
|
1118
1118
|
data_path: str | typing.Any = "",
|
|
@@ -1120,8 +1120,8 @@ def context_scale_float(
|
|
|
1120
1120
|
):
|
|
1121
1121
|
"""Scale a float context value
|
|
1122
1122
|
|
|
1123
|
-
:type override_context: dict[str, typing.Any] |
|
|
1124
|
-
:type execution_context:
|
|
1123
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1124
|
+
:type execution_context: int | str | None
|
|
1125
1125
|
:type undo: bool | None
|
|
1126
1126
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1127
1127
|
:type data_path: str | typing.Any
|
|
@@ -1132,8 +1132,8 @@ def context_scale_float(
|
|
|
1132
1132
|
...
|
|
1133
1133
|
|
|
1134
1134
|
def context_scale_int(
|
|
1135
|
-
override_context: dict[str, typing.Any] |
|
|
1136
|
-
execution_context:
|
|
1135
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1136
|
+
execution_context: int | str | None = None,
|
|
1137
1137
|
undo: bool | None = None,
|
|
1138
1138
|
*,
|
|
1139
1139
|
data_path: str | typing.Any = "",
|
|
@@ -1142,8 +1142,8 @@ def context_scale_int(
|
|
|
1142
1142
|
):
|
|
1143
1143
|
"""Scale an int context value
|
|
1144
1144
|
|
|
1145
|
-
:type override_context: dict[str, typing.Any] |
|
|
1146
|
-
:type execution_context:
|
|
1145
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1146
|
+
:type execution_context: int | str | None
|
|
1147
1147
|
:type undo: bool | None
|
|
1148
1148
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1149
1149
|
:type data_path: str | typing.Any
|
|
@@ -1156,8 +1156,8 @@ def context_scale_int(
|
|
|
1156
1156
|
...
|
|
1157
1157
|
|
|
1158
1158
|
def context_set_boolean(
|
|
1159
|
-
override_context: dict[str, typing.Any] |
|
|
1160
|
-
execution_context:
|
|
1159
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1160
|
+
execution_context: int | str | None = None,
|
|
1161
1161
|
undo: bool | None = None,
|
|
1162
1162
|
*,
|
|
1163
1163
|
data_path: str | typing.Any = "",
|
|
@@ -1165,8 +1165,8 @@ def context_set_boolean(
|
|
|
1165
1165
|
):
|
|
1166
1166
|
"""Set a context value
|
|
1167
1167
|
|
|
1168
|
-
:type override_context: dict[str, typing.Any] |
|
|
1169
|
-
:type execution_context:
|
|
1168
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1169
|
+
:type execution_context: int | str | None
|
|
1170
1170
|
:type undo: bool | None
|
|
1171
1171
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1172
1172
|
:type data_path: str | typing.Any
|
|
@@ -1177,8 +1177,8 @@ def context_set_boolean(
|
|
|
1177
1177
|
...
|
|
1178
1178
|
|
|
1179
1179
|
def context_set_enum(
|
|
1180
|
-
override_context: dict[str, typing.Any] |
|
|
1181
|
-
execution_context:
|
|
1180
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1181
|
+
execution_context: int | str | None = None,
|
|
1182
1182
|
undo: bool | None = None,
|
|
1183
1183
|
*,
|
|
1184
1184
|
data_path: str | typing.Any = "",
|
|
@@ -1186,8 +1186,8 @@ def context_set_enum(
|
|
|
1186
1186
|
):
|
|
1187
1187
|
"""Set a context value
|
|
1188
1188
|
|
|
1189
|
-
:type override_context: dict[str, typing.Any] |
|
|
1190
|
-
:type execution_context:
|
|
1189
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1190
|
+
:type execution_context: int | str | None
|
|
1191
1191
|
:type undo: bool | None
|
|
1192
1192
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1193
1193
|
:type data_path: str | typing.Any
|
|
@@ -1198,8 +1198,8 @@ def context_set_enum(
|
|
|
1198
1198
|
...
|
|
1199
1199
|
|
|
1200
1200
|
def context_set_float(
|
|
1201
|
-
override_context: dict[str, typing.Any] |
|
|
1202
|
-
execution_context:
|
|
1201
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1202
|
+
execution_context: int | str | None = None,
|
|
1203
1203
|
undo: bool | None = None,
|
|
1204
1204
|
*,
|
|
1205
1205
|
data_path: str | typing.Any = "",
|
|
@@ -1208,8 +1208,8 @@ def context_set_float(
|
|
|
1208
1208
|
):
|
|
1209
1209
|
"""Set a context value
|
|
1210
1210
|
|
|
1211
|
-
:type override_context: dict[str, typing.Any] |
|
|
1212
|
-
:type execution_context:
|
|
1211
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1212
|
+
:type execution_context: int | str | None
|
|
1213
1213
|
:type undo: bool | None
|
|
1214
1214
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1215
1215
|
:type data_path: str | typing.Any
|
|
@@ -1222,8 +1222,8 @@ def context_set_float(
|
|
|
1222
1222
|
...
|
|
1223
1223
|
|
|
1224
1224
|
def context_set_id(
|
|
1225
|
-
override_context: dict[str, typing.Any] |
|
|
1226
|
-
execution_context:
|
|
1225
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1226
|
+
execution_context: int | str | None = None,
|
|
1227
1227
|
undo: bool | None = None,
|
|
1228
1228
|
*,
|
|
1229
1229
|
data_path: str | typing.Any = "",
|
|
@@ -1231,8 +1231,8 @@ def context_set_id(
|
|
|
1231
1231
|
):
|
|
1232
1232
|
"""Set a context value to an ID data-block
|
|
1233
1233
|
|
|
1234
|
-
:type override_context: dict[str, typing.Any] |
|
|
1235
|
-
:type execution_context:
|
|
1234
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1235
|
+
:type execution_context: int | str | None
|
|
1236
1236
|
:type undo: bool | None
|
|
1237
1237
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1238
1238
|
:type data_path: str | typing.Any
|
|
@@ -1243,8 +1243,8 @@ def context_set_id(
|
|
|
1243
1243
|
...
|
|
1244
1244
|
|
|
1245
1245
|
def context_set_int(
|
|
1246
|
-
override_context: dict[str, typing.Any] |
|
|
1247
|
-
execution_context:
|
|
1246
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1247
|
+
execution_context: int | str | None = None,
|
|
1248
1248
|
undo: bool | None = None,
|
|
1249
1249
|
*,
|
|
1250
1250
|
data_path: str | typing.Any = "",
|
|
@@ -1253,8 +1253,8 @@ def context_set_int(
|
|
|
1253
1253
|
):
|
|
1254
1254
|
"""Set a context value
|
|
1255
1255
|
|
|
1256
|
-
:type override_context: dict[str, typing.Any] |
|
|
1257
|
-
:type execution_context:
|
|
1256
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1257
|
+
:type execution_context: int | str | None
|
|
1258
1258
|
:type undo: bool | None
|
|
1259
1259
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1260
1260
|
:type data_path: str | typing.Any
|
|
@@ -1267,8 +1267,8 @@ def context_set_int(
|
|
|
1267
1267
|
...
|
|
1268
1268
|
|
|
1269
1269
|
def context_set_string(
|
|
1270
|
-
override_context: dict[str, typing.Any] |
|
|
1271
|
-
execution_context:
|
|
1270
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1271
|
+
execution_context: int | str | None = None,
|
|
1272
1272
|
undo: bool | None = None,
|
|
1273
1273
|
*,
|
|
1274
1274
|
data_path: str | typing.Any = "",
|
|
@@ -1276,8 +1276,8 @@ def context_set_string(
|
|
|
1276
1276
|
):
|
|
1277
1277
|
"""Set a context value
|
|
1278
1278
|
|
|
1279
|
-
:type override_context: dict[str, typing.Any] |
|
|
1280
|
-
:type execution_context:
|
|
1279
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1280
|
+
:type execution_context: int | str | None
|
|
1281
1281
|
:type undo: bool | None
|
|
1282
1282
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1283
1283
|
:type data_path: str | typing.Any
|
|
@@ -1288,8 +1288,8 @@ def context_set_string(
|
|
|
1288
1288
|
...
|
|
1289
1289
|
|
|
1290
1290
|
def context_set_value(
|
|
1291
|
-
override_context: dict[str, typing.Any] |
|
|
1292
|
-
execution_context:
|
|
1291
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1292
|
+
execution_context: int | str | None = None,
|
|
1293
1293
|
undo: bool | None = None,
|
|
1294
1294
|
*,
|
|
1295
1295
|
data_path: str | typing.Any = "",
|
|
@@ -1297,8 +1297,8 @@ def context_set_value(
|
|
|
1297
1297
|
):
|
|
1298
1298
|
"""Set a context value
|
|
1299
1299
|
|
|
1300
|
-
:type override_context: dict[str, typing.Any] |
|
|
1301
|
-
:type execution_context:
|
|
1300
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1301
|
+
:type execution_context: int | str | None
|
|
1302
1302
|
:type undo: bool | None
|
|
1303
1303
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1304
1304
|
:type data_path: str | typing.Any
|
|
@@ -1309,8 +1309,8 @@ def context_set_value(
|
|
|
1309
1309
|
...
|
|
1310
1310
|
|
|
1311
1311
|
def context_toggle(
|
|
1312
|
-
override_context: dict[str, typing.Any] |
|
|
1313
|
-
execution_context:
|
|
1312
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1313
|
+
execution_context: int | str | None = None,
|
|
1314
1314
|
undo: bool | None = None,
|
|
1315
1315
|
*,
|
|
1316
1316
|
data_path: str | typing.Any = "",
|
|
@@ -1318,8 +1318,8 @@ def context_toggle(
|
|
|
1318
1318
|
):
|
|
1319
1319
|
"""Toggle a context value
|
|
1320
1320
|
|
|
1321
|
-
:type override_context: dict[str, typing.Any] |
|
|
1322
|
-
:type execution_context:
|
|
1321
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1322
|
+
:type execution_context: int | str | None
|
|
1323
1323
|
:type undo: bool | None
|
|
1324
1324
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1325
1325
|
:type data_path: str | typing.Any
|
|
@@ -1330,8 +1330,8 @@ def context_toggle(
|
|
|
1330
1330
|
...
|
|
1331
1331
|
|
|
1332
1332
|
def context_toggle_enum(
|
|
1333
|
-
override_context: dict[str, typing.Any] |
|
|
1334
|
-
execution_context:
|
|
1333
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1334
|
+
execution_context: int | str | None = None,
|
|
1335
1335
|
undo: bool | None = None,
|
|
1336
1336
|
*,
|
|
1337
1337
|
data_path: str | typing.Any = "",
|
|
@@ -1340,8 +1340,8 @@ def context_toggle_enum(
|
|
|
1340
1340
|
):
|
|
1341
1341
|
"""Toggle a context value
|
|
1342
1342
|
|
|
1343
|
-
:type override_context: dict[str, typing.Any] |
|
|
1344
|
-
:type execution_context:
|
|
1343
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1344
|
+
:type execution_context: int | str | None
|
|
1345
1345
|
:type undo: bool | None
|
|
1346
1346
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
1347
1347
|
:type data_path: str | typing.Any
|
|
@@ -1354,16 +1354,16 @@ def context_toggle_enum(
|
|
|
1354
1354
|
...
|
|
1355
1355
|
|
|
1356
1356
|
def debug_menu(
|
|
1357
|
-
override_context: dict[str, typing.Any] |
|
|
1358
|
-
execution_context:
|
|
1357
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1358
|
+
execution_context: int | str | None = None,
|
|
1359
1359
|
undo: bool | None = None,
|
|
1360
1360
|
*,
|
|
1361
1361
|
debug_value: typing.Any | None = 0,
|
|
1362
1362
|
):
|
|
1363
1363
|
"""Open a popup to set the debug level
|
|
1364
1364
|
|
|
1365
|
-
:type override_context: dict[str, typing.Any] |
|
|
1366
|
-
:type execution_context:
|
|
1365
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1366
|
+
:type execution_context: int | str | None
|
|
1367
1367
|
:type undo: bool | None
|
|
1368
1368
|
:param debug_value: Debug Value
|
|
1369
1369
|
:type debug_value: typing.Any | None
|
|
@@ -1372,16 +1372,16 @@ def debug_menu(
|
|
|
1372
1372
|
...
|
|
1373
1373
|
|
|
1374
1374
|
def doc_view(
|
|
1375
|
-
override_context: dict[str, typing.Any] |
|
|
1376
|
-
execution_context:
|
|
1375
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1376
|
+
execution_context: int | str | None = None,
|
|
1377
1377
|
undo: bool | None = None,
|
|
1378
1378
|
*,
|
|
1379
1379
|
doc_id: str | typing.Any = "",
|
|
1380
1380
|
):
|
|
1381
1381
|
"""Open online reference docs in a web browser
|
|
1382
1382
|
|
|
1383
|
-
:type override_context: dict[str, typing.Any] |
|
|
1384
|
-
:type execution_context:
|
|
1383
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1384
|
+
:type execution_context: int | str | None
|
|
1385
1385
|
:type undo: bool | None
|
|
1386
1386
|
:param doc_id: Doc ID
|
|
1387
1387
|
:type doc_id: str | typing.Any
|
|
@@ -1390,16 +1390,16 @@ def doc_view(
|
|
|
1390
1390
|
...
|
|
1391
1391
|
|
|
1392
1392
|
def doc_view_manual(
|
|
1393
|
-
override_context: dict[str, typing.Any] |
|
|
1394
|
-
execution_context:
|
|
1393
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1394
|
+
execution_context: int | str | None = None,
|
|
1395
1395
|
undo: bool | None = None,
|
|
1396
1396
|
*,
|
|
1397
1397
|
doc_id: str | typing.Any = "",
|
|
1398
1398
|
):
|
|
1399
1399
|
"""Load online manual
|
|
1400
1400
|
|
|
1401
|
-
:type override_context: dict[str, typing.Any] |
|
|
1402
|
-
:type execution_context:
|
|
1401
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1402
|
+
:type execution_context: int | str | None
|
|
1403
1403
|
:type undo: bool | None
|
|
1404
1404
|
:param doc_id: Doc ID
|
|
1405
1405
|
:type doc_id: str | typing.Any
|
|
@@ -1408,30 +1408,30 @@ def doc_view_manual(
|
|
|
1408
1408
|
...
|
|
1409
1409
|
|
|
1410
1410
|
def doc_view_manual_ui_context(
|
|
1411
|
-
override_context: dict[str, typing.Any] |
|
|
1412
|
-
execution_context:
|
|
1411
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1412
|
+
execution_context: int | str | None = None,
|
|
1413
1413
|
undo: bool | None = None,
|
|
1414
1414
|
):
|
|
1415
1415
|
"""View a context based online manual in a web browser
|
|
1416
1416
|
|
|
1417
|
-
:type override_context: dict[str, typing.Any] |
|
|
1418
|
-
:type execution_context:
|
|
1417
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1418
|
+
:type execution_context: int | str | None
|
|
1419
1419
|
:type undo: bool | None
|
|
1420
1420
|
"""
|
|
1421
1421
|
|
|
1422
1422
|
...
|
|
1423
1423
|
|
|
1424
1424
|
def drop_blend_file(
|
|
1425
|
-
override_context: dict[str, typing.Any] |
|
|
1426
|
-
execution_context:
|
|
1425
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1426
|
+
execution_context: int | str | None = None,
|
|
1427
1427
|
undo: bool | None = None,
|
|
1428
1428
|
*,
|
|
1429
1429
|
filepath: str | typing.Any = "",
|
|
1430
1430
|
):
|
|
1431
1431
|
"""Undocumented, consider contributing.
|
|
1432
1432
|
|
|
1433
|
-
:type override_context: dict[str, typing.Any] |
|
|
1434
|
-
:type execution_context:
|
|
1433
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1434
|
+
:type execution_context: int | str | None
|
|
1435
1435
|
:type undo: bool | None
|
|
1436
1436
|
:param filepath: filepath
|
|
1437
1437
|
:type filepath: str | typing.Any
|
|
@@ -1440,8 +1440,8 @@ def drop_blend_file(
|
|
|
1440
1440
|
...
|
|
1441
1441
|
|
|
1442
1442
|
def drop_import_file(
|
|
1443
|
-
override_context: dict[str, typing.Any] |
|
|
1444
|
-
execution_context:
|
|
1443
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1444
|
+
execution_context: int | str | None = None,
|
|
1445
1445
|
undo: bool | None = None,
|
|
1446
1446
|
*,
|
|
1447
1447
|
directory: str | typing.Any = "",
|
|
@@ -1450,8 +1450,8 @@ def drop_import_file(
|
|
|
1450
1450
|
):
|
|
1451
1451
|
"""Operator that allows file handlers to receive file drops
|
|
1452
1452
|
|
|
1453
|
-
:type override_context: dict[str, typing.Any] |
|
|
1454
|
-
:type execution_context:
|
|
1453
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1454
|
+
:type execution_context: int | str | None
|
|
1455
1455
|
:type undo: bool | None
|
|
1456
1456
|
:param directory: Directory, Directory of the file
|
|
1457
1457
|
:type directory: str | typing.Any
|
|
@@ -1462,8 +1462,8 @@ def drop_import_file(
|
|
|
1462
1462
|
...
|
|
1463
1463
|
|
|
1464
1464
|
def gpencil_export_pdf(
|
|
1465
|
-
override_context: dict[str, typing.Any] |
|
|
1466
|
-
execution_context:
|
|
1465
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1466
|
+
execution_context: int | str | None = None,
|
|
1467
1467
|
undo: bool | None = None,
|
|
1468
1468
|
*,
|
|
1469
1469
|
filepath: str | typing.Any = "",
|
|
@@ -1496,8 +1496,8 @@ def gpencil_export_pdf(
|
|
|
1496
1496
|
):
|
|
1497
1497
|
"""Export grease pencil to PDF
|
|
1498
1498
|
|
|
1499
|
-
:type override_context: dict[str, typing.Any] |
|
|
1500
|
-
:type execution_context:
|
|
1499
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1500
|
+
:type execution_context: int | str | None
|
|
1501
1501
|
:type undo: bool | None
|
|
1502
1502
|
:param filepath: File Path, Path to file
|
|
1503
1503
|
:type filepath: str | typing.Any
|
|
@@ -1588,8 +1588,8 @@ def gpencil_export_pdf(
|
|
|
1588
1588
|
...
|
|
1589
1589
|
|
|
1590
1590
|
def gpencil_export_svg(
|
|
1591
|
-
override_context: dict[str, typing.Any] |
|
|
1592
|
-
execution_context:
|
|
1591
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1592
|
+
execution_context: int | str | None = None,
|
|
1593
1593
|
undo: bool | None = None,
|
|
1594
1594
|
*,
|
|
1595
1595
|
filepath: str | typing.Any = "",
|
|
@@ -1622,8 +1622,8 @@ def gpencil_export_svg(
|
|
|
1622
1622
|
):
|
|
1623
1623
|
"""Export grease pencil to SVG
|
|
1624
1624
|
|
|
1625
|
-
:type override_context: dict[str, typing.Any] |
|
|
1626
|
-
:type execution_context:
|
|
1625
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1626
|
+
:type execution_context: int | str | None
|
|
1627
1627
|
:type undo: bool | None
|
|
1628
1628
|
:param filepath: File Path, Path to file
|
|
1629
1629
|
:type filepath: str | typing.Any
|
|
@@ -1705,8 +1705,8 @@ def gpencil_export_svg(
|
|
|
1705
1705
|
...
|
|
1706
1706
|
|
|
1707
1707
|
def gpencil_import_svg(
|
|
1708
|
-
override_context: dict[str, typing.Any] |
|
|
1709
|
-
execution_context:
|
|
1708
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1709
|
+
execution_context: int | str | None = None,
|
|
1710
1710
|
undo: bool | None = None,
|
|
1711
1711
|
*,
|
|
1712
1712
|
filepath: str | typing.Any = "",
|
|
@@ -1740,8 +1740,8 @@ def gpencil_import_svg(
|
|
|
1740
1740
|
):
|
|
1741
1741
|
"""Import SVG into grease pencil
|
|
1742
1742
|
|
|
1743
|
-
:type override_context: dict[str, typing.Any] |
|
|
1744
|
-
:type execution_context:
|
|
1743
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1744
|
+
:type execution_context: int | str | None
|
|
1745
1745
|
:type undo: bool | None
|
|
1746
1746
|
:param filepath: File Path, Path to file
|
|
1747
1747
|
:type filepath: str | typing.Any
|
|
@@ -1814,8 +1814,8 @@ def gpencil_import_svg(
|
|
|
1814
1814
|
...
|
|
1815
1815
|
|
|
1816
1816
|
def interface_theme_preset_add(
|
|
1817
|
-
override_context: dict[str, typing.Any] |
|
|
1818
|
-
execution_context:
|
|
1817
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1818
|
+
execution_context: int | str | None = None,
|
|
1819
1819
|
undo: bool | None = None,
|
|
1820
1820
|
*,
|
|
1821
1821
|
name: str | typing.Any = "",
|
|
@@ -1824,8 +1824,8 @@ def interface_theme_preset_add(
|
|
|
1824
1824
|
):
|
|
1825
1825
|
"""Add a custom theme to the preset list
|
|
1826
1826
|
|
|
1827
|
-
:type override_context: dict[str, typing.Any] |
|
|
1828
|
-
:type execution_context:
|
|
1827
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1828
|
+
:type execution_context: int | str | None
|
|
1829
1829
|
:type undo: bool | None
|
|
1830
1830
|
:param name: Name, Name of the preset, used to make the path name
|
|
1831
1831
|
:type name: str | typing.Any
|
|
@@ -1838,8 +1838,8 @@ def interface_theme_preset_add(
|
|
|
1838
1838
|
...
|
|
1839
1839
|
|
|
1840
1840
|
def interface_theme_preset_remove(
|
|
1841
|
-
override_context: dict[str, typing.Any] |
|
|
1842
|
-
execution_context:
|
|
1841
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1842
|
+
execution_context: int | str | None = None,
|
|
1843
1843
|
undo: bool | None = None,
|
|
1844
1844
|
*,
|
|
1845
1845
|
name: str | typing.Any = "",
|
|
@@ -1848,8 +1848,8 @@ def interface_theme_preset_remove(
|
|
|
1848
1848
|
):
|
|
1849
1849
|
"""Remove a custom theme from the preset list
|
|
1850
1850
|
|
|
1851
|
-
:type override_context: dict[str, typing.Any] |
|
|
1852
|
-
:type execution_context:
|
|
1851
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1852
|
+
:type execution_context: int | str | None
|
|
1853
1853
|
:type undo: bool | None
|
|
1854
1854
|
:param name: Name, Name of the preset, used to make the path name
|
|
1855
1855
|
:type name: str | typing.Any
|
|
@@ -1862,8 +1862,8 @@ def interface_theme_preset_remove(
|
|
|
1862
1862
|
...
|
|
1863
1863
|
|
|
1864
1864
|
def interface_theme_preset_save(
|
|
1865
|
-
override_context: dict[str, typing.Any] |
|
|
1866
|
-
execution_context:
|
|
1865
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1866
|
+
execution_context: int | str | None = None,
|
|
1867
1867
|
undo: bool | None = None,
|
|
1868
1868
|
*,
|
|
1869
1869
|
name: str | typing.Any = "",
|
|
@@ -1872,8 +1872,8 @@ def interface_theme_preset_save(
|
|
|
1872
1872
|
):
|
|
1873
1873
|
"""Save a custom theme in the preset list
|
|
1874
1874
|
|
|
1875
|
-
:type override_context: dict[str, typing.Any] |
|
|
1876
|
-
:type execution_context:
|
|
1875
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1876
|
+
:type execution_context: int | str | None
|
|
1877
1877
|
:type undo: bool | None
|
|
1878
1878
|
:param name: Name, Name of the preset, used to make the path name
|
|
1879
1879
|
:type name: str | typing.Any
|
|
@@ -1886,8 +1886,8 @@ def interface_theme_preset_save(
|
|
|
1886
1886
|
...
|
|
1887
1887
|
|
|
1888
1888
|
def keyconfig_preset_add(
|
|
1889
|
-
override_context: dict[str, typing.Any] |
|
|
1890
|
-
execution_context:
|
|
1889
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1890
|
+
execution_context: int | str | None = None,
|
|
1891
1891
|
undo: bool | None = None,
|
|
1892
1892
|
*,
|
|
1893
1893
|
name: str | typing.Any = "",
|
|
@@ -1896,8 +1896,8 @@ def keyconfig_preset_add(
|
|
|
1896
1896
|
):
|
|
1897
1897
|
"""Add a custom keymap configuration to the preset list
|
|
1898
1898
|
|
|
1899
|
-
:type override_context: dict[str, typing.Any] |
|
|
1900
|
-
:type execution_context:
|
|
1899
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1900
|
+
:type execution_context: int | str | None
|
|
1901
1901
|
:type undo: bool | None
|
|
1902
1902
|
:param name: Name, Name of the preset, used to make the path name
|
|
1903
1903
|
:type name: str | typing.Any
|
|
@@ -1910,8 +1910,8 @@ def keyconfig_preset_add(
|
|
|
1910
1910
|
...
|
|
1911
1911
|
|
|
1912
1912
|
def keyconfig_preset_remove(
|
|
1913
|
-
override_context: dict[str, typing.Any] |
|
|
1914
|
-
execution_context:
|
|
1913
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1914
|
+
execution_context: int | str | None = None,
|
|
1915
1915
|
undo: bool | None = None,
|
|
1916
1916
|
*,
|
|
1917
1917
|
name: str | typing.Any = "",
|
|
@@ -1920,8 +1920,8 @@ def keyconfig_preset_remove(
|
|
|
1920
1920
|
):
|
|
1921
1921
|
"""Remove a custom keymap configuration from the preset list
|
|
1922
1922
|
|
|
1923
|
-
:type override_context: dict[str, typing.Any] |
|
|
1924
|
-
:type execution_context:
|
|
1923
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1924
|
+
:type execution_context: int | str | None
|
|
1925
1925
|
:type undo: bool | None
|
|
1926
1926
|
:param name: Name, Name of the preset, used to make the path name
|
|
1927
1927
|
:type name: str | typing.Any
|
|
@@ -1934,8 +1934,8 @@ def keyconfig_preset_remove(
|
|
|
1934
1934
|
...
|
|
1935
1935
|
|
|
1936
1936
|
def lib_reload(
|
|
1937
|
-
override_context: dict[str, typing.Any] |
|
|
1938
|
-
execution_context:
|
|
1937
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1938
|
+
execution_context: int | str | None = None,
|
|
1939
1939
|
undo: bool | None = None,
|
|
1940
1940
|
*,
|
|
1941
1941
|
library: str | typing.Any = "",
|
|
@@ -1968,8 +1968,8 @@ def lib_reload(
|
|
|
1968
1968
|
):
|
|
1969
1969
|
"""Reload the given library
|
|
1970
1970
|
|
|
1971
|
-
:type override_context: dict[str, typing.Any] |
|
|
1972
|
-
:type execution_context:
|
|
1971
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1972
|
+
:type execution_context: int | str | None
|
|
1973
1973
|
:type undo: bool | None
|
|
1974
1974
|
:param library: Library, Library to reload
|
|
1975
1975
|
:type library: str | typing.Any
|
|
@@ -2042,8 +2042,8 @@ def lib_reload(
|
|
|
2042
2042
|
...
|
|
2043
2043
|
|
|
2044
2044
|
def lib_relocate(
|
|
2045
|
-
override_context: dict[str, typing.Any] |
|
|
2046
|
-
execution_context:
|
|
2045
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2046
|
+
execution_context: int | str | None = None,
|
|
2047
2047
|
undo: bool | None = None,
|
|
2048
2048
|
*,
|
|
2049
2049
|
library: str | typing.Any = "",
|
|
@@ -2078,8 +2078,8 @@ def lib_relocate(
|
|
|
2078
2078
|
):
|
|
2079
2079
|
"""Relocate the given library to one or several others
|
|
2080
2080
|
|
|
2081
|
-
:type override_context: dict[str, typing.Any] |
|
|
2082
|
-
:type execution_context:
|
|
2081
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2082
|
+
:type execution_context: int | str | None
|
|
2083
2083
|
:type undo: bool | None
|
|
2084
2084
|
:param library: Library, Library to relocate
|
|
2085
2085
|
:type library: str | typing.Any
|
|
@@ -2154,8 +2154,8 @@ def lib_relocate(
|
|
|
2154
2154
|
...
|
|
2155
2155
|
|
|
2156
2156
|
def link(
|
|
2157
|
-
override_context: dict[str, typing.Any] |
|
|
2158
|
-
execution_context:
|
|
2157
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2158
|
+
execution_context: int | str | None = None,
|
|
2159
2159
|
undo: bool | None = None,
|
|
2160
2160
|
*,
|
|
2161
2161
|
filepath: str | typing.Any = "",
|
|
@@ -2195,8 +2195,8 @@ def link(
|
|
|
2195
2195
|
):
|
|
2196
2196
|
"""Link from a Library .blend file
|
|
2197
2197
|
|
|
2198
|
-
:type override_context: dict[str, typing.Any] |
|
|
2199
|
-
:type execution_context:
|
|
2198
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2199
|
+
:type execution_context: int | str | None
|
|
2200
2200
|
:type undo: bool | None
|
|
2201
2201
|
:param filepath: File Path, Path to file
|
|
2202
2202
|
:type filepath: str | typing.Any
|
|
@@ -2281,22 +2281,22 @@ def link(
|
|
|
2281
2281
|
...
|
|
2282
2282
|
|
|
2283
2283
|
def memory_statistics(
|
|
2284
|
-
override_context: dict[str, typing.Any] |
|
|
2285
|
-
execution_context:
|
|
2284
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2285
|
+
execution_context: int | str | None = None,
|
|
2286
2286
|
undo: bool | None = None,
|
|
2287
2287
|
):
|
|
2288
2288
|
"""Print memory statistics to the console
|
|
2289
2289
|
|
|
2290
|
-
:type override_context: dict[str, typing.Any] |
|
|
2291
|
-
:type execution_context:
|
|
2290
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2291
|
+
:type execution_context: int | str | None
|
|
2292
2292
|
:type undo: bool | None
|
|
2293
2293
|
"""
|
|
2294
2294
|
|
|
2295
2295
|
...
|
|
2296
2296
|
|
|
2297
2297
|
def obj_export(
|
|
2298
|
-
override_context: dict[str, typing.Any] |
|
|
2299
|
-
execution_context:
|
|
2298
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2299
|
+
execution_context: int | str | None = None,
|
|
2300
2300
|
undo: bool | None = None,
|
|
2301
2301
|
*,
|
|
2302
2302
|
filepath: str | typing.Any = "",
|
|
@@ -2348,8 +2348,8 @@ def obj_export(
|
|
|
2348
2348
|
):
|
|
2349
2349
|
"""Save the scene to a Wavefront OBJ file
|
|
2350
2350
|
|
|
2351
|
-
:type override_context: dict[str, typing.Any] |
|
|
2352
|
-
:type execution_context:
|
|
2351
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2352
|
+
:type execution_context: int | str | None
|
|
2353
2353
|
:type undo: bool | None
|
|
2354
2354
|
:param filepath: File Path, Path to file
|
|
2355
2355
|
:type filepath: str | typing.Any
|
|
@@ -2520,8 +2520,8 @@ def obj_export(
|
|
|
2520
2520
|
...
|
|
2521
2521
|
|
|
2522
2522
|
def obj_import(
|
|
2523
|
-
override_context: dict[str, typing.Any] |
|
|
2524
|
-
execution_context:
|
|
2523
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2524
|
+
execution_context: int | str | None = None,
|
|
2525
2525
|
undo: bool | None = None,
|
|
2526
2526
|
*,
|
|
2527
2527
|
filepath: str | typing.Any = "",
|
|
@@ -2562,8 +2562,8 @@ def obj_import(
|
|
|
2562
2562
|
):
|
|
2563
2563
|
"""Load a Wavefront OBJ scene
|
|
2564
2564
|
|
|
2565
|
-
:type override_context: dict[str, typing.Any] |
|
|
2566
|
-
:type execution_context:
|
|
2565
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2566
|
+
:type execution_context: int | str | None
|
|
2567
2567
|
:type undo: bool | None
|
|
2568
2568
|
:param filepath: File Path, Path to file
|
|
2569
2569
|
:type filepath: str | typing.Any
|
|
@@ -2686,8 +2686,8 @@ def obj_import(
|
|
|
2686
2686
|
...
|
|
2687
2687
|
|
|
2688
2688
|
def open_mainfile(
|
|
2689
|
-
override_context: dict[str, typing.Any] |
|
|
2690
|
-
execution_context:
|
|
2689
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2690
|
+
execution_context: int | str | None = None,
|
|
2691
2691
|
undo: bool | None = None,
|
|
2692
2692
|
*,
|
|
2693
2693
|
filepath: str | typing.Any = "",
|
|
@@ -2720,8 +2720,8 @@ def open_mainfile(
|
|
|
2720
2720
|
):
|
|
2721
2721
|
"""Open a Blender file
|
|
2722
2722
|
|
|
2723
|
-
:type override_context: dict[str, typing.Any] |
|
|
2724
|
-
:type execution_context:
|
|
2723
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2724
|
+
:type execution_context: int | str | None
|
|
2725
2725
|
:type undo: bool | None
|
|
2726
2726
|
:param filepath: File Path, Path to file
|
|
2727
2727
|
:type filepath: str | typing.Any
|
|
@@ -2794,36 +2794,36 @@ def open_mainfile(
|
|
|
2794
2794
|
...
|
|
2795
2795
|
|
|
2796
2796
|
def operator_cheat_sheet(
|
|
2797
|
-
override_context: dict[str, typing.Any] |
|
|
2798
|
-
execution_context:
|
|
2797
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2798
|
+
execution_context: int | str | None = None,
|
|
2799
2799
|
undo: bool | None = None,
|
|
2800
2800
|
):
|
|
2801
2801
|
"""List all the operators in a text-block, useful for scripting
|
|
2802
2802
|
|
|
2803
|
-
:type override_context: dict[str, typing.Any] |
|
|
2804
|
-
:type execution_context:
|
|
2803
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2804
|
+
:type execution_context: int | str | None
|
|
2805
2805
|
:type undo: bool | None
|
|
2806
2806
|
"""
|
|
2807
2807
|
|
|
2808
2808
|
...
|
|
2809
2809
|
|
|
2810
2810
|
def operator_defaults(
|
|
2811
|
-
override_context: dict[str, typing.Any] |
|
|
2812
|
-
execution_context:
|
|
2811
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2812
|
+
execution_context: int | str | None = None,
|
|
2813
2813
|
undo: bool | None = None,
|
|
2814
2814
|
):
|
|
2815
2815
|
"""Set the active operator to its default values
|
|
2816
2816
|
|
|
2817
|
-
:type override_context: dict[str, typing.Any] |
|
|
2818
|
-
:type execution_context:
|
|
2817
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2818
|
+
:type execution_context: int | str | None
|
|
2819
2819
|
:type undo: bool | None
|
|
2820
2820
|
"""
|
|
2821
2821
|
|
|
2822
2822
|
...
|
|
2823
2823
|
|
|
2824
2824
|
def operator_pie_enum(
|
|
2825
|
-
override_context: dict[str, typing.Any] |
|
|
2826
|
-
execution_context:
|
|
2825
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2826
|
+
execution_context: int | str | None = None,
|
|
2827
2827
|
undo: bool | None = None,
|
|
2828
2828
|
*,
|
|
2829
2829
|
data_path: str | typing.Any = "",
|
|
@@ -2831,8 +2831,8 @@ def operator_pie_enum(
|
|
|
2831
2831
|
):
|
|
2832
2832
|
"""Undocumented, consider contributing.
|
|
2833
2833
|
|
|
2834
|
-
:type override_context: dict[str, typing.Any] |
|
|
2835
|
-
:type execution_context:
|
|
2834
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2835
|
+
:type execution_context: int | str | None
|
|
2836
2836
|
:type undo: bool | None
|
|
2837
2837
|
:param data_path: Operator, Operator name (in Python as string)
|
|
2838
2838
|
:type data_path: str | typing.Any
|
|
@@ -2843,8 +2843,8 @@ def operator_pie_enum(
|
|
|
2843
2843
|
...
|
|
2844
2844
|
|
|
2845
2845
|
def operator_preset_add(
|
|
2846
|
-
override_context: dict[str, typing.Any] |
|
|
2847
|
-
execution_context:
|
|
2846
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2847
|
+
execution_context: int | str | None = None,
|
|
2848
2848
|
undo: bool | None = None,
|
|
2849
2849
|
*,
|
|
2850
2850
|
name: str | typing.Any = "",
|
|
@@ -2854,8 +2854,8 @@ def operator_preset_add(
|
|
|
2854
2854
|
):
|
|
2855
2855
|
"""Add or remove an Operator Preset
|
|
2856
2856
|
|
|
2857
|
-
:type override_context: dict[str, typing.Any] |
|
|
2858
|
-
:type execution_context:
|
|
2857
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2858
|
+
:type execution_context: int | str | None
|
|
2859
2859
|
:type undo: bool | None
|
|
2860
2860
|
:param name: Name, Name of the preset, used to make the path name
|
|
2861
2861
|
:type name: str | typing.Any
|
|
@@ -2870,8 +2870,8 @@ def operator_preset_add(
|
|
|
2870
2870
|
...
|
|
2871
2871
|
|
|
2872
2872
|
def operator_presets_cleanup(
|
|
2873
|
-
override_context: dict[str, typing.Any] |
|
|
2874
|
-
execution_context:
|
|
2873
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2874
|
+
execution_context: int | str | None = None,
|
|
2875
2875
|
undo: bool | None = None,
|
|
2876
2876
|
*,
|
|
2877
2877
|
operator: str | typing.Any = "",
|
|
@@ -2880,8 +2880,8 @@ def operator_presets_cleanup(
|
|
|
2880
2880
|
):
|
|
2881
2881
|
"""Remove outdated operator properties from presets that may cause problems
|
|
2882
2882
|
|
|
2883
|
-
:type override_context: dict[str, typing.Any] |
|
|
2884
|
-
:type execution_context:
|
|
2883
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2884
|
+
:type execution_context: int | str | None
|
|
2885
2885
|
:type undo: bool | None
|
|
2886
2886
|
:param operator: operator
|
|
2887
2887
|
:type operator: str | typing.Any
|
|
@@ -2892,16 +2892,16 @@ def operator_presets_cleanup(
|
|
|
2892
2892
|
...
|
|
2893
2893
|
|
|
2894
2894
|
def owner_disable(
|
|
2895
|
-
override_context: dict[str, typing.Any] |
|
|
2896
|
-
execution_context:
|
|
2895
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2896
|
+
execution_context: int | str | None = None,
|
|
2897
2897
|
undo: bool | None = None,
|
|
2898
2898
|
*,
|
|
2899
2899
|
owner_id: str | typing.Any = "",
|
|
2900
2900
|
):
|
|
2901
2901
|
"""Disable add-on for workspace
|
|
2902
2902
|
|
|
2903
|
-
:type override_context: dict[str, typing.Any] |
|
|
2904
|
-
:type execution_context:
|
|
2903
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2904
|
+
:type execution_context: int | str | None
|
|
2905
2905
|
:type undo: bool | None
|
|
2906
2906
|
:param owner_id: UI Tag
|
|
2907
2907
|
:type owner_id: str | typing.Any
|
|
@@ -2910,16 +2910,16 @@ def owner_disable(
|
|
|
2910
2910
|
...
|
|
2911
2911
|
|
|
2912
2912
|
def owner_enable(
|
|
2913
|
-
override_context: dict[str, typing.Any] |
|
|
2914
|
-
execution_context:
|
|
2913
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2914
|
+
execution_context: int | str | None = None,
|
|
2915
2915
|
undo: bool | None = None,
|
|
2916
2916
|
*,
|
|
2917
2917
|
owner_id: str | typing.Any = "",
|
|
2918
2918
|
):
|
|
2919
2919
|
"""Enable add-on for workspace
|
|
2920
2920
|
|
|
2921
|
-
:type override_context: dict[str, typing.Any] |
|
|
2922
|
-
:type execution_context:
|
|
2921
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2922
|
+
:type execution_context: int | str | None
|
|
2923
2923
|
:type undo: bool | None
|
|
2924
2924
|
:param owner_id: UI Tag
|
|
2925
2925
|
:type owner_id: str | typing.Any
|
|
@@ -2928,16 +2928,16 @@ def owner_enable(
|
|
|
2928
2928
|
...
|
|
2929
2929
|
|
|
2930
2930
|
def path_open(
|
|
2931
|
-
override_context: dict[str, typing.Any] |
|
|
2932
|
-
execution_context:
|
|
2931
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2932
|
+
execution_context: int | str | None = None,
|
|
2933
2933
|
undo: bool | None = None,
|
|
2934
2934
|
*,
|
|
2935
2935
|
filepath: str | typing.Any = "",
|
|
2936
2936
|
):
|
|
2937
2937
|
"""Open a path in a file browser
|
|
2938
2938
|
|
|
2939
|
-
:type override_context: dict[str, typing.Any] |
|
|
2940
|
-
:type execution_context:
|
|
2939
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2940
|
+
:type execution_context: int | str | None
|
|
2941
2941
|
:type undo: bool | None
|
|
2942
2942
|
:param filepath: filepath
|
|
2943
2943
|
:type filepath: str | typing.Any
|
|
@@ -2946,8 +2946,8 @@ def path_open(
|
|
|
2946
2946
|
...
|
|
2947
2947
|
|
|
2948
2948
|
def ply_export(
|
|
2949
|
-
override_context: dict[str, typing.Any] |
|
|
2950
|
-
execution_context:
|
|
2949
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2950
|
+
execution_context: int | str | None = None,
|
|
2951
2951
|
undo: bool | None = None,
|
|
2952
2952
|
*,
|
|
2953
2953
|
filepath: str | typing.Any = "",
|
|
@@ -2988,8 +2988,8 @@ def ply_export(
|
|
|
2988
2988
|
):
|
|
2989
2989
|
"""Save the scene to a PLY file
|
|
2990
2990
|
|
|
2991
|
-
:type override_context: dict[str, typing.Any] |
|
|
2992
|
-
:type execution_context:
|
|
2991
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2992
|
+
:type execution_context: int | str | None
|
|
2993
2993
|
:type undo: bool | None
|
|
2994
2994
|
:param filepath: File Path, Path to file
|
|
2995
2995
|
:type filepath: str | typing.Any
|
|
@@ -3123,8 +3123,8 @@ def ply_export(
|
|
|
3123
3123
|
...
|
|
3124
3124
|
|
|
3125
3125
|
def ply_import(
|
|
3126
|
-
override_context: dict[str, typing.Any] |
|
|
3127
|
-
execution_context:
|
|
3126
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3127
|
+
execution_context: int | str | None = None,
|
|
3128
3128
|
undo: bool | None = None,
|
|
3129
3129
|
*,
|
|
3130
3130
|
filepath: str | typing.Any = "",
|
|
@@ -3163,8 +3163,8 @@ def ply_import(
|
|
|
3163
3163
|
):
|
|
3164
3164
|
"""Import an PLY file as an object
|
|
3165
3165
|
|
|
3166
|
-
:type override_context: dict[str, typing.Any] |
|
|
3167
|
-
:type execution_context:
|
|
3166
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3167
|
+
:type execution_context: int | str | None
|
|
3168
3168
|
:type undo: bool | None
|
|
3169
3169
|
:param filepath: File Path, Path to file
|
|
3170
3170
|
:type filepath: str | typing.Any
|
|
@@ -3292,8 +3292,8 @@ def ply_import(
|
|
|
3292
3292
|
...
|
|
3293
3293
|
|
|
3294
3294
|
def previews_batch_clear(
|
|
3295
|
-
override_context: dict[str, typing.Any] |
|
|
3296
|
-
execution_context:
|
|
3295
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3296
|
+
execution_context: int | str | None = None,
|
|
3297
3297
|
undo: bool | None = None,
|
|
3298
3298
|
*,
|
|
3299
3299
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
@@ -3310,8 +3310,8 @@ def previews_batch_clear(
|
|
|
3310
3310
|
):
|
|
3311
3311
|
"""Clear selected .blend file's previews
|
|
3312
3312
|
|
|
3313
|
-
:type override_context: dict[str, typing.Any] |
|
|
3314
|
-
:type execution_context:
|
|
3313
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3314
|
+
:type execution_context: int | str | None
|
|
3315
3315
|
:type undo: bool | None
|
|
3316
3316
|
:param files: files
|
|
3317
3317
|
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
@@ -3338,8 +3338,8 @@ def previews_batch_clear(
|
|
|
3338
3338
|
...
|
|
3339
3339
|
|
|
3340
3340
|
def previews_batch_generate(
|
|
3341
|
-
override_context: dict[str, typing.Any] |
|
|
3342
|
-
execution_context:
|
|
3341
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3342
|
+
execution_context: int | str | None = None,
|
|
3343
3343
|
undo: bool | None = None,
|
|
3344
3344
|
*,
|
|
3345
3345
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
@@ -3356,8 +3356,8 @@ def previews_batch_generate(
|
|
|
3356
3356
|
):
|
|
3357
3357
|
"""Generate selected .blend file's previews
|
|
3358
3358
|
|
|
3359
|
-
:type override_context: dict[str, typing.Any] |
|
|
3360
|
-
:type execution_context:
|
|
3359
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3360
|
+
:type execution_context: int | str | None
|
|
3361
3361
|
:type undo: bool | None
|
|
3362
3362
|
:param files: Collection of file paths with common directory root
|
|
3363
3363
|
:type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
|
|
@@ -3384,16 +3384,16 @@ def previews_batch_generate(
|
|
|
3384
3384
|
...
|
|
3385
3385
|
|
|
3386
3386
|
def previews_clear(
|
|
3387
|
-
override_context: dict[str, typing.Any] |
|
|
3388
|
-
execution_context:
|
|
3387
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3388
|
+
execution_context: int | str | None = None,
|
|
3389
3389
|
undo: bool | None = None,
|
|
3390
3390
|
*,
|
|
3391
3391
|
id_type: set[str] | None = {},
|
|
3392
3392
|
):
|
|
3393
3393
|
"""Clear data-block previews (only for some types like objects, materials, textures, etc.)
|
|
3394
3394
|
|
|
3395
|
-
:type override_context: dict[str, typing.Any] |
|
|
3396
|
-
:type execution_context:
|
|
3395
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3396
|
+
:type execution_context: int | str | None
|
|
3397
3397
|
:type undo: bool | None
|
|
3398
3398
|
:param id_type: Data-Block Type, Which data-block previews to clear
|
|
3399
3399
|
|
|
@@ -3435,30 +3435,30 @@ def previews_clear(
|
|
|
3435
3435
|
...
|
|
3436
3436
|
|
|
3437
3437
|
def previews_ensure(
|
|
3438
|
-
override_context: dict[str, typing.Any] |
|
|
3439
|
-
execution_context:
|
|
3438
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3439
|
+
execution_context: int | str | None = None,
|
|
3440
3440
|
undo: bool | None = None,
|
|
3441
3441
|
):
|
|
3442
3442
|
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
|
|
3443
3443
|
|
|
3444
|
-
:type override_context: dict[str, typing.Any] |
|
|
3445
|
-
:type execution_context:
|
|
3444
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3445
|
+
:type execution_context: int | str | None
|
|
3446
3446
|
:type undo: bool | None
|
|
3447
3447
|
"""
|
|
3448
3448
|
|
|
3449
3449
|
...
|
|
3450
3450
|
|
|
3451
3451
|
def properties_add(
|
|
3452
|
-
override_context: dict[str, typing.Any] |
|
|
3453
|
-
execution_context:
|
|
3452
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3453
|
+
execution_context: int | str | None = None,
|
|
3454
3454
|
undo: bool | None = None,
|
|
3455
3455
|
*,
|
|
3456
3456
|
data_path: str | typing.Any = "",
|
|
3457
3457
|
):
|
|
3458
3458
|
"""Add your own property to the data-block
|
|
3459
3459
|
|
|
3460
|
-
:type override_context: dict[str, typing.Any] |
|
|
3461
|
-
:type execution_context:
|
|
3460
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3461
|
+
:type execution_context: int | str | None
|
|
3462
3462
|
:type undo: bool | None
|
|
3463
3463
|
:param data_path: Property Edit, Property data_path edit
|
|
3464
3464
|
:type data_path: str | typing.Any
|
|
@@ -3467,16 +3467,16 @@ def properties_add(
|
|
|
3467
3467
|
...
|
|
3468
3468
|
|
|
3469
3469
|
def properties_context_change(
|
|
3470
|
-
override_context: dict[str, typing.Any] |
|
|
3471
|
-
execution_context:
|
|
3470
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3471
|
+
execution_context: int | str | None = None,
|
|
3472
3472
|
undo: bool | None = None,
|
|
3473
3473
|
*,
|
|
3474
3474
|
context: str | typing.Any = "",
|
|
3475
3475
|
):
|
|
3476
3476
|
"""Jump to a different tab inside the properties editor
|
|
3477
3477
|
|
|
3478
|
-
:type override_context: dict[str, typing.Any] |
|
|
3479
|
-
:type execution_context:
|
|
3478
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3479
|
+
:type execution_context: int | str | None
|
|
3480
3480
|
:type undo: bool | None
|
|
3481
3481
|
:param context: Context
|
|
3482
3482
|
:type context: str | typing.Any
|
|
@@ -3485,8 +3485,8 @@ def properties_context_change(
|
|
|
3485
3485
|
...
|
|
3486
3486
|
|
|
3487
3487
|
def properties_edit(
|
|
3488
|
-
override_context: dict[str, typing.Any] |
|
|
3489
|
-
execution_context:
|
|
3488
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3489
|
+
execution_context: int | str | None = None,
|
|
3490
3490
|
undo: bool | None = None,
|
|
3491
3491
|
*,
|
|
3492
3492
|
data_path: str | typing.Any = "",
|
|
@@ -3616,8 +3616,8 @@ def properties_edit(
|
|
|
3616
3616
|
):
|
|
3617
3617
|
"""Change a custom property's type, or adjust how it is displayed in the interface
|
|
3618
3618
|
|
|
3619
|
-
:type override_context: dict[str, typing.Any] |
|
|
3620
|
-
:type execution_context:
|
|
3619
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3620
|
+
:type execution_context: int | str | None
|
|
3621
3621
|
:type undo: bool | None
|
|
3622
3622
|
:param data_path: Property Edit, Property data_path edit
|
|
3623
3623
|
:type data_path: str | typing.Any
|
|
@@ -3701,8 +3701,8 @@ def properties_edit(
|
|
|
3701
3701
|
...
|
|
3702
3702
|
|
|
3703
3703
|
def properties_edit_value(
|
|
3704
|
-
override_context: dict[str, typing.Any] |
|
|
3705
|
-
execution_context:
|
|
3704
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3705
|
+
execution_context: int | str | None = None,
|
|
3706
3706
|
undo: bool | None = None,
|
|
3707
3707
|
*,
|
|
3708
3708
|
data_path: str | typing.Any = "",
|
|
@@ -3711,8 +3711,8 @@ def properties_edit_value(
|
|
|
3711
3711
|
):
|
|
3712
3712
|
"""Edit the value of a custom property
|
|
3713
3713
|
|
|
3714
|
-
:type override_context: dict[str, typing.Any] |
|
|
3715
|
-
:type execution_context:
|
|
3714
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3715
|
+
:type execution_context: int | str | None
|
|
3716
3716
|
:type undo: bool | None
|
|
3717
3717
|
:param data_path: Property Edit, Property data_path edit
|
|
3718
3718
|
:type data_path: str | typing.Any
|
|
@@ -3725,8 +3725,8 @@ def properties_edit_value(
|
|
|
3725
3725
|
...
|
|
3726
3726
|
|
|
3727
3727
|
def properties_remove(
|
|
3728
|
-
override_context: dict[str, typing.Any] |
|
|
3729
|
-
execution_context:
|
|
3728
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3729
|
+
execution_context: int | str | None = None,
|
|
3730
3730
|
undo: bool | None = None,
|
|
3731
3731
|
*,
|
|
3732
3732
|
data_path: str | typing.Any = "",
|
|
@@ -3734,8 +3734,8 @@ def properties_remove(
|
|
|
3734
3734
|
):
|
|
3735
3735
|
"""Internal use (edit a property data_path)
|
|
3736
3736
|
|
|
3737
|
-
:type override_context: dict[str, typing.Any] |
|
|
3738
|
-
:type execution_context:
|
|
3737
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3738
|
+
:type execution_context: int | str | None
|
|
3739
3739
|
:type undo: bool | None
|
|
3740
3740
|
:param data_path: Property Edit, Property data_path edit
|
|
3741
3741
|
:type data_path: str | typing.Any
|
|
@@ -3746,22 +3746,22 @@ def properties_remove(
|
|
|
3746
3746
|
...
|
|
3747
3747
|
|
|
3748
3748
|
def quit_blender(
|
|
3749
|
-
override_context: dict[str, typing.Any] |
|
|
3750
|
-
execution_context:
|
|
3749
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3750
|
+
execution_context: int | str | None = None,
|
|
3751
3751
|
undo: bool | None = None,
|
|
3752
3752
|
):
|
|
3753
3753
|
"""Quit Blender
|
|
3754
3754
|
|
|
3755
|
-
:type override_context: dict[str, typing.Any] |
|
|
3756
|
-
:type execution_context:
|
|
3755
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3756
|
+
:type execution_context: int | str | None
|
|
3757
3757
|
:type undo: bool | None
|
|
3758
3758
|
"""
|
|
3759
3759
|
|
|
3760
3760
|
...
|
|
3761
3761
|
|
|
3762
3762
|
def radial_control(
|
|
3763
|
-
override_context: dict[str, typing.Any] |
|
|
3764
|
-
execution_context:
|
|
3763
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3764
|
+
execution_context: int | str | None = None,
|
|
3765
3765
|
undo: bool | None = None,
|
|
3766
3766
|
*,
|
|
3767
3767
|
data_path_primary: str | typing.Any = "",
|
|
@@ -3779,8 +3779,8 @@ def radial_control(
|
|
|
3779
3779
|
):
|
|
3780
3780
|
"""Set some size property (e.g. brush size) with mouse wheel
|
|
3781
3781
|
|
|
3782
|
-
:type override_context: dict[str, typing.Any] |
|
|
3783
|
-
:type execution_context:
|
|
3782
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3783
|
+
:type execution_context: int | str | None
|
|
3784
3784
|
:type undo: bool | None
|
|
3785
3785
|
:param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
|
|
3786
3786
|
:type data_path_primary: str | typing.Any
|
|
@@ -3811,8 +3811,8 @@ def radial_control(
|
|
|
3811
3811
|
...
|
|
3812
3812
|
|
|
3813
3813
|
def read_factory_settings(
|
|
3814
|
-
override_context: dict[str, typing.Any] |
|
|
3815
|
-
execution_context:
|
|
3814
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3815
|
+
execution_context: int | str | None = None,
|
|
3816
3816
|
undo: bool | None = None,
|
|
3817
3817
|
*,
|
|
3818
3818
|
use_factory_startup_app_template_only: bool | typing.Any | None = False,
|
|
@@ -3821,8 +3821,8 @@ def read_factory_settings(
|
|
|
3821
3821
|
):
|
|
3822
3822
|
"""Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
|
|
3823
3823
|
|
|
3824
|
-
:type override_context: dict[str, typing.Any] |
|
|
3825
|
-
:type execution_context:
|
|
3824
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3825
|
+
:type execution_context: int | str | None
|
|
3826
3826
|
:type undo: bool | None
|
|
3827
3827
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3828
3828
|
:type use_factory_startup_app_template_only: bool | typing.Any | None
|
|
@@ -3834,16 +3834,16 @@ def read_factory_settings(
|
|
|
3834
3834
|
...
|
|
3835
3835
|
|
|
3836
3836
|
def read_factory_userpref(
|
|
3837
|
-
override_context: dict[str, typing.Any] |
|
|
3838
|
-
execution_context:
|
|
3837
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3838
|
+
execution_context: int | str | None = None,
|
|
3839
3839
|
undo: bool | None = None,
|
|
3840
3840
|
*,
|
|
3841
3841
|
use_factory_startup_app_template_only: bool | typing.Any | None = False,
|
|
3842
3842
|
):
|
|
3843
3843
|
"""Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
|
|
3844
3844
|
|
|
3845
|
-
:type override_context: dict[str, typing.Any] |
|
|
3846
|
-
:type execution_context:
|
|
3845
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3846
|
+
:type execution_context: int | str | None
|
|
3847
3847
|
:type undo: bool | None
|
|
3848
3848
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3849
3849
|
:type use_factory_startup_app_template_only: bool | typing.Any | None
|
|
@@ -3852,22 +3852,22 @@ def read_factory_userpref(
|
|
|
3852
3852
|
...
|
|
3853
3853
|
|
|
3854
3854
|
def read_history(
|
|
3855
|
-
override_context: dict[str, typing.Any] |
|
|
3856
|
-
execution_context:
|
|
3855
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3856
|
+
execution_context: int | str | None = None,
|
|
3857
3857
|
undo: bool | None = None,
|
|
3858
3858
|
):
|
|
3859
3859
|
"""Reloads history and bookmarks
|
|
3860
3860
|
|
|
3861
|
-
:type override_context: dict[str, typing.Any] |
|
|
3862
|
-
:type execution_context:
|
|
3861
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3862
|
+
:type execution_context: int | str | None
|
|
3863
3863
|
:type undo: bool | None
|
|
3864
3864
|
"""
|
|
3865
3865
|
|
|
3866
3866
|
...
|
|
3867
3867
|
|
|
3868
3868
|
def read_homefile(
|
|
3869
|
-
override_context: dict[str, typing.Any] |
|
|
3870
|
-
execution_context:
|
|
3869
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3870
|
+
execution_context: int | str | None = None,
|
|
3871
3871
|
undo: bool | None = None,
|
|
3872
3872
|
*,
|
|
3873
3873
|
filepath: str | typing.Any = "",
|
|
@@ -3880,8 +3880,8 @@ def read_homefile(
|
|
|
3880
3880
|
):
|
|
3881
3881
|
"""Open the default file
|
|
3882
3882
|
|
|
3883
|
-
:type override_context: dict[str, typing.Any] |
|
|
3884
|
-
:type execution_context:
|
|
3883
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3884
|
+
:type execution_context: int | str | None
|
|
3885
3885
|
:type undo: bool | None
|
|
3886
3886
|
:param filepath: File Path, Path to an alternative start-up file
|
|
3887
3887
|
:type filepath: str | typing.Any
|
|
@@ -3901,22 +3901,22 @@ def read_homefile(
|
|
|
3901
3901
|
...
|
|
3902
3902
|
|
|
3903
3903
|
def read_userpref(
|
|
3904
|
-
override_context: dict[str, typing.Any] |
|
|
3905
|
-
execution_context:
|
|
3904
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3905
|
+
execution_context: int | str | None = None,
|
|
3906
3906
|
undo: bool | None = None,
|
|
3907
3907
|
):
|
|
3908
3908
|
"""Load last saved preferences
|
|
3909
3909
|
|
|
3910
|
-
:type override_context: dict[str, typing.Any] |
|
|
3911
|
-
:type execution_context:
|
|
3910
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3911
|
+
:type execution_context: int | str | None
|
|
3912
3912
|
:type undo: bool | None
|
|
3913
3913
|
"""
|
|
3914
3914
|
|
|
3915
3915
|
...
|
|
3916
3916
|
|
|
3917
3917
|
def recover_auto_save(
|
|
3918
|
-
override_context: dict[str, typing.Any] |
|
|
3919
|
-
execution_context:
|
|
3918
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3919
|
+
execution_context: int | str | None = None,
|
|
3920
3920
|
undo: bool | None = None,
|
|
3921
3921
|
*,
|
|
3922
3922
|
filepath: str | typing.Any = "",
|
|
@@ -3946,8 +3946,8 @@ def recover_auto_save(
|
|
|
3946
3946
|
):
|
|
3947
3947
|
"""Open an automatically saved file to recover it
|
|
3948
3948
|
|
|
3949
|
-
:type override_context: dict[str, typing.Any] |
|
|
3950
|
-
:type execution_context:
|
|
3949
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3950
|
+
:type execution_context: int | str | None
|
|
3951
3951
|
:type undo: bool | None
|
|
3952
3952
|
:param filepath: File Path, Path to file
|
|
3953
3953
|
:type filepath: str | typing.Any
|
|
@@ -4014,16 +4014,16 @@ def recover_auto_save(
|
|
|
4014
4014
|
...
|
|
4015
4015
|
|
|
4016
4016
|
def recover_last_session(
|
|
4017
|
-
override_context: dict[str, typing.Any] |
|
|
4018
|
-
execution_context:
|
|
4017
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4018
|
+
execution_context: int | str | None = None,
|
|
4019
4019
|
undo: bool | None = None,
|
|
4020
4020
|
*,
|
|
4021
4021
|
use_scripts: bool | typing.Any | None = True,
|
|
4022
4022
|
):
|
|
4023
4023
|
"""Open the last closed file ("quit.blend")
|
|
4024
4024
|
|
|
4025
|
-
:type override_context: dict[str, typing.Any] |
|
|
4026
|
-
:type execution_context:
|
|
4025
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4026
|
+
:type execution_context: int | str | None
|
|
4027
4027
|
:type undo: bool | None
|
|
4028
4028
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
4029
4029
|
:type use_scripts: bool | typing.Any | None
|
|
@@ -4032,8 +4032,8 @@ def recover_last_session(
|
|
|
4032
4032
|
...
|
|
4033
4033
|
|
|
4034
4034
|
def redraw_timer(
|
|
4035
|
-
override_context: dict[str, typing.Any] |
|
|
4036
|
-
execution_context:
|
|
4035
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4036
|
+
execution_context: int | str | None = None,
|
|
4037
4037
|
undo: bool | None = None,
|
|
4038
4038
|
*,
|
|
4039
4039
|
type: str | None = "DRAW",
|
|
@@ -4042,8 +4042,8 @@ def redraw_timer(
|
|
|
4042
4042
|
):
|
|
4043
4043
|
"""Simple redraw timer to test the speed of updating the interface
|
|
4044
4044
|
|
|
4045
|
-
:type override_context: dict[str, typing.Any] |
|
|
4046
|
-
:type execution_context:
|
|
4045
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4046
|
+
:type execution_context: int | str | None
|
|
4047
4047
|
:type undo: bool | None
|
|
4048
4048
|
:param type: Type
|
|
4049
4049
|
|
|
@@ -4077,16 +4077,16 @@ def redraw_timer(
|
|
|
4077
4077
|
...
|
|
4078
4078
|
|
|
4079
4079
|
def revert_mainfile(
|
|
4080
|
-
override_context: dict[str, typing.Any] |
|
|
4081
|
-
execution_context:
|
|
4080
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4081
|
+
execution_context: int | str | None = None,
|
|
4082
4082
|
undo: bool | None = None,
|
|
4083
4083
|
*,
|
|
4084
4084
|
use_scripts: bool | typing.Any | None = True,
|
|
4085
4085
|
):
|
|
4086
4086
|
"""Reload the saved file
|
|
4087
4087
|
|
|
4088
|
-
:type override_context: dict[str, typing.Any] |
|
|
4089
|
-
:type execution_context:
|
|
4088
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4089
|
+
:type execution_context: int | str | None
|
|
4090
4090
|
:type undo: bool | None
|
|
4091
4091
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
4092
4092
|
:type use_scripts: bool | typing.Any | None
|
|
@@ -4095,8 +4095,8 @@ def revert_mainfile(
|
|
|
4095
4095
|
...
|
|
4096
4096
|
|
|
4097
4097
|
def save_as_mainfile(
|
|
4098
|
-
override_context: dict[str, typing.Any] |
|
|
4099
|
-
execution_context:
|
|
4098
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4099
|
+
execution_context: int | str | None = None,
|
|
4100
4100
|
undo: bool | None = None,
|
|
4101
4101
|
*,
|
|
4102
4102
|
filepath: str | typing.Any = "",
|
|
@@ -4128,8 +4128,8 @@ def save_as_mainfile(
|
|
|
4128
4128
|
):
|
|
4129
4129
|
"""Save the current file in the desired location
|
|
4130
4130
|
|
|
4131
|
-
:type override_context: dict[str, typing.Any] |
|
|
4132
|
-
:type execution_context:
|
|
4131
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4132
|
+
:type execution_context: int | str | None
|
|
4133
4133
|
:type undo: bool | None
|
|
4134
4134
|
:param filepath: File Path, Path to file
|
|
4135
4135
|
:type filepath: str | typing.Any
|
|
@@ -4200,22 +4200,22 @@ def save_as_mainfile(
|
|
|
4200
4200
|
...
|
|
4201
4201
|
|
|
4202
4202
|
def save_homefile(
|
|
4203
|
-
override_context: dict[str, typing.Any] |
|
|
4204
|
-
execution_context:
|
|
4203
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4204
|
+
execution_context: int | str | None = None,
|
|
4205
4205
|
undo: bool | None = None,
|
|
4206
4206
|
):
|
|
4207
4207
|
"""Make the current file the default startup file
|
|
4208
4208
|
|
|
4209
|
-
:type override_context: dict[str, typing.Any] |
|
|
4210
|
-
:type execution_context:
|
|
4209
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4210
|
+
:type execution_context: int | str | None
|
|
4211
4211
|
:type undo: bool | None
|
|
4212
4212
|
"""
|
|
4213
4213
|
|
|
4214
4214
|
...
|
|
4215
4215
|
|
|
4216
4216
|
def save_mainfile(
|
|
4217
|
-
override_context: dict[str, typing.Any] |
|
|
4218
|
-
execution_context:
|
|
4217
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4218
|
+
execution_context: int | str | None = None,
|
|
4219
4219
|
undo: bool | None = None,
|
|
4220
4220
|
*,
|
|
4221
4221
|
filepath: str | typing.Any = "",
|
|
@@ -4248,8 +4248,8 @@ def save_mainfile(
|
|
|
4248
4248
|
):
|
|
4249
4249
|
"""Save the current Blender file
|
|
4250
4250
|
|
|
4251
|
-
:type override_context: dict[str, typing.Any] |
|
|
4252
|
-
:type execution_context:
|
|
4251
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4252
|
+
:type execution_context: int | str | None
|
|
4253
4253
|
:type undo: bool | None
|
|
4254
4254
|
:param filepath: File Path, Path to file
|
|
4255
4255
|
:type filepath: str | typing.Any
|
|
@@ -4322,50 +4322,50 @@ def save_mainfile(
|
|
|
4322
4322
|
...
|
|
4323
4323
|
|
|
4324
4324
|
def save_userpref(
|
|
4325
|
-
override_context: dict[str, typing.Any] |
|
|
4326
|
-
execution_context:
|
|
4325
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4326
|
+
execution_context: int | str | None = None,
|
|
4327
4327
|
undo: bool | None = None,
|
|
4328
4328
|
):
|
|
4329
4329
|
"""Make the current preferences default
|
|
4330
4330
|
|
|
4331
|
-
:type override_context: dict[str, typing.Any] |
|
|
4332
|
-
:type execution_context:
|
|
4331
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4332
|
+
:type execution_context: int | str | None
|
|
4333
4333
|
:type undo: bool | None
|
|
4334
4334
|
"""
|
|
4335
4335
|
|
|
4336
4336
|
...
|
|
4337
4337
|
|
|
4338
4338
|
def search_menu(
|
|
4339
|
-
override_context: dict[str, typing.Any] |
|
|
4340
|
-
execution_context:
|
|
4339
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4340
|
+
execution_context: int | str | None = None,
|
|
4341
4341
|
undo: bool | None = None,
|
|
4342
4342
|
):
|
|
4343
4343
|
"""Pop-up a search over all menus in the current context
|
|
4344
4344
|
|
|
4345
|
-
:type override_context: dict[str, typing.Any] |
|
|
4346
|
-
:type execution_context:
|
|
4345
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4346
|
+
:type execution_context: int | str | None
|
|
4347
4347
|
:type undo: bool | None
|
|
4348
4348
|
"""
|
|
4349
4349
|
|
|
4350
4350
|
...
|
|
4351
4351
|
|
|
4352
4352
|
def search_operator(
|
|
4353
|
-
override_context: dict[str, typing.Any] |
|
|
4354
|
-
execution_context:
|
|
4353
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4354
|
+
execution_context: int | str | None = None,
|
|
4355
4355
|
undo: bool | None = None,
|
|
4356
4356
|
):
|
|
4357
4357
|
"""Pop-up a search over all available operators in current context
|
|
4358
4358
|
|
|
4359
|
-
:type override_context: dict[str, typing.Any] |
|
|
4360
|
-
:type execution_context:
|
|
4359
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4360
|
+
:type execution_context: int | str | None
|
|
4361
4361
|
:type undo: bool | None
|
|
4362
4362
|
"""
|
|
4363
4363
|
|
|
4364
4364
|
...
|
|
4365
4365
|
|
|
4366
4366
|
def search_single_menu(
|
|
4367
|
-
override_context: dict[str, typing.Any] |
|
|
4368
|
-
execution_context:
|
|
4367
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4368
|
+
execution_context: int | str | None = None,
|
|
4369
4369
|
undo: bool | None = None,
|
|
4370
4370
|
*,
|
|
4371
4371
|
menu_idname: str | typing.Any = "",
|
|
@@ -4373,8 +4373,8 @@ def search_single_menu(
|
|
|
4373
4373
|
):
|
|
4374
4374
|
"""Pop-up a search for a menu in current context
|
|
4375
4375
|
|
|
4376
|
-
:type override_context: dict[str, typing.Any] |
|
|
4377
|
-
:type execution_context:
|
|
4376
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4377
|
+
:type execution_context: int | str | None
|
|
4378
4378
|
:type undo: bool | None
|
|
4379
4379
|
:param menu_idname: Menu Name, Menu to search in
|
|
4380
4380
|
:type menu_idname: str | typing.Any
|
|
@@ -4385,8 +4385,8 @@ def search_single_menu(
|
|
|
4385
4385
|
...
|
|
4386
4386
|
|
|
4387
4387
|
def set_stereo_3d(
|
|
4388
|
-
override_context: dict[str, typing.Any] |
|
|
4389
|
-
execution_context:
|
|
4388
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4389
|
+
execution_context: int | str | None = None,
|
|
4390
4390
|
undo: bool | None = None,
|
|
4391
4391
|
*,
|
|
4392
4392
|
display_mode: str | None = "ANAGLYPH",
|
|
@@ -4397,8 +4397,8 @@ def set_stereo_3d(
|
|
|
4397
4397
|
):
|
|
4398
4398
|
"""Toggle 3D stereo support for current window (or change the display mode)
|
|
4399
4399
|
|
|
4400
|
-
:type override_context: dict[str, typing.Any] |
|
|
4401
|
-
:type execution_context:
|
|
4400
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4401
|
+
:type execution_context: int | str | None
|
|
4402
4402
|
:type undo: bool | None
|
|
4403
4403
|
:param display_mode: Display Mode
|
|
4404
4404
|
:type display_mode: str | None
|
|
@@ -4415,36 +4415,36 @@ def set_stereo_3d(
|
|
|
4415
4415
|
...
|
|
4416
4416
|
|
|
4417
4417
|
def splash(
|
|
4418
|
-
override_context: dict[str, typing.Any] |
|
|
4419
|
-
execution_context:
|
|
4418
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4419
|
+
execution_context: int | str | None = None,
|
|
4420
4420
|
undo: bool | None = None,
|
|
4421
4421
|
):
|
|
4422
4422
|
"""Open the splash screen with release info
|
|
4423
4423
|
|
|
4424
|
-
:type override_context: dict[str, typing.Any] |
|
|
4425
|
-
:type execution_context:
|
|
4424
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4425
|
+
:type execution_context: int | str | None
|
|
4426
4426
|
:type undo: bool | None
|
|
4427
4427
|
"""
|
|
4428
4428
|
|
|
4429
4429
|
...
|
|
4430
4430
|
|
|
4431
4431
|
def splash_about(
|
|
4432
|
-
override_context: dict[str, typing.Any] |
|
|
4433
|
-
execution_context:
|
|
4432
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4433
|
+
execution_context: int | str | None = None,
|
|
4434
4434
|
undo: bool | None = None,
|
|
4435
4435
|
):
|
|
4436
4436
|
"""Open a window with information about Blender
|
|
4437
4437
|
|
|
4438
|
-
:type override_context: dict[str, typing.Any] |
|
|
4439
|
-
:type execution_context:
|
|
4438
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4439
|
+
:type execution_context: int | str | None
|
|
4440
4440
|
:type undo: bool | None
|
|
4441
4441
|
"""
|
|
4442
4442
|
|
|
4443
4443
|
...
|
|
4444
4444
|
|
|
4445
4445
|
def stl_export(
|
|
4446
|
-
override_context: dict[str, typing.Any] |
|
|
4447
|
-
execution_context:
|
|
4446
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4447
|
+
execution_context: int | str | None = None,
|
|
4448
4448
|
undo: bool | None = None,
|
|
4449
4449
|
*,
|
|
4450
4450
|
filepath: str | typing.Any = "",
|
|
@@ -4482,8 +4482,8 @@ def stl_export(
|
|
|
4482
4482
|
):
|
|
4483
4483
|
"""Save the scene to an STL file
|
|
4484
4484
|
|
|
4485
|
-
:type override_context: dict[str, typing.Any] |
|
|
4486
|
-
:type execution_context:
|
|
4485
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4486
|
+
:type execution_context: int | str | None
|
|
4487
4487
|
:type undo: bool | None
|
|
4488
4488
|
:param filepath: File Path, Path to file
|
|
4489
4489
|
:type filepath: str | typing.Any
|
|
@@ -4602,8 +4602,8 @@ def stl_export(
|
|
|
4602
4602
|
...
|
|
4603
4603
|
|
|
4604
4604
|
def stl_import(
|
|
4605
|
-
override_context: dict[str, typing.Any] |
|
|
4606
|
-
execution_context:
|
|
4605
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4606
|
+
execution_context: int | str | None = None,
|
|
4607
4607
|
undo: bool | None = None,
|
|
4608
4608
|
*,
|
|
4609
4609
|
filepath: str | typing.Any = "",
|
|
@@ -4641,8 +4641,8 @@ def stl_import(
|
|
|
4641
4641
|
):
|
|
4642
4642
|
"""Import an STL file as an object
|
|
4643
4643
|
|
|
4644
|
-
:type override_context: dict[str, typing.Any] |
|
|
4645
|
-
:type execution_context:
|
|
4644
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4645
|
+
:type execution_context: int | str | None
|
|
4646
4646
|
:type undo: bool | None
|
|
4647
4647
|
:param filepath: File Path, Path to file
|
|
4648
4648
|
:type filepath: str | typing.Any
|
|
@@ -4759,16 +4759,16 @@ def stl_import(
|
|
|
4759
4759
|
...
|
|
4760
4760
|
|
|
4761
4761
|
def sysinfo(
|
|
4762
|
-
override_context: dict[str, typing.Any] |
|
|
4763
|
-
execution_context:
|
|
4762
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4763
|
+
execution_context: int | str | None = None,
|
|
4764
4764
|
undo: bool | None = None,
|
|
4765
4765
|
*,
|
|
4766
4766
|
filepath: str | typing.Any = "",
|
|
4767
4767
|
):
|
|
4768
4768
|
"""Generate system information, saved into a text file
|
|
4769
4769
|
|
|
4770
|
-
:type override_context: dict[str, typing.Any] |
|
|
4771
|
-
:type execution_context:
|
|
4770
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4771
|
+
:type execution_context: int | str | None
|
|
4772
4772
|
:type undo: bool | None
|
|
4773
4773
|
:param filepath: filepath
|
|
4774
4774
|
:type filepath: str | typing.Any
|
|
@@ -4777,8 +4777,8 @@ def sysinfo(
|
|
|
4777
4777
|
...
|
|
4778
4778
|
|
|
4779
4779
|
def tool_set_by_id(
|
|
4780
|
-
override_context: dict[str, typing.Any] |
|
|
4781
|
-
execution_context:
|
|
4780
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4781
|
+
execution_context: int | str | None = None,
|
|
4782
4782
|
undo: bool | None = None,
|
|
4783
4783
|
*,
|
|
4784
4784
|
name: str | typing.Any = "",
|
|
@@ -4788,8 +4788,8 @@ def tool_set_by_id(
|
|
|
4788
4788
|
):
|
|
4789
4789
|
"""Set the tool by name (for key-maps)
|
|
4790
4790
|
|
|
4791
|
-
:type override_context: dict[str, typing.Any] |
|
|
4792
|
-
:type execution_context:
|
|
4791
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4792
|
+
:type execution_context: int | str | None
|
|
4793
4793
|
:type undo: bool | None
|
|
4794
4794
|
:param name: Identifier, Identifier of the tool
|
|
4795
4795
|
:type name: str | typing.Any
|
|
@@ -4804,8 +4804,8 @@ def tool_set_by_id(
|
|
|
4804
4804
|
...
|
|
4805
4805
|
|
|
4806
4806
|
def tool_set_by_index(
|
|
4807
|
-
override_context: dict[str, typing.Any] |
|
|
4808
|
-
execution_context:
|
|
4807
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4808
|
+
execution_context: int | str | None = None,
|
|
4809
4809
|
undo: bool | None = None,
|
|
4810
4810
|
*,
|
|
4811
4811
|
index: typing.Any | None = 0,
|
|
@@ -4816,8 +4816,8 @@ def tool_set_by_index(
|
|
|
4816
4816
|
):
|
|
4817
4817
|
"""Set the tool by index (for key-maps)
|
|
4818
4818
|
|
|
4819
|
-
:type override_context: dict[str, typing.Any] |
|
|
4820
|
-
:type execution_context:
|
|
4819
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4820
|
+
:type execution_context: int | str | None
|
|
4821
4821
|
:type undo: bool | None
|
|
4822
4822
|
:param index: Index in Toolbar
|
|
4823
4823
|
:type index: typing.Any | None
|
|
@@ -4834,58 +4834,58 @@ def tool_set_by_index(
|
|
|
4834
4834
|
...
|
|
4835
4835
|
|
|
4836
4836
|
def toolbar(
|
|
4837
|
-
override_context: dict[str, typing.Any] |
|
|
4838
|
-
execution_context:
|
|
4837
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4838
|
+
execution_context: int | str | None = None,
|
|
4839
4839
|
undo: bool | None = None,
|
|
4840
4840
|
):
|
|
4841
4841
|
"""Undocumented, consider contributing.
|
|
4842
4842
|
|
|
4843
|
-
:type override_context: dict[str, typing.Any] |
|
|
4844
|
-
:type execution_context:
|
|
4843
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4844
|
+
:type execution_context: int | str | None
|
|
4845
4845
|
:type undo: bool | None
|
|
4846
4846
|
"""
|
|
4847
4847
|
|
|
4848
4848
|
...
|
|
4849
4849
|
|
|
4850
4850
|
def toolbar_fallback_pie(
|
|
4851
|
-
override_context: dict[str, typing.Any] |
|
|
4852
|
-
execution_context:
|
|
4851
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4852
|
+
execution_context: int | str | None = None,
|
|
4853
4853
|
undo: bool | None = None,
|
|
4854
4854
|
):
|
|
4855
4855
|
"""Undocumented, consider contributing.
|
|
4856
4856
|
|
|
4857
|
-
:type override_context: dict[str, typing.Any] |
|
|
4858
|
-
:type execution_context:
|
|
4857
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4858
|
+
:type execution_context: int | str | None
|
|
4859
4859
|
:type undo: bool | None
|
|
4860
4860
|
"""
|
|
4861
4861
|
|
|
4862
4862
|
...
|
|
4863
4863
|
|
|
4864
4864
|
def toolbar_prompt(
|
|
4865
|
-
override_context: dict[str, typing.Any] |
|
|
4866
|
-
execution_context:
|
|
4865
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4866
|
+
execution_context: int | str | None = None,
|
|
4867
4867
|
undo: bool | None = None,
|
|
4868
4868
|
):
|
|
4869
4869
|
"""Leader key like functionality for accessing tools
|
|
4870
4870
|
|
|
4871
|
-
:type override_context: dict[str, typing.Any] |
|
|
4872
|
-
:type execution_context:
|
|
4871
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4872
|
+
:type execution_context: int | str | None
|
|
4873
4873
|
:type undo: bool | None
|
|
4874
4874
|
"""
|
|
4875
4875
|
|
|
4876
4876
|
...
|
|
4877
4877
|
|
|
4878
4878
|
def url_open(
|
|
4879
|
-
override_context: dict[str, typing.Any] |
|
|
4880
|
-
execution_context:
|
|
4879
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4880
|
+
execution_context: int | str | None = None,
|
|
4881
4881
|
undo: bool | None = None,
|
|
4882
4882
|
*,
|
|
4883
4883
|
url: str | typing.Any = "",
|
|
4884
4884
|
):
|
|
4885
4885
|
"""Open a website in the web browser
|
|
4886
4886
|
|
|
4887
|
-
:type override_context: dict[str, typing.Any] |
|
|
4888
|
-
:type execution_context:
|
|
4887
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4888
|
+
:type execution_context: int | str | None
|
|
4889
4889
|
:type undo: bool | None
|
|
4890
4890
|
:param url: URL, URL to open
|
|
4891
4891
|
:type url: str | typing.Any
|
|
@@ -4894,8 +4894,8 @@ def url_open(
|
|
|
4894
4894
|
...
|
|
4895
4895
|
|
|
4896
4896
|
def url_open_preset(
|
|
4897
|
-
override_context: dict[str, typing.Any] |
|
|
4898
|
-
execution_context:
|
|
4897
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4898
|
+
execution_context: int | str | None = None,
|
|
4899
4899
|
undo: bool | None = None,
|
|
4900
4900
|
*,
|
|
4901
4901
|
type: str | None = "",
|
|
@@ -4903,8 +4903,8 @@ def url_open_preset(
|
|
|
4903
4903
|
):
|
|
4904
4904
|
"""Open a preset website in the web browser
|
|
4905
4905
|
|
|
4906
|
-
:type override_context: dict[str, typing.Any] |
|
|
4907
|
-
:type execution_context:
|
|
4906
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4907
|
+
:type execution_context: int | str | None
|
|
4908
4908
|
:type undo: bool | None
|
|
4909
4909
|
:param type: Site
|
|
4910
4910
|
:type type: str | None
|
|
@@ -4915,8 +4915,8 @@ def url_open_preset(
|
|
|
4915
4915
|
...
|
|
4916
4916
|
|
|
4917
4917
|
def usd_export(
|
|
4918
|
-
override_context: dict[str, typing.Any] |
|
|
4919
|
-
execution_context:
|
|
4918
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4919
|
+
execution_context: int | str | None = None,
|
|
4920
4920
|
undo: bool | None = None,
|
|
4921
4921
|
*,
|
|
4922
4922
|
filepath: str | typing.Any = "",
|
|
@@ -4977,11 +4977,13 @@ def usd_export(
|
|
|
4977
4977
|
triangulate_meshes: bool | typing.Any | None = False,
|
|
4978
4978
|
quad_method: str | None = "SHORTEST_DIAGONAL",
|
|
4979
4979
|
ngon_method: str | None = "BEAUTY",
|
|
4980
|
+
usdz_downscale_size: str | None = "KEEP",
|
|
4981
|
+
usdz_downscale_custom_size: typing.Any | None = 128,
|
|
4980
4982
|
):
|
|
4981
4983
|
"""Export current scene in a USD archive
|
|
4982
4984
|
|
|
4983
|
-
:type override_context: dict[str, typing.Any] |
|
|
4984
|
-
:type execution_context:
|
|
4985
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4986
|
+
:type execution_context: int | str | None
|
|
4985
4987
|
:type undo: bool | None
|
|
4986
4988
|
:param filepath: File Path, Path to file
|
|
4987
4989
|
:type filepath: str | typing.Any
|
|
@@ -5170,13 +5172,38 @@ def usd_export(
|
|
|
5170
5172
|
:type quad_method: str | None
|
|
5171
5173
|
:param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
|
|
5172
5174
|
:type ngon_method: str | None
|
|
5175
|
+
:param usdz_downscale_size: USDZ Texture Downsampling, Choose a maximum size for all exported textures
|
|
5176
|
+
|
|
5177
|
+
KEEP
|
|
5178
|
+
Keep -- Keep all current texture sizes.
|
|
5179
|
+
|
|
5180
|
+
256
|
|
5181
|
+
256 -- Resize to a maximum of 256 pixels.
|
|
5182
|
+
|
|
5183
|
+
512
|
|
5184
|
+
512 -- Resize to a maximum of 512 pixels.
|
|
5185
|
+
|
|
5186
|
+
1024
|
|
5187
|
+
1024 -- Resize to a maximum of 1024 pixels.
|
|
5188
|
+
|
|
5189
|
+
2048
|
|
5190
|
+
2048 -- Resize to a maximum of 2048 pixels.
|
|
5191
|
+
|
|
5192
|
+
4096
|
|
5193
|
+
4096 -- Resize to a maximum of 4096 pixels.
|
|
5194
|
+
|
|
5195
|
+
CUSTOM
|
|
5196
|
+
Custom -- Specify a custom size.
|
|
5197
|
+
:type usdz_downscale_size: str | None
|
|
5198
|
+
:param usdz_downscale_custom_size: USDZ Custom Downscale Size, Custom size for downscaling exported textures
|
|
5199
|
+
:type usdz_downscale_custom_size: typing.Any | None
|
|
5173
5200
|
"""
|
|
5174
5201
|
|
|
5175
5202
|
...
|
|
5176
5203
|
|
|
5177
5204
|
def usd_import(
|
|
5178
|
-
override_context: dict[str, typing.Any] |
|
|
5179
|
-
execution_context:
|
|
5205
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5206
|
+
execution_context: int | str | None = None,
|
|
5180
5207
|
undo: bool | None = None,
|
|
5181
5208
|
*,
|
|
5182
5209
|
filepath: str | typing.Any = "",
|
|
@@ -5241,8 +5268,8 @@ def usd_import(
|
|
|
5241
5268
|
):
|
|
5242
5269
|
"""Import USD stage into current scene
|
|
5243
5270
|
|
|
5244
|
-
:type override_context: dict[str, typing.Any] |
|
|
5245
|
-
:type execution_context:
|
|
5271
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5272
|
+
:type execution_context: int | str | None
|
|
5246
5273
|
:type undo: bool | None
|
|
5247
5274
|
:param filepath: File Path, Path to file
|
|
5248
5275
|
:type filepath: str | typing.Any
|
|
@@ -5408,64 +5435,64 @@ def usd_import(
|
|
|
5408
5435
|
...
|
|
5409
5436
|
|
|
5410
5437
|
def window_close(
|
|
5411
|
-
override_context: dict[str, typing.Any] |
|
|
5412
|
-
execution_context:
|
|
5438
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5439
|
+
execution_context: int | str | None = None,
|
|
5413
5440
|
undo: bool | None = None,
|
|
5414
5441
|
):
|
|
5415
5442
|
"""Close the current window
|
|
5416
5443
|
|
|
5417
|
-
:type override_context: dict[str, typing.Any] |
|
|
5418
|
-
:type execution_context:
|
|
5444
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5445
|
+
:type execution_context: int | str | None
|
|
5419
5446
|
:type undo: bool | None
|
|
5420
5447
|
"""
|
|
5421
5448
|
|
|
5422
5449
|
...
|
|
5423
5450
|
|
|
5424
5451
|
def window_fullscreen_toggle(
|
|
5425
|
-
override_context: dict[str, typing.Any] |
|
|
5426
|
-
execution_context:
|
|
5452
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5453
|
+
execution_context: int | str | None = None,
|
|
5427
5454
|
undo: bool | None = None,
|
|
5428
5455
|
):
|
|
5429
5456
|
"""Toggle the current window full-screen
|
|
5430
5457
|
|
|
5431
|
-
:type override_context: dict[str, typing.Any] |
|
|
5432
|
-
:type execution_context:
|
|
5458
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5459
|
+
:type execution_context: int | str | None
|
|
5433
5460
|
:type undo: bool | None
|
|
5434
5461
|
"""
|
|
5435
5462
|
|
|
5436
5463
|
...
|
|
5437
5464
|
|
|
5438
5465
|
def window_new(
|
|
5439
|
-
override_context: dict[str, typing.Any] |
|
|
5440
|
-
execution_context:
|
|
5466
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5467
|
+
execution_context: int | str | None = None,
|
|
5441
5468
|
undo: bool | None = None,
|
|
5442
5469
|
):
|
|
5443
5470
|
"""Create a new window
|
|
5444
5471
|
|
|
5445
|
-
:type override_context: dict[str, typing.Any] |
|
|
5446
|
-
:type execution_context:
|
|
5472
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5473
|
+
:type execution_context: int | str | None
|
|
5447
5474
|
:type undo: bool | None
|
|
5448
5475
|
"""
|
|
5449
5476
|
|
|
5450
5477
|
...
|
|
5451
5478
|
|
|
5452
5479
|
def window_new_main(
|
|
5453
|
-
override_context: dict[str, typing.Any] |
|
|
5454
|
-
execution_context:
|
|
5480
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5481
|
+
execution_context: int | str | None = None,
|
|
5455
5482
|
undo: bool | None = None,
|
|
5456
5483
|
):
|
|
5457
5484
|
"""Create a new main window with its own workspace and scene selection
|
|
5458
5485
|
|
|
5459
|
-
:type override_context: dict[str, typing.Any] |
|
|
5460
|
-
:type execution_context:
|
|
5486
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5487
|
+
:type execution_context: int | str | None
|
|
5461
5488
|
:type undo: bool | None
|
|
5462
5489
|
"""
|
|
5463
5490
|
|
|
5464
5491
|
...
|
|
5465
5492
|
|
|
5466
5493
|
def xr_navigation_fly(
|
|
5467
|
-
override_context: dict[str, typing.Any] |
|
|
5468
|
-
execution_context:
|
|
5494
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5495
|
+
execution_context: int | str | None = None,
|
|
5469
5496
|
undo: bool | None = None,
|
|
5470
5497
|
*,
|
|
5471
5498
|
mode: str | None = "VIEWER_FORWARD",
|
|
@@ -5479,8 +5506,8 @@ def xr_navigation_fly(
|
|
|
5479
5506
|
):
|
|
5480
5507
|
"""Move/turn relative to the VR viewer or controller
|
|
5481
5508
|
|
|
5482
|
-
:type override_context: dict[str, typing.Any] |
|
|
5483
|
-
:type execution_context:
|
|
5509
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5510
|
+
:type execution_context: int | str | None
|
|
5484
5511
|
:type undo: bool | None
|
|
5485
5512
|
:param mode: Mode, Fly mode
|
|
5486
5513
|
|
|
@@ -5542,8 +5569,8 @@ def xr_navigation_fly(
|
|
|
5542
5569
|
...
|
|
5543
5570
|
|
|
5544
5571
|
def xr_navigation_grab(
|
|
5545
|
-
override_context: dict[str, typing.Any] |
|
|
5546
|
-
execution_context:
|
|
5572
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5573
|
+
execution_context: int | str | None = None,
|
|
5547
5574
|
undo: bool | None = None,
|
|
5548
5575
|
*,
|
|
5549
5576
|
lock_location: bool | typing.Any | None = False,
|
|
@@ -5554,8 +5581,8 @@ def xr_navigation_grab(
|
|
|
5554
5581
|
):
|
|
5555
5582
|
"""Navigate the VR scene by grabbing with controllers
|
|
5556
5583
|
|
|
5557
|
-
:type override_context: dict[str, typing.Any] |
|
|
5558
|
-
:type execution_context:
|
|
5584
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5585
|
+
:type execution_context: int | str | None
|
|
5559
5586
|
:type undo: bool | None
|
|
5560
5587
|
:param lock_location: Lock Location, Prevent changes to viewer location
|
|
5561
5588
|
:type lock_location: bool | typing.Any | None
|
|
@@ -5572,8 +5599,8 @@ def xr_navigation_grab(
|
|
|
5572
5599
|
...
|
|
5573
5600
|
|
|
5574
5601
|
def xr_navigation_reset(
|
|
5575
|
-
override_context: dict[str, typing.Any] |
|
|
5576
|
-
execution_context:
|
|
5602
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5603
|
+
execution_context: int | str | None = None,
|
|
5577
5604
|
undo: bool | None = None,
|
|
5578
5605
|
*,
|
|
5579
5606
|
location: bool | typing.Any | None = True,
|
|
@@ -5582,8 +5609,8 @@ def xr_navigation_reset(
|
|
|
5582
5609
|
):
|
|
5583
5610
|
"""Reset VR navigation deltas relative to session base pose
|
|
5584
5611
|
|
|
5585
|
-
:type override_context: dict[str, typing.Any] |
|
|
5586
|
-
:type execution_context:
|
|
5612
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5613
|
+
:type execution_context: int | str | None
|
|
5587
5614
|
:type undo: bool | None
|
|
5588
5615
|
:param location: Location, Reset location deltas
|
|
5589
5616
|
:type location: bool | typing.Any | None
|
|
@@ -5596,8 +5623,8 @@ def xr_navigation_reset(
|
|
|
5596
5623
|
...
|
|
5597
5624
|
|
|
5598
5625
|
def xr_navigation_teleport(
|
|
5599
|
-
override_context: dict[str, typing.Any] |
|
|
5600
|
-
execution_context:
|
|
5626
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5627
|
+
execution_context: int | str | None = None,
|
|
5601
5628
|
undo: bool | None = None,
|
|
5602
5629
|
*,
|
|
5603
5630
|
teleport_axes: list[bool] | typing.Any | None = (True, True, True),
|
|
@@ -5611,8 +5638,8 @@ def xr_navigation_teleport(
|
|
|
5611
5638
|
):
|
|
5612
5639
|
"""Set VR viewer location to controller raycast hit location
|
|
5613
5640
|
|
|
5614
|
-
:type override_context: dict[str, typing.Any] |
|
|
5615
|
-
:type execution_context:
|
|
5641
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5642
|
+
:type execution_context: int | str | None
|
|
5616
5643
|
:type undo: bool | None
|
|
5617
5644
|
:param teleport_axes: Teleport Axes, Enabled teleport axes in navigation space
|
|
5618
5645
|
:type teleport_axes: list[bool] | typing.Any | None
|
|
@@ -5635,14 +5662,14 @@ def xr_navigation_teleport(
|
|
|
5635
5662
|
...
|
|
5636
5663
|
|
|
5637
5664
|
def xr_session_toggle(
|
|
5638
|
-
override_context: dict[str, typing.Any] |
|
|
5639
|
-
execution_context:
|
|
5665
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5666
|
+
execution_context: int | str | None = None,
|
|
5640
5667
|
undo: bool | None = None,
|
|
5641
5668
|
):
|
|
5642
5669
|
"""Open a view for use with virtual reality headsets, or close it if already opened
|
|
5643
5670
|
|
|
5644
|
-
:type override_context: dict[str, typing.Any] |
|
|
5645
|
-
:type execution_context:
|
|
5671
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5672
|
+
:type execution_context: int | str | None
|
|
5646
5673
|
:type undo: bool | None
|
|
5647
5674
|
"""
|
|
5648
5675
|
|