fake-bpy-module 20241206__py3-none-any.whl → 20241208__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.
- addon_utils/__init__.pyi +2 -1
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +5 -2
- bl_console_utils/autocomplete/complete_import/__init__.pyi +6 -3
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +2 -1
- bl_console_utils/autocomplete/intellisense/__init__.pyi +8 -2
- blf/__init__.pyi +2 -1
- bmesh/ops/__init__.pyi +110 -53
- bmesh/types/__init__.pyi +18 -10
- bmesh/utils/__init__.pyi +14 -4
- bpy/app/icons/__init__.pyi +4 -1
- bpy/app/translations/__init__.pyi +4 -1
- bpy/msgbus/__init__.pyi +8 -5
- bpy/path/__init__.pyi +4 -2
- bpy/types/__init__.pyi +80 -36
- bpy/utils/__init__.pyi +18 -9
- bpy_extras/bmesh_utils/__init__.pyi +2 -1
- bpy_extras/io_utils/__init__.pyi +7 -2
- bpy_extras/mesh_utils/__init__.pyi +19 -7
- bpy_extras/view3d_utils/__init__.pyi +2 -2
- {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/METADATA +1 -1
- {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/RECORD +40 -40
- freestyle/functions/__init__.pyi +16 -4
- freestyle/types/__init__.pyi +60 -23
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +1 -1
- gpu/capabilities/__init__.pyi +2 -1
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +2 -2
- gpu_extras/batch/__init__.pyi +6 -3
- idprop/types/__init__.pyi +4 -3
- imbuf/__init__.pyi +2 -1
- imbuf/types/__init__.pyi +5 -2
- mathutils/__init__.pyi +25 -14
- mathutils/bvhtree/__init__.pyi +8 -7
- mathutils/geometry/__init__.pyi +38 -17
- mathutils/interpolate/__init__.pyi +2 -1
- mathutils/kdtree/__init__.pyi +11 -6
- mathutils/noise/__init__.pyi +2 -1
- {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20241206.dist-info → fake_bpy_module-20241208.dist-info}/top_level.txt +0 -0
bpy/types/__init__.pyi
CHANGED
|
@@ -36249,6 +36249,7 @@ Executing the operator will then print all values.
|
|
|
36249
36249
|
--------------------
|
|
36250
36250
|
|
|
36251
36251
|
* Lightgroups.add
|
|
36252
|
+
* Lightgroups.remove
|
|
36252
36253
|
* ViewLayer.active_lightgroup
|
|
36253
36254
|
* ViewLayer.lightgroups
|
|
36254
36255
|
|
|
@@ -102852,11 +102853,12 @@ class bpy_prop_collection[_GenericType1]:
|
|
|
102852
102853
|
:rtype: list[tuple[str, _GenericType1]]
|
|
102853
102854
|
"""
|
|
102854
102855
|
|
|
102855
|
-
def keys(self):
|
|
102856
|
+
def keys(self) -> list[str]:
|
|
102856
102857
|
"""Return the identifiers of collection members
|
|
102857
102858
|
(matching Python's dict.keys() functionality).
|
|
102858
102859
|
|
|
102859
102860
|
:return: the identifiers for each member of this collection.
|
|
102861
|
+
:rtype: list[str]
|
|
102860
102862
|
"""
|
|
102861
102863
|
|
|
102862
102864
|
def values(self) -> list[_GenericType1 | None]:
|
|
@@ -102878,13 +102880,13 @@ class bpy_prop_collection[_GenericType1]:
|
|
|
102878
102880
|
"""
|
|
102879
102881
|
|
|
102880
102882
|
@typing.overload
|
|
102881
|
-
def __getitem__(self, key: slice) ->
|
|
102883
|
+
def __getitem__(self, key: slice) -> list[_GenericType1, ...]:
|
|
102882
102884
|
"""
|
|
102883
102885
|
|
|
102884
102886
|
:param key:
|
|
102885
102887
|
:type key: slice
|
|
102886
102888
|
:return:
|
|
102887
|
-
:rtype:
|
|
102889
|
+
:rtype: list[_GenericType1, ...]
|
|
102888
102890
|
"""
|
|
102889
102891
|
|
|
102890
102892
|
def __setitem__(self, key: int | str, value: GenericType1 | None):
|
|
@@ -102965,7 +102967,9 @@ class bpy_struct[_GenericType1]:
|
|
|
102965
102967
|
:rtype: int
|
|
102966
102968
|
"""
|
|
102967
102969
|
|
|
102968
|
-
def driver_add(
|
|
102970
|
+
def driver_add(
|
|
102971
|
+
self, path: str | None, index: int | None = -1
|
|
102972
|
+
) -> FCurve | list[FCurve]:
|
|
102969
102973
|
"""Adds driver(s) to the given property
|
|
102970
102974
|
|
|
102971
102975
|
:param path: path to the property to drive, analogous to the fcurve's data path.
|
|
@@ -102973,7 +102977,7 @@ class bpy_struct[_GenericType1]:
|
|
|
102973
102977
|
:param index: array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array.
|
|
102974
102978
|
:type index: int | None
|
|
102975
102979
|
:return: The driver added or a list of drivers when index is -1.
|
|
102976
|
-
:rtype: FCurve
|
|
102980
|
+
:rtype: FCurve | list[FCurve]
|
|
102977
102981
|
"""
|
|
102978
102982
|
|
|
102979
102983
|
def driver_remove(self, path: str | None, index: int | None = -1) -> bool:
|
|
@@ -102987,7 +102991,7 @@ class bpy_struct[_GenericType1]:
|
|
|
102987
102991
|
:rtype: bool
|
|
102988
102992
|
"""
|
|
102989
102993
|
|
|
102990
|
-
def get(self, key: str | None, default=None):
|
|
102994
|
+
def get(self, key: str | None, default: typing.Any | None = None):
|
|
102991
102995
|
"""Returns the value of the custom property assigned to key or default
|
|
102992
102996
|
when not found (matches Python's dictionary function of the same name).
|
|
102993
102997
|
|
|
@@ -102995,6 +102999,7 @@ class bpy_struct[_GenericType1]:
|
|
|
102995
102999
|
:type key: str | None
|
|
102996
103000
|
:param default: Optional argument for the value to return if
|
|
102997
103001
|
key is not found.
|
|
103002
|
+
:type default: typing.Any | None
|
|
102998
103003
|
"""
|
|
102999
103004
|
|
|
103000
103005
|
def id_properties_clear(self):
|
|
@@ -103154,7 +103159,7 @@ class bpy_struct[_GenericType1]:
|
|
|
103154
103159
|
:type coerce: bool | None
|
|
103155
103160
|
"""
|
|
103156
103161
|
|
|
103157
|
-
def pop(self, key: str | None, default=None):
|
|
103162
|
+
def pop(self, key: str | None, default: typing.Any | None = None):
|
|
103158
103163
|
"""Remove and return the value of the custom property assigned to key or default
|
|
103159
103164
|
when not found (matches Python's dictionary function of the same name).
|
|
103160
103165
|
|
|
@@ -103162,6 +103167,7 @@ class bpy_struct[_GenericType1]:
|
|
|
103162
103167
|
:type key: str | None
|
|
103163
103168
|
:param default: Optional argument for the value to return if
|
|
103164
103169
|
key is not found.
|
|
103170
|
+
:type default: typing.Any | None
|
|
103165
103171
|
"""
|
|
103166
103172
|
|
|
103167
103173
|
def property_overridable_library_set(self, property, overridable) -> bool:
|
|
@@ -103268,13 +103274,13 @@ class bpy_prop_array[_GenericType1]:
|
|
|
103268
103274
|
"""
|
|
103269
103275
|
|
|
103270
103276
|
@typing.overload
|
|
103271
|
-
def __getitem__(self, key: slice) ->
|
|
103277
|
+
def __getitem__(self, key: slice) -> list[_GenericType1, ...]:
|
|
103272
103278
|
"""
|
|
103273
103279
|
|
|
103274
103280
|
:param key:
|
|
103275
103281
|
:type key: slice
|
|
103276
103282
|
:return:
|
|
103277
|
-
:rtype:
|
|
103283
|
+
:rtype: list[_GenericType1, ...]
|
|
103278
103284
|
"""
|
|
103279
103285
|
|
|
103280
103286
|
@typing.overload
|
|
@@ -108975,6 +108981,13 @@ class Lightgroups(bpy_prop_collection[Lightgroup], bpy_struct):
|
|
|
108975
108981
|
:rtype: Lightgroup
|
|
108976
108982
|
"""
|
|
108977
108983
|
|
|
108984
|
+
def remove(self, lightgroup: Lightgroup):
|
|
108985
|
+
"""Remove given light group
|
|
108986
|
+
|
|
108987
|
+
:param lightgroup: Lightgroup to remove
|
|
108988
|
+
:type lightgroup: Lightgroup
|
|
108989
|
+
"""
|
|
108990
|
+
|
|
108978
108991
|
@classmethod
|
|
108979
108992
|
def bl_rna_get_subclass(cls, id: str | None, default=None) -> Struct:
|
|
108980
108993
|
"""
|
|
@@ -116424,13 +116437,14 @@ class BlendData(bpy_struct):
|
|
|
116424
116437
|
:rtype: typing_extensions.Self
|
|
116425
116438
|
"""
|
|
116426
116439
|
|
|
116427
|
-
def user_map(self, subset, key_types, value_types):
|
|
116440
|
+
def user_map(self, subset, key_types, value_types) -> dict[ID]:
|
|
116428
116441
|
"""Returns a mapping of all ID data-blocks in current bpy.data to a set of all data-blocks using them.For list of valid set members for key_types & value_types, see: `bpy.types.KeyingSetPath.id_type`.
|
|
116429
116442
|
|
|
116430
116443
|
:param subset: When passed, only these data-blocks and their users will be included as keys/values in the map.
|
|
116431
116444
|
:param key_types: Filter the keys mapped by ID types.
|
|
116432
116445
|
:param value_types: Filter the values in the set by ID types.
|
|
116433
116446
|
:return: dictionary that maps data-blocks ID's to their users.
|
|
116447
|
+
:rtype: dict[ID]
|
|
116434
116448
|
"""
|
|
116435
116449
|
|
|
116436
116450
|
class BlendImportContext(bpy_struct):
|
|
@@ -157174,7 +157188,7 @@ class Gizmo(bpy_struct):
|
|
|
157174
157188
|
|
|
157175
157189
|
def draw_custom_shape(
|
|
157176
157190
|
self,
|
|
157177
|
-
shape,
|
|
157191
|
+
shape: typing.Any | None,
|
|
157178
157192
|
*,
|
|
157179
157193
|
matrix: collections.abc.Sequence[collections.abc.Sequence[float]]
|
|
157180
157194
|
| mathutils.Matrix
|
|
@@ -157184,6 +157198,7 @@ class Gizmo(bpy_struct):
|
|
|
157184
157198
|
"""Draw a shape created form `Gizmo.draw_custom_shape`.
|
|
157185
157199
|
|
|
157186
157200
|
:param shape: The cached shape to draw.
|
|
157201
|
+
:type shape: typing.Any | None
|
|
157187
157202
|
:param matrix: 4x4 matrix, when not given `Gizmo.matrix_world` is used.
|
|
157188
157203
|
:type matrix: collections.abc.Sequence[collections.abc.Sequence[float]] | mathutils.Matrix | None
|
|
157189
157204
|
:param select_id: The selection id.
|
|
@@ -157192,13 +157207,14 @@ class Gizmo(bpy_struct):
|
|
|
157192
157207
|
"""
|
|
157193
157208
|
|
|
157194
157209
|
@staticmethod
|
|
157195
|
-
def new_custom_shape(type: str | None, verts):
|
|
157210
|
+
def new_custom_shape(type: str | None, verts) -> typing.Any:
|
|
157196
157211
|
"""Create a new shape that can be passed to `Gizmo.draw_custom_shape`.
|
|
157197
157212
|
|
|
157198
157213
|
:param type: The type of shape to create in (POINTS, LINES, TRIS, LINE_STRIP).
|
|
157199
157214
|
:type type: str | None
|
|
157200
157215
|
:param verts: Sequence of 2D or 3D coordinates.
|
|
157201
157216
|
:return: The newly created shape (the return type make change).
|
|
157217
|
+
:rtype: typing.Any
|
|
157202
157218
|
"""
|
|
157203
157219
|
|
|
157204
157220
|
@classmethod
|
|
@@ -157223,20 +157239,21 @@ class Gizmo(bpy_struct):
|
|
|
157223
157239
|
:rtype: typing.Any
|
|
157224
157240
|
"""
|
|
157225
157241
|
|
|
157226
|
-
def target_get_range(self, target):
|
|
157242
|
+
def target_get_range(self, target) -> tuple[float, float]:
|
|
157227
157243
|
"""Get the range for this target property.
|
|
157228
157244
|
|
|
157229
157245
|
:param target: Target property name.
|
|
157230
157246
|
:return: The range of this property (min, max).
|
|
157247
|
+
:rtype: tuple[float, float]
|
|
157231
157248
|
"""
|
|
157232
157249
|
|
|
157233
|
-
def target_get_value(self, target: str | None) -> float:
|
|
157250
|
+
def target_get_value(self, target: str | None) -> float | tuple[float, int]:
|
|
157234
157251
|
"""Get the value of this target property.
|
|
157235
157252
|
|
|
157236
157253
|
:param target: Target property name.
|
|
157237
157254
|
:type target: str | None
|
|
157238
157255
|
:return: The value of the target property as a value or array based on the target type.
|
|
157239
|
-
:rtype: float
|
|
157256
|
+
:rtype: float | tuple[float, int]
|
|
157240
157257
|
"""
|
|
157241
157258
|
|
|
157242
157259
|
def target_set_handler(
|
|
@@ -173078,7 +173095,7 @@ class Menu(bpy_struct):
|
|
|
173078
173095
|
searchpaths,
|
|
173079
173096
|
operator: str | None,
|
|
173080
173097
|
*,
|
|
173081
|
-
props_default=None,
|
|
173098
|
+
props_default: dict[str, typing.Any] | None = None,
|
|
173082
173099
|
prop_filepath: str | None = "filepath",
|
|
173083
173100
|
filter_ext: collections.abc.Callable | None = None,
|
|
173084
173101
|
filter_path=None,
|
|
@@ -173092,6 +173109,7 @@ class Menu(bpy_struct):
|
|
|
173092
173109
|
:param operator: The operator id to use with each file.
|
|
173093
173110
|
:type operator: str | None
|
|
173094
173111
|
:param props_default: Properties to assign to each operator.
|
|
173112
|
+
:type props_default: dict[str, typing.Any] | None
|
|
173095
173113
|
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
173096
173114
|
:type prop_filepath: str | None
|
|
173097
173115
|
:param filter_ext: Optional callback that takes the file extensions.
|
|
@@ -207963,7 +207981,7 @@ class Space(bpy_struct):
|
|
|
207963
207981
|
def draw_handler_add(
|
|
207964
207982
|
cls,
|
|
207965
207983
|
callback: collections.abc.Callable | None,
|
|
207966
|
-
args,
|
|
207984
|
+
args: tuple[typing.Any, int] | None,
|
|
207967
207985
|
region_type: str | None,
|
|
207968
207986
|
draw_type: str | None,
|
|
207969
207987
|
) -> typing.Any:
|
|
@@ -207975,6 +207993,7 @@ class Space(bpy_struct):
|
|
|
207975
207993
|
It gets the specified arguments as input, it's return value is ignored.
|
|
207976
207994
|
:type callback: collections.abc.Callable | None
|
|
207977
207995
|
:param args: Arguments that will be passed to the callback.
|
|
207996
|
+
:type args: tuple[typing.Any, int] | None
|
|
207978
207997
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
207979
207998
|
:type region_type: str | None
|
|
207980
207999
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -208306,7 +208325,7 @@ class SpaceClipEditor(Space, bpy_struct):
|
|
|
208306
208325
|
def draw_handler_add(
|
|
208307
208326
|
cls,
|
|
208308
208327
|
callback: collections.abc.Callable | None,
|
|
208309
|
-
args,
|
|
208328
|
+
args: tuple[typing.Any, int] | None,
|
|
208310
208329
|
region_type: str | None,
|
|
208311
208330
|
draw_type: str | None,
|
|
208312
208331
|
) -> typing.Any:
|
|
@@ -208318,6 +208337,7 @@ class SpaceClipEditor(Space, bpy_struct):
|
|
|
208318
208337
|
It gets the specified arguments as input, it's return value is ignored.
|
|
208319
208338
|
:type callback: collections.abc.Callable | None
|
|
208320
208339
|
:param args: Arguments that will be passed to the callback.
|
|
208340
|
+
:type args: tuple[typing.Any, int] | None
|
|
208321
208341
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208322
208342
|
:type region_type: str | None
|
|
208323
208343
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -208407,7 +208427,7 @@ class SpaceConsole(Space, bpy_struct):
|
|
|
208407
208427
|
def draw_handler_add(
|
|
208408
208428
|
cls,
|
|
208409
208429
|
callback: collections.abc.Callable | None,
|
|
208410
|
-
args,
|
|
208430
|
+
args: tuple[typing.Any, int] | None,
|
|
208411
208431
|
region_type: str | None,
|
|
208412
208432
|
draw_type: str | None,
|
|
208413
208433
|
) -> typing.Any:
|
|
@@ -208419,6 +208439,7 @@ class SpaceConsole(Space, bpy_struct):
|
|
|
208419
208439
|
It gets the specified arguments as input, it's return value is ignored.
|
|
208420
208440
|
:type callback: collections.abc.Callable | None
|
|
208421
208441
|
:param args: Arguments that will be passed to the callback.
|
|
208442
|
+
:type args: tuple[typing.Any, int] | None
|
|
208422
208443
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208423
208444
|
:type region_type: str | None
|
|
208424
208445
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -208614,7 +208635,7 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
|
|
|
208614
208635
|
def draw_handler_add(
|
|
208615
208636
|
cls,
|
|
208616
208637
|
callback: collections.abc.Callable | None,
|
|
208617
|
-
args,
|
|
208638
|
+
args: tuple[typing.Any, int] | None,
|
|
208618
208639
|
region_type: str | None,
|
|
208619
208640
|
draw_type: str | None,
|
|
208620
208641
|
) -> typing.Any:
|
|
@@ -208626,6 +208647,7 @@ class SpaceDopeSheetEditor(Space, bpy_struct):
|
|
|
208626
208647
|
It gets the specified arguments as input, it's return value is ignored.
|
|
208627
208648
|
:type callback: collections.abc.Callable | None
|
|
208628
208649
|
:param args: Arguments that will be passed to the callback.
|
|
208650
|
+
:type args: tuple[typing.Any, int] | None
|
|
208629
208651
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208630
208652
|
:type region_type: str | None
|
|
208631
208653
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -208784,7 +208806,7 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
208784
208806
|
def draw_handler_add(
|
|
208785
208807
|
cls,
|
|
208786
208808
|
callback: collections.abc.Callable | None,
|
|
208787
|
-
args,
|
|
208809
|
+
args: tuple[typing.Any, int] | None,
|
|
208788
208810
|
region_type: str | None,
|
|
208789
208811
|
draw_type: str | None,
|
|
208790
208812
|
) -> typing.Any:
|
|
@@ -208796,6 +208818,7 @@ class SpaceFileBrowser(Space, bpy_struct):
|
|
|
208796
208818
|
It gets the specified arguments as input, it's return value is ignored.
|
|
208797
208819
|
:type callback: collections.abc.Callable | None
|
|
208798
208820
|
:param args: Arguments that will be passed to the callback.
|
|
208821
|
+
:type args: tuple[typing.Any, int] | None
|
|
208799
208822
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208800
208823
|
:type region_type: str | None
|
|
208801
208824
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -208969,7 +208992,7 @@ class SpaceGraphEditor(Space, bpy_struct):
|
|
|
208969
208992
|
def draw_handler_add(
|
|
208970
208993
|
cls,
|
|
208971
208994
|
callback: collections.abc.Callable | None,
|
|
208972
|
-
args,
|
|
208995
|
+
args: tuple[typing.Any, int] | None,
|
|
208973
208996
|
region_type: str | None,
|
|
208974
208997
|
draw_type: str | None,
|
|
208975
208998
|
) -> typing.Any:
|
|
@@ -208981,6 +209004,7 @@ class SpaceGraphEditor(Space, bpy_struct):
|
|
|
208981
209004
|
It gets the specified arguments as input, it's return value is ignored.
|
|
208982
209005
|
:type callback: collections.abc.Callable | None
|
|
208983
209006
|
:param args: Arguments that will be passed to the callback.
|
|
209007
|
+
:type args: tuple[typing.Any, int] | None
|
|
208984
209008
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
208985
209009
|
:type region_type: str | None
|
|
208986
209010
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -209252,7 +209276,7 @@ class SpaceImageEditor(Space, bpy_struct):
|
|
|
209252
209276
|
def draw_handler_add(
|
|
209253
209277
|
cls,
|
|
209254
209278
|
callback: collections.abc.Callable | None,
|
|
209255
|
-
args,
|
|
209279
|
+
args: tuple[typing.Any, int] | None,
|
|
209256
209280
|
region_type: str | None,
|
|
209257
209281
|
draw_type: str | None,
|
|
209258
209282
|
) -> typing.Any:
|
|
@@ -209264,6 +209288,7 @@ class SpaceImageEditor(Space, bpy_struct):
|
|
|
209264
209288
|
It gets the specified arguments as input, it's return value is ignored.
|
|
209265
209289
|
:type callback: collections.abc.Callable | None
|
|
209266
209290
|
:param args: Arguments that will be passed to the callback.
|
|
209291
|
+
:type args: tuple[typing.Any, int] | None
|
|
209267
209292
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209268
209293
|
:type region_type: str | None
|
|
209269
209294
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -209378,7 +209403,7 @@ class SpaceInfo(Space, bpy_struct):
|
|
|
209378
209403
|
def draw_handler_add(
|
|
209379
209404
|
cls,
|
|
209380
209405
|
callback: collections.abc.Callable | None,
|
|
209381
|
-
args,
|
|
209406
|
+
args: tuple[typing.Any, int] | None,
|
|
209382
209407
|
region_type: str | None,
|
|
209383
209408
|
draw_type: str | None,
|
|
209384
209409
|
) -> typing.Any:
|
|
@@ -209390,6 +209415,7 @@ class SpaceInfo(Space, bpy_struct):
|
|
|
209390
209415
|
It gets the specified arguments as input, it's return value is ignored.
|
|
209391
209416
|
:type callback: collections.abc.Callable | None
|
|
209392
209417
|
:param args: Arguments that will be passed to the callback.
|
|
209418
|
+
:type args: tuple[typing.Any, int] | None
|
|
209393
209419
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209394
209420
|
:type region_type: str | None
|
|
209395
209421
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -209491,7 +209517,7 @@ class SpaceNLA(Space, bpy_struct):
|
|
|
209491
209517
|
def draw_handler_add(
|
|
209492
209518
|
cls,
|
|
209493
209519
|
callback: collections.abc.Callable | None,
|
|
209494
|
-
args,
|
|
209520
|
+
args: tuple[typing.Any, int] | None,
|
|
209495
209521
|
region_type: str | None,
|
|
209496
209522
|
draw_type: str | None,
|
|
209497
209523
|
) -> typing.Any:
|
|
@@ -209503,6 +209529,7 @@ class SpaceNLA(Space, bpy_struct):
|
|
|
209503
209529
|
It gets the specified arguments as input, it's return value is ignored.
|
|
209504
209530
|
:type callback: collections.abc.Callable | None
|
|
209505
209531
|
:param args: Arguments that will be passed to the callback.
|
|
209532
|
+
:type args: tuple[typing.Any, int] | None
|
|
209506
209533
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209507
209534
|
:type region_type: str | None
|
|
209508
209535
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -209693,7 +209720,7 @@ class SpaceNodeEditor(Space, bpy_struct):
|
|
|
209693
209720
|
def draw_handler_add(
|
|
209694
209721
|
cls,
|
|
209695
209722
|
callback: collections.abc.Callable | None,
|
|
209696
|
-
args,
|
|
209723
|
+
args: tuple[typing.Any, int] | None,
|
|
209697
209724
|
region_type: str | None,
|
|
209698
209725
|
draw_type: str | None,
|
|
209699
209726
|
) -> typing.Any:
|
|
@@ -209705,6 +209732,7 @@ class SpaceNodeEditor(Space, bpy_struct):
|
|
|
209705
209732
|
It gets the specified arguments as input, it's return value is ignored.
|
|
209706
209733
|
:type callback: collections.abc.Callable | None
|
|
209707
209734
|
:param args: Arguments that will be passed to the callback.
|
|
209735
|
+
:type args: tuple[typing.Any, int] | None
|
|
209708
209736
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
209709
209737
|
:type region_type: str | None
|
|
209710
209738
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210025,7 +210053,7 @@ class SpaceOutliner(Space, bpy_struct):
|
|
|
210025
210053
|
def draw_handler_add(
|
|
210026
210054
|
cls,
|
|
210027
210055
|
callback: collections.abc.Callable | None,
|
|
210028
|
-
args,
|
|
210056
|
+
args: tuple[typing.Any, int] | None,
|
|
210029
210057
|
region_type: str | None,
|
|
210030
210058
|
draw_type: str | None,
|
|
210031
210059
|
) -> typing.Any:
|
|
@@ -210037,6 +210065,7 @@ class SpaceOutliner(Space, bpy_struct):
|
|
|
210037
210065
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210038
210066
|
:type callback: collections.abc.Callable | None
|
|
210039
210067
|
:param args: Arguments that will be passed to the callback.
|
|
210068
|
+
:type args: tuple[typing.Any, int] | None
|
|
210040
210069
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210041
210070
|
:type region_type: str | None
|
|
210042
210071
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210096,7 +210125,7 @@ class SpacePreferences(Space, bpy_struct):
|
|
|
210096
210125
|
def draw_handler_add(
|
|
210097
210126
|
cls,
|
|
210098
210127
|
callback: collections.abc.Callable | None,
|
|
210099
|
-
args,
|
|
210128
|
+
args: tuple[typing.Any, int] | None,
|
|
210100
210129
|
region_type: str | None,
|
|
210101
210130
|
draw_type: str | None,
|
|
210102
210131
|
) -> typing.Any:
|
|
@@ -210108,6 +210137,7 @@ class SpacePreferences(Space, bpy_struct):
|
|
|
210108
210137
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210109
210138
|
:type callback: collections.abc.Callable | None
|
|
210110
210139
|
:param args: Arguments that will be passed to the callback.
|
|
210140
|
+
:type args: tuple[typing.Any, int] | None
|
|
210111
210141
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210112
210142
|
:type region_type: str | None
|
|
210113
210143
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210210,7 +210240,7 @@ class SpaceProperties(Space, bpy_struct):
|
|
|
210210
210240
|
def draw_handler_add(
|
|
210211
210241
|
cls,
|
|
210212
210242
|
callback: collections.abc.Callable | None,
|
|
210213
|
-
args,
|
|
210243
|
+
args: tuple[typing.Any, int] | None,
|
|
210214
210244
|
region_type: str | None,
|
|
210215
210245
|
draw_type: str | None,
|
|
210216
210246
|
) -> typing.Any:
|
|
@@ -210222,6 +210252,7 @@ class SpaceProperties(Space, bpy_struct):
|
|
|
210222
210252
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210223
210253
|
:type callback: collections.abc.Callable | None
|
|
210224
210254
|
:param args: Arguments that will be passed to the callback.
|
|
210255
|
+
:type args: tuple[typing.Any, int] | None
|
|
210225
210256
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210226
210257
|
:type region_type: str | None
|
|
210227
210258
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210465,7 +210496,7 @@ class SpaceSequenceEditor(Space, bpy_struct):
|
|
|
210465
210496
|
def draw_handler_add(
|
|
210466
210497
|
cls,
|
|
210467
210498
|
callback: collections.abc.Callable | None,
|
|
210468
|
-
args,
|
|
210499
|
+
args: tuple[typing.Any, int] | None,
|
|
210469
210500
|
region_type: str | None,
|
|
210470
210501
|
draw_type: str | None,
|
|
210471
210502
|
) -> typing.Any:
|
|
@@ -210477,6 +210508,7 @@ class SpaceSequenceEditor(Space, bpy_struct):
|
|
|
210477
210508
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210478
210509
|
:type callback: collections.abc.Callable | None
|
|
210479
210510
|
:param args: Arguments that will be passed to the callback.
|
|
210511
|
+
:type args: tuple[typing.Any, int] | None
|
|
210480
210512
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210481
210513
|
:type region_type: str | None
|
|
210482
210514
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210608,7 +210640,7 @@ class SpaceSpreadsheet(Space, bpy_struct):
|
|
|
210608
210640
|
def draw_handler_add(
|
|
210609
210641
|
cls,
|
|
210610
210642
|
callback: collections.abc.Callable | None,
|
|
210611
|
-
args,
|
|
210643
|
+
args: tuple[typing.Any, int] | None,
|
|
210612
210644
|
region_type: str | None,
|
|
210613
210645
|
draw_type: str | None,
|
|
210614
210646
|
) -> typing.Any:
|
|
@@ -210620,6 +210652,7 @@ class SpaceSpreadsheet(Space, bpy_struct):
|
|
|
210620
210652
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210621
210653
|
:type callback: collections.abc.Callable | None
|
|
210622
210654
|
:param args: Arguments that will be passed to the callback.
|
|
210655
|
+
:type args: tuple[typing.Any, int] | None
|
|
210623
210656
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210624
210657
|
:type region_type: str | None
|
|
210625
210658
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -210807,7 +210840,7 @@ class SpaceTextEditor(Space, bpy_struct):
|
|
|
210807
210840
|
def draw_handler_add(
|
|
210808
210841
|
cls,
|
|
210809
210842
|
callback: collections.abc.Callable | None,
|
|
210810
|
-
args,
|
|
210843
|
+
args: tuple[typing.Any, int] | None,
|
|
210811
210844
|
region_type: str | None,
|
|
210812
210845
|
draw_type: str | None,
|
|
210813
210846
|
) -> typing.Any:
|
|
@@ -210819,6 +210852,7 @@ class SpaceTextEditor(Space, bpy_struct):
|
|
|
210819
210852
|
It gets the specified arguments as input, it's return value is ignored.
|
|
210820
210853
|
:type callback: collections.abc.Callable | None
|
|
210821
210854
|
:param args: Arguments that will be passed to the callback.
|
|
210855
|
+
:type args: tuple[typing.Any, int] | None
|
|
210822
210856
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
210823
210857
|
:type region_type: str | None
|
|
210824
210858
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -211511,7 +211545,7 @@ class SpaceView3D(Space, bpy_struct):
|
|
|
211511
211545
|
def draw_handler_add(
|
|
211512
211546
|
cls,
|
|
211513
211547
|
callback: collections.abc.Callable | None,
|
|
211514
|
-
args,
|
|
211548
|
+
args: tuple[typing.Any, int] | None,
|
|
211515
211549
|
region_type: str | None,
|
|
211516
211550
|
draw_type: str | None,
|
|
211517
211551
|
) -> typing.Any:
|
|
@@ -211523,6 +211557,7 @@ class SpaceView3D(Space, bpy_struct):
|
|
|
211523
211557
|
It gets the specified arguments as input, it's return value is ignored.
|
|
211524
211558
|
:type callback: collections.abc.Callable | None
|
|
211525
211559
|
:param args: Arguments that will be passed to the callback.
|
|
211560
|
+
:type args: tuple[typing.Any, int] | None
|
|
211526
211561
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
|
211527
211562
|
:type region_type: str | None
|
|
211528
211563
|
:param draw_type: Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.
|
|
@@ -213641,17 +213676,24 @@ class Text(ID, bpy_struct):
|
|
|
213641
213676
|
:rtype: typing.Any
|
|
213642
213677
|
"""
|
|
213643
213678
|
|
|
213644
|
-
def region_as_string(
|
|
213679
|
+
def region_as_string(
|
|
213680
|
+
self, range: tuple[tuple[int, int], tuple[int, int]] | None = None
|
|
213681
|
+
) -> str:
|
|
213645
213682
|
"""
|
|
213646
213683
|
|
|
213647
213684
|
:param range: The region of text to be returned, defaulting to the selection when no range is passed.
|
|
213648
213685
|
Each int pair represents a line and column: ((start_line, start_column), (end_line, end_column))
|
|
213649
213686
|
The values match Python's slicing logic (negative values count backwards from the end, the end value is not inclusive).
|
|
213687
|
+
:type range: tuple[tuple[int, int], tuple[int, int]] | None
|
|
213650
213688
|
:return: The specified region as a string.
|
|
213651
213689
|
:rtype: str
|
|
213652
213690
|
"""
|
|
213653
213691
|
|
|
213654
|
-
def region_from_string(
|
|
213692
|
+
def region_from_string(
|
|
213693
|
+
self,
|
|
213694
|
+
body: str | None,
|
|
213695
|
+
range: tuple[tuple[int, int], tuple[int, int]] | None = None,
|
|
213696
|
+
):
|
|
213655
213697
|
"""
|
|
213656
213698
|
|
|
213657
213699
|
:param body: The text to be inserted.
|
|
@@ -213659,6 +213701,7 @@ class Text(ID, bpy_struct):
|
|
|
213659
213701
|
:param range: The region of text to be returned, defaulting to the selection when no range is passed.
|
|
213660
213702
|
Each int pair represents a line and column: ((start_line, start_column), (end_line, end_column))
|
|
213661
213703
|
The values match Python's slicing logic (negative values count backwards from the end, the end value is not inclusive).
|
|
213704
|
+
:type range: tuple[tuple[int, int], tuple[int, int]] | None
|
|
213662
213705
|
"""
|
|
213663
213706
|
|
|
213664
213707
|
class TextBox(bpy_struct):
|
|
@@ -229630,7 +229673,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
229630
229673
|
def draw_cursor_add(
|
|
229631
229674
|
cls,
|
|
229632
229675
|
callback: collections.abc.Callable | None,
|
|
229633
|
-
args,
|
|
229676
|
+
args: tuple[typing.Any, int] | None,
|
|
229634
229677
|
space_type: str | None,
|
|
229635
229678
|
region_type: str | None,
|
|
229636
229679
|
) -> typing.Any:
|
|
@@ -229642,6 +229685,7 @@ class WindowManager(ID, bpy_struct):
|
|
|
229642
229685
|
It gets the specified arguments as input with the mouse position (tuple) as last argument.
|
|
229643
229686
|
:type callback: collections.abc.Callable | None
|
|
229644
229687
|
:param args: Arguments that will be passed to the callback.
|
|
229688
|
+
:type args: tuple[typing.Any, int] | None
|
|
229645
229689
|
:param space_type: The space type the callback draws in; for example VIEW_3D. (`bpy.types.Space.type`)
|
|
229646
229690
|
:type space_type: str | None
|
|
229647
229691
|
:param region_type: The region type the callback draws in; usually WINDOW. (`bpy.types.Region.type`)
|
bpy/utils/__init__.pyi
CHANGED
|
@@ -26,7 +26,9 @@ def app_template_paths(*, path: str | None = None):
|
|
|
26
26
|
:return: App template paths.
|
|
27
27
|
"""
|
|
28
28
|
|
|
29
|
-
def blend_paths(
|
|
29
|
+
def blend_paths(
|
|
30
|
+
absolute: bool = False, packed: bool = False, local: bool = False
|
|
31
|
+
) -> list[str]:
|
|
30
32
|
"""Returns a list of paths to external files referenced by the loaded .blend file.
|
|
31
33
|
|
|
32
34
|
:param absolute: When true the paths returned are made absolute.
|
|
@@ -36,6 +38,7 @@ def blend_paths(absolute: bool = False, packed: bool = False, local: bool = Fals
|
|
|
36
38
|
:param local: When true skip linked library paths.
|
|
37
39
|
:type local: bool
|
|
38
40
|
:return: path list.
|
|
41
|
+
:rtype: list[str]
|
|
39
42
|
"""
|
|
40
43
|
|
|
41
44
|
def escape_identifier(string: str) -> str:
|
|
@@ -125,7 +128,9 @@ def load_scripts_extensions(*, reload_scripts: bool = False):
|
|
|
125
128
|
:type reload_scripts: bool
|
|
126
129
|
"""
|
|
127
130
|
|
|
128
|
-
def make_rna_paths(
|
|
131
|
+
def make_rna_paths(
|
|
132
|
+
struct_name: str, prop_name: str, enum_name: str
|
|
133
|
+
) -> tuple[str, str, str]:
|
|
129
134
|
"""Create RNA "paths" from given names.
|
|
130
135
|
|
|
131
136
|
:param struct_name: Name of a RNA struct (like e.g. "Scene").
|
|
@@ -137,7 +142,7 @@ def make_rna_paths(struct_name: str, prop_name: str, enum_name: str) -> str:
|
|
|
137
142
|
:return: A triple of three "RNA paths"
|
|
138
143
|
(most_complete_path, "struct.prop", "struct.prop:'enum'").
|
|
139
144
|
If no enum_name is given, the third element will always be void.
|
|
140
|
-
:rtype: str
|
|
145
|
+
:rtype: tuple[str, str, str]
|
|
141
146
|
"""
|
|
142
147
|
|
|
143
148
|
def manual_language_code(default="en") -> str:
|
|
@@ -149,7 +154,7 @@ def manual_language_code(default="en") -> str:
|
|
|
149
154
|
"""
|
|
150
155
|
|
|
151
156
|
def manual_map(): ...
|
|
152
|
-
def modules_from_path(path: str, loaded_modules):
|
|
157
|
+
def modules_from_path(path: str, loaded_modules) -> list:
|
|
153
158
|
"""Load all modules in a path and return them as a list.
|
|
154
159
|
|
|
155
160
|
:param path: this path is scanned for scripts and packages.
|
|
@@ -157,15 +162,17 @@ def modules_from_path(path: str, loaded_modules):
|
|
|
157
162
|
:param loaded_modules: already loaded module names, files matching these
|
|
158
163
|
names will be ignored.
|
|
159
164
|
:return: all loaded modules.
|
|
165
|
+
:rtype: list
|
|
160
166
|
"""
|
|
161
167
|
|
|
162
168
|
def preset_find(name, preset_path, *, display_name=False, ext=".py"): ...
|
|
163
|
-
def preset_paths(subdir: str):
|
|
169
|
+
def preset_paths(subdir: str) -> list[str]:
|
|
164
170
|
"""Returns a list of paths for a specific preset.
|
|
165
171
|
|
|
166
172
|
:param subdir: preset subdirectory (must not be an absolute path).
|
|
167
173
|
:type subdir: str
|
|
168
174
|
:return: Script paths.
|
|
175
|
+
:rtype: list[str]
|
|
169
176
|
"""
|
|
170
177
|
|
|
171
178
|
def refresh_script_paths():
|
|
@@ -223,8 +230,8 @@ def register_preset_path(path: str) -> bool:
|
|
|
223
230
|
"""
|
|
224
231
|
|
|
225
232
|
def register_submodule_factory(
|
|
226
|
-
module_name: str, submodule_names
|
|
227
|
-
) -> collections.abc.Callable:
|
|
233
|
+
module_name: str, submodule_names: list[str]
|
|
234
|
+
) -> tuple[collections.abc.Callable, collections.abc.Callable]:
|
|
228
235
|
"""Utility function to create register and unregister functions
|
|
229
236
|
which simply load submodules,
|
|
230
237
|
calling their register & unregister functions.
|
|
@@ -232,8 +239,9 @@ def register_submodule_factory(
|
|
|
232
239
|
:param module_name: The module name, typically __name__.
|
|
233
240
|
:type module_name: str
|
|
234
241
|
:param submodule_names: List of submodule names to load and unload.
|
|
242
|
+
:type submodule_names: list[str]
|
|
235
243
|
:return: register and unregister functions.
|
|
236
|
-
:rtype: collections.abc.Callable
|
|
244
|
+
:rtype: tuple[collections.abc.Callable, collections.abc.Callable]
|
|
237
245
|
"""
|
|
238
246
|
|
|
239
247
|
def register_tool(
|
|
@@ -279,7 +287,7 @@ def script_paths(
|
|
|
279
287
|
check_all: bool = False,
|
|
280
288
|
use_user: bool = True,
|
|
281
289
|
use_system_environment: bool = True,
|
|
282
|
-
):
|
|
290
|
+
) -> list[str]:
|
|
283
291
|
"""Returns a list of valid script paths.
|
|
284
292
|
|
|
285
293
|
:param subdir: Optional subdir.
|
|
@@ -293,6 +301,7 @@ def script_paths(
|
|
|
293
301
|
:param use_system_environment: Include BLENDER_SYSTEM_SCRIPTS variable path
|
|
294
302
|
:type use_system_environment: bool
|
|
295
303
|
:return: script paths.
|
|
304
|
+
:rtype: list[str]
|
|
296
305
|
"""
|
|
297
306
|
|
|
298
307
|
def script_paths_pref():
|
|
@@ -2,12 +2,13 @@ import typing
|
|
|
2
2
|
import collections.abc
|
|
3
3
|
import typing_extensions
|
|
4
4
|
|
|
5
|
-
def bmesh_linked_uv_islands(bm, uv_layer):
|
|
5
|
+
def bmesh_linked_uv_islands(bm, uv_layer) -> list[list[int]]:
|
|
6
6
|
"""Returns lists of faces connected by UV islands.For meshes use `bpy.types.Mesh.mesh_linked_uv_islands` instead.
|
|
7
7
|
|
|
8
8
|
:param bm: the bmesh used to group with.
|
|
9
9
|
:param uv_layer: the UV layer to source UVs from.
|
|
10
10
|
:return: list of lists containing polygon indices
|
|
11
|
+
:rtype: list[list[int]]
|
|
11
12
|
"""
|
|
12
13
|
|
|
13
14
|
def match_uv(face, vert, uv, uv_layer): ...
|