fake-bpy-module 20241103__py3-none-any.whl → 20241112__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 +28 -13
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +1 -2
- bl_console_utils/autocomplete/complete_import/__init__.pyi +3 -6
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +1 -2
- bl_console_utils/autocomplete/intellisense/__init__.pyi +2 -6
- bl_operators/image_as_planes/__init__.pyi +12 -39
- bl_operators/uvcalc_transform/__init__.pyi +4 -42
- bl_operators/wm/__init__.pyi +8 -0
- bl_ui/generic_ui_list/__init__.pyi +2 -1
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -7
- bl_ui/space_userpref/__init__.pyi +2 -2
- blf/__init__.pyi +3 -5
- bmesh/types/__init__.pyi +22 -33
- bmesh/utils/__init__.pyi +6 -16
- bpy/app/icons/__init__.pyi +5 -11
- bpy/app/translations/__init__.pyi +7 -14
- bpy/msgbus/__init__.pyi +7 -8
- bpy/ops/curves/__init__.pyi +16 -0
- bpy/ops/nla/__init__.pyi +1 -1
- bpy/ops/sequencer/__init__.pyi +3 -0
- bpy/path/__init__.pyi +6 -16
- bpy/props/__init__.pyi +122 -135
- bpy/types/__init__.pyi +418 -615
- bpy/typing/__init__.pyi +1 -1
- bpy/utils/__init__.pyi +30 -29
- bpy/utils/previews/__init__.pyi +1 -2
- bpy/utils/units/__init__.pyi +1 -2
- bpy_extras/anim_utils/__init__.pyi +5 -12
- bpy_extras/bmesh_utils/__init__.pyi +1 -2
- bpy_extras/image_utils/__init__.pyi +2 -5
- bpy_extras/io_utils/__init__.pyi +8 -14
- bpy_extras/mesh_utils/__init__.pyi +14 -29
- bpy_extras/object_utils/__init__.pyi +1 -1
- bpy_extras/view3d_utils/__init__.pyi +3 -10
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/METADATA +1 -1
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/RECORD +57 -57
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/WHEEL +1 -1
- freestyle/chainingiterators/__init__.pyi +2 -7
- freestyle/functions/__init__.pyi +4 -16
- freestyle/types/__init__.pyi +29 -63
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +1 -2
- gpu/__init__.pyi +19 -5
- gpu/matrix/__init__.pyi +2 -2
- gpu/state/__init__.pyi +16 -8
- gpu/types/__init__.pyi +14 -29
- gpu_extras/batch/__init__.pyi +9 -9
- gpu_extras/presets/__init__.pyi +4 -11
- idprop/types/__init__.pyi +1 -2
- imbuf/__init__.pyi +2 -4
- mathutils/__init__.pyi +30 -95
- mathutils/bvhtree/__init__.pyi +13 -17
- mathutils/geometry/__init__.pyi +26 -45
- mathutils/interpolate/__init__.pyi +2 -2
- mathutils/kdtree/__init__.pyi +13 -28
- rna_info/__init__.pyi +1 -2
- {fake_bpy_module-20241103.dist-info → fake_bpy_module-20241112.dist-info}/top_level.txt +0 -0
bpy/props/__init__.pyi
CHANGED
|
@@ -71,7 +71,11 @@ of the operator, only its other properties.
|
|
|
71
71
|
|
|
72
72
|
Getter/setter functions can be used for boolean, int, float, string and enum properties.
|
|
73
73
|
If these callbacks are defined the property will not be stored in the ID properties
|
|
74
|
-
automatically. Instead, the get
|
|
74
|
+
automatically. Instead, the get
|
|
75
|
+
|
|
76
|
+
and set
|
|
77
|
+
|
|
78
|
+
functions will be called when the property
|
|
75
79
|
is respectively read or written from the API.
|
|
76
80
|
|
|
77
81
|
[WARNING]
|
|
@@ -99,13 +103,13 @@ def BoolProperty(
|
|
|
99
103
|
description: str | None = "",
|
|
100
104
|
translation_context: str | None = "*",
|
|
101
105
|
default=False,
|
|
102
|
-
options:
|
|
103
|
-
override:
|
|
104
|
-
tags
|
|
106
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
107
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
108
|
+
tags=set(),
|
|
105
109
|
subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
|
|
106
|
-
update:
|
|
107
|
-
get:
|
|
108
|
-
set:
|
|
110
|
+
update: collections.abc.Callable | None = None,
|
|
111
|
+
get: collections.abc.Callable | None = None,
|
|
112
|
+
set: collections.abc.Callable | None = None,
|
|
109
113
|
):
|
|
110
114
|
"""Returns a new boolean property definition.
|
|
111
115
|
|
|
@@ -116,23 +120,22 @@ def BoolProperty(
|
|
|
116
120
|
:param translation_context: Text used as context to disambiguate translations.
|
|
117
121
|
:type translation_context: str | None
|
|
118
122
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
119
|
-
:type options:
|
|
123
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
120
124
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
121
|
-
:type override:
|
|
125
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
122
126
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
123
|
-
:type tags: set | None
|
|
124
127
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
125
128
|
:type subtype: bpy.typing.PropertySubtypeNumberItems
|
|
126
129
|
:param update: Function to be called when this value is modified,
|
|
127
130
|
This function must take 2 values (self, context) and return None.
|
|
128
131
|
Warning there are no safety checks to avoid infinite recursion.
|
|
129
|
-
:type update:
|
|
132
|
+
:type update: collections.abc.Callable | None
|
|
130
133
|
:param get: Function to be called when this value is 'read',
|
|
131
134
|
This function must take 1 value (self) and return the value of the property.
|
|
132
|
-
:type get:
|
|
135
|
+
:type get: collections.abc.Callable | None
|
|
133
136
|
:param set: Function to be called when this value is 'written',
|
|
134
137
|
This function must take 2 values (self, value) and return None.
|
|
135
|
-
:type set:
|
|
138
|
+
:type set: collections.abc.Callable | None
|
|
136
139
|
"""
|
|
137
140
|
|
|
138
141
|
def BoolVectorProperty(
|
|
@@ -140,15 +143,15 @@ def BoolVectorProperty(
|
|
|
140
143
|
name: str | None = "",
|
|
141
144
|
description: str | None = "",
|
|
142
145
|
translation_context: str | None = "*",
|
|
143
|
-
default
|
|
144
|
-
options:
|
|
145
|
-
override:
|
|
146
|
-
tags
|
|
146
|
+
default=(False, False, False),
|
|
147
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
148
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
149
|
+
tags=set(),
|
|
147
150
|
subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
|
|
148
|
-
size
|
|
149
|
-
update:
|
|
150
|
-
get:
|
|
151
|
-
set:
|
|
151
|
+
size=3,
|
|
152
|
+
update: collections.abc.Callable | None = None,
|
|
153
|
+
get: collections.abc.Callable | None = None,
|
|
154
|
+
set: collections.abc.Callable | None = None,
|
|
152
155
|
):
|
|
153
156
|
"""Returns a new vector boolean property definition.
|
|
154
157
|
|
|
@@ -159,42 +162,40 @@ def BoolVectorProperty(
|
|
|
159
162
|
:param translation_context: Text used as context to disambiguate translations.
|
|
160
163
|
:type translation_context: str | None
|
|
161
164
|
:param default: sequence of booleans the length of size.
|
|
162
|
-
:type default: collections.abc.Sequence | None
|
|
163
165
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
164
|
-
:type options:
|
|
166
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
165
167
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
166
|
-
:type override:
|
|
168
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
167
169
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
168
|
-
:type tags: set | None
|
|
169
170
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
170
171
|
:type subtype: bpy.typing.PropertySubtypeNumberArrayItems
|
|
171
172
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
172
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
173
173
|
:param update: Function to be called when this value is modified,
|
|
174
174
|
This function must take 2 values (self, context) and return None.
|
|
175
175
|
Warning there are no safety checks to avoid infinite recursion.
|
|
176
|
-
:type update:
|
|
176
|
+
:type update: collections.abc.Callable | None
|
|
177
177
|
:param get: Function to be called when this value is 'read',
|
|
178
178
|
This function must take 1 value (self) and return the value of the property.
|
|
179
|
-
:type get:
|
|
179
|
+
:type get: collections.abc.Callable | None
|
|
180
180
|
:param set: Function to be called when this value is 'written',
|
|
181
181
|
This function must take 2 values (self, value) and return None.
|
|
182
|
-
:type set:
|
|
182
|
+
:type set: collections.abc.Callable | None
|
|
183
183
|
"""
|
|
184
184
|
|
|
185
185
|
def CollectionProperty(
|
|
186
186
|
*,
|
|
187
|
-
type=None,
|
|
187
|
+
type: bpy.types.PropertyGroup | None = None,
|
|
188
188
|
name: str | None = "",
|
|
189
189
|
description: str | None = "",
|
|
190
190
|
translation_context: str | None = "*",
|
|
191
|
-
options:
|
|
192
|
-
override:
|
|
193
|
-
tags
|
|
191
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
192
|
+
override: bpy.typing.PropertyOverrideFlagCollectionItems = set(),
|
|
193
|
+
tags=set(),
|
|
194
194
|
):
|
|
195
195
|
"""Returns a new collection property definition.
|
|
196
196
|
|
|
197
|
-
:param type: A subclass of
|
|
197
|
+
:param type: A subclass of a property group.
|
|
198
|
+
:type type: bpy.types.PropertyGroup | None
|
|
198
199
|
:param name: Name used in the user interface.
|
|
199
200
|
:type name: str | None
|
|
200
201
|
:param description: Text used for the tooltip and api documentation.
|
|
@@ -202,11 +203,10 @@ def CollectionProperty(
|
|
|
202
203
|
:param translation_context: Text used as context to disambiguate translations.
|
|
203
204
|
:type translation_context: str | None
|
|
204
205
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
205
|
-
:type options:
|
|
206
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
206
207
|
:param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
|
|
207
|
-
:type override:
|
|
208
|
+
:type override: bpy.typing.PropertyOverrideFlagCollectionItems
|
|
208
209
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
209
|
-
:type tags: set | None
|
|
210
210
|
"""
|
|
211
211
|
|
|
212
212
|
def EnumProperty(
|
|
@@ -229,13 +229,13 @@ def EnumProperty(
|
|
|
229
229
|
name: str | None = "",
|
|
230
230
|
description: str | None = "",
|
|
231
231
|
translation_context: str | None = "*",
|
|
232
|
-
default
|
|
233
|
-
options:
|
|
234
|
-
override:
|
|
235
|
-
tags
|
|
236
|
-
update:
|
|
237
|
-
get:
|
|
238
|
-
set:
|
|
232
|
+
default=None,
|
|
233
|
+
options: bpy.typing.PropertyFlagEnumItems = {"ANIMATABLE"},
|
|
234
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
235
|
+
tags=set(),
|
|
236
|
+
update: collections.abc.Callable | None = None,
|
|
237
|
+
get: collections.abc.Callable | None = None,
|
|
238
|
+
set: collections.abc.Callable | None = None,
|
|
239
239
|
):
|
|
240
240
|
"""Returns a new enumerator property definition.
|
|
241
241
|
|
|
@@ -288,23 +288,21 @@ def EnumProperty(
|
|
|
288
288
|
If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
|
|
289
289
|
WARNING: Strings cannot be specified for dynamic enums
|
|
290
290
|
(i.e. if a callback function is given as items parameter).
|
|
291
|
-
:type default: int | set | str | None
|
|
292
291
|
:param options: Enumerator in `rna_enum_property_flag_enum_items`.
|
|
293
|
-
:type options:
|
|
292
|
+
:type options: bpy.typing.PropertyFlagEnumItems
|
|
294
293
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
295
|
-
:type override:
|
|
294
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
296
295
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
297
|
-
:type tags: set | None
|
|
298
296
|
:param update: Function to be called when this value is modified,
|
|
299
297
|
This function must take 2 values (self, context) and return None.
|
|
300
298
|
Warning there are no safety checks to avoid infinite recursion.
|
|
301
|
-
:type update:
|
|
299
|
+
:type update: collections.abc.Callable | None
|
|
302
300
|
:param get: Function to be called when this value is 'read',
|
|
303
301
|
This function must take 1 value (self) and return the value of the property.
|
|
304
|
-
:type get:
|
|
302
|
+
:type get: collections.abc.Callable | None
|
|
305
303
|
:param set: Function to be called when this value is 'written',
|
|
306
304
|
This function must take 2 values (self, value) and return None.
|
|
307
|
-
:type set:
|
|
305
|
+
:type set: collections.abc.Callable | None
|
|
308
306
|
"""
|
|
309
307
|
|
|
310
308
|
def FloatProperty(
|
|
@@ -319,14 +317,14 @@ def FloatProperty(
|
|
|
319
317
|
soft_max: float | None = 3.402823e38,
|
|
320
318
|
step: int | None = 3,
|
|
321
319
|
precision: int | None = 2,
|
|
322
|
-
options:
|
|
323
|
-
override:
|
|
324
|
-
tags
|
|
320
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
321
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
322
|
+
tags=set(),
|
|
325
323
|
subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
|
|
326
324
|
unit: bpy.typing.PropertyUnitItems = "NONE",
|
|
327
|
-
update:
|
|
328
|
-
get:
|
|
329
|
-
set:
|
|
325
|
+
update: collections.abc.Callable | None = None,
|
|
326
|
+
get: collections.abc.Callable | None = None,
|
|
327
|
+
set: collections.abc.Callable | None = None,
|
|
330
328
|
):
|
|
331
329
|
"""Returns a new float (single precision) property definition.
|
|
332
330
|
|
|
@@ -349,11 +347,10 @@ def FloatProperty(
|
|
|
349
347
|
:param precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame count) and step divisible by 100.
|
|
350
348
|
:type precision: int | None
|
|
351
349
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
352
|
-
:type options:
|
|
350
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
353
351
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
354
|
-
:type override:
|
|
352
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
355
353
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
356
|
-
:type tags: set | None
|
|
357
354
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
358
355
|
:type subtype: bpy.typing.PropertySubtypeNumberItems
|
|
359
356
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
@@ -361,13 +358,13 @@ def FloatProperty(
|
|
|
361
358
|
:param update: Function to be called when this value is modified,
|
|
362
359
|
This function must take 2 values (self, context) and return None.
|
|
363
360
|
Warning there are no safety checks to avoid infinite recursion.
|
|
364
|
-
:type update:
|
|
361
|
+
:type update: collections.abc.Callable | None
|
|
365
362
|
:param get: Function to be called when this value is 'read',
|
|
366
363
|
This function must take 1 value (self) and return the value of the property.
|
|
367
|
-
:type get:
|
|
364
|
+
:type get: collections.abc.Callable | None
|
|
368
365
|
:param set: Function to be called when this value is 'written',
|
|
369
366
|
This function must take 2 values (self, value) and return None.
|
|
370
|
-
:type set:
|
|
367
|
+
:type set: collections.abc.Callable | None
|
|
371
368
|
"""
|
|
372
369
|
|
|
373
370
|
def FloatVectorProperty(
|
|
@@ -375,22 +372,22 @@ def FloatVectorProperty(
|
|
|
375
372
|
name: str | None = "",
|
|
376
373
|
description: str | None = "",
|
|
377
374
|
translation_context: str | None = "*",
|
|
378
|
-
default
|
|
375
|
+
default=(0.0, 0.0, 0.0),
|
|
379
376
|
min: float | None = sys.float_info.min,
|
|
380
377
|
max: float | None = sys.float_info.max,
|
|
381
378
|
soft_min: float | None = sys.float_info.min,
|
|
382
379
|
soft_max: float | None = sys.float_info.max,
|
|
383
380
|
step: int | None = 3,
|
|
384
381
|
precision: int | None = 2,
|
|
385
|
-
options:
|
|
386
|
-
override:
|
|
387
|
-
tags
|
|
382
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
383
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
384
|
+
tags=set(),
|
|
388
385
|
subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
|
|
389
386
|
unit: bpy.typing.PropertyUnitItems = "NONE",
|
|
390
|
-
size
|
|
391
|
-
update:
|
|
392
|
-
get:
|
|
393
|
-
set:
|
|
387
|
+
size=3,
|
|
388
|
+
update: collections.abc.Callable | None = None,
|
|
389
|
+
get: collections.abc.Callable | None = None,
|
|
390
|
+
set: collections.abc.Callable | None = None,
|
|
394
391
|
):
|
|
395
392
|
"""Returns a new vector float property definition.
|
|
396
393
|
|
|
@@ -400,8 +397,7 @@ def FloatVectorProperty(
|
|
|
400
397
|
:type description: str | None
|
|
401
398
|
:param translation_context: Text used as context to disambiguate translations.
|
|
402
399
|
:type translation_context: str | None
|
|
403
|
-
:param default:
|
|
404
|
-
:type default: collections.abc.Sequence | None
|
|
400
|
+
:param default: Sequence of floats the length of size.
|
|
405
401
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
406
402
|
:type min: float | None
|
|
407
403
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
@@ -415,27 +411,25 @@ def FloatVectorProperty(
|
|
|
415
411
|
:param precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame count) and step divisible by 100.
|
|
416
412
|
:type precision: int | None
|
|
417
413
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
418
|
-
:type options:
|
|
414
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
419
415
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
420
|
-
:type override:
|
|
416
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
421
417
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
422
|
-
:type tags: set | None
|
|
423
418
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
424
419
|
:type subtype: bpy.typing.PropertySubtypeNumberArrayItems
|
|
425
420
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
426
421
|
:type unit: bpy.typing.PropertyUnitItems
|
|
427
422
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
428
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
429
423
|
:param update: Function to be called when this value is modified,
|
|
430
424
|
This function must take 2 values (self, context) and return None.
|
|
431
425
|
Warning there are no safety checks to avoid infinite recursion.
|
|
432
|
-
:type update:
|
|
426
|
+
:type update: collections.abc.Callable | None
|
|
433
427
|
:param get: Function to be called when this value is 'read',
|
|
434
428
|
This function must take 1 value (self) and return the value of the property.
|
|
435
|
-
:type get:
|
|
429
|
+
:type get: collections.abc.Callable | None
|
|
436
430
|
:param set: Function to be called when this value is 'written',
|
|
437
431
|
This function must take 2 values (self, value) and return None.
|
|
438
|
-
:type set:
|
|
432
|
+
:type set: collections.abc.Callable | None
|
|
439
433
|
"""
|
|
440
434
|
|
|
441
435
|
def IntProperty(
|
|
@@ -449,13 +443,13 @@ def IntProperty(
|
|
|
449
443
|
soft_min: int | None = None,
|
|
450
444
|
soft_max: int | None = None,
|
|
451
445
|
step: int | None = 1,
|
|
452
|
-
options:
|
|
453
|
-
override:
|
|
454
|
-
tags
|
|
446
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
447
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
448
|
+
tags=set(),
|
|
455
449
|
subtype: bpy.typing.PropertySubtypeNumberItems = "NONE",
|
|
456
|
-
update:
|
|
457
|
-
get:
|
|
458
|
-
set:
|
|
450
|
+
update: collections.abc.Callable | None = None,
|
|
451
|
+
get: collections.abc.Callable | None = None,
|
|
452
|
+
set: collections.abc.Callable | None = None,
|
|
459
453
|
):
|
|
460
454
|
"""Returns a new int property definition.
|
|
461
455
|
|
|
@@ -476,23 +470,22 @@ def IntProperty(
|
|
|
476
470
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
477
471
|
:type step: int | None
|
|
478
472
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
479
|
-
:type options:
|
|
473
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
480
474
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
481
|
-
:type override:
|
|
475
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
482
476
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
483
|
-
:type tags: set | None
|
|
484
477
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
485
478
|
:type subtype: bpy.typing.PropertySubtypeNumberItems
|
|
486
479
|
:param update: Function to be called when this value is modified,
|
|
487
480
|
This function must take 2 values (self, context) and return None.
|
|
488
481
|
Warning there are no safety checks to avoid infinite recursion.
|
|
489
|
-
:type update:
|
|
482
|
+
:type update: collections.abc.Callable | None
|
|
490
483
|
:param get: Function to be called when this value is 'read',
|
|
491
484
|
This function must take 1 value (self) and return the value of the property.
|
|
492
|
-
:type get:
|
|
485
|
+
:type get: collections.abc.Callable | None
|
|
493
486
|
:param set: Function to be called when this value is 'written',
|
|
494
487
|
This function must take 2 values (self, value) and return None.
|
|
495
|
-
:type set:
|
|
488
|
+
:type set: collections.abc.Callable | None
|
|
496
489
|
"""
|
|
497
490
|
|
|
498
491
|
def IntVectorProperty(
|
|
@@ -500,20 +493,20 @@ def IntVectorProperty(
|
|
|
500
493
|
name: str | None = "",
|
|
501
494
|
description: str | None = "",
|
|
502
495
|
translation_context: str | None = "*",
|
|
503
|
-
default
|
|
496
|
+
default=(0, 0, 0),
|
|
504
497
|
min: int | None = None,
|
|
505
498
|
max: int | None = None,
|
|
506
499
|
soft_min: int | None = None,
|
|
507
500
|
soft_max: int | None = None,
|
|
508
501
|
step: int | None = 1,
|
|
509
|
-
options:
|
|
510
|
-
override:
|
|
511
|
-
tags
|
|
502
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
503
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
504
|
+
tags=set(),
|
|
512
505
|
subtype: bpy.typing.PropertySubtypeNumberArrayItems = "NONE",
|
|
513
|
-
size
|
|
514
|
-
update:
|
|
515
|
-
get:
|
|
516
|
-
set:
|
|
506
|
+
size=3,
|
|
507
|
+
update: collections.abc.Callable | None = None,
|
|
508
|
+
get: collections.abc.Callable | None = None,
|
|
509
|
+
set: collections.abc.Callable | None = None,
|
|
517
510
|
):
|
|
518
511
|
"""Returns a new vector int property definition.
|
|
519
512
|
|
|
@@ -524,7 +517,6 @@ def IntVectorProperty(
|
|
|
524
517
|
:param translation_context: Text used as context to disambiguate translations.
|
|
525
518
|
:type translation_context: str | None
|
|
526
519
|
:param default: sequence of ints the length of size.
|
|
527
|
-
:type default: collections.abc.Sequence | None
|
|
528
520
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
529
521
|
:type min: int | None
|
|
530
522
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
@@ -536,25 +528,23 @@ def IntVectorProperty(
|
|
|
536
528
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
537
529
|
:type step: int | None
|
|
538
530
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
539
|
-
:type options:
|
|
531
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
540
532
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
541
|
-
:type override:
|
|
533
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
542
534
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
543
|
-
:type tags: set | None
|
|
544
535
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
545
536
|
:type subtype: bpy.typing.PropertySubtypeNumberArrayItems
|
|
546
537
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
547
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
548
538
|
:param update: Function to be called when this value is modified,
|
|
549
539
|
This function must take 2 values (self, context) and return None.
|
|
550
540
|
Warning there are no safety checks to avoid infinite recursion.
|
|
551
|
-
:type update:
|
|
541
|
+
:type update: collections.abc.Callable | None
|
|
552
542
|
:param get: Function to be called when this value is 'read',
|
|
553
543
|
This function must take 1 value (self) and return the value of the property.
|
|
554
|
-
:type get:
|
|
544
|
+
:type get: collections.abc.Callable | None
|
|
555
545
|
:param set: Function to be called when this value is 'written',
|
|
556
546
|
This function must take 2 values (self, value) and return None.
|
|
557
|
-
:type set:
|
|
547
|
+
:type set: collections.abc.Callable | None
|
|
558
548
|
"""
|
|
559
549
|
|
|
560
550
|
def PointerProperty(
|
|
@@ -563,15 +553,15 @@ def PointerProperty(
|
|
|
563
553
|
name: str | None = "",
|
|
564
554
|
description: str | None = "",
|
|
565
555
|
translation_context: str | None = "*",
|
|
566
|
-
options:
|
|
567
|
-
override:
|
|
568
|
-
tags
|
|
569
|
-
poll:
|
|
570
|
-
update:
|
|
556
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
557
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
558
|
+
tags=set(),
|
|
559
|
+
poll: collections.abc.Callable | None = None,
|
|
560
|
+
update: collections.abc.Callable | None = None,
|
|
571
561
|
):
|
|
572
562
|
"""Returns a new pointer property definition.
|
|
573
563
|
|
|
574
|
-
:param type: A subclass of
|
|
564
|
+
:param type: A subclass of a property group or ID types.
|
|
575
565
|
:param name: Name used in the user interface.
|
|
576
566
|
:type name: str | None
|
|
577
567
|
:param description: Text used for the tooltip and api documentation.
|
|
@@ -579,18 +569,17 @@ def PointerProperty(
|
|
|
579
569
|
:param translation_context: Text used as context to disambiguate translations.
|
|
580
570
|
:type translation_context: str | None
|
|
581
571
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
582
|
-
:type options:
|
|
572
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
583
573
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
584
|
-
:type override:
|
|
574
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
585
575
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
586
|
-
:type tags: set | None
|
|
587
576
|
:param poll: function to be called to determine whether an item is valid for this property.
|
|
588
577
|
The function must take 2 values (self, object) and return Bool.
|
|
589
|
-
:type poll:
|
|
578
|
+
:type poll: collections.abc.Callable | None
|
|
590
579
|
:param update: Function to be called when this value is modified,
|
|
591
580
|
This function must take 2 values (self, context) and return None.
|
|
592
581
|
Warning there are no safety checks to avoid infinite recursion.
|
|
593
|
-
:type update:
|
|
582
|
+
:type update: collections.abc.Callable | None
|
|
594
583
|
"""
|
|
595
584
|
|
|
596
585
|
def RemoveProperty(*, cls: typing.Any | None, attr: str | None):
|
|
@@ -609,15 +598,15 @@ def StringProperty(
|
|
|
609
598
|
translation_context: str | None = "*",
|
|
610
599
|
default: str | None = "",
|
|
611
600
|
maxlen: int | None = 0,
|
|
612
|
-
options:
|
|
613
|
-
override:
|
|
614
|
-
tags
|
|
601
|
+
options: bpy.typing.PropertyFlagItems = {"ANIMATABLE"},
|
|
602
|
+
override: bpy.typing.PropertyOverrideFlagItems = set(),
|
|
603
|
+
tags=set(),
|
|
615
604
|
subtype: bpy.typing.PropertySubtypeStringItems = "NONE",
|
|
616
|
-
update:
|
|
617
|
-
get:
|
|
618
|
-
set:
|
|
619
|
-
search:
|
|
620
|
-
search_options
|
|
605
|
+
update: collections.abc.Callable | None = None,
|
|
606
|
+
get: collections.abc.Callable | None = None,
|
|
607
|
+
set: collections.abc.Callable | None = None,
|
|
608
|
+
search: collections.abc.Callable | None = None,
|
|
609
|
+
search_options={"SUGGESTION"},
|
|
621
610
|
):
|
|
622
611
|
"""Returns a new string property definition.
|
|
623
612
|
|
|
@@ -632,23 +621,22 @@ def StringProperty(
|
|
|
632
621
|
:param maxlen: maximum length of the string.
|
|
633
622
|
:type maxlen: int | None
|
|
634
623
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
635
|
-
:type options:
|
|
624
|
+
:type options: bpy.typing.PropertyFlagItems
|
|
636
625
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
637
|
-
:type override:
|
|
626
|
+
:type override: bpy.typing.PropertyOverrideFlagItems
|
|
638
627
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
639
|
-
:type tags: set | None
|
|
640
628
|
:param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
|
|
641
629
|
:type subtype: bpy.typing.PropertySubtypeStringItems
|
|
642
630
|
:param update: Function to be called when this value is modified,
|
|
643
631
|
This function must take 2 values (self, context) and return None.
|
|
644
632
|
Warning there are no safety checks to avoid infinite recursion.
|
|
645
|
-
:type update:
|
|
633
|
+
:type update: collections.abc.Callable | None
|
|
646
634
|
:param get: Function to be called when this value is 'read',
|
|
647
635
|
This function must take 1 value (self) and return the value of the property.
|
|
648
|
-
:type get:
|
|
636
|
+
:type get: collections.abc.Callable | None
|
|
649
637
|
:param set: Function to be called when this value is 'written',
|
|
650
638
|
This function must take 2 values (self, value) and return None.
|
|
651
|
-
:type set:
|
|
639
|
+
:type set: collections.abc.Callable | None
|
|
652
640
|
:param search: Function to be called to show candidates for this string (shown in the UI).
|
|
653
641
|
This function must take 3 values (self, context, edit_text)
|
|
654
642
|
and return a sequence, iterator or generator where each item must be:
|
|
@@ -657,7 +645,7 @@ def StringProperty(
|
|
|
657
645
|
|
|
658
646
|
A tuple-pair of strings, where the first is a candidate and the second
|
|
659
647
|
is additional information about the candidate.
|
|
660
|
-
:type search:
|
|
648
|
+
:type search: collections.abc.Callable | None
|
|
661
649
|
:param search_options: Set of strings in:
|
|
662
650
|
|
|
663
651
|
'SORT' sorts the resulting items.
|
|
@@ -665,5 +653,4 @@ def StringProperty(
|
|
|
665
653
|
'SUGGESTION' lets the user enter values not found in search candidates.
|
|
666
654
|
WARNING disabling this flag causes the search callback to run on redraw,
|
|
667
655
|
so only disable this flag if it's not likely to cause performance issues.
|
|
668
|
-
:type search_options: set | None
|
|
669
656
|
"""
|