fake-bpy-module 20241208__py3-none-any.whl → 20241209__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bpy/ops/action/__init__.pyi +38 -138
- bpy/ops/anim/__init__.pyi +61 -179
- bpy/ops/armature/__init__.pyi +48 -147
- bpy/ops/asset/__init__.pyi +16 -71
- bpy/ops/boid/__init__.pyi +8 -41
- bpy/ops/brush/__init__.pyi +13 -39
- bpy/ops/buttons/__init__.pyi +6 -29
- bpy/ops/cachefile/__init__.pyi +5 -19
- bpy/ops/camera/__init__.pyi +2 -5
- bpy/ops/clip/__init__.pyi +92 -290
- bpy/ops/cloth/__init__.pyi +1 -3
- bpy/ops/collection/__init__.pyi +9 -25
- bpy/ops/console/__init__.pyi +21 -79
- bpy/ops/constraint/__init__.pyi +18 -45
- bpy/ops/curve/__init__.pyi +51 -180
- bpy/ops/curves/__init__.pyi +28 -100
- bpy/ops/cycles/__init__.pyi +3 -9
- bpy/ops/dpaint/__init__.pyi +5 -19
- bpy/ops/ed/__init__.pyi +12 -53
- bpy/ops/export_anim/__init__.pyi +1 -3
- bpy/ops/export_scene/__init__.pyi +2 -5
- bpy/ops/extensions/__init__.pyi +34 -110
- bpy/ops/file/__init__.pyi +40 -167
- bpy/ops/fluid/__init__.pyi +14 -77
- bpy/ops/font/__init__.pyi +23 -85
- bpy/ops/geometry/__init__.pyi +10 -27
- bpy/ops/gizmogroup/__init__.pyi +2 -9
- bpy/ops/gpencil/__init__.pyi +8 -32
- bpy/ops/graph/__init__.pyi +65 -184
- bpy/ops/grease_pencil/__init__.pyi +108 -290
- bpy/ops/image/__init__.pyi +49 -154
- bpy/ops/import_anim/__init__.pyi +1 -3
- bpy/ops/import_curve/__init__.pyi +1 -3
- bpy/ops/import_scene/__init__.pyi +2 -4
- bpy/ops/info/__init__.pyi +7 -29
- bpy/ops/lattice/__init__.pyi +8 -29
- bpy/ops/marker/__init__.pyi +11 -31
- bpy/ops/mask/__init__.pyi +39 -132
- bpy/ops/material/__init__.pyi +3 -19
- bpy/ops/mball/__init__.pyi +8 -19
- bpy/ops/mesh/__init__.pyi +164 -401
- bpy/ops/nla/__init__.pyi +39 -147
- bpy/ops/node/__init__.pyi +115 -390
- bpy/ops/object/__init__.pyi +237 -630
- bpy/ops/outliner/__init__.pyi +71 -263
- bpy/ops/paint/__init__.pyi +54 -140
- bpy/ops/paintcurve/__init__.pyi +8 -33
- bpy/ops/palette/__init__.pyi +7 -27
- bpy/ops/particle/__init__.pyi +36 -134
- bpy/ops/pose/__init__.pyi +51 -169
- bpy/ops/poselib/__init__.pyi +9 -33
- bpy/ops/preferences/__init__.pyi +35 -94
- bpy/ops/ptcache/__init__.pyi +7 -33
- bpy/ops/render/__init__.pyi +13 -37
- bpy/ops/rigidbody/__init__.pyi +13 -45
- bpy/ops/scene/__init__.pyi +37 -121
- bpy/ops/screen/__init__.pyi +39 -137
- bpy/ops/script/__init__.pyi +3 -11
- bpy/ops/sculpt/__init__.pyi +37 -94
- bpy/ops/sculpt_curves/__init__.pyi +4 -10
- bpy/ops/sequencer/__init__.pyi +89 -284
- bpy/ops/sound/__init__.pyi +7 -23
- bpy/ops/spreadsheet/__init__.pyi +4 -15
- bpy/ops/surface/__init__.pyi +6 -13
- bpy/ops/text/__init__.pyi +43 -175
- bpy/ops/text_editor/__init__.pyi +1 -3
- bpy/ops/texture/__init__.pyi +4 -21
- bpy/ops/transform/__init__.pyi +27 -61
- bpy/ops/ui/__init__.pyi +34 -117
- bpy/ops/uilist/__init__.pyi +3 -7
- bpy/ops/uv/__init__.pyi +49 -134
- bpy/ops/view2d/__init__.pyi +14 -39
- bpy/ops/view3d/__init__.pyi +67 -232
- bpy/ops/wm/__init__.pyi +114 -298
- bpy/ops/workspace/__init__.pyi +7 -33
- bpy/ops/world/__init__.pyi +2 -11
- {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/METADATA +1 -1
- {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/RECORD +80 -80
- {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20241208.dist-info → fake_bpy_module-20241209.dist-info}/top_level.txt +0 -0
bpy/ops/wm/__init__.pyi
CHANGED
|
@@ -7,9 +7,9 @@ import bpy.typing
|
|
|
7
7
|
import mathutils
|
|
8
8
|
|
|
9
9
|
def alembic_export(
|
|
10
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
11
10
|
execution_context: int | str | None = None,
|
|
12
11
|
undo: bool | None = None,
|
|
12
|
+
/,
|
|
13
13
|
*,
|
|
14
14
|
filepath: str = "",
|
|
15
15
|
check_existing: bool | None = True,
|
|
@@ -71,7 +71,6 @@ def alembic_export(
|
|
|
71
71
|
):
|
|
72
72
|
"""Export current scene in an Alembic archive
|
|
73
73
|
|
|
74
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
75
74
|
:type execution_context: int | str | None
|
|
76
75
|
:type undo: bool | None
|
|
77
76
|
:param filepath: File Path, Path to file
|
|
@@ -199,9 +198,9 @@ def alembic_export(
|
|
|
199
198
|
"""
|
|
200
199
|
|
|
201
200
|
def alembic_import(
|
|
202
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
203
201
|
execution_context: int | str | None = None,
|
|
204
202
|
undo: bool | None = None,
|
|
203
|
+
/,
|
|
205
204
|
*,
|
|
206
205
|
filepath: str = "",
|
|
207
206
|
directory: str = "",
|
|
@@ -242,7 +241,6 @@ def alembic_import(
|
|
|
242
241
|
):
|
|
243
242
|
"""Load an Alembic archive
|
|
244
243
|
|
|
245
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
246
244
|
:type execution_context: int | str | None
|
|
247
245
|
:type undo: bool | None
|
|
248
246
|
:param filepath: File Path, Path to file
|
|
@@ -323,9 +321,9 @@ def alembic_import(
|
|
|
323
321
|
"""
|
|
324
322
|
|
|
325
323
|
def append(
|
|
326
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
327
324
|
execution_context: int | str | None = None,
|
|
328
325
|
undo: bool | None = None,
|
|
326
|
+
/,
|
|
329
327
|
*,
|
|
330
328
|
filepath: str = "",
|
|
331
329
|
directory: str = "",
|
|
@@ -368,7 +366,6 @@ def append(
|
|
|
368
366
|
):
|
|
369
367
|
"""Append from a Library .blend file
|
|
370
368
|
|
|
371
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
372
369
|
:type execution_context: int | str | None
|
|
373
370
|
:type undo: bool | None
|
|
374
371
|
:param filepath: File Path, Path to file
|
|
@@ -454,9 +451,9 @@ def append(
|
|
|
454
451
|
"""
|
|
455
452
|
|
|
456
453
|
def batch_rename(
|
|
457
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
458
454
|
execution_context: int | str | None = None,
|
|
459
455
|
undo: bool | None = None,
|
|
456
|
+
/,
|
|
460
457
|
*,
|
|
461
458
|
data_type: typing.Literal[
|
|
462
459
|
"OBJECT",
|
|
@@ -487,7 +484,6 @@ def batch_rename(
|
|
|
487
484
|
):
|
|
488
485
|
"""Rename multiple items at once
|
|
489
486
|
|
|
490
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
491
487
|
:type execution_context: int | str | None
|
|
492
488
|
:type undo: bool | None
|
|
493
489
|
:param data_type: Type, Type of data to rename
|
|
@@ -499,27 +495,23 @@ def batch_rename(
|
|
|
499
495
|
"""
|
|
500
496
|
|
|
501
497
|
def blend_strings_utf8_validate(
|
|
502
|
-
|
|
503
|
-
execution_context: int | str | None = None,
|
|
504
|
-
undo: bool | None = None,
|
|
498
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
505
499
|
):
|
|
506
500
|
"""Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
|
|
507
501
|
|
|
508
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
509
502
|
:type execution_context: int | str | None
|
|
510
503
|
:type undo: bool | None
|
|
511
504
|
"""
|
|
512
505
|
|
|
513
506
|
def call_asset_shelf_popover(
|
|
514
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
515
507
|
execution_context: int | str | None = None,
|
|
516
508
|
undo: bool | None = None,
|
|
509
|
+
/,
|
|
517
510
|
*,
|
|
518
511
|
name: str = "",
|
|
519
512
|
):
|
|
520
513
|
"""Open a predefined asset shelf in a popup
|
|
521
514
|
|
|
522
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
523
515
|
:type execution_context: int | str | None
|
|
524
516
|
:type undo: bool | None
|
|
525
517
|
:param name: Asset Shelf Name, Identifier of the asset shelf to display
|
|
@@ -527,15 +519,14 @@ def call_asset_shelf_popover(
|
|
|
527
519
|
"""
|
|
528
520
|
|
|
529
521
|
def call_menu(
|
|
530
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
531
522
|
execution_context: int | str | None = None,
|
|
532
523
|
undo: bool | None = None,
|
|
524
|
+
/,
|
|
533
525
|
*,
|
|
534
526
|
name: str = "",
|
|
535
527
|
):
|
|
536
528
|
"""Open a predefined menu
|
|
537
529
|
|
|
538
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
539
530
|
:type execution_context: int | str | None
|
|
540
531
|
:type undo: bool | None
|
|
541
532
|
:param name: Name, Name of the menu
|
|
@@ -543,15 +534,14 @@ def call_menu(
|
|
|
543
534
|
"""
|
|
544
535
|
|
|
545
536
|
def call_menu_pie(
|
|
546
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
547
537
|
execution_context: int | str | None = None,
|
|
548
538
|
undo: bool | None = None,
|
|
539
|
+
/,
|
|
549
540
|
*,
|
|
550
541
|
name: str = "",
|
|
551
542
|
):
|
|
552
543
|
"""Open a predefined pie menu
|
|
553
544
|
|
|
554
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
555
545
|
:type execution_context: int | str | None
|
|
556
546
|
:type undo: bool | None
|
|
557
547
|
:param name: Name, Name of the pie menu
|
|
@@ -559,16 +549,15 @@ def call_menu_pie(
|
|
|
559
549
|
"""
|
|
560
550
|
|
|
561
551
|
def call_panel(
|
|
562
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
563
552
|
execution_context: int | str | None = None,
|
|
564
553
|
undo: bool | None = None,
|
|
554
|
+
/,
|
|
565
555
|
*,
|
|
566
556
|
name: str = "",
|
|
567
557
|
keep_open: bool | None = True,
|
|
568
558
|
):
|
|
569
559
|
"""Open a predefined panel
|
|
570
560
|
|
|
571
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
572
561
|
:type execution_context: int | str | None
|
|
573
562
|
:type undo: bool | None
|
|
574
563
|
:param name: Name, Name of the menu
|
|
@@ -578,15 +567,14 @@ def call_panel(
|
|
|
578
567
|
"""
|
|
579
568
|
|
|
580
569
|
def clear_recent_files(
|
|
581
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
582
570
|
execution_context: int | str | None = None,
|
|
583
571
|
undo: bool | None = None,
|
|
572
|
+
/,
|
|
584
573
|
*,
|
|
585
574
|
remove: typing.Literal["ALL", "MISSING"] | None = "ALL",
|
|
586
575
|
):
|
|
587
576
|
"""Clear the recent files list
|
|
588
577
|
|
|
589
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
590
578
|
:type execution_context: int | str | None
|
|
591
579
|
:type undo: bool | None
|
|
592
580
|
:param remove: Remove
|
|
@@ -594,9 +582,9 @@ def clear_recent_files(
|
|
|
594
582
|
"""
|
|
595
583
|
|
|
596
584
|
def collada_export(
|
|
597
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
598
585
|
execution_context: int | str | None = None,
|
|
599
586
|
undo: bool | None = None,
|
|
587
|
+
/,
|
|
600
588
|
*,
|
|
601
589
|
filepath: str = "",
|
|
602
590
|
check_existing: bool | None = True,
|
|
@@ -668,7 +656,6 @@ def collada_export(
|
|
|
668
656
|
):
|
|
669
657
|
"""Save a Collada file
|
|
670
658
|
|
|
671
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
672
659
|
:type execution_context: int | str | None
|
|
673
660
|
:type undo: bool | None
|
|
674
661
|
:param filepath: File Path, Path to file
|
|
@@ -870,9 +857,9 @@ def collada_export(
|
|
|
870
857
|
"""
|
|
871
858
|
|
|
872
859
|
def collada_import(
|
|
873
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
874
860
|
execution_context: int | str | None = None,
|
|
875
861
|
undo: bool | None = None,
|
|
862
|
+
/,
|
|
876
863
|
*,
|
|
877
864
|
filepath: str = "",
|
|
878
865
|
check_existing: bool | None = False,
|
|
@@ -910,7 +897,6 @@ def collada_import(
|
|
|
910
897
|
):
|
|
911
898
|
"""Load a Collada file
|
|
912
899
|
|
|
913
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
914
900
|
:type execution_context: int | str | None
|
|
915
901
|
:type undo: bool | None
|
|
916
902
|
:param filepath: File Path, Path to file
|
|
@@ -987,21 +973,18 @@ def collada_import(
|
|
|
987
973
|
"""
|
|
988
974
|
|
|
989
975
|
def collection_export_all(
|
|
990
|
-
|
|
991
|
-
execution_context: int | str | None = None,
|
|
992
|
-
undo: bool | None = None,
|
|
976
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
993
977
|
):
|
|
994
978
|
"""Invoke all configured exporters for all collections
|
|
995
979
|
|
|
996
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
997
980
|
:type execution_context: int | str | None
|
|
998
981
|
:type undo: bool | None
|
|
999
982
|
"""
|
|
1000
983
|
|
|
1001
984
|
def context_collection_boolean_set(
|
|
1002
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1003
985
|
execution_context: int | str | None = None,
|
|
1004
986
|
undo: bool | None = None,
|
|
987
|
+
/,
|
|
1005
988
|
*,
|
|
1006
989
|
data_path_iter: str = "",
|
|
1007
990
|
data_path_item: str = "",
|
|
@@ -1009,7 +992,6 @@ def context_collection_boolean_set(
|
|
|
1009
992
|
):
|
|
1010
993
|
"""Set boolean values for a collection of items
|
|
1011
994
|
|
|
1012
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1013
995
|
:type execution_context: int | str | None
|
|
1014
996
|
:type undo: bool | None
|
|
1015
997
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
@@ -1021,16 +1003,15 @@ def context_collection_boolean_set(
|
|
|
1021
1003
|
"""
|
|
1022
1004
|
|
|
1023
1005
|
def context_cycle_array(
|
|
1024
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1025
1006
|
execution_context: int | str | None = None,
|
|
1026
1007
|
undo: bool | None = None,
|
|
1008
|
+
/,
|
|
1027
1009
|
*,
|
|
1028
1010
|
data_path: str = "",
|
|
1029
1011
|
reverse: bool | None = False,
|
|
1030
1012
|
):
|
|
1031
1013
|
"""Set a context array value (useful for cycling the active mesh edit mode)
|
|
1032
1014
|
|
|
1033
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1034
1015
|
:type execution_context: int | str | None
|
|
1035
1016
|
:type undo: bool | None
|
|
1036
1017
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1040,9 +1021,9 @@ def context_cycle_array(
|
|
|
1040
1021
|
"""
|
|
1041
1022
|
|
|
1042
1023
|
def context_cycle_enum(
|
|
1043
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1044
1024
|
execution_context: int | str | None = None,
|
|
1045
1025
|
undo: bool | None = None,
|
|
1026
|
+
/,
|
|
1046
1027
|
*,
|
|
1047
1028
|
data_path: str = "",
|
|
1048
1029
|
reverse: bool | None = False,
|
|
@@ -1050,7 +1031,6 @@ def context_cycle_enum(
|
|
|
1050
1031
|
):
|
|
1051
1032
|
"""Toggle a context value
|
|
1052
1033
|
|
|
1053
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1054
1034
|
:type execution_context: int | str | None
|
|
1055
1035
|
:type undo: bool | None
|
|
1056
1036
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1062,9 +1042,9 @@ def context_cycle_enum(
|
|
|
1062
1042
|
"""
|
|
1063
1043
|
|
|
1064
1044
|
def context_cycle_int(
|
|
1065
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1066
1045
|
execution_context: int | str | None = None,
|
|
1067
1046
|
undo: bool | None = None,
|
|
1047
|
+
/,
|
|
1068
1048
|
*,
|
|
1069
1049
|
data_path: str = "",
|
|
1070
1050
|
reverse: bool | None = False,
|
|
@@ -1072,7 +1052,6 @@ def context_cycle_int(
|
|
|
1072
1052
|
):
|
|
1073
1053
|
"""Set a context value (useful for cycling active material, shape keys, groups, etc.)
|
|
1074
1054
|
|
|
1075
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1076
1055
|
:type execution_context: int | str | None
|
|
1077
1056
|
:type undo: bool | None
|
|
1078
1057
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1084,15 +1063,14 @@ def context_cycle_int(
|
|
|
1084
1063
|
"""
|
|
1085
1064
|
|
|
1086
1065
|
def context_menu_enum(
|
|
1087
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1088
1066
|
execution_context: int | str | None = None,
|
|
1089
1067
|
undo: bool | None = None,
|
|
1068
|
+
/,
|
|
1090
1069
|
*,
|
|
1091
1070
|
data_path: str = "",
|
|
1092
1071
|
):
|
|
1093
1072
|
"""Undocumented, consider contributing.
|
|
1094
1073
|
|
|
1095
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1096
1074
|
:type execution_context: int | str | None
|
|
1097
1075
|
:type undo: bool | None
|
|
1098
1076
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1100,9 +1078,9 @@ def context_menu_enum(
|
|
|
1100
1078
|
"""
|
|
1101
1079
|
|
|
1102
1080
|
def context_modal_mouse(
|
|
1103
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1104
1081
|
execution_context: int | str | None = None,
|
|
1105
1082
|
undo: bool | None = None,
|
|
1083
|
+
/,
|
|
1106
1084
|
*,
|
|
1107
1085
|
data_path_iter: str = "",
|
|
1108
1086
|
data_path_item: str = "",
|
|
@@ -1113,7 +1091,6 @@ def context_modal_mouse(
|
|
|
1113
1091
|
):
|
|
1114
1092
|
"""Adjust arbitrary values with mouse input
|
|
1115
1093
|
|
|
1116
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1117
1094
|
:type execution_context: int | str | None
|
|
1118
1095
|
:type undo: bool | None
|
|
1119
1096
|
:param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
|
|
@@ -1131,15 +1108,14 @@ def context_modal_mouse(
|
|
|
1131
1108
|
"""
|
|
1132
1109
|
|
|
1133
1110
|
def context_pie_enum(
|
|
1134
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1135
1111
|
execution_context: int | str | None = None,
|
|
1136
1112
|
undo: bool | None = None,
|
|
1113
|
+
/,
|
|
1137
1114
|
*,
|
|
1138
1115
|
data_path: str = "",
|
|
1139
1116
|
):
|
|
1140
1117
|
"""Undocumented, consider contributing.
|
|
1141
1118
|
|
|
1142
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1143
1119
|
:type execution_context: int | str | None
|
|
1144
1120
|
:type undo: bool | None
|
|
1145
1121
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1147,16 +1123,15 @@ def context_pie_enum(
|
|
|
1147
1123
|
"""
|
|
1148
1124
|
|
|
1149
1125
|
def context_scale_float(
|
|
1150
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1151
1126
|
execution_context: int | str | None = None,
|
|
1152
1127
|
undo: bool | None = None,
|
|
1128
|
+
/,
|
|
1153
1129
|
*,
|
|
1154
1130
|
data_path: str = "",
|
|
1155
1131
|
value: float | None = 1.0,
|
|
1156
1132
|
):
|
|
1157
1133
|
"""Scale a float context value
|
|
1158
1134
|
|
|
1159
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1160
1135
|
:type execution_context: int | str | None
|
|
1161
1136
|
:type undo: bool | None
|
|
1162
1137
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1166,9 +1141,9 @@ def context_scale_float(
|
|
|
1166
1141
|
"""
|
|
1167
1142
|
|
|
1168
1143
|
def context_scale_int(
|
|
1169
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1170
1144
|
execution_context: int | str | None = None,
|
|
1171
1145
|
undo: bool | None = None,
|
|
1146
|
+
/,
|
|
1172
1147
|
*,
|
|
1173
1148
|
data_path: str = "",
|
|
1174
1149
|
value: float | None = 1.0,
|
|
@@ -1176,7 +1151,6 @@ def context_scale_int(
|
|
|
1176
1151
|
):
|
|
1177
1152
|
"""Scale an int context value
|
|
1178
1153
|
|
|
1179
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1180
1154
|
:type execution_context: int | str | None
|
|
1181
1155
|
:type undo: bool | None
|
|
1182
1156
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1188,16 +1162,15 @@ def context_scale_int(
|
|
|
1188
1162
|
"""
|
|
1189
1163
|
|
|
1190
1164
|
def context_set_boolean(
|
|
1191
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1192
1165
|
execution_context: int | str | None = None,
|
|
1193
1166
|
undo: bool | None = None,
|
|
1167
|
+
/,
|
|
1194
1168
|
*,
|
|
1195
1169
|
data_path: str = "",
|
|
1196
1170
|
value: bool | None = True,
|
|
1197
1171
|
):
|
|
1198
1172
|
"""Set a context value
|
|
1199
1173
|
|
|
1200
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1201
1174
|
:type execution_context: int | str | None
|
|
1202
1175
|
:type undo: bool | None
|
|
1203
1176
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1207,16 +1180,15 @@ def context_set_boolean(
|
|
|
1207
1180
|
"""
|
|
1208
1181
|
|
|
1209
1182
|
def context_set_enum(
|
|
1210
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1211
1183
|
execution_context: int | str | None = None,
|
|
1212
1184
|
undo: bool | None = None,
|
|
1185
|
+
/,
|
|
1213
1186
|
*,
|
|
1214
1187
|
data_path: str = "",
|
|
1215
1188
|
value: str = "",
|
|
1216
1189
|
):
|
|
1217
1190
|
"""Set a context value
|
|
1218
1191
|
|
|
1219
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1220
1192
|
:type execution_context: int | str | None
|
|
1221
1193
|
:type undo: bool | None
|
|
1222
1194
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1226,9 +1198,9 @@ def context_set_enum(
|
|
|
1226
1198
|
"""
|
|
1227
1199
|
|
|
1228
1200
|
def context_set_float(
|
|
1229
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1230
1201
|
execution_context: int | str | None = None,
|
|
1231
1202
|
undo: bool | None = None,
|
|
1203
|
+
/,
|
|
1232
1204
|
*,
|
|
1233
1205
|
data_path: str = "",
|
|
1234
1206
|
value: float | None = 0.0,
|
|
@@ -1236,7 +1208,6 @@ def context_set_float(
|
|
|
1236
1208
|
):
|
|
1237
1209
|
"""Set a context value
|
|
1238
1210
|
|
|
1239
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1240
1211
|
:type execution_context: int | str | None
|
|
1241
1212
|
:type undo: bool | None
|
|
1242
1213
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1248,16 +1219,15 @@ def context_set_float(
|
|
|
1248
1219
|
"""
|
|
1249
1220
|
|
|
1250
1221
|
def context_set_id(
|
|
1251
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1252
1222
|
execution_context: int | str | None = None,
|
|
1253
1223
|
undo: bool | None = None,
|
|
1224
|
+
/,
|
|
1254
1225
|
*,
|
|
1255
1226
|
data_path: str = "",
|
|
1256
1227
|
value: str = "",
|
|
1257
1228
|
):
|
|
1258
1229
|
"""Set a context value to an ID data-block
|
|
1259
1230
|
|
|
1260
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1261
1231
|
:type execution_context: int | str | None
|
|
1262
1232
|
:type undo: bool | None
|
|
1263
1233
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1267,9 +1237,9 @@ def context_set_id(
|
|
|
1267
1237
|
"""
|
|
1268
1238
|
|
|
1269
1239
|
def context_set_int(
|
|
1270
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1271
1240
|
execution_context: int | str | None = None,
|
|
1272
1241
|
undo: bool | None = None,
|
|
1242
|
+
/,
|
|
1273
1243
|
*,
|
|
1274
1244
|
data_path: str = "",
|
|
1275
1245
|
value: int | None = 0,
|
|
@@ -1277,7 +1247,6 @@ def context_set_int(
|
|
|
1277
1247
|
):
|
|
1278
1248
|
"""Set a context value
|
|
1279
1249
|
|
|
1280
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1281
1250
|
:type execution_context: int | str | None
|
|
1282
1251
|
:type undo: bool | None
|
|
1283
1252
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1289,16 +1258,15 @@ def context_set_int(
|
|
|
1289
1258
|
"""
|
|
1290
1259
|
|
|
1291
1260
|
def context_set_string(
|
|
1292
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1293
1261
|
execution_context: int | str | None = None,
|
|
1294
1262
|
undo: bool | None = None,
|
|
1263
|
+
/,
|
|
1295
1264
|
*,
|
|
1296
1265
|
data_path: str = "",
|
|
1297
1266
|
value: str = "",
|
|
1298
1267
|
):
|
|
1299
1268
|
"""Set a context value
|
|
1300
1269
|
|
|
1301
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1302
1270
|
:type execution_context: int | str | None
|
|
1303
1271
|
:type undo: bool | None
|
|
1304
1272
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1308,16 +1276,15 @@ def context_set_string(
|
|
|
1308
1276
|
"""
|
|
1309
1277
|
|
|
1310
1278
|
def context_set_value(
|
|
1311
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1312
1279
|
execution_context: int | str | None = None,
|
|
1313
1280
|
undo: bool | None = None,
|
|
1281
|
+
/,
|
|
1314
1282
|
*,
|
|
1315
1283
|
data_path: str = "",
|
|
1316
1284
|
value: str = "",
|
|
1317
1285
|
):
|
|
1318
1286
|
"""Set a context value
|
|
1319
1287
|
|
|
1320
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1321
1288
|
:type execution_context: int | str | None
|
|
1322
1289
|
:type undo: bool | None
|
|
1323
1290
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1327,16 +1294,15 @@ def context_set_value(
|
|
|
1327
1294
|
"""
|
|
1328
1295
|
|
|
1329
1296
|
def context_toggle(
|
|
1330
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1331
1297
|
execution_context: int | str | None = None,
|
|
1332
1298
|
undo: bool | None = None,
|
|
1299
|
+
/,
|
|
1333
1300
|
*,
|
|
1334
1301
|
data_path: str = "",
|
|
1335
1302
|
module: str = "",
|
|
1336
1303
|
):
|
|
1337
1304
|
"""Toggle a context value
|
|
1338
1305
|
|
|
1339
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1340
1306
|
:type execution_context: int | str | None
|
|
1341
1307
|
:type undo: bool | None
|
|
1342
1308
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1346,9 +1312,9 @@ def context_toggle(
|
|
|
1346
1312
|
"""
|
|
1347
1313
|
|
|
1348
1314
|
def context_toggle_enum(
|
|
1349
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1350
1315
|
execution_context: int | str | None = None,
|
|
1351
1316
|
undo: bool | None = None,
|
|
1317
|
+
/,
|
|
1352
1318
|
*,
|
|
1353
1319
|
data_path: str = "",
|
|
1354
1320
|
value_1: str = "",
|
|
@@ -1356,7 +1322,6 @@ def context_toggle_enum(
|
|
|
1356
1322
|
):
|
|
1357
1323
|
"""Toggle a context value
|
|
1358
1324
|
|
|
1359
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1360
1325
|
:type execution_context: int | str | None
|
|
1361
1326
|
:type undo: bool | None
|
|
1362
1327
|
:param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
|
|
@@ -1368,15 +1333,14 @@ def context_toggle_enum(
|
|
|
1368
1333
|
"""
|
|
1369
1334
|
|
|
1370
1335
|
def debug_menu(
|
|
1371
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1372
1336
|
execution_context: int | str | None = None,
|
|
1373
1337
|
undo: bool | None = None,
|
|
1338
|
+
/,
|
|
1374
1339
|
*,
|
|
1375
1340
|
debug_value: int | None = 0,
|
|
1376
1341
|
):
|
|
1377
1342
|
"""Open a popup to set the debug level
|
|
1378
1343
|
|
|
1379
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1380
1344
|
:type execution_context: int | str | None
|
|
1381
1345
|
:type undo: bool | None
|
|
1382
1346
|
:param debug_value: Debug Value
|
|
@@ -1384,15 +1348,14 @@ def debug_menu(
|
|
|
1384
1348
|
"""
|
|
1385
1349
|
|
|
1386
1350
|
def doc_view(
|
|
1387
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1388
1351
|
execution_context: int | str | None = None,
|
|
1389
1352
|
undo: bool | None = None,
|
|
1353
|
+
/,
|
|
1390
1354
|
*,
|
|
1391
1355
|
doc_id: str = "",
|
|
1392
1356
|
):
|
|
1393
1357
|
"""Open online reference docs in a web browser
|
|
1394
1358
|
|
|
1395
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1396
1359
|
:type execution_context: int | str | None
|
|
1397
1360
|
:type undo: bool | None
|
|
1398
1361
|
:param doc_id: Doc ID
|
|
@@ -1400,15 +1363,14 @@ def doc_view(
|
|
|
1400
1363
|
"""
|
|
1401
1364
|
|
|
1402
1365
|
def doc_view_manual(
|
|
1403
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1404
1366
|
execution_context: int | str | None = None,
|
|
1405
1367
|
undo: bool | None = None,
|
|
1368
|
+
/,
|
|
1406
1369
|
*,
|
|
1407
1370
|
doc_id: str = "",
|
|
1408
1371
|
):
|
|
1409
1372
|
"""Load online manual
|
|
1410
1373
|
|
|
1411
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1412
1374
|
:type execution_context: int | str | None
|
|
1413
1375
|
:type undo: bool | None
|
|
1414
1376
|
:param doc_id: Doc ID
|
|
@@ -1416,27 +1378,23 @@ def doc_view_manual(
|
|
|
1416
1378
|
"""
|
|
1417
1379
|
|
|
1418
1380
|
def doc_view_manual_ui_context(
|
|
1419
|
-
|
|
1420
|
-
execution_context: int | str | None = None,
|
|
1421
|
-
undo: bool | None = None,
|
|
1381
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
1422
1382
|
):
|
|
1423
1383
|
"""View a context based online manual in a web browser
|
|
1424
1384
|
|
|
1425
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1426
1385
|
:type execution_context: int | str | None
|
|
1427
1386
|
:type undo: bool | None
|
|
1428
1387
|
"""
|
|
1429
1388
|
|
|
1430
1389
|
def drop_blend_file(
|
|
1431
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1432
1390
|
execution_context: int | str | None = None,
|
|
1433
1391
|
undo: bool | None = None,
|
|
1392
|
+
/,
|
|
1434
1393
|
*,
|
|
1435
1394
|
filepath: str = "",
|
|
1436
1395
|
):
|
|
1437
1396
|
"""Undocumented, consider contributing.
|
|
1438
1397
|
|
|
1439
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1440
1398
|
:type execution_context: int | str | None
|
|
1441
1399
|
:type undo: bool | None
|
|
1442
1400
|
:param filepath: filepath
|
|
@@ -1444,9 +1402,9 @@ def drop_blend_file(
|
|
|
1444
1402
|
"""
|
|
1445
1403
|
|
|
1446
1404
|
def drop_import_file(
|
|
1447
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1448
1405
|
execution_context: int | str | None = None,
|
|
1449
1406
|
undo: bool | None = None,
|
|
1407
|
+
/,
|
|
1450
1408
|
*,
|
|
1451
1409
|
directory: str = "",
|
|
1452
1410
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
@@ -1454,7 +1412,6 @@ def drop_import_file(
|
|
|
1454
1412
|
):
|
|
1455
1413
|
"""Operator that allows file handlers to receive file drops
|
|
1456
1414
|
|
|
1457
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1458
1415
|
:type execution_context: int | str | None
|
|
1459
1416
|
:type undo: bool | None
|
|
1460
1417
|
:param directory: Directory, Directory of the file
|
|
@@ -1464,9 +1421,9 @@ def drop_import_file(
|
|
|
1464
1421
|
"""
|
|
1465
1422
|
|
|
1466
1423
|
def grease_pencil_export_pdf(
|
|
1467
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1468
1424
|
execution_context: int | str | None = None,
|
|
1469
1425
|
undo: bool | None = None,
|
|
1426
|
+
/,
|
|
1470
1427
|
*,
|
|
1471
1428
|
filepath: str = "",
|
|
1472
1429
|
check_existing: bool | None = True,
|
|
@@ -1502,7 +1459,6 @@ def grease_pencil_export_pdf(
|
|
|
1502
1459
|
):
|
|
1503
1460
|
"""Export Grease Pencil to PDF
|
|
1504
1461
|
|
|
1505
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1506
1462
|
:type execution_context: int | str | None
|
|
1507
1463
|
:type undo: bool | None
|
|
1508
1464
|
:param filepath: File Path, Path to file
|
|
@@ -1592,9 +1548,9 @@ def grease_pencil_export_pdf(
|
|
|
1592
1548
|
"""
|
|
1593
1549
|
|
|
1594
1550
|
def grease_pencil_export_svg(
|
|
1595
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1596
1551
|
execution_context: int | str | None = None,
|
|
1597
1552
|
undo: bool | None = None,
|
|
1553
|
+
/,
|
|
1598
1554
|
*,
|
|
1599
1555
|
filepath: str = "",
|
|
1600
1556
|
check_existing: bool | None = True,
|
|
@@ -1630,7 +1586,6 @@ def grease_pencil_export_svg(
|
|
|
1630
1586
|
):
|
|
1631
1587
|
"""Export Grease Pencil to SVG
|
|
1632
1588
|
|
|
1633
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1634
1589
|
:type execution_context: int | str | None
|
|
1635
1590
|
:type undo: bool | None
|
|
1636
1591
|
:param filepath: File Path, Path to file
|
|
@@ -1711,9 +1666,9 @@ def grease_pencil_export_svg(
|
|
|
1711
1666
|
"""
|
|
1712
1667
|
|
|
1713
1668
|
def grease_pencil_import_svg(
|
|
1714
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1715
1669
|
execution_context: int | str | None = None,
|
|
1716
1670
|
undo: bool | None = None,
|
|
1671
|
+
/,
|
|
1717
1672
|
*,
|
|
1718
1673
|
filepath: str = "",
|
|
1719
1674
|
directory: str = "",
|
|
@@ -1750,7 +1705,6 @@ def grease_pencil_import_svg(
|
|
|
1750
1705
|
):
|
|
1751
1706
|
"""Import SVG into Grease Pencil
|
|
1752
1707
|
|
|
1753
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1754
1708
|
:type execution_context: int | str | None
|
|
1755
1709
|
:type undo: bool | None
|
|
1756
1710
|
:param filepath: File Path, Path to file
|
|
@@ -1824,9 +1778,9 @@ def grease_pencil_import_svg(
|
|
|
1824
1778
|
"""
|
|
1825
1779
|
|
|
1826
1780
|
def interface_theme_preset_add(
|
|
1827
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1828
1781
|
execution_context: int | str | None = None,
|
|
1829
1782
|
undo: bool | None = None,
|
|
1783
|
+
/,
|
|
1830
1784
|
*,
|
|
1831
1785
|
name: str = "",
|
|
1832
1786
|
remove_name: bool | None = False,
|
|
@@ -1834,7 +1788,6 @@ def interface_theme_preset_add(
|
|
|
1834
1788
|
):
|
|
1835
1789
|
"""Add a custom theme to the preset list
|
|
1836
1790
|
|
|
1837
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1838
1791
|
:type execution_context: int | str | None
|
|
1839
1792
|
:type undo: bool | None
|
|
1840
1793
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -1846,9 +1799,9 @@ def interface_theme_preset_add(
|
|
|
1846
1799
|
"""
|
|
1847
1800
|
|
|
1848
1801
|
def interface_theme_preset_remove(
|
|
1849
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1850
1802
|
execution_context: int | str | None = None,
|
|
1851
1803
|
undo: bool | None = None,
|
|
1804
|
+
/,
|
|
1852
1805
|
*,
|
|
1853
1806
|
name: str = "",
|
|
1854
1807
|
remove_name: bool | None = False,
|
|
@@ -1856,7 +1809,6 @@ def interface_theme_preset_remove(
|
|
|
1856
1809
|
):
|
|
1857
1810
|
"""Remove a custom theme from the preset list
|
|
1858
1811
|
|
|
1859
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1860
1812
|
:type execution_context: int | str | None
|
|
1861
1813
|
:type undo: bool | None
|
|
1862
1814
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -1868,9 +1820,9 @@ def interface_theme_preset_remove(
|
|
|
1868
1820
|
"""
|
|
1869
1821
|
|
|
1870
1822
|
def interface_theme_preset_save(
|
|
1871
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1872
1823
|
execution_context: int | str | None = None,
|
|
1873
1824
|
undo: bool | None = None,
|
|
1825
|
+
/,
|
|
1874
1826
|
*,
|
|
1875
1827
|
name: str = "",
|
|
1876
1828
|
remove_name: bool | None = False,
|
|
@@ -1878,7 +1830,6 @@ def interface_theme_preset_save(
|
|
|
1878
1830
|
):
|
|
1879
1831
|
"""Save a custom theme in the preset list
|
|
1880
1832
|
|
|
1881
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1882
1833
|
:type execution_context: int | str | None
|
|
1883
1834
|
:type undo: bool | None
|
|
1884
1835
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -1890,9 +1841,9 @@ def interface_theme_preset_save(
|
|
|
1890
1841
|
"""
|
|
1891
1842
|
|
|
1892
1843
|
def keyconfig_preset_add(
|
|
1893
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1894
1844
|
execution_context: int | str | None = None,
|
|
1895
1845
|
undo: bool | None = None,
|
|
1846
|
+
/,
|
|
1896
1847
|
*,
|
|
1897
1848
|
name: str = "",
|
|
1898
1849
|
remove_name: bool | None = False,
|
|
@@ -1900,7 +1851,6 @@ def keyconfig_preset_add(
|
|
|
1900
1851
|
):
|
|
1901
1852
|
"""Add a custom keymap configuration to the preset list
|
|
1902
1853
|
|
|
1903
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1904
1854
|
:type execution_context: int | str | None
|
|
1905
1855
|
:type undo: bool | None
|
|
1906
1856
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -1912,9 +1862,9 @@ def keyconfig_preset_add(
|
|
|
1912
1862
|
"""
|
|
1913
1863
|
|
|
1914
1864
|
def keyconfig_preset_remove(
|
|
1915
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1916
1865
|
execution_context: int | str | None = None,
|
|
1917
1866
|
undo: bool | None = None,
|
|
1867
|
+
/,
|
|
1918
1868
|
*,
|
|
1919
1869
|
name: str = "",
|
|
1920
1870
|
remove_name: bool | None = False,
|
|
@@ -1922,7 +1872,6 @@ def keyconfig_preset_remove(
|
|
|
1922
1872
|
):
|
|
1923
1873
|
"""Remove a custom keymap configuration from the preset list
|
|
1924
1874
|
|
|
1925
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1926
1875
|
:type execution_context: int | str | None
|
|
1927
1876
|
:type undo: bool | None
|
|
1928
1877
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -1934,9 +1883,9 @@ def keyconfig_preset_remove(
|
|
|
1934
1883
|
"""
|
|
1935
1884
|
|
|
1936
1885
|
def lib_reload(
|
|
1937
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
1938
1886
|
execution_context: int | str | None = None,
|
|
1939
1887
|
undo: bool | None = None,
|
|
1888
|
+
/,
|
|
1940
1889
|
*,
|
|
1941
1890
|
library: str = "",
|
|
1942
1891
|
filepath: str = "",
|
|
@@ -1971,7 +1920,6 @@ def lib_reload(
|
|
|
1971
1920
|
):
|
|
1972
1921
|
"""Reload the given library
|
|
1973
1922
|
|
|
1974
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
1975
1923
|
:type execution_context: int | str | None
|
|
1976
1924
|
:type undo: bool | None
|
|
1977
1925
|
:param library: Library, Library to reload
|
|
@@ -2043,9 +1991,9 @@ def lib_reload(
|
|
|
2043
1991
|
"""
|
|
2044
1992
|
|
|
2045
1993
|
def lib_relocate(
|
|
2046
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2047
1994
|
execution_context: int | str | None = None,
|
|
2048
1995
|
undo: bool | None = None,
|
|
1996
|
+
/,
|
|
2049
1997
|
*,
|
|
2050
1998
|
library: str = "",
|
|
2051
1999
|
filepath: str = "",
|
|
@@ -2082,7 +2030,6 @@ def lib_relocate(
|
|
|
2082
2030
|
):
|
|
2083
2031
|
"""Relocate the given library to one or several others
|
|
2084
2032
|
|
|
2085
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2086
2033
|
:type execution_context: int | str | None
|
|
2087
2034
|
:type undo: bool | None
|
|
2088
2035
|
:param library: Library, Library to relocate
|
|
@@ -2156,9 +2103,9 @@ def lib_relocate(
|
|
|
2156
2103
|
"""
|
|
2157
2104
|
|
|
2158
2105
|
def link(
|
|
2159
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2160
2106
|
execution_context: int | str | None = None,
|
|
2161
2107
|
undo: bool | None = None,
|
|
2108
|
+
/,
|
|
2162
2109
|
*,
|
|
2163
2110
|
filepath: str = "",
|
|
2164
2111
|
directory: str = "",
|
|
@@ -2200,7 +2147,6 @@ def link(
|
|
|
2200
2147
|
):
|
|
2201
2148
|
"""Link from a Library .blend file
|
|
2202
2149
|
|
|
2203
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2204
2150
|
:type execution_context: int | str | None
|
|
2205
2151
|
:type undo: bool | None
|
|
2206
2152
|
:param filepath: File Path, Path to file
|
|
@@ -2284,21 +2230,18 @@ def link(
|
|
|
2284
2230
|
"""
|
|
2285
2231
|
|
|
2286
2232
|
def memory_statistics(
|
|
2287
|
-
|
|
2288
|
-
execution_context: int | str | None = None,
|
|
2289
|
-
undo: bool | None = None,
|
|
2233
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
2290
2234
|
):
|
|
2291
2235
|
"""Print memory statistics to the console
|
|
2292
2236
|
|
|
2293
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2294
2237
|
:type execution_context: int | str | None
|
|
2295
2238
|
:type undo: bool | None
|
|
2296
2239
|
"""
|
|
2297
2240
|
|
|
2298
2241
|
def obj_export(
|
|
2299
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2300
2242
|
execution_context: int | str | None = None,
|
|
2301
2243
|
undo: bool | None = None,
|
|
2244
|
+
/,
|
|
2302
2245
|
*,
|
|
2303
2246
|
filepath: str = "",
|
|
2304
2247
|
check_existing: bool | None = True,
|
|
@@ -2358,7 +2301,6 @@ def obj_export(
|
|
|
2358
2301
|
):
|
|
2359
2302
|
"""Save the scene to a Wavefront OBJ file
|
|
2360
2303
|
|
|
2361
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2362
2304
|
:type execution_context: int | str | None
|
|
2363
2305
|
:type undo: bool | None
|
|
2364
2306
|
:param filepath: File Path, Path to file
|
|
@@ -2528,9 +2470,9 @@ def obj_export(
|
|
|
2528
2470
|
"""
|
|
2529
2471
|
|
|
2530
2472
|
def obj_import(
|
|
2531
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2532
2473
|
execution_context: int | str | None = None,
|
|
2533
2474
|
undo: bool | None = None,
|
|
2475
|
+
/,
|
|
2534
2476
|
*,
|
|
2535
2477
|
filepath: str = "",
|
|
2536
2478
|
directory: str = "",
|
|
@@ -2578,7 +2520,6 @@ def obj_import(
|
|
|
2578
2520
|
):
|
|
2579
2521
|
"""Load a Wavefront OBJ scene
|
|
2580
2522
|
|
|
2581
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2582
2523
|
:type execution_context: int | str | None
|
|
2583
2524
|
:type undo: bool | None
|
|
2584
2525
|
:param filepath: File Path, Path to file
|
|
@@ -2702,9 +2643,9 @@ def obj_import(
|
|
|
2702
2643
|
"""
|
|
2703
2644
|
|
|
2704
2645
|
def open_mainfile(
|
|
2705
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2706
2646
|
execution_context: int | str | None = None,
|
|
2707
2647
|
undo: bool | None = None,
|
|
2648
|
+
/,
|
|
2708
2649
|
*,
|
|
2709
2650
|
filepath: str = "",
|
|
2710
2651
|
hide_props_region: bool | None = True,
|
|
@@ -2739,7 +2680,6 @@ def open_mainfile(
|
|
|
2739
2680
|
):
|
|
2740
2681
|
"""Open a Blender file
|
|
2741
2682
|
|
|
2742
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2743
2683
|
:type execution_context: int | str | None
|
|
2744
2684
|
:type undo: bool | None
|
|
2745
2685
|
:param filepath: File Path, Path to file
|
|
@@ -2811,40 +2751,33 @@ def open_mainfile(
|
|
|
2811
2751
|
"""
|
|
2812
2752
|
|
|
2813
2753
|
def operator_cheat_sheet(
|
|
2814
|
-
|
|
2815
|
-
execution_context: int | str | None = None,
|
|
2816
|
-
undo: bool | None = None,
|
|
2754
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
2817
2755
|
):
|
|
2818
2756
|
"""List all the operators in a text-block, useful for scripting
|
|
2819
2757
|
|
|
2820
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2821
2758
|
:type execution_context: int | str | None
|
|
2822
2759
|
:type undo: bool | None
|
|
2823
2760
|
"""
|
|
2824
2761
|
|
|
2825
2762
|
def operator_defaults(
|
|
2826
|
-
|
|
2827
|
-
execution_context: int | str | None = None,
|
|
2828
|
-
undo: bool | None = None,
|
|
2763
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
2829
2764
|
):
|
|
2830
2765
|
"""Set the active operator to its default values
|
|
2831
2766
|
|
|
2832
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2833
2767
|
:type execution_context: int | str | None
|
|
2834
2768
|
:type undo: bool | None
|
|
2835
2769
|
"""
|
|
2836
2770
|
|
|
2837
2771
|
def operator_pie_enum(
|
|
2838
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2839
2772
|
execution_context: int | str | None = None,
|
|
2840
2773
|
undo: bool | None = None,
|
|
2774
|
+
/,
|
|
2841
2775
|
*,
|
|
2842
2776
|
data_path: str = "",
|
|
2843
2777
|
prop_string: str = "",
|
|
2844
2778
|
):
|
|
2845
2779
|
"""Undocumented, consider contributing.
|
|
2846
2780
|
|
|
2847
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2848
2781
|
:type execution_context: int | str | None
|
|
2849
2782
|
:type undo: bool | None
|
|
2850
2783
|
:param data_path: Operator, Operator name (in Python as string)
|
|
@@ -2854,9 +2787,9 @@ def operator_pie_enum(
|
|
|
2854
2787
|
"""
|
|
2855
2788
|
|
|
2856
2789
|
def operator_preset_add(
|
|
2857
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2858
2790
|
execution_context: int | str | None = None,
|
|
2859
2791
|
undo: bool | None = None,
|
|
2792
|
+
/,
|
|
2860
2793
|
*,
|
|
2861
2794
|
name: str = "",
|
|
2862
2795
|
remove_name: bool | None = False,
|
|
@@ -2865,7 +2798,6 @@ def operator_preset_add(
|
|
|
2865
2798
|
):
|
|
2866
2799
|
"""Add or remove an Operator Preset
|
|
2867
2800
|
|
|
2868
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2869
2801
|
:type execution_context: int | str | None
|
|
2870
2802
|
:type undo: bool | None
|
|
2871
2803
|
:param name: Name, Name of the preset, used to make the path name
|
|
@@ -2879,9 +2811,9 @@ def operator_preset_add(
|
|
|
2879
2811
|
"""
|
|
2880
2812
|
|
|
2881
2813
|
def operator_presets_cleanup(
|
|
2882
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2883
2814
|
execution_context: int | str | None = None,
|
|
2884
2815
|
undo: bool | None = None,
|
|
2816
|
+
/,
|
|
2885
2817
|
*,
|
|
2886
2818
|
operator: str = "",
|
|
2887
2819
|
properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
@@ -2889,7 +2821,6 @@ def operator_presets_cleanup(
|
|
|
2889
2821
|
):
|
|
2890
2822
|
"""Remove outdated operator properties from presets that may cause problems
|
|
2891
2823
|
|
|
2892
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2893
2824
|
:type execution_context: int | str | None
|
|
2894
2825
|
:type undo: bool | None
|
|
2895
2826
|
:param operator: operator
|
|
@@ -2899,15 +2830,14 @@ def operator_presets_cleanup(
|
|
|
2899
2830
|
"""
|
|
2900
2831
|
|
|
2901
2832
|
def owner_disable(
|
|
2902
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2903
2833
|
execution_context: int | str | None = None,
|
|
2904
2834
|
undo: bool | None = None,
|
|
2835
|
+
/,
|
|
2905
2836
|
*,
|
|
2906
2837
|
owner_id: str = "",
|
|
2907
2838
|
):
|
|
2908
2839
|
"""Disable add-on for workspace
|
|
2909
2840
|
|
|
2910
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2911
2841
|
:type execution_context: int | str | None
|
|
2912
2842
|
:type undo: bool | None
|
|
2913
2843
|
:param owner_id: UI Tag
|
|
@@ -2915,15 +2845,14 @@ def owner_disable(
|
|
|
2915
2845
|
"""
|
|
2916
2846
|
|
|
2917
2847
|
def owner_enable(
|
|
2918
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2919
2848
|
execution_context: int | str | None = None,
|
|
2920
2849
|
undo: bool | None = None,
|
|
2850
|
+
/,
|
|
2921
2851
|
*,
|
|
2922
2852
|
owner_id: str = "",
|
|
2923
2853
|
):
|
|
2924
2854
|
"""Enable add-on for workspace
|
|
2925
2855
|
|
|
2926
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2927
2856
|
:type execution_context: int | str | None
|
|
2928
2857
|
:type undo: bool | None
|
|
2929
2858
|
:param owner_id: UI Tag
|
|
@@ -2931,15 +2860,14 @@ def owner_enable(
|
|
|
2931
2860
|
"""
|
|
2932
2861
|
|
|
2933
2862
|
def path_open(
|
|
2934
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2935
2863
|
execution_context: int | str | None = None,
|
|
2936
2864
|
undo: bool | None = None,
|
|
2865
|
+
/,
|
|
2937
2866
|
*,
|
|
2938
2867
|
filepath: str = "",
|
|
2939
2868
|
):
|
|
2940
2869
|
"""Open a path in a file browser
|
|
2941
2870
|
|
|
2942
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
2943
2871
|
:type execution_context: int | str | None
|
|
2944
2872
|
:type undo: bool | None
|
|
2945
2873
|
:param filepath: filepath
|
|
@@ -2947,9 +2875,9 @@ def path_open(
|
|
|
2947
2875
|
"""
|
|
2948
2876
|
|
|
2949
2877
|
def ply_export(
|
|
2950
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
2951
2878
|
execution_context: int | str | None = None,
|
|
2952
2879
|
undo: bool | None = None,
|
|
2880
|
+
/,
|
|
2953
2881
|
*,
|
|
2954
2882
|
filepath: str = "",
|
|
2955
2883
|
check_existing: bool | None = True,
|
|
@@ -2996,7 +2924,6 @@ def ply_export(
|
|
|
2996
2924
|
):
|
|
2997
2925
|
"""Save the scene to a PLY file
|
|
2998
2926
|
|
|
2999
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3000
2927
|
:type execution_context: int | str | None
|
|
3001
2928
|
:type undo: bool | None
|
|
3002
2929
|
:param filepath: File Path, Path to file
|
|
@@ -3129,9 +3056,9 @@ def ply_export(
|
|
|
3129
3056
|
"""
|
|
3130
3057
|
|
|
3131
3058
|
def ply_import(
|
|
3132
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3133
3059
|
execution_context: int | str | None = None,
|
|
3134
3060
|
undo: bool | None = None,
|
|
3061
|
+
/,
|
|
3135
3062
|
*,
|
|
3136
3063
|
filepath: str = "",
|
|
3137
3064
|
directory: str = "",
|
|
@@ -3176,7 +3103,6 @@ def ply_import(
|
|
|
3176
3103
|
):
|
|
3177
3104
|
"""Import an PLY file as an object
|
|
3178
3105
|
|
|
3179
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3180
3106
|
:type execution_context: int | str | None
|
|
3181
3107
|
:type undo: bool | None
|
|
3182
3108
|
:param filepath: File Path, Path to file
|
|
@@ -3303,9 +3229,9 @@ def ply_import(
|
|
|
3303
3229
|
"""
|
|
3304
3230
|
|
|
3305
3231
|
def previews_batch_clear(
|
|
3306
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3307
3232
|
execution_context: int | str | None = None,
|
|
3308
3233
|
undo: bool | None = None,
|
|
3234
|
+
/,
|
|
3309
3235
|
*,
|
|
3310
3236
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
3311
3237
|
| None = None,
|
|
@@ -3321,7 +3247,6 @@ def previews_batch_clear(
|
|
|
3321
3247
|
):
|
|
3322
3248
|
"""Clear selected .blend file's previews
|
|
3323
3249
|
|
|
3324
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3325
3250
|
:type execution_context: int | str | None
|
|
3326
3251
|
:type undo: bool | None
|
|
3327
3252
|
:param files: files
|
|
@@ -3347,9 +3272,9 @@ def previews_batch_clear(
|
|
|
3347
3272
|
"""
|
|
3348
3273
|
|
|
3349
3274
|
def previews_batch_generate(
|
|
3350
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3351
3275
|
execution_context: int | str | None = None,
|
|
3352
3276
|
undo: bool | None = None,
|
|
3277
|
+
/,
|
|
3353
3278
|
*,
|
|
3354
3279
|
files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
|
|
3355
3280
|
| None = None,
|
|
@@ -3365,7 +3290,6 @@ def previews_batch_generate(
|
|
|
3365
3290
|
):
|
|
3366
3291
|
"""Generate selected .blend file's previews
|
|
3367
3292
|
|
|
3368
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3369
3293
|
:type execution_context: int | str | None
|
|
3370
3294
|
:type undo: bool | None
|
|
3371
3295
|
:param files: Collection of file paths with common directory root
|
|
@@ -3391,9 +3315,9 @@ def previews_batch_generate(
|
|
|
3391
3315
|
"""
|
|
3392
3316
|
|
|
3393
3317
|
def previews_clear(
|
|
3394
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3395
3318
|
execution_context: int | str | None = None,
|
|
3396
3319
|
undo: bool | None = None,
|
|
3320
|
+
/,
|
|
3397
3321
|
*,
|
|
3398
3322
|
id_type: set[
|
|
3399
3323
|
typing.Literal[
|
|
@@ -3414,7 +3338,6 @@ def previews_clear(
|
|
|
3414
3338
|
):
|
|
3415
3339
|
"""Clear data-block previews (only for some types like objects, materials, textures, etc.)
|
|
3416
3340
|
|
|
3417
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3418
3341
|
:type execution_context: int | str | None
|
|
3419
3342
|
:type undo: bool | None
|
|
3420
3343
|
:param id_type: Data-Block Type, Which data-block previews to clear
|
|
@@ -3455,27 +3378,23 @@ def previews_clear(
|
|
|
3455
3378
|
"""
|
|
3456
3379
|
|
|
3457
3380
|
def previews_ensure(
|
|
3458
|
-
|
|
3459
|
-
execution_context: int | str | None = None,
|
|
3460
|
-
undo: bool | None = None,
|
|
3381
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
3461
3382
|
):
|
|
3462
3383
|
"""Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
|
|
3463
3384
|
|
|
3464
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3465
3385
|
:type execution_context: int | str | None
|
|
3466
3386
|
:type undo: bool | None
|
|
3467
3387
|
"""
|
|
3468
3388
|
|
|
3469
3389
|
def properties_add(
|
|
3470
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3471
3390
|
execution_context: int | str | None = None,
|
|
3472
3391
|
undo: bool | None = None,
|
|
3392
|
+
/,
|
|
3473
3393
|
*,
|
|
3474
3394
|
data_path: str = "",
|
|
3475
3395
|
):
|
|
3476
3396
|
"""Add your own property to the data-block
|
|
3477
3397
|
|
|
3478
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3479
3398
|
:type execution_context: int | str | None
|
|
3480
3399
|
:type undo: bool | None
|
|
3481
3400
|
:param data_path: Property Edit, Property data_path edit
|
|
@@ -3483,15 +3402,14 @@ def properties_add(
|
|
|
3483
3402
|
"""
|
|
3484
3403
|
|
|
3485
3404
|
def properties_context_change(
|
|
3486
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3487
3405
|
execution_context: int | str | None = None,
|
|
3488
3406
|
undo: bool | None = None,
|
|
3407
|
+
/,
|
|
3489
3408
|
*,
|
|
3490
3409
|
context: str = "",
|
|
3491
3410
|
):
|
|
3492
3411
|
"""Jump to a different tab inside the properties editor
|
|
3493
3412
|
|
|
3494
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3495
3413
|
:type execution_context: int | str | None
|
|
3496
3414
|
:type undo: bool | None
|
|
3497
3415
|
:param context: Context
|
|
@@ -3499,9 +3417,9 @@ def properties_context_change(
|
|
|
3499
3417
|
"""
|
|
3500
3418
|
|
|
3501
3419
|
def properties_edit(
|
|
3502
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3503
3420
|
execution_context: int | str | None = None,
|
|
3504
3421
|
undo: bool | None = None,
|
|
3422
|
+
/,
|
|
3505
3423
|
*,
|
|
3506
3424
|
data_path: str = "",
|
|
3507
3425
|
property_name: str = "",
|
|
@@ -3682,7 +3600,6 @@ def properties_edit(
|
|
|
3682
3600
|
):
|
|
3683
3601
|
"""Change a custom property's type, or adjust how it is displayed in the interface
|
|
3684
3602
|
|
|
3685
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3686
3603
|
:type execution_context: int | str | None
|
|
3687
3604
|
:type undo: bool | None
|
|
3688
3605
|
:param data_path: Property Edit, Property data_path edit
|
|
@@ -3765,9 +3682,9 @@ def properties_edit(
|
|
|
3765
3682
|
"""
|
|
3766
3683
|
|
|
3767
3684
|
def properties_edit_value(
|
|
3768
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3769
3685
|
execution_context: int | str | None = None,
|
|
3770
3686
|
undo: bool | None = None,
|
|
3687
|
+
/,
|
|
3771
3688
|
*,
|
|
3772
3689
|
data_path: str = "",
|
|
3773
3690
|
property_name: str = "",
|
|
@@ -3775,7 +3692,6 @@ def properties_edit_value(
|
|
|
3775
3692
|
):
|
|
3776
3693
|
"""Edit the value of a custom property
|
|
3777
3694
|
|
|
3778
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3779
3695
|
:type execution_context: int | str | None
|
|
3780
3696
|
:type undo: bool | None
|
|
3781
3697
|
:param data_path: Property Edit, Property data_path edit
|
|
@@ -3787,16 +3703,15 @@ def properties_edit_value(
|
|
|
3787
3703
|
"""
|
|
3788
3704
|
|
|
3789
3705
|
def properties_remove(
|
|
3790
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3791
3706
|
execution_context: int | str | None = None,
|
|
3792
3707
|
undo: bool | None = None,
|
|
3708
|
+
/,
|
|
3793
3709
|
*,
|
|
3794
3710
|
data_path: str = "",
|
|
3795
3711
|
property_name: str = "",
|
|
3796
3712
|
):
|
|
3797
3713
|
"""Internal use (edit a property data_path)
|
|
3798
3714
|
|
|
3799
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3800
3715
|
:type execution_context: int | str | None
|
|
3801
3716
|
:type undo: bool | None
|
|
3802
3717
|
:param data_path: Property Edit, Property data_path edit
|
|
@@ -3805,22 +3720,17 @@ def properties_remove(
|
|
|
3805
3720
|
:type property_name: str
|
|
3806
3721
|
"""
|
|
3807
3722
|
|
|
3808
|
-
def quit_blender(
|
|
3809
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3810
|
-
execution_context: int | str | None = None,
|
|
3811
|
-
undo: bool | None = None,
|
|
3812
|
-
):
|
|
3723
|
+
def quit_blender(execution_context: int | str | None = None, undo: bool | None = None):
|
|
3813
3724
|
"""Quit Blender
|
|
3814
3725
|
|
|
3815
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3816
3726
|
:type execution_context: int | str | None
|
|
3817
3727
|
:type undo: bool | None
|
|
3818
3728
|
"""
|
|
3819
3729
|
|
|
3820
3730
|
def radial_control(
|
|
3821
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3822
3731
|
execution_context: int | str | None = None,
|
|
3823
3732
|
undo: bool | None = None,
|
|
3733
|
+
/,
|
|
3824
3734
|
*,
|
|
3825
3735
|
data_path_primary: str = "",
|
|
3826
3736
|
data_path_secondary: str = "",
|
|
@@ -3837,7 +3747,6 @@ def radial_control(
|
|
|
3837
3747
|
):
|
|
3838
3748
|
"""Set some size property (e.g. brush size) with mouse wheel
|
|
3839
3749
|
|
|
3840
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3841
3750
|
:type execution_context: int | str | None
|
|
3842
3751
|
:type undo: bool | None
|
|
3843
3752
|
:param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
|
|
@@ -3867,9 +3776,9 @@ def radial_control(
|
|
|
3867
3776
|
"""
|
|
3868
3777
|
|
|
3869
3778
|
def read_factory_settings(
|
|
3870
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3871
3779
|
execution_context: int | str | None = None,
|
|
3872
3780
|
undo: bool | None = None,
|
|
3781
|
+
/,
|
|
3873
3782
|
*,
|
|
3874
3783
|
use_factory_startup_app_template_only: bool | None = False,
|
|
3875
3784
|
app_template: str = "Template",
|
|
@@ -3877,7 +3786,6 @@ def read_factory_settings(
|
|
|
3877
3786
|
):
|
|
3878
3787
|
"""Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
|
|
3879
3788
|
|
|
3880
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3881
3789
|
:type execution_context: int | str | None
|
|
3882
3790
|
:type undo: bool | None
|
|
3883
3791
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
@@ -3888,37 +3796,31 @@ def read_factory_settings(
|
|
|
3888
3796
|
"""
|
|
3889
3797
|
|
|
3890
3798
|
def read_factory_userpref(
|
|
3891
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3892
3799
|
execution_context: int | str | None = None,
|
|
3893
3800
|
undo: bool | None = None,
|
|
3801
|
+
/,
|
|
3894
3802
|
*,
|
|
3895
3803
|
use_factory_startup_app_template_only: bool | None = False,
|
|
3896
3804
|
):
|
|
3897
3805
|
"""Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
|
|
3898
3806
|
|
|
3899
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3900
3807
|
:type execution_context: int | str | None
|
|
3901
3808
|
:type undo: bool | None
|
|
3902
3809
|
:param use_factory_startup_app_template_only: Factory Startup App-Template Only
|
|
3903
3810
|
:type use_factory_startup_app_template_only: bool | None
|
|
3904
3811
|
"""
|
|
3905
3812
|
|
|
3906
|
-
def read_history(
|
|
3907
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3908
|
-
execution_context: int | str | None = None,
|
|
3909
|
-
undo: bool | None = None,
|
|
3910
|
-
):
|
|
3813
|
+
def read_history(execution_context: int | str | None = None, undo: bool | None = None):
|
|
3911
3814
|
"""Reloads history and bookmarks
|
|
3912
3815
|
|
|
3913
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3914
3816
|
:type execution_context: int | str | None
|
|
3915
3817
|
:type undo: bool | None
|
|
3916
3818
|
"""
|
|
3917
3819
|
|
|
3918
3820
|
def read_homefile(
|
|
3919
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3920
3821
|
execution_context: int | str | None = None,
|
|
3921
3822
|
undo: bool | None = None,
|
|
3823
|
+
/,
|
|
3922
3824
|
*,
|
|
3923
3825
|
filepath: str = "",
|
|
3924
3826
|
load_ui: bool | None = True,
|
|
@@ -3930,7 +3832,6 @@ def read_homefile(
|
|
|
3930
3832
|
):
|
|
3931
3833
|
"""Open the default file
|
|
3932
3834
|
|
|
3933
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3934
3835
|
:type execution_context: int | str | None
|
|
3935
3836
|
:type undo: bool | None
|
|
3936
3837
|
:param filepath: File Path, Path to an alternative start-up file
|
|
@@ -3948,22 +3849,17 @@ def read_homefile(
|
|
|
3948
3849
|
:type use_empty: bool | None
|
|
3949
3850
|
"""
|
|
3950
3851
|
|
|
3951
|
-
def read_userpref(
|
|
3952
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3953
|
-
execution_context: int | str | None = None,
|
|
3954
|
-
undo: bool | None = None,
|
|
3955
|
-
):
|
|
3852
|
+
def read_userpref(execution_context: int | str | None = None, undo: bool | None = None):
|
|
3956
3853
|
"""Load last saved preferences
|
|
3957
3854
|
|
|
3958
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3959
3855
|
:type execution_context: int | str | None
|
|
3960
3856
|
:type undo: bool | None
|
|
3961
3857
|
"""
|
|
3962
3858
|
|
|
3963
3859
|
def recover_auto_save(
|
|
3964
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
3965
3860
|
execution_context: int | str | None = None,
|
|
3966
3861
|
undo: bool | None = None,
|
|
3862
|
+
/,
|
|
3967
3863
|
*,
|
|
3968
3864
|
filepath: str = "",
|
|
3969
3865
|
hide_props_region: bool | None = True,
|
|
@@ -3995,7 +3891,6 @@ def recover_auto_save(
|
|
|
3995
3891
|
):
|
|
3996
3892
|
"""Open an automatically saved file to recover it
|
|
3997
3893
|
|
|
3998
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
3999
3894
|
:type execution_context: int | str | None
|
|
4000
3895
|
:type undo: bool | None
|
|
4001
3896
|
:param filepath: File Path, Path to file
|
|
@@ -4061,15 +3956,14 @@ def recover_auto_save(
|
|
|
4061
3956
|
"""
|
|
4062
3957
|
|
|
4063
3958
|
def recover_last_session(
|
|
4064
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4065
3959
|
execution_context: int | str | None = None,
|
|
4066
3960
|
undo: bool | None = None,
|
|
3961
|
+
/,
|
|
4067
3962
|
*,
|
|
4068
3963
|
use_scripts: bool | None = True,
|
|
4069
3964
|
):
|
|
4070
3965
|
"""Open the last closed file ("quit.blend")
|
|
4071
3966
|
|
|
4072
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4073
3967
|
:type execution_context: int | str | None
|
|
4074
3968
|
:type undo: bool | None
|
|
4075
3969
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
@@ -4077,9 +3971,9 @@ def recover_last_session(
|
|
|
4077
3971
|
"""
|
|
4078
3972
|
|
|
4079
3973
|
def redraw_timer(
|
|
4080
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4081
3974
|
execution_context: int | str | None = None,
|
|
4082
3975
|
undo: bool | None = None,
|
|
3976
|
+
/,
|
|
4083
3977
|
*,
|
|
4084
3978
|
type: typing.Literal[
|
|
4085
3979
|
"DRAW",
|
|
@@ -4096,7 +3990,6 @@ def redraw_timer(
|
|
|
4096
3990
|
):
|
|
4097
3991
|
"""Simple redraw timer to test the speed of updating the interface
|
|
4098
3992
|
|
|
4099
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4100
3993
|
:type execution_context: int | str | None
|
|
4101
3994
|
:type undo: bool | None
|
|
4102
3995
|
:param type: Type
|
|
@@ -4129,15 +4022,14 @@ def redraw_timer(
|
|
|
4129
4022
|
"""
|
|
4130
4023
|
|
|
4131
4024
|
def revert_mainfile(
|
|
4132
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4133
4025
|
execution_context: int | str | None = None,
|
|
4134
4026
|
undo: bool | None = None,
|
|
4027
|
+
/,
|
|
4135
4028
|
*,
|
|
4136
4029
|
use_scripts: bool | None = True,
|
|
4137
4030
|
):
|
|
4138
4031
|
"""Reload the saved file
|
|
4139
4032
|
|
|
4140
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4141
4033
|
:type execution_context: int | str | None
|
|
4142
4034
|
:type undo: bool | None
|
|
4143
4035
|
:param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
|
|
@@ -4145,9 +4037,9 @@ def revert_mainfile(
|
|
|
4145
4037
|
"""
|
|
4146
4038
|
|
|
4147
4039
|
def save_as_mainfile(
|
|
4148
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4149
4040
|
execution_context: int | str | None = None,
|
|
4150
4041
|
undo: bool | None = None,
|
|
4042
|
+
/,
|
|
4151
4043
|
*,
|
|
4152
4044
|
filepath: str = "",
|
|
4153
4045
|
hide_props_region: bool | None = True,
|
|
@@ -4181,7 +4073,6 @@ def save_as_mainfile(
|
|
|
4181
4073
|
):
|
|
4182
4074
|
"""Save the current file in the desired location
|
|
4183
4075
|
|
|
4184
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4185
4076
|
:type execution_context: int | str | None
|
|
4186
4077
|
:type undo: bool | None
|
|
4187
4078
|
:param filepath: File Path, Path to file
|
|
@@ -4250,22 +4141,17 @@ def save_as_mainfile(
|
|
|
4250
4141
|
:type copy: bool | None
|
|
4251
4142
|
"""
|
|
4252
4143
|
|
|
4253
|
-
def save_homefile(
|
|
4254
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4255
|
-
execution_context: int | str | None = None,
|
|
4256
|
-
undo: bool | None = None,
|
|
4257
|
-
):
|
|
4144
|
+
def save_homefile(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4258
4145
|
"""Make the current file the default startup file
|
|
4259
4146
|
|
|
4260
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4261
4147
|
:type execution_context: int | str | None
|
|
4262
4148
|
:type undo: bool | None
|
|
4263
4149
|
"""
|
|
4264
4150
|
|
|
4265
4151
|
def save_mainfile(
|
|
4266
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4267
4152
|
execution_context: int | str | None = None,
|
|
4268
4153
|
undo: bool | None = None,
|
|
4154
|
+
/,
|
|
4269
4155
|
*,
|
|
4270
4156
|
filepath: str = "",
|
|
4271
4157
|
hide_props_region: bool | None = True,
|
|
@@ -4300,7 +4186,6 @@ def save_mainfile(
|
|
|
4300
4186
|
):
|
|
4301
4187
|
"""Save the current Blender file
|
|
4302
4188
|
|
|
4303
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4304
4189
|
:type execution_context: int | str | None
|
|
4305
4190
|
:type undo: bool | None
|
|
4306
4191
|
:param filepath: File Path, Path to file
|
|
@@ -4371,53 +4256,39 @@ def save_mainfile(
|
|
|
4371
4256
|
:type incremental: bool | None
|
|
4372
4257
|
"""
|
|
4373
4258
|
|
|
4374
|
-
def save_userpref(
|
|
4375
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4376
|
-
execution_context: int | str | None = None,
|
|
4377
|
-
undo: bool | None = None,
|
|
4378
|
-
):
|
|
4259
|
+
def save_userpref(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4379
4260
|
"""Make the current preferences default
|
|
4380
4261
|
|
|
4381
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4382
4262
|
:type execution_context: int | str | None
|
|
4383
4263
|
:type undo: bool | None
|
|
4384
4264
|
"""
|
|
4385
4265
|
|
|
4386
|
-
def search_menu(
|
|
4387
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4388
|
-
execution_context: int | str | None = None,
|
|
4389
|
-
undo: bool | None = None,
|
|
4390
|
-
):
|
|
4266
|
+
def search_menu(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4391
4267
|
"""Pop-up a search over all menus in the current context
|
|
4392
4268
|
|
|
4393
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4394
4269
|
:type execution_context: int | str | None
|
|
4395
4270
|
:type undo: bool | None
|
|
4396
4271
|
"""
|
|
4397
4272
|
|
|
4398
4273
|
def search_operator(
|
|
4399
|
-
|
|
4400
|
-
execution_context: int | str | None = None,
|
|
4401
|
-
undo: bool | None = None,
|
|
4274
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
4402
4275
|
):
|
|
4403
4276
|
"""Pop-up a search over all available operators in current context
|
|
4404
4277
|
|
|
4405
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4406
4278
|
:type execution_context: int | str | None
|
|
4407
4279
|
:type undo: bool | None
|
|
4408
4280
|
"""
|
|
4409
4281
|
|
|
4410
4282
|
def search_single_menu(
|
|
4411
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4412
4283
|
execution_context: int | str | None = None,
|
|
4413
4284
|
undo: bool | None = None,
|
|
4285
|
+
/,
|
|
4414
4286
|
*,
|
|
4415
4287
|
menu_idname: str = "",
|
|
4416
4288
|
initial_query: str = "",
|
|
4417
4289
|
):
|
|
4418
4290
|
"""Pop-up a search for a menu in current context
|
|
4419
4291
|
|
|
4420
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4421
4292
|
:type execution_context: int | str | None
|
|
4422
4293
|
:type undo: bool | None
|
|
4423
4294
|
:param menu_idname: Menu Name, Menu to search in
|
|
@@ -4427,9 +4298,9 @@ def search_single_menu(
|
|
|
4427
4298
|
"""
|
|
4428
4299
|
|
|
4429
4300
|
def set_stereo_3d(
|
|
4430
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4431
4301
|
execution_context: int | str | None = None,
|
|
4432
4302
|
undo: bool | None = None,
|
|
4303
|
+
/,
|
|
4433
4304
|
*,
|
|
4434
4305
|
display_mode: bpy.typing.Stereo3DDisplayItems | None = "ANAGLYPH",
|
|
4435
4306
|
anaglyph_type: bpy.typing.Stereo3DAnaglyphTypeItems | None = "RED_CYAN",
|
|
@@ -4439,7 +4310,6 @@ def set_stereo_3d(
|
|
|
4439
4310
|
):
|
|
4440
4311
|
"""Toggle 3D stereo support for current window (or change the display mode)
|
|
4441
4312
|
|
|
4442
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4443
4313
|
:type execution_context: int | str | None
|
|
4444
4314
|
:type undo: bool | None
|
|
4445
4315
|
:param display_mode: Display Mode
|
|
@@ -4454,34 +4324,24 @@ def set_stereo_3d(
|
|
|
4454
4324
|
:type use_sidebyside_crosseyed: bool | None
|
|
4455
4325
|
"""
|
|
4456
4326
|
|
|
4457
|
-
def splash(
|
|
4458
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4459
|
-
execution_context: int | str | None = None,
|
|
4460
|
-
undo: bool | None = None,
|
|
4461
|
-
):
|
|
4327
|
+
def splash(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4462
4328
|
"""Open the splash screen with release info
|
|
4463
4329
|
|
|
4464
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4465
4330
|
:type execution_context: int | str | None
|
|
4466
4331
|
:type undo: bool | None
|
|
4467
4332
|
"""
|
|
4468
4333
|
|
|
4469
|
-
def splash_about(
|
|
4470
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4471
|
-
execution_context: int | str | None = None,
|
|
4472
|
-
undo: bool | None = None,
|
|
4473
|
-
):
|
|
4334
|
+
def splash_about(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4474
4335
|
"""Open a window with information about Blender
|
|
4475
4336
|
|
|
4476
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4477
4337
|
:type execution_context: int | str | None
|
|
4478
4338
|
:type undo: bool | None
|
|
4479
4339
|
"""
|
|
4480
4340
|
|
|
4481
4341
|
def stl_export(
|
|
4482
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4483
4342
|
execution_context: int | str | None = None,
|
|
4484
4343
|
undo: bool | None = None,
|
|
4344
|
+
/,
|
|
4485
4345
|
*,
|
|
4486
4346
|
filepath: str = "",
|
|
4487
4347
|
check_existing: bool | None = True,
|
|
@@ -4525,7 +4385,6 @@ def stl_export(
|
|
|
4525
4385
|
):
|
|
4526
4386
|
"""Save the scene to an STL file
|
|
4527
4387
|
|
|
4528
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4529
4388
|
:type execution_context: int | str | None
|
|
4530
4389
|
:type undo: bool | None
|
|
4531
4390
|
:param filepath: File Path, Path to file
|
|
@@ -4643,9 +4502,9 @@ def stl_export(
|
|
|
4643
4502
|
"""
|
|
4644
4503
|
|
|
4645
4504
|
def stl_import(
|
|
4646
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4647
4505
|
execution_context: int | str | None = None,
|
|
4648
4506
|
undo: bool | None = None,
|
|
4507
|
+
/,
|
|
4649
4508
|
*,
|
|
4650
4509
|
filepath: str = "",
|
|
4651
4510
|
directory: str = "",
|
|
@@ -4689,7 +4548,6 @@ def stl_import(
|
|
|
4689
4548
|
):
|
|
4690
4549
|
"""Import an STL file as an object
|
|
4691
4550
|
|
|
4692
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4693
4551
|
:type execution_context: int | str | None
|
|
4694
4552
|
:type undo: bool | None
|
|
4695
4553
|
:param filepath: File Path, Path to file
|
|
@@ -4805,15 +4663,14 @@ def stl_import(
|
|
|
4805
4663
|
"""
|
|
4806
4664
|
|
|
4807
4665
|
def sysinfo(
|
|
4808
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4809
4666
|
execution_context: int | str | None = None,
|
|
4810
4667
|
undo: bool | None = None,
|
|
4668
|
+
/,
|
|
4811
4669
|
*,
|
|
4812
4670
|
filepath: str = "",
|
|
4813
4671
|
):
|
|
4814
4672
|
"""Generate system information, saved into a text file
|
|
4815
4673
|
|
|
4816
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4817
4674
|
:type execution_context: int | str | None
|
|
4818
4675
|
:type undo: bool | None
|
|
4819
4676
|
:param filepath: filepath
|
|
@@ -4821,9 +4678,9 @@ def sysinfo(
|
|
|
4821
4678
|
"""
|
|
4822
4679
|
|
|
4823
4680
|
def tool_set_by_brush_type(
|
|
4824
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4825
4681
|
execution_context: int | str | None = None,
|
|
4826
4682
|
undo: bool | None = None,
|
|
4683
|
+
/,
|
|
4827
4684
|
*,
|
|
4828
4685
|
brush_type: str = "",
|
|
4829
4686
|
space_type: typing.Literal[
|
|
@@ -4851,7 +4708,6 @@ def tool_set_by_brush_type(
|
|
|
4851
4708
|
):
|
|
4852
4709
|
"""Look up the most appropriate tool for the given brush type and activate that
|
|
4853
4710
|
|
|
4854
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4855
4711
|
:type execution_context: int | str | None
|
|
4856
4712
|
:type undo: bool | None
|
|
4857
4713
|
:param brush_type: Brush Type, Brush type identifier for which the most appropriate tool will be looked up
|
|
@@ -4861,9 +4717,9 @@ def tool_set_by_brush_type(
|
|
|
4861
4717
|
"""
|
|
4862
4718
|
|
|
4863
4719
|
def tool_set_by_id(
|
|
4864
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4865
4720
|
execution_context: int | str | None = None,
|
|
4866
4721
|
undo: bool | None = None,
|
|
4722
|
+
/,
|
|
4867
4723
|
*,
|
|
4868
4724
|
name: str = "",
|
|
4869
4725
|
cycle: bool | None = False,
|
|
@@ -4893,7 +4749,6 @@ def tool_set_by_id(
|
|
|
4893
4749
|
):
|
|
4894
4750
|
"""Set the tool by name (for key-maps)
|
|
4895
4751
|
|
|
4896
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4897
4752
|
:type execution_context: int | str | None
|
|
4898
4753
|
:type undo: bool | None
|
|
4899
4754
|
:param name: Identifier, Identifier of the tool
|
|
@@ -4907,9 +4762,9 @@ def tool_set_by_id(
|
|
|
4907
4762
|
"""
|
|
4908
4763
|
|
|
4909
4764
|
def tool_set_by_index(
|
|
4910
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4911
4765
|
execution_context: int | str | None = None,
|
|
4912
4766
|
undo: bool | None = None,
|
|
4767
|
+
/,
|
|
4913
4768
|
*,
|
|
4914
4769
|
index: int | None = 0,
|
|
4915
4770
|
cycle: bool | None = False,
|
|
@@ -4940,7 +4795,6 @@ def tool_set_by_index(
|
|
|
4940
4795
|
):
|
|
4941
4796
|
"""Set the tool by index (for key-maps)
|
|
4942
4797
|
|
|
4943
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4944
4798
|
:type execution_context: int | str | None
|
|
4945
4799
|
:type undo: bool | None
|
|
4946
4800
|
:param index: Index in Toolbar
|
|
@@ -4955,52 +4809,40 @@ def tool_set_by_index(
|
|
|
4955
4809
|
:type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
|
|
4956
4810
|
"""
|
|
4957
4811
|
|
|
4958
|
-
def toolbar(
|
|
4959
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4960
|
-
execution_context: int | str | None = None,
|
|
4961
|
-
undo: bool | None = None,
|
|
4962
|
-
):
|
|
4812
|
+
def toolbar(execution_context: int | str | None = None, undo: bool | None = None):
|
|
4963
4813
|
"""Undocumented, consider contributing.
|
|
4964
4814
|
|
|
4965
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4966
4815
|
:type execution_context: int | str | None
|
|
4967
4816
|
:type undo: bool | None
|
|
4968
4817
|
"""
|
|
4969
4818
|
|
|
4970
4819
|
def toolbar_fallback_pie(
|
|
4971
|
-
|
|
4972
|
-
execution_context: int | str | None = None,
|
|
4973
|
-
undo: bool | None = None,
|
|
4820
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
4974
4821
|
):
|
|
4975
4822
|
"""Undocumented, consider contributing.
|
|
4976
4823
|
|
|
4977
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4978
4824
|
:type execution_context: int | str | None
|
|
4979
4825
|
:type undo: bool | None
|
|
4980
4826
|
"""
|
|
4981
4827
|
|
|
4982
4828
|
def toolbar_prompt(
|
|
4983
|
-
|
|
4984
|
-
execution_context: int | str | None = None,
|
|
4985
|
-
undo: bool | None = None,
|
|
4829
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
4986
4830
|
):
|
|
4987
4831
|
"""Leader key like functionality for accessing tools
|
|
4988
4832
|
|
|
4989
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
4990
4833
|
:type execution_context: int | str | None
|
|
4991
4834
|
:type undo: bool | None
|
|
4992
4835
|
"""
|
|
4993
4836
|
|
|
4994
4837
|
def url_open(
|
|
4995
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
4996
4838
|
execution_context: int | str | None = None,
|
|
4997
4839
|
undo: bool | None = None,
|
|
4840
|
+
/,
|
|
4998
4841
|
*,
|
|
4999
4842
|
url: str = "",
|
|
5000
4843
|
):
|
|
5001
4844
|
"""Open a website in the web browser
|
|
5002
4845
|
|
|
5003
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5004
4846
|
:type execution_context: int | str | None
|
|
5005
4847
|
:type undo: bool | None
|
|
5006
4848
|
:param url: URL, URL to open
|
|
@@ -5008,15 +4850,14 @@ def url_open(
|
|
|
5008
4850
|
"""
|
|
5009
4851
|
|
|
5010
4852
|
def url_open_preset(
|
|
5011
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5012
4853
|
execution_context: int | str | None = None,
|
|
5013
4854
|
undo: bool | None = None,
|
|
4855
|
+
/,
|
|
5014
4856
|
*,
|
|
5015
4857
|
type: str | None = "",
|
|
5016
4858
|
):
|
|
5017
4859
|
"""Open a preset website in the web browser
|
|
5018
4860
|
|
|
5019
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5020
4861
|
:type execution_context: int | str | None
|
|
5021
4862
|
:type undo: bool | None
|
|
5022
4863
|
:param type: Site
|
|
@@ -5024,9 +4865,9 @@ def url_open_preset(
|
|
|
5024
4865
|
"""
|
|
5025
4866
|
|
|
5026
4867
|
def usd_export(
|
|
5027
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5028
4868
|
execution_context: int | str | None = None,
|
|
5029
4869
|
undo: bool | None = None,
|
|
4870
|
+
/,
|
|
5030
4871
|
*,
|
|
5031
4872
|
filepath: str = "",
|
|
5032
4873
|
check_existing: bool | None = True,
|
|
@@ -5112,7 +4953,6 @@ def usd_export(
|
|
|
5112
4953
|
):
|
|
5113
4954
|
"""Export current scene in a USD archive
|
|
5114
4955
|
|
|
5115
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5116
4956
|
:type execution_context: int | str | None
|
|
5117
4957
|
:type undo: bool | None
|
|
5118
4958
|
:param filepath: File Path, Path to file
|
|
@@ -5354,9 +5194,9 @@ def usd_export(
|
|
|
5354
5194
|
"""
|
|
5355
5195
|
|
|
5356
5196
|
def usd_import(
|
|
5357
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5358
5197
|
execution_context: int | str | None = None,
|
|
5359
5198
|
undo: bool | None = None,
|
|
5199
|
+
/,
|
|
5360
5200
|
*,
|
|
5361
5201
|
filepath: str = "",
|
|
5362
5202
|
check_existing: bool | None = False,
|
|
@@ -5429,7 +5269,6 @@ def usd_import(
|
|
|
5429
5269
|
):
|
|
5430
5270
|
"""Import USD stage into current scene
|
|
5431
5271
|
|
|
5432
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5433
5272
|
:type execution_context: int | str | None
|
|
5434
5273
|
:type undo: bool | None
|
|
5435
5274
|
:param filepath: File Path, Path to file
|
|
@@ -5606,58 +5445,42 @@ def usd_import(
|
|
|
5606
5445
|
:type merge_parent_xform: bool | None
|
|
5607
5446
|
"""
|
|
5608
5447
|
|
|
5609
|
-
def window_close(
|
|
5610
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5611
|
-
execution_context: int | str | None = None,
|
|
5612
|
-
undo: bool | None = None,
|
|
5613
|
-
):
|
|
5448
|
+
def window_close(execution_context: int | str | None = None, undo: bool | None = None):
|
|
5614
5449
|
"""Close the current window
|
|
5615
5450
|
|
|
5616
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5617
5451
|
:type execution_context: int | str | None
|
|
5618
5452
|
:type undo: bool | None
|
|
5619
5453
|
"""
|
|
5620
5454
|
|
|
5621
5455
|
def window_fullscreen_toggle(
|
|
5622
|
-
|
|
5623
|
-
execution_context: int | str | None = None,
|
|
5624
|
-
undo: bool | None = None,
|
|
5456
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
5625
5457
|
):
|
|
5626
5458
|
"""Toggle the current window full-screen
|
|
5627
5459
|
|
|
5628
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5629
5460
|
:type execution_context: int | str | None
|
|
5630
5461
|
:type undo: bool | None
|
|
5631
5462
|
"""
|
|
5632
5463
|
|
|
5633
|
-
def window_new(
|
|
5634
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5635
|
-
execution_context: int | str | None = None,
|
|
5636
|
-
undo: bool | None = None,
|
|
5637
|
-
):
|
|
5464
|
+
def window_new(execution_context: int | str | None = None, undo: bool | None = None):
|
|
5638
5465
|
"""Create a new window
|
|
5639
5466
|
|
|
5640
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5641
5467
|
:type execution_context: int | str | None
|
|
5642
5468
|
:type undo: bool | None
|
|
5643
5469
|
"""
|
|
5644
5470
|
|
|
5645
5471
|
def window_new_main(
|
|
5646
|
-
|
|
5647
|
-
execution_context: int | str | None = None,
|
|
5648
|
-
undo: bool | None = None,
|
|
5472
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
5649
5473
|
):
|
|
5650
5474
|
"""Create a new main window with its own workspace and scene selection
|
|
5651
5475
|
|
|
5652
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5653
5476
|
:type execution_context: int | str | None
|
|
5654
5477
|
:type undo: bool | None
|
|
5655
5478
|
"""
|
|
5656
5479
|
|
|
5657
5480
|
def xr_navigation_fly(
|
|
5658
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5659
5481
|
execution_context: int | str | None = None,
|
|
5660
5482
|
undo: bool | None = None,
|
|
5483
|
+
/,
|
|
5661
5484
|
*,
|
|
5662
5485
|
mode: typing.Literal[
|
|
5663
5486
|
"FORWARD",
|
|
@@ -5691,7 +5514,6 @@ def xr_navigation_fly(
|
|
|
5691
5514
|
):
|
|
5692
5515
|
"""Move/turn relative to the VR viewer or controller
|
|
5693
5516
|
|
|
5694
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5695
5517
|
:type execution_context: int | str | None
|
|
5696
5518
|
:type undo: bool | None
|
|
5697
5519
|
:param mode: Mode, Fly mode
|
|
@@ -5752,9 +5574,9 @@ def xr_navigation_fly(
|
|
|
5752
5574
|
"""
|
|
5753
5575
|
|
|
5754
5576
|
def xr_navigation_grab(
|
|
5755
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5756
5577
|
execution_context: int | str | None = None,
|
|
5757
5578
|
undo: bool | None = None,
|
|
5579
|
+
/,
|
|
5758
5580
|
*,
|
|
5759
5581
|
lock_location: bool | None = False,
|
|
5760
5582
|
lock_location_z: bool | None = False,
|
|
@@ -5764,7 +5586,6 @@ def xr_navigation_grab(
|
|
|
5764
5586
|
):
|
|
5765
5587
|
"""Navigate the VR scene by grabbing with controllers
|
|
5766
5588
|
|
|
5767
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5768
5589
|
:type execution_context: int | str | None
|
|
5769
5590
|
:type undo: bool | None
|
|
5770
5591
|
:param lock_location: Lock Location, Prevent changes to viewer location
|
|
@@ -5780,9 +5601,9 @@ def xr_navigation_grab(
|
|
|
5780
5601
|
"""
|
|
5781
5602
|
|
|
5782
5603
|
def xr_navigation_reset(
|
|
5783
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5784
5604
|
execution_context: int | str | None = None,
|
|
5785
5605
|
undo: bool | None = None,
|
|
5606
|
+
/,
|
|
5786
5607
|
*,
|
|
5787
5608
|
location: bool | None = True,
|
|
5788
5609
|
rotation: bool | None = True,
|
|
@@ -5790,7 +5611,6 @@ def xr_navigation_reset(
|
|
|
5790
5611
|
):
|
|
5791
5612
|
"""Reset VR navigation deltas relative to session base pose
|
|
5792
5613
|
|
|
5793
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5794
5614
|
:type execution_context: int | str | None
|
|
5795
5615
|
:type undo: bool | None
|
|
5796
5616
|
:param location: Location, Reset location deltas
|
|
@@ -5802,9 +5622,9 @@ def xr_navigation_reset(
|
|
|
5802
5622
|
"""
|
|
5803
5623
|
|
|
5804
5624
|
def xr_navigation_teleport(
|
|
5805
|
-
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
5806
5625
|
execution_context: int | str | None = None,
|
|
5807
5626
|
undo: bool | None = None,
|
|
5627
|
+
/,
|
|
5808
5628
|
*,
|
|
5809
5629
|
teleport_axes: collections.abc.Iterable[bool] | None = (True, True, True),
|
|
5810
5630
|
interpolation: float | None = 1.0,
|
|
@@ -5817,7 +5637,6 @@ def xr_navigation_teleport(
|
|
|
5817
5637
|
):
|
|
5818
5638
|
"""Set VR viewer location to controller raycast hit location
|
|
5819
5639
|
|
|
5820
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5821
5640
|
:type execution_context: int | str | None
|
|
5822
5641
|
:type undo: bool | None
|
|
5823
5642
|
:param teleport_axes: Teleport Axes, Enabled teleport axes in navigation space
|
|
@@ -5839,13 +5658,10 @@ def xr_navigation_teleport(
|
|
|
5839
5658
|
"""
|
|
5840
5659
|
|
|
5841
5660
|
def xr_session_toggle(
|
|
5842
|
-
|
|
5843
|
-
execution_context: int | str | None = None,
|
|
5844
|
-
undo: bool | None = None,
|
|
5661
|
+
execution_context: int | str | None = None, undo: bool | None = None
|
|
5845
5662
|
):
|
|
5846
5663
|
"""Open a view for use with virtual reality headsets, or close it if already opened
|
|
5847
5664
|
|
|
5848
|
-
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
5849
5665
|
:type execution_context: int | str | None
|
|
5850
5666
|
:type undo: bool | None
|
|
5851
5667
|
"""
|