fake-bge-module 20250104__py3-none-any.whl → 20250201__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.
- addon_utils/__init__.pyi +11 -6
- aud/__init__.pyi +4 -0
- bge/types/__init__.pyi +66 -27
- bgl/__init__.pyi +2 -2
- bgui/image/__init__.pyi +3 -1
- bgui/system/__init__.pyi +12 -4
- 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
- bl_operators/node/__init__.pyi +78 -0
- bl_ui/anim/__init__.pyi +6 -0
- bl_ui/generic_ui_list/__init__.pyi +2 -2
- bl_ui/node_add_menu_shader/__init__.pyi +0 -1
- bl_ui/node_add_menu_texture/__init__.pyi +1 -0
- bl_ui/properties_data_camera/__init__.pyi +0 -2
- bl_ui/properties_mask_common/__init__.pyi +17 -0
- bl_ui/properties_material_gpencil/__init__.pyi +29 -0
- bl_ui/properties_scene/__init__.pyi +6 -0
- bl_ui/properties_view_layer/__init__.pyi +1 -0
- bl_ui/space_clip/__init__.pyi +53 -0
- bl_ui/space_graph/__init__.pyi +2 -0
- bl_ui/space_image/__init__.pyi +25 -0
- bl_ui/space_node/__init__.pyi +0 -1
- bl_ui/space_sequencer/__init__.pyi +2 -1
- blf/__init__.pyi +6 -3
- bmesh/ops/__init__.pyi +111 -54
- bmesh/types/__init__.pyi +134 -46
- bmesh/utils/__init__.pyi +17 -5
- bpy/__init__.pyi +1 -2
- bpy/_typing/__init__.pyi +4 -0
- bpy/{typing → _typing/rna_enums}/__init__.pyi +36 -36
- bpy/app/__init__.pyi +13 -5
- bpy/app/handlers/__init__.pyi +4 -2
- bpy/app/icons/__init__.pyi +6 -2
- bpy/app/translations/__init__.pyi +17 -8
- bpy/msgbus/__init__.pyi +14 -2
- bpy/ops/action/__init__.pyi +51 -151
- 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 +11 -44
- bpy/ops/brush/__init__.pyi +16 -42
- 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 +95 -293
- bpy/ops/cloth/__init__.pyi +1 -3
- bpy/ops/collection/__init__.pyi +10 -26
- bpy/ops/console/__init__.pyi +21 -79
- bpy/ops/constraint/__init__.pyi +18 -45
- bpy/ops/curve/__init__.pyi +57 -186
- bpy/ops/curves/__init__.pyi +37 -109
- bpy/ops/cycles/__init__.pyi +3 -9
- bpy/ops/dpaint/__init__.pyi +8 -22
- bpy/ops/ed/__init__.pyi +20 -52
- bpy/ops/export_anim/__init__.pyi +1 -3
- bpy/ops/export_scene/__init__.pyi +55 -32
- 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 +29 -46
- bpy/ops/gizmogroup/__init__.pyi +2 -9
- bpy/ops/gpencil/__init__.pyi +8 -32
- bpy/ops/graph/__init__.pyi +82 -201
- bpy/ops/grease_pencil/__init__.pyi +125 -324
- bpy/ops/image/__init__.pyi +61 -163
- bpy/ops/import_anim/__init__.pyi +1 -3
- bpy/ops/import_curve/__init__.pyi +1 -3
- bpy/ops/import_scene/__init__.pyi +4 -6
- bpy/ops/info/__init__.pyi +7 -29
- bpy/ops/lattice/__init__.pyi +11 -32
- bpy/ops/logic/__init__.pyi +26 -65
- 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 +223 -470
- bpy/ops/nla/__init__.pyi +42 -150
- bpy/ops/node/__init__.pyi +169 -393
- bpy/ops/object/__init__.pyi +320 -749
- bpy/ops/outliner/__init__.pyi +76 -268
- bpy/ops/paint/__init__.pyi +67 -147
- bpy/ops/paintcurve/__init__.pyi +8 -33
- bpy/ops/palette/__init__.pyi +7 -27
- bpy/ops/particle/__init__.pyi +39 -134
- bpy/ops/pose/__init__.pyi +64 -182
- 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 +22 -54
- bpy/ops/scene/__init__.pyi +47 -130
- bpy/ops/screen/__init__.pyi +46 -144
- bpy/ops/script/__init__.pyi +3 -11
- bpy/ops/sculpt/__init__.pyi +40 -94
- bpy/ops/sculpt_curves/__init__.pyi +4 -10
- bpy/ops/sequencer/__init__.pyi +104 -327
- bpy/ops/sound/__init__.pyi +17 -28
- 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 +114 -134
- bpy/ops/ui/__init__.pyi +39 -120
- bpy/ops/uilist/__init__.pyi +3 -7
- bpy/ops/uv/__init__.pyi +58 -143
- bpy/ops/view2d/__init__.pyi +14 -39
- bpy/ops/view3d/__init__.pyi +68 -238
- bpy/ops/wm/__init__.pyi +178 -319
- bpy/ops/workspace/__init__.pyi +7 -33
- bpy/ops/world/__init__.pyi +2 -11
- bpy/path/__init__.pyi +16 -6
- bpy/props/__init__.pyi +157 -127
- bpy/types/__init__.pyi +35227 -34838
- bpy/utils/__init__.pyi +71 -25
- bpy/utils/previews/__init__.pyi +2 -1
- bpy/utils/units/__init__.pyi +2 -1
- bpy_extras/anim_utils/__init__.pyi +11 -3
- bpy_extras/bmesh_utils/__init__.pyi +2 -1
- bpy_extras/image_utils/__init__.pyi +5 -2
- bpy_extras/io_utils/__init__.pyi +12 -5
- bpy_extras/mesh_utils/__init__.pyi +27 -6
- bpy_extras/object_utils/__init__.pyi +6 -5
- bpy_extras/view3d_utils/__init__.pyi +9 -2
- {fake_bge_module-20250104.dist-info → fake_bge_module-20250201.dist-info}/METADATA +3 -3
- {fake_bge_module-20250104.dist-info → fake_bge_module-20250201.dist-info}/RECORD +153 -152
- {fake_bge_module-20250104.dist-info → fake_bge_module-20250201.dist-info}/WHEEL +1 -1
- freestyle/chainingiterators/__init__.pyi +7 -2
- freestyle/functions/__init__.pyi +16 -4
- freestyle/shaders/__init__.pyi +5 -1
- freestyle/types/__init__.pyi +103 -30
- freestyle/utils/ContextFunctions/__init__.pyi +2 -2
- freestyle/utils/__init__.pyi +2 -1
- gpu/capabilities/__init__.pyi +2 -1
- gpu/matrix/__init__.pyi +4 -2
- gpu/state/__init__.pyi +2 -2
- gpu/types/__init__.pyi +40 -8
- gpu_extras/batch/__init__.pyi +13 -1
- gpu_extras/presets/__init__.pyi +10 -1
- idprop/types/__init__.pyi +4 -2
- imbuf/__init__.pyi +6 -3
- imbuf/types/__init__.pyi +5 -2
- mathutils/__init__.pyi +126 -35
- mathutils/bvhtree/__init__.pyi +21 -6
- mathutils/geometry/__init__.pyi +68 -22
- mathutils/interpolate/__init__.pyi +5 -1
- mathutils/kdtree/__init__.pyi +21 -8
- mathutils/noise/__init__.pyi +2 -1
- rna_info/__init__.pyi +2 -1
- {fake_bge_module-20250104.dist-info → fake_bge_module-20250201.dist-info}/top_level.txt +0 -0
bpy/props/__init__.pyi
CHANGED
|
@@ -26,7 +26,7 @@ When accessing external non-Blender data, thread safety mechanisms should be con
|
|
|
26
26
|
|
|
27
27
|
A common use of custom properties is for python based Operator
|
|
28
28
|
classes. Test this code by running it in the text editor, or by clicking the
|
|
29
|
-
button in the 3D
|
|
29
|
+
button in the 3D View-port's Tools panel. The latter will show the properties
|
|
30
30
|
in the Redo panel and allow you to change them.
|
|
31
31
|
|
|
32
32
|
```../examples/bpy.props.1.py```
|
|
@@ -98,8 +98,8 @@ Instead use del cls.attr
|
|
|
98
98
|
import typing
|
|
99
99
|
import collections.abc
|
|
100
100
|
import typing_extensions
|
|
101
|
+
import bpy._typing.rna_enums
|
|
101
102
|
import bpy.types
|
|
102
|
-
import bpy.typing
|
|
103
103
|
|
|
104
104
|
def BoolProperty(
|
|
105
105
|
*,
|
|
@@ -107,13 +107,14 @@ def BoolProperty(
|
|
|
107
107
|
description: str | None = "",
|
|
108
108
|
translation_context: str | None = "*",
|
|
109
109
|
default=False,
|
|
110
|
-
options: bpy.
|
|
111
|
-
override: bpy.
|
|
110
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
111
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
112
112
|
tags=set(),
|
|
113
|
-
subtype: bpy.
|
|
114
|
-
update: collections.abc.Callable
|
|
115
|
-
|
|
116
|
-
|
|
113
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
114
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
115
|
+
| None = None,
|
|
116
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], bool] | None = None,
|
|
117
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, bool], None] | None = None,
|
|
117
118
|
):
|
|
118
119
|
"""Returns a new boolean property definition.
|
|
119
120
|
|
|
@@ -124,22 +125,22 @@ def BoolProperty(
|
|
|
124
125
|
:param translation_context: Text used as context to disambiguate translations.
|
|
125
126
|
:type translation_context: str | None
|
|
126
127
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
127
|
-
:type options: bpy.
|
|
128
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
128
129
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
129
|
-
:type override: bpy.
|
|
130
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
130
131
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
131
132
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
132
|
-
:type subtype: bpy.
|
|
133
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
|
|
133
134
|
:param update: Function to be called when this value is modified,
|
|
134
135
|
This function must take 2 values (self, context) and return None.
|
|
135
136
|
Warning there are no safety checks to avoid infinite recursion.
|
|
136
|
-
:type update: collections.abc.Callable | None
|
|
137
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
137
138
|
:param get: Function to be called when this value is 'read',
|
|
138
139
|
This function must take 1 value (self) and return the value of the property.
|
|
139
|
-
:type get: collections.abc.Callable | None
|
|
140
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], bool] | None
|
|
140
141
|
:param set: Function to be called when this value is 'written',
|
|
141
142
|
This function must take 2 values (self, value) and return None.
|
|
142
|
-
:type set: collections.abc.Callable | None
|
|
143
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, bool], None] | None
|
|
143
144
|
"""
|
|
144
145
|
|
|
145
146
|
def BoolVectorProperty(
|
|
@@ -147,15 +148,20 @@ def BoolVectorProperty(
|
|
|
147
148
|
name: str | None = "",
|
|
148
149
|
description: str | None = "",
|
|
149
150
|
translation_context: str | None = "*",
|
|
150
|
-
default=(False, False, False),
|
|
151
|
-
options: bpy.
|
|
152
|
-
override: bpy.
|
|
151
|
+
default: collections.abc.Sequence[bool] | None = (False, False, False),
|
|
152
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
153
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
153
154
|
tags=set(),
|
|
154
|
-
subtype: bpy.
|
|
155
|
-
size=3,
|
|
156
|
-
update: collections.abc.Callable
|
|
157
|
-
|
|
158
|
-
|
|
155
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
156
|
+
size: collections.abc.Sequence[int] | int | None = 3,
|
|
157
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
158
|
+
| None = None,
|
|
159
|
+
get: collections.abc.Callable[
|
|
160
|
+
[bpy.types.bpy_struct], collections.abc.Sequence[bool]
|
|
161
|
+
]
|
|
162
|
+
| None = None,
|
|
163
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, ...]], None]
|
|
164
|
+
| None = None,
|
|
159
165
|
):
|
|
160
166
|
"""Returns a new vector boolean property definition.
|
|
161
167
|
|
|
@@ -166,40 +172,42 @@ def BoolVectorProperty(
|
|
|
166
172
|
:param translation_context: Text used as context to disambiguate translations.
|
|
167
173
|
:type translation_context: str | None
|
|
168
174
|
:param default: sequence of booleans the length of size.
|
|
175
|
+
:type default: collections.abc.Sequence[bool] | None
|
|
169
176
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
170
|
-
:type options: bpy.
|
|
177
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
171
178
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
172
|
-
:type override: bpy.
|
|
179
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
173
180
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
174
181
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
175
|
-
:type subtype: bpy.
|
|
182
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
|
|
176
183
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
184
|
+
:type size: collections.abc.Sequence[int] | int | None
|
|
177
185
|
:param update: Function to be called when this value is modified,
|
|
178
186
|
This function must take 2 values (self, context) and return None.
|
|
179
187
|
Warning there are no safety checks to avoid infinite recursion.
|
|
180
|
-
:type update: collections.abc.Callable | None
|
|
188
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
181
189
|
:param get: Function to be called when this value is 'read',
|
|
182
190
|
This function must take 1 value (self) and return the value of the property.
|
|
183
|
-
:type get: collections.abc.Callable | None
|
|
191
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[bool]] | None
|
|
184
192
|
:param set: Function to be called when this value is 'written',
|
|
185
193
|
This function must take 2 values (self, value) and return None.
|
|
186
|
-
:type set: collections.abc.Callable | None
|
|
194
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[bool, ...]], None] | None
|
|
187
195
|
"""
|
|
188
196
|
|
|
189
197
|
def CollectionProperty(
|
|
190
198
|
*,
|
|
191
|
-
type: bpy.types.PropertyGroup | None = None,
|
|
199
|
+
type: type[bpy.types.PropertyGroup] | None = None,
|
|
192
200
|
name: str | None = "",
|
|
193
201
|
description: str | None = "",
|
|
194
202
|
translation_context: str | None = "*",
|
|
195
|
-
options: bpy.
|
|
196
|
-
override: bpy.
|
|
203
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
204
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagCollectionItems] = set(),
|
|
197
205
|
tags=set(),
|
|
198
206
|
):
|
|
199
207
|
"""Returns a new collection property definition.
|
|
200
208
|
|
|
201
209
|
:param type: A subclass of a property group.
|
|
202
|
-
:type type: bpy.types.PropertyGroup | None
|
|
210
|
+
:type type: type[bpy.types.PropertyGroup] | None
|
|
203
211
|
:param name: Name used in the user interface.
|
|
204
212
|
:type name: str | None
|
|
205
213
|
:param description: Text used for the tooltip and api documentation.
|
|
@@ -207,9 +215,9 @@ def CollectionProperty(
|
|
|
207
215
|
:param translation_context: Text used as context to disambiguate translations.
|
|
208
216
|
:type translation_context: str | None
|
|
209
217
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
210
|
-
:type options: bpy.
|
|
218
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
211
219
|
:param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
|
|
212
|
-
:type override: bpy.
|
|
220
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagCollectionItems]
|
|
213
221
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
214
222
|
"""
|
|
215
223
|
|
|
@@ -233,13 +241,14 @@ def EnumProperty(
|
|
|
233
241
|
name: str | None = "",
|
|
234
242
|
description: str | None = "",
|
|
235
243
|
translation_context: str | None = "*",
|
|
236
|
-
default=None,
|
|
237
|
-
options: bpy.
|
|
238
|
-
override: bpy.
|
|
244
|
+
default: int | str | None = None,
|
|
245
|
+
options: set[bpy._typing.rna_enums.PropertyFlagEnumItems] = {"ANIMATABLE"},
|
|
246
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
239
247
|
tags=set(),
|
|
240
|
-
update: collections.abc.Callable
|
|
241
|
-
|
|
242
|
-
|
|
248
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
249
|
+
| None = None,
|
|
250
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None = None,
|
|
251
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None = None,
|
|
243
252
|
):
|
|
244
253
|
"""Returns a new enumerator property definition.
|
|
245
254
|
|
|
@@ -295,21 +304,22 @@ def EnumProperty(
|
|
|
295
304
|
If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
|
|
296
305
|
WARNING: Strings cannot be specified for dynamic enums
|
|
297
306
|
(i.e. if a callback function is given as items parameter).
|
|
307
|
+
:type default: int | str | None
|
|
298
308
|
:param options: Enumerator in `rna_enum_property_flag_enum_items`.
|
|
299
|
-
:type options: bpy.
|
|
309
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagEnumItems]
|
|
300
310
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
301
|
-
:type override: bpy.
|
|
311
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
302
312
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
303
313
|
:param update: Function to be called when this value is modified,
|
|
304
314
|
This function must take 2 values (self, context) and return None.
|
|
305
315
|
Warning there are no safety checks to avoid infinite recursion.
|
|
306
|
-
:type update: collections.abc.Callable | None
|
|
316
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
307
317
|
:param get: Function to be called when this value is 'read',
|
|
308
318
|
This function must take 1 value (self) and return the value of the property.
|
|
309
|
-
:type get: collections.abc.Callable | None
|
|
319
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None
|
|
310
320
|
:param set: Function to be called when this value is 'written',
|
|
311
321
|
This function must take 2 values (self, value) and return None.
|
|
312
|
-
:type set: collections.abc.Callable | None
|
|
322
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None
|
|
313
323
|
"""
|
|
314
324
|
|
|
315
325
|
def FloatProperty(
|
|
@@ -324,14 +334,15 @@ def FloatProperty(
|
|
|
324
334
|
soft_max: float | None = 3.402823e38,
|
|
325
335
|
step: int | None = 3,
|
|
326
336
|
precision: int | None = 2,
|
|
327
|
-
options: bpy.
|
|
328
|
-
override: bpy.
|
|
337
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
338
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
329
339
|
tags=set(),
|
|
330
|
-
subtype: bpy.
|
|
331
|
-
unit: bpy.
|
|
332
|
-
update: collections.abc.Callable
|
|
333
|
-
|
|
334
|
-
|
|
340
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
341
|
+
unit: bpy._typing.rna_enums.PropertyUnitItems = "NONE",
|
|
342
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
343
|
+
| None = None,
|
|
344
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], float] | None = None,
|
|
345
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, float], None] | None = None,
|
|
335
346
|
):
|
|
336
347
|
"""Returns a new float (single precision) property definition.
|
|
337
348
|
|
|
@@ -354,24 +365,24 @@ def FloatProperty(
|
|
|
354
365
|
: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.
|
|
355
366
|
:type precision: int | None
|
|
356
367
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
357
|
-
:type options: bpy.
|
|
368
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
358
369
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
359
|
-
:type override: bpy.
|
|
370
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
360
371
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
361
372
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
362
|
-
:type subtype: bpy.
|
|
373
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
|
|
363
374
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
364
|
-
:type unit: bpy.
|
|
375
|
+
:type unit: bpy._typing.rna_enums.PropertyUnitItems
|
|
365
376
|
:param update: Function to be called when this value is modified,
|
|
366
377
|
This function must take 2 values (self, context) and return None.
|
|
367
378
|
Warning there are no safety checks to avoid infinite recursion.
|
|
368
|
-
:type update: collections.abc.Callable | None
|
|
379
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
369
380
|
:param get: Function to be called when this value is 'read',
|
|
370
381
|
This function must take 1 value (self) and return the value of the property.
|
|
371
|
-
:type get: collections.abc.Callable | None
|
|
382
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], float] | None
|
|
372
383
|
:param set: Function to be called when this value is 'written',
|
|
373
384
|
This function must take 2 values (self, value) and return None.
|
|
374
|
-
:type set: collections.abc.Callable | None
|
|
385
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, float], None] | None
|
|
375
386
|
"""
|
|
376
387
|
|
|
377
388
|
def FloatVectorProperty(
|
|
@@ -379,22 +390,27 @@ def FloatVectorProperty(
|
|
|
379
390
|
name: str | None = "",
|
|
380
391
|
description: str | None = "",
|
|
381
392
|
translation_context: str | None = "*",
|
|
382
|
-
default=(0.0, 0.0, 0.0),
|
|
393
|
+
default: collections.abc.Sequence[float] | None = (0.0, 0.0, 0.0),
|
|
383
394
|
min: float | None = sys.float_info.min,
|
|
384
395
|
max: float | None = sys.float_info.max,
|
|
385
396
|
soft_min: float | None = sys.float_info.min,
|
|
386
397
|
soft_max: float | None = sys.float_info.max,
|
|
387
398
|
step: int | None = 3,
|
|
388
399
|
precision: int | None = 2,
|
|
389
|
-
options: bpy.
|
|
390
|
-
override: bpy.
|
|
400
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
401
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
391
402
|
tags=set(),
|
|
392
|
-
subtype: bpy.
|
|
393
|
-
unit: bpy.
|
|
394
|
-
size=3,
|
|
395
|
-
update: collections.abc.Callable
|
|
396
|
-
|
|
397
|
-
|
|
403
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
404
|
+
unit: bpy._typing.rna_enums.PropertyUnitItems = "NONE",
|
|
405
|
+
size: collections.abc.Sequence[int] | int | None = 3,
|
|
406
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
407
|
+
| None = None,
|
|
408
|
+
get: collections.abc.Callable[
|
|
409
|
+
[bpy.types.bpy_struct], collections.abc.Sequence[float]
|
|
410
|
+
]
|
|
411
|
+
| None = None,
|
|
412
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, ...]], None]
|
|
413
|
+
| None = None,
|
|
398
414
|
):
|
|
399
415
|
"""Returns a new vector float property definition.
|
|
400
416
|
|
|
@@ -405,6 +421,7 @@ def FloatVectorProperty(
|
|
|
405
421
|
:param translation_context: Text used as context to disambiguate translations.
|
|
406
422
|
:type translation_context: str | None
|
|
407
423
|
:param default: Sequence of floats the length of size.
|
|
424
|
+
:type default: collections.abc.Sequence[float] | None
|
|
408
425
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
409
426
|
:type min: float | None
|
|
410
427
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
@@ -418,25 +435,26 @@ def FloatVectorProperty(
|
|
|
418
435
|
: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.
|
|
419
436
|
:type precision: int | None
|
|
420
437
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
421
|
-
:type options: bpy.
|
|
438
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
422
439
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
423
|
-
:type override: bpy.
|
|
440
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
424
441
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
425
442
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
426
|
-
:type subtype: bpy.
|
|
443
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
|
|
427
444
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
428
|
-
:type unit: bpy.
|
|
445
|
+
:type unit: bpy._typing.rna_enums.PropertyUnitItems
|
|
429
446
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
447
|
+
:type size: collections.abc.Sequence[int] | int | None
|
|
430
448
|
:param update: Function to be called when this value is modified,
|
|
431
449
|
This function must take 2 values (self, context) and return None.
|
|
432
450
|
Warning there are no safety checks to avoid infinite recursion.
|
|
433
|
-
:type update: collections.abc.Callable | None
|
|
451
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
434
452
|
:param get: Function to be called when this value is 'read',
|
|
435
453
|
This function must take 1 value (self) and return the value of the property.
|
|
436
|
-
:type get: collections.abc.Callable | None
|
|
454
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[float]] | None
|
|
437
455
|
:param set: Function to be called when this value is 'written',
|
|
438
456
|
This function must take 2 values (self, value) and return None.
|
|
439
|
-
:type set: collections.abc.Callable | None
|
|
457
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[float, ...]], None] | None
|
|
440
458
|
"""
|
|
441
459
|
|
|
442
460
|
def IntProperty(
|
|
@@ -450,13 +468,14 @@ def IntProperty(
|
|
|
450
468
|
soft_min: int | None = None,
|
|
451
469
|
soft_max: int | None = None,
|
|
452
470
|
step: int | None = 1,
|
|
453
|
-
options: bpy.
|
|
454
|
-
override: bpy.
|
|
471
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
472
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
455
473
|
tags=set(),
|
|
456
|
-
subtype: bpy.
|
|
457
|
-
update: collections.abc.Callable
|
|
458
|
-
|
|
459
|
-
|
|
474
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
475
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
476
|
+
| None = None,
|
|
477
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None = None,
|
|
478
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None = None,
|
|
460
479
|
):
|
|
461
480
|
"""Returns a new int property definition.
|
|
462
481
|
|
|
@@ -477,22 +496,22 @@ def IntProperty(
|
|
|
477
496
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
478
497
|
:type step: int | None
|
|
479
498
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
480
|
-
:type options: bpy.
|
|
499
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
481
500
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
482
|
-
:type override: bpy.
|
|
501
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
483
502
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
484
503
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
485
|
-
:type subtype: bpy.
|
|
504
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberItems
|
|
486
505
|
:param update: Function to be called when this value is modified,
|
|
487
506
|
This function must take 2 values (self, context) and return None.
|
|
488
507
|
Warning there are no safety checks to avoid infinite recursion.
|
|
489
|
-
:type update: collections.abc.Callable | None
|
|
508
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
490
509
|
:param get: Function to be called when this value is 'read',
|
|
491
510
|
This function must take 1 value (self) and return the value of the property.
|
|
492
|
-
:type get: collections.abc.Callable | None
|
|
511
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], int] | None
|
|
493
512
|
:param set: Function to be called when this value is 'written',
|
|
494
513
|
This function must take 2 values (self, value) and return None.
|
|
495
|
-
:type set: collections.abc.Callable | None
|
|
514
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, int], None] | None
|
|
496
515
|
"""
|
|
497
516
|
|
|
498
517
|
def IntVectorProperty(
|
|
@@ -500,20 +519,23 @@ def IntVectorProperty(
|
|
|
500
519
|
name: str | None = "",
|
|
501
520
|
description: str | None = "",
|
|
502
521
|
translation_context: str | None = "*",
|
|
503
|
-
default=(0, 0, 0),
|
|
522
|
+
default: collections.abc.Sequence[int] | None = (0, 0, 0),
|
|
504
523
|
min: int | None = None,
|
|
505
524
|
max: int | None = None,
|
|
506
525
|
soft_min: int | None = None,
|
|
507
526
|
soft_max: int | None = None,
|
|
508
527
|
step: int | None = 1,
|
|
509
|
-
options: bpy.
|
|
510
|
-
override: bpy.
|
|
528
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
529
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
511
530
|
tags=set(),
|
|
512
|
-
subtype: bpy.
|
|
513
|
-
size=3,
|
|
514
|
-
update: collections.abc.Callable
|
|
515
|
-
|
|
516
|
-
|
|
531
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
532
|
+
size: collections.abc.Sequence[int] | int | None = 3,
|
|
533
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
534
|
+
| None = None,
|
|
535
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[int]]
|
|
536
|
+
| None = None,
|
|
537
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, ...]], None]
|
|
538
|
+
| None = None,
|
|
517
539
|
):
|
|
518
540
|
"""Returns a new vector int property definition.
|
|
519
541
|
|
|
@@ -524,6 +546,7 @@ def IntVectorProperty(
|
|
|
524
546
|
:param translation_context: Text used as context to disambiguate translations.
|
|
525
547
|
:type translation_context: str | None
|
|
526
548
|
:param default: sequence of ints the length of size.
|
|
549
|
+
:type default: collections.abc.Sequence[int] | None
|
|
527
550
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
528
551
|
:type min: int | None
|
|
529
552
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
@@ -535,40 +558,44 @@ def IntVectorProperty(
|
|
|
535
558
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
536
559
|
:type step: int | None
|
|
537
560
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
538
|
-
:type options: bpy.
|
|
561
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
539
562
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
540
|
-
:type override: bpy.
|
|
563
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
541
564
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
542
565
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
543
|
-
:type subtype: bpy.
|
|
566
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeNumberArrayItems
|
|
544
567
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
568
|
+
:type size: collections.abc.Sequence[int] | int | None
|
|
545
569
|
:param update: Function to be called when this value is modified,
|
|
546
570
|
This function must take 2 values (self, context) and return None.
|
|
547
571
|
Warning there are no safety checks to avoid infinite recursion.
|
|
548
|
-
:type update: collections.abc.Callable | None
|
|
572
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
549
573
|
:param get: Function to be called when this value is 'read',
|
|
550
574
|
This function must take 1 value (self) and return the value of the property.
|
|
551
|
-
:type get: collections.abc.Callable | None
|
|
575
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], collections.abc.Sequence[int]] | None
|
|
552
576
|
:param set: Function to be called when this value is 'written',
|
|
553
577
|
This function must take 2 values (self, value) and return None.
|
|
554
|
-
:type set: collections.abc.Callable | None
|
|
578
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, tuple[int, ...]], None] | None
|
|
555
579
|
"""
|
|
556
580
|
|
|
557
581
|
def PointerProperty(
|
|
558
582
|
*,
|
|
559
|
-
type=None,
|
|
583
|
+
type: type[bpy.types.PropertyGroup | bpy.types.ID] | None = None,
|
|
560
584
|
name: str | None = "",
|
|
561
585
|
description: str | None = "",
|
|
562
586
|
translation_context: str | None = "*",
|
|
563
|
-
options: bpy.
|
|
564
|
-
override: bpy.
|
|
587
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
588
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
565
589
|
tags=set(),
|
|
566
|
-
poll: collections.abc.Callable
|
|
567
|
-
|
|
590
|
+
poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool]
|
|
591
|
+
| None = None,
|
|
592
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
593
|
+
| None = None,
|
|
568
594
|
):
|
|
569
595
|
"""Returns a new pointer property definition.
|
|
570
596
|
|
|
571
597
|
:param type: A subclass of a property group or ID types.
|
|
598
|
+
:type type: type[bpy.types.PropertyGroup | bpy.types.ID] | None
|
|
572
599
|
:param name: Name used in the user interface.
|
|
573
600
|
:type name: str | None
|
|
574
601
|
:param description: Text used for the tooltip and api documentation.
|
|
@@ -576,18 +603,19 @@ def PointerProperty(
|
|
|
576
603
|
:param translation_context: Text used as context to disambiguate translations.
|
|
577
604
|
:type translation_context: str | None
|
|
578
605
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
579
|
-
:type options: bpy.
|
|
606
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
580
607
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
581
|
-
:type override: bpy.
|
|
608
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
582
609
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
583
|
-
:param poll:
|
|
584
|
-
The function must take 2 values (self, object) and return
|
|
585
|
-
|
|
586
|
-
|
|
610
|
+
:param poll: Function that determines whether an item is valid for this property.
|
|
611
|
+
The function must take 2 values (self, object) and return a boolean.
|
|
612
|
+
|
|
613
|
+
The return value will be checked only when assigning an item from the UI, but it is still possible to assign an "invalid" item to the property directly.
|
|
614
|
+
:type poll: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.ID], bool] | None
|
|
587
615
|
:param update: Function to be called when this value is modified,
|
|
588
616
|
This function must take 2 values (self, context) and return None.
|
|
589
617
|
Warning there are no safety checks to avoid infinite recursion.
|
|
590
|
-
:type update: collections.abc.Callable | None
|
|
618
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
591
619
|
"""
|
|
592
620
|
|
|
593
621
|
def RemoveProperty(*, cls: typing.Any | None, attr: str | None):
|
|
@@ -606,14 +634,16 @@ def StringProperty(
|
|
|
606
634
|
translation_context: str | None = "*",
|
|
607
635
|
default: str | None = "",
|
|
608
636
|
maxlen: int | None = 0,
|
|
609
|
-
options: bpy.
|
|
610
|
-
override: bpy.
|
|
637
|
+
options: set[bpy._typing.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
638
|
+
override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
611
639
|
tags=set(),
|
|
612
|
-
subtype: bpy.
|
|
613
|
-
update: collections.abc.Callable
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
640
|
+
subtype: bpy._typing.rna_enums.PropertySubtypeStringItems = "NONE",
|
|
641
|
+
update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None]
|
|
642
|
+
| None = None,
|
|
643
|
+
get: collections.abc.Callable[[bpy.types.bpy_struct], str] | None = None,
|
|
644
|
+
set: collections.abc.Callable[[bpy.types.bpy_struct, str], None] | None = None,
|
|
645
|
+
search: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context, str]]
|
|
646
|
+
| None = None,
|
|
617
647
|
search_options={"SUGGESTION"},
|
|
618
648
|
):
|
|
619
649
|
"""Returns a new string property definition.
|
|
@@ -629,22 +659,22 @@ def StringProperty(
|
|
|
629
659
|
:param maxlen: maximum length of the string.
|
|
630
660
|
:type maxlen: int | None
|
|
631
661
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
632
|
-
:type options: bpy.
|
|
662
|
+
:type options: set[bpy._typing.rna_enums.PropertyFlagItems]
|
|
633
663
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
634
|
-
:type override: bpy.
|
|
664
|
+
:type override: set[bpy._typing.rna_enums.PropertyOverrideFlagItems]
|
|
635
665
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
636
666
|
:param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
|
|
637
|
-
:type subtype: bpy.
|
|
667
|
+
:type subtype: bpy._typing.rna_enums.PropertySubtypeStringItems
|
|
638
668
|
:param update: Function to be called when this value is modified,
|
|
639
669
|
This function must take 2 values (self, context) and return None.
|
|
640
670
|
Warning there are no safety checks to avoid infinite recursion.
|
|
641
|
-
:type update: collections.abc.Callable | None
|
|
671
|
+
:type update: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context], None] | None
|
|
642
672
|
:param get: Function to be called when this value is 'read',
|
|
643
673
|
This function must take 1 value (self) and return the value of the property.
|
|
644
|
-
:type get: collections.abc.Callable | None
|
|
674
|
+
:type get: collections.abc.Callable[[bpy.types.bpy_struct], str] | None
|
|
645
675
|
:param set: Function to be called when this value is 'written',
|
|
646
676
|
This function must take 2 values (self, value) and return None.
|
|
647
|
-
:type set: collections.abc.Callable | None
|
|
677
|
+
:type set: collections.abc.Callable[[bpy.types.bpy_struct, str], None] | None
|
|
648
678
|
:param search: Function to be called to show candidates for this string (shown in the UI).
|
|
649
679
|
This function must take 3 values (self, context, edit_text)
|
|
650
680
|
and return a sequence, iterator or generator where each item must be:
|
|
@@ -653,7 +683,7 @@ def StringProperty(
|
|
|
653
683
|
|
|
654
684
|
A tuple-pair of strings, where the first is a candidate and the second
|
|
655
685
|
is additional information about the candidate.
|
|
656
|
-
:type search: collections.abc.Callable | None
|
|
686
|
+
:type search: collections.abc.Callable[[bpy.types.bpy_struct, bpy.types.Context, str]] | None
|
|
657
687
|
:param search_options: Set of strings in:
|
|
658
688
|
|
|
659
689
|
'SORT' sorts the resulting items.
|