fake-bpy-module-latest 20260113__py3-none-any.whl → 20260114__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.
- _bl_console_utils/autocomplete/complete_calltip/__init__.pyi +0 -13
- _bl_console_utils/autocomplete/complete_import/__init__.pyi +0 -5
- _bl_console_utils/autocomplete/complete_namespace/__init__.pyi +0 -11
- _bl_console_utils/autocomplete/intellisense/__init__.pyi +0 -10
- _bpy_types/__init__.pyi +1 -122
- _rna_info/__init__.pyi +0 -1
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +0 -146
- bl_math/__init__.pyi +0 -12
- bl_operators/add_mesh_torus/__init__.pyi +0 -2
- bl_operators/anim/__init__.pyi +0 -26
- bl_operators/assets/__init__.pyi +0 -6
- bl_operators/bone_selection_sets/__init__.pyi +0 -28
- bl_operators/clip/__init__.pyi +0 -20
- bl_operators/connect_to_output/__init__.pyi +0 -2
- bl_operators/console/__init__.pyi +0 -10
- bl_operators/constraint/__init__.pyi +0 -8
- bl_operators/copy_global_transform/__init__.pyi +0 -10
- bl_operators/file/__init__.pyi +0 -6
- bl_operators/freestyle/__init__.pyi +0 -8
- bl_operators/geometry_nodes/__init__.pyi +0 -8
- bl_operators/grease_pencil/__init__.pyi +0 -2
- bl_operators/image/__init__.pyi +0 -10
- bl_operators/image_as_planes/__init__.pyi +0 -4
- bl_operators/mesh/__init__.pyi +0 -4
- bl_operators/node/__init__.pyi +0 -44
- bl_operators/object/__init__.pyi +0 -30
- bl_operators/object_align/__init__.pyi +0 -2
- bl_operators/object_quick_effects/__init__.pyi +0 -8
- bl_operators/object_randomize_transform/__init__.pyi +0 -2
- bl_operators/presets/__init__.pyi +0 -50
- bl_operators/rigidbody/__init__.pyi +0 -6
- bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
- bl_operators/sequencer/__init__.pyi +0 -16
- bl_operators/spreadsheet/__init__.pyi +0 -2
- bl_operators/userpref/__init__.pyi +0 -50
- bl_operators/uvcalc_follow_active/__init__.pyi +0 -2
- bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
- bl_operators/uvcalc_transform/__init__.pyi +0 -4
- bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
- bl_operators/view3d/__init__.pyi +0 -16
- bl_operators/wm/__init__.pyi +0 -92
- bl_operators/world/__init__.pyi +0 -2
- bl_ui/__init__.pyi +0 -4
- bl_ui/anim/__init__.pyi +0 -2
- bl_ui/asset_shelf/__init__.pyi +0 -2
- bl_ui/generic_ui_list/__init__.pyi +1 -17
- bl_ui/node_add_menu/__init__.pyi +0 -10
- bl_ui/node_add_menu_compositor/__init__.pyi +0 -38
- bl_ui/node_add_menu_geometry/__init__.pyi +0 -112
- bl_ui/node_add_menu_shader/__init__.pyi +0 -20
- bl_ui/node_add_menu_texture/__init__.pyi +0 -16
- bl_ui/properties_collection/__init__.pyi +0 -14
- bl_ui/properties_constraint/__init__.pyi +0 -154
- bl_ui/properties_data_armature/__init__.pyi +0 -36
- bl_ui/properties_data_bone/__init__.pyi +0 -20
- bl_ui/properties_data_camera/__init__.pyi +0 -30
- bl_ui/properties_data_curve/__init__.pyi +0 -30
- bl_ui/properties_data_curves/__init__.pyi +0 -16
- bl_ui/properties_data_empty/__init__.pyi +0 -4
- bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
- bl_ui/properties_data_lattice/__init__.pyi +0 -8
- bl_ui/properties_data_light/__init__.pyi +0 -20
- bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
- bl_ui/properties_data_mesh/__init__.pyi +0 -42
- bl_ui/properties_data_metaball/__init__.pyi +0 -12
- bl_ui/properties_data_modifier/__init__.pyi +0 -18
- bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
- bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
- bl_ui/properties_data_speaker/__init__.pyi +0 -12
- bl_ui/properties_data_volume/__init__.pyi +0 -18
- bl_ui/properties_freestyle/__init__.pyi +0 -50
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -14
- bl_ui/properties_mask_common/__init__.pyi +0 -14
- bl_ui/properties_material/__init__.pyi +0 -32
- bl_ui/properties_material_gpencil/__init__.pyi +0 -22
- bl_ui/properties_object/__init__.pyi +0 -44
- bl_ui/properties_output/__init__.pyi +0 -40
- bl_ui/properties_paint_common/__init__.pyi +0 -4
- bl_ui/properties_particle/__init__.pyi +0 -106
- bl_ui/properties_physics_cloth/__init__.pyi +0 -28
- bl_ui/properties_physics_common/__init__.pyi +0 -2
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
- bl_ui/properties_physics_field/__init__.pyi +0 -20
- bl_ui/properties_physics_fluid/__init__.pyi +0 -56
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
- bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
- bl_ui/properties_physics_softbody/__init__.pyi +0 -30
- bl_ui/properties_render/__init__.pyi +0 -90
- bl_ui/properties_scene/__init__.pyi +0 -34
- bl_ui/properties_strip/__init__.pyi +0 -42
- bl_ui/properties_strip_modifier/__init__.pyi +0 -2
- bl_ui/properties_texture/__init__.pyi +0 -54
- bl_ui/properties_view_layer/__init__.pyi +0 -28
- bl_ui/properties_workspace/__init__.pyi +0 -8
- bl_ui/properties_world/__init__.pyi +0 -22
- bl_ui/space_clip/__init__.pyi +0 -150
- bl_ui/space_console/__init__.pyi +0 -12
- bl_ui/space_dopesheet/__init__.pyi +0 -64
- bl_ui/space_filebrowser/__init__.pyi +0 -60
- bl_ui/space_graph/__init__.pyi +0 -44
- bl_ui/space_image/__init__.pyi +0 -142
- bl_ui/space_info/__init__.pyi +0 -12
- bl_ui/space_nla/__init__.pyi +0 -36
- bl_ui/space_node/__init__.pyi +0 -66
- bl_ui/space_outliner/__init__.pyi +0 -30
- bl_ui/space_properties/__init__.pyi +0 -8
- bl_ui/space_sequencer/__init__.pyi +0 -136
- bl_ui/space_spreadsheet/__init__.pyi +0 -6
- bl_ui/space_statusbar/__init__.pyi +0 -2
- bl_ui/space_text/__init__.pyi +0 -32
- bl_ui/space_time/__init__.pyi +0 -12
- bl_ui/space_topbar/__init__.pyi +0 -52
- bl_ui/space_userpref/__init__.pyi +0 -186
- bl_ui/space_view3d/__init__.pyi +0 -536
- bl_ui/space_view3d_sidebar/__init__.pyi +0 -8
- bl_ui/space_view3d_toolbar/__init__.pyi +0 -162
- blf/__init__.pyi +0 -47
- bmesh/__init__.pyi +0 -7
- bmesh/geometry/__init__.pyi +0 -3
- bmesh/ops/__init__.pyi +0 -451
- bmesh/types/__init__.pyi +65 -427
- bmesh/utils/__init__.pyi +0 -44
- bpy/app/__init__.pyi +0 -5
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +0 -6
- bpy/app/translations/__init__.pyi +0 -15
- bpy/msgbus/__init__.pyi +1 -4
- bpy/ops/action/__init__.pyi +15 -165
- bpy/ops/anim/__init__.pyi +27 -274
- bpy/ops/armature/__init__.pyi +17 -191
- bpy/ops/asset/__init__.pyi +11 -97
- bpy/ops/boid/__init__.pyi +7 -38
- bpy/ops/brush/__init__.pyi +3 -72
- bpy/ops/buttons/__init__.pyi +4 -71
- bpy/ops/cachefile/__init__.pyi +2 -63
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +43 -427
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +2 -34
- bpy/ops/console/__init__.pyi +10 -88
- bpy/ops/constraint/__init__.pyi +3 -80
- bpy/ops/curve/__init__.pyi +23 -254
- bpy/ops/curves/__init__.pyi +15 -164
- bpy/ops/cycles/__init__.pyi +1 -14
- bpy/ops/dpaint/__init__.pyi +3 -21
- bpy/ops/ed/__init__.pyi +10 -82
- bpy/ops/export_anim/__init__.pyi +0 -11
- bpy/ops/export_scene/__init__.pyi +0 -154
- bpy/ops/extensions/__init__.pyi +15 -150
- bpy/ops/file/__init__.pyi +27 -217
- bpy/ops/fluid/__init__.pyi +13 -70
- bpy/ops/font/__init__.pyi +10 -134
- bpy/ops/geometry/__init__.pyi +3 -41
- bpy/ops/gizmogroup/__init__.pyi +1 -12
- bpy/ops/gpencil/__init__.pyi +5 -38
- bpy/ops/graph/__init__.pyi +18 -316
- bpy/ops/grease_pencil/__init__.pyi +27 -522
- bpy/ops/image/__init__.pyi +19 -379
- bpy/ops/import_anim/__init__.pyi +0 -14
- bpy/ops/import_curve/__init__.pyi +0 -6
- bpy/ops/import_scene/__init__.pyi +0 -50
- bpy/ops/info/__init__.pyi +4 -35
- bpy/ops/lattice/__init__.pyi +3 -33
- bpy/ops/marker/__init__.pyi +2 -50
- bpy/ops/mask/__init__.pyi +17 -176
- bpy/ops/material/__init__.pyi +3 -15
- bpy/ops/mball/__init__.pyi +1 -30
- bpy/ops/mesh/__init__.pyi +30 -913
- bpy/ops/nla/__init__.pyi +19 -183
- bpy/ops/node/__init__.pyi +53 -745
- bpy/ops/object/__init__.pyi +75 -1285
- bpy/ops/outliner/__init__.pyi +47 -327
- bpy/ops/paint/__init__.pyi +14 -279
- bpy/ops/paintcurve/__init__.pyi +4 -36
- bpy/ops/palette/__init__.pyi +3 -27
- bpy/ops/particle/__init__.pyi +20 -160
- bpy/ops/pointcloud/__init__.pyi +3 -35
- bpy/ops/pose/__init__.pyi +25 -230
- bpy/ops/poselib/__init__.pyi +4 -47
- bpy/ops/preferences/__init__.pyi +9 -177
- bpy/ops/ptcache/__init__.pyi +5 -31
- bpy/ops/render/__init__.pyi +3 -70
- bpy/ops/rigidbody/__init__.pyi +6 -56
- bpy/ops/scene/__init__.pyi +22 -167
- bpy/ops/screen/__init__.pyi +19 -214
- bpy/ops/script/__init__.pyi +1 -12
- bpy/ops/sculpt/__init__.pyi +7 -271
- bpy/ops/sculpt_curves/__init__.pyi +1 -20
- bpy/ops/sequencer/__init__.pyi +36 -672
- bpy/ops/sound/__init__.pyi +3 -109
- bpy/ops/spreadsheet/__init__.pyi +5 -32
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +25 -226
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +3 -18
- bpy/ops/transform/__init__.pyi +2 -381
- bpy/ops/ui/__init__.pyi +21 -158
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +9 -316
- bpy/ops/view2d/__init__.pyi +3 -73
- bpy/ops/view3d/__init__.pyi +37 -339
- bpy/ops/wm/__init__.pyi +25 -1308
- bpy/ops/workspace/__init__.pyi +7 -39
- bpy/ops/world/__init__.pyi +2 -10
- bpy/path/__init__.pyi +0 -34
- bpy/props/__init__.pyi +12 -148
- bpy/types/__init__.pyi +9867 -55713
- bpy/utils/__init__.pyi +2 -73
- bpy/utils/previews/__init__.pyi +0 -9
- bpy/utils/units/__init__.pyi +0 -12
- bpy_extras/anim_utils/__init__.pyi +0 -8
- bpy_extras/bmesh_utils/__init__.pyi +0 -1
- bpy_extras/id_map_utils/__init__.pyi +4 -5
- bpy_extras/image_utils/__init__.pyi +0 -9
- bpy_extras/io_utils/__init__.pyi +2 -22
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/object_utils/__init__.pyi +0 -14
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/METADATA +2 -1
- fake_bpy_module_latest-20260114.dist-info/RECORD +382 -0
- freestyle/chainingiterators/__init__.pyi +0 -22
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +0 -51
- freestyle/shaders/__init__.pyi +0 -65
- freestyle/types/__init__.pyi +139 -777
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +0 -6
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +0 -9
- gpu/platform/__init__.pyi +0 -5
- gpu/shader/__init__.pyi +0 -5
- gpu/state/__init__.pyi +0 -29
- gpu/texture/__init__.pyi +0 -2
- gpu/types/__init__.pyi +10 -149
- gpu_extras/batch/__init__.pyi +0 -4
- gpu_extras/presets/__init__.pyi +0 -9
- idprop/types/__init__.pyi +0 -4
- imbuf/__init__.pyi +0 -7
- imbuf/types/__init__.pyi +5 -25
- keyingsets_builtins/__init__.pyi +0 -44
- mathutils/__init__.pyi +46 -2160
- mathutils/bvhtree/__init__.pyi +1 -24
- mathutils/geometry/__init__.pyi +0 -129
- mathutils/interpolate/__init__.pyi +0 -3
- mathutils/kdtree/__init__.pyi +0 -11
- mathutils/noise/__init__.pyi +0 -62
- fake_bpy_module_latest-20260113.dist-info/RECORD +0 -382
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/WHEEL +0 -0
- {fake_bpy_module_latest-20260113.dist-info → fake_bpy_module_latest-20260114.dist-info}/top_level.txt +0 -0
bpy/props/__init__.pyi
CHANGED
|
@@ -157,7 +157,7 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
157
157
|
default=False,
|
|
158
158
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
159
159
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
160
|
-
tags=set(),
|
|
160
|
+
tags: set[str] | None = set(),
|
|
161
161
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
162
162
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
163
163
|
| None = None,
|
|
@@ -173,34 +173,25 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
173
173
|
"""Returns a new boolean property definition.
|
|
174
174
|
|
|
175
175
|
:param name: Name used in the user interface.
|
|
176
|
-
:type name: str | None
|
|
177
176
|
:param description: Text used for the tooltip and api documentation.
|
|
178
|
-
:type description: str | None
|
|
179
177
|
:param translation_context: Text used as context to disambiguate translations.
|
|
180
|
-
:type translation_context: str | None
|
|
181
178
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
182
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
183
179
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
184
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
185
180
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
186
181
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
187
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
188
182
|
:param update: Function to be called when this value is modified,
|
|
189
183
|
This function must take 2 values (self, context) and return None.
|
|
190
184
|
Warning there are no safety checks to avoid infinite recursion.
|
|
191
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
192
185
|
:param get: Function to be called when this value is read, and the default,
|
|
193
186
|
system-defined storage is not used for this property.
|
|
194
187
|
This function must take 1 value (self) and return the value of the property.
|
|
195
188
|
|
|
196
189
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
197
|
-
:type get: collections.abc.Callable[[_GenericType1], bool] | None
|
|
198
190
|
:param set: Function to be called when this value is written, and the default,
|
|
199
191
|
system-defined storage is not used for this property.
|
|
200
192
|
This function must take 2 values (self, value) and return None.
|
|
201
193
|
|
|
202
194
|
Defining this callback without a matching get one is invalid.
|
|
203
|
-
:type set: collections.abc.Callable[[_GenericType1, bool], None] | None
|
|
204
195
|
:param get_transform: Function to be called when this value is read,
|
|
205
196
|
if some additional processing must be performed on the stored value.
|
|
206
197
|
This function must take three arguments (self, the stored value,
|
|
@@ -208,7 +199,6 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
208
199
|
and return the final, transformed value of the property.
|
|
209
200
|
|
|
210
201
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
211
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, bool, bool], bool] | None
|
|
212
202
|
:param set_transform: Function to be called when this value is written,
|
|
213
203
|
if some additional processing must be performed on the given value before storing it.
|
|
214
204
|
This function must take four arguments (self, the given value to store,
|
|
@@ -217,7 +207,6 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
217
207
|
and return the final, transformed value of the property.
|
|
218
208
|
|
|
219
209
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
220
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, bool, bool, bool], bool] | None
|
|
221
210
|
"""
|
|
222
211
|
|
|
223
212
|
def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -228,7 +217,7 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
228
217
|
default: collections.abc.Sequence[bool] | None = (False, False, False),
|
|
229
218
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
230
219
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
231
|
-
tags=set(),
|
|
220
|
+
tags: set[str] | None = set(),
|
|
232
221
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
233
222
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
234
223
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -256,38 +245,27 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
256
245
|
"""Returns a new vector boolean property definition.
|
|
257
246
|
|
|
258
247
|
:param name: Name used in the user interface.
|
|
259
|
-
:type name: str | None
|
|
260
248
|
:param description: Text used for the tooltip and api documentation.
|
|
261
|
-
:type description: str | None
|
|
262
249
|
:param translation_context: Text used as context to disambiguate translations.
|
|
263
|
-
:type translation_context: str | None
|
|
264
250
|
:param default: sequence of booleans the length of size.
|
|
265
|
-
:type default: collections.abc.Sequence[bool] | None
|
|
266
251
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
267
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
268
252
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
269
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
270
253
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
271
254
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
272
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
273
255
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
274
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
275
256
|
:param update: Function to be called when this value is modified,
|
|
276
257
|
This function must take 2 values (self, context) and return None.
|
|
277
258
|
Warning there are no safety checks to avoid infinite recursion.
|
|
278
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
279
259
|
:param get: Function to be called when this value is read, and the default,
|
|
280
260
|
system-defined storage is not used for this property.
|
|
281
261
|
This function must take 1 value (self) and return the value of the property.
|
|
282
262
|
|
|
283
263
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
284
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[bool]] | None
|
|
285
264
|
:param set: Function to be called when this value is written, and the default,
|
|
286
265
|
system-defined storage is not used for this property.
|
|
287
266
|
This function must take 2 values (self, value) and return None.
|
|
288
267
|
|
|
289
268
|
Defining this callback without a matching get one is invalid.
|
|
290
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[bool]], None] | None
|
|
291
269
|
:param get_transform: Function to be called when this value is read,
|
|
292
270
|
if some additional processing must be performed on the stored value.
|
|
293
271
|
This function must take three arguments (self, the stored value,
|
|
@@ -295,7 +273,6 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
295
273
|
and return the final, transformed value of the property.
|
|
296
274
|
|
|
297
275
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
298
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[bool], bool], collections.abc.Sequence[bool]] | None
|
|
299
276
|
:param set_transform: Function to be called when this value is written,
|
|
300
277
|
if some additional processing must be performed on the given value before storing it.
|
|
301
278
|
This function must take four arguments (self, the given value to store,
|
|
@@ -304,7 +281,6 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
304
281
|
and return the final, transformed value of the property.
|
|
305
282
|
|
|
306
283
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
307
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[bool], collections.abc.Sequence[bool], bool], collections.abc.Sequence[bool]] | None
|
|
308
284
|
"""
|
|
309
285
|
|
|
310
286
|
def CollectionProperty(
|
|
@@ -317,22 +293,16 @@ def CollectionProperty(
|
|
|
317
293
|
override: set[
|
|
318
294
|
bpy.stub_internal.rna_enums.PropertyOverrideFlagCollectionItems
|
|
319
295
|
] = set(),
|
|
320
|
-
tags=set(),
|
|
296
|
+
tags: set[str] | None = set(),
|
|
321
297
|
) -> None:
|
|
322
298
|
"""Returns a new collection property definition.
|
|
323
299
|
|
|
324
300
|
:param type: A subclass of a property group.
|
|
325
|
-
:type type: type[bpy.types.PropertyGroup] | None
|
|
326
301
|
:param name: Name used in the user interface.
|
|
327
|
-
:type name: str | None
|
|
328
302
|
:param description: Text used for the tooltip and api documentation.
|
|
329
|
-
:type description: str | None
|
|
330
303
|
:param translation_context: Text used as context to disambiguate translations.
|
|
331
|
-
:type translation_context: str | None
|
|
332
304
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
333
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
334
305
|
:param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
|
|
335
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagCollectionItems]
|
|
336
306
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
337
307
|
"""
|
|
338
308
|
|
|
@@ -356,10 +326,10 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
356
326
|
name: str | None = "",
|
|
357
327
|
description: str | None = "",
|
|
358
328
|
translation_context: str | None = "*",
|
|
359
|
-
default: int | str | None = None,
|
|
329
|
+
default: int | set[str] | str | None = None,
|
|
360
330
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagEnumItems] = {"ANIMATABLE"},
|
|
361
331
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
362
|
-
tags=set(),
|
|
332
|
+
tags: set[str] | None = set(),
|
|
363
333
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
364
334
|
| None = None,
|
|
365
335
|
get: collections.abc.Callable[[_GenericType1], int] | None = None,
|
|
@@ -412,39 +382,29 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
412
382
|
There is a known bug with using a callback,
|
|
413
383
|
Python must keep a reference to the strings returned by the callback or Blender
|
|
414
384
|
will misbehave or even crash.
|
|
415
|
-
:type items: collections.abc.Iterable[tuple[str, str, str] | tuple[str, str, str, int] | tuple[str, str, str, str, int] | None] | collections.abc.Callable[[_GenericType1, bpy.types.Context | None], collections.abc.Iterable[tuple[str, str, str] | tuple[str, str, str, int] | tuple[str, str, str, str, int] | None]]
|
|
416
385
|
:param name: Name used in the user interface.
|
|
417
|
-
:type name: str | None
|
|
418
386
|
:param description: Text used for the tooltip and api documentation.
|
|
419
|
-
:type description: str | None
|
|
420
387
|
:param translation_context: Text used as context to disambiguate translations.
|
|
421
|
-
:type translation_context: str | None
|
|
422
388
|
:param default: The default value for this enum, a string from the identifiers used in items, or integer matching an item number.
|
|
423
389
|
If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
|
|
424
390
|
WARNING: Strings cannot be specified for dynamic enums
|
|
425
391
|
(i.e. if a callback function is given as items parameter).
|
|
426
|
-
:type default: int | str | None
|
|
427
392
|
:param options: Enumerator in `rna_enum_property_flag_enum_items`.
|
|
428
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagEnumItems]
|
|
429
393
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
430
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
431
394
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
432
395
|
:param update: Function to be called when this value is modified,
|
|
433
396
|
This function must take 2 values (self, context) and return None.
|
|
434
397
|
Warning there are no safety checks to avoid infinite recursion.
|
|
435
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
436
398
|
:param get: Function to be called when this value is read, and the default,
|
|
437
399
|
system-defined storage is not used for this property.
|
|
438
400
|
This function must take 1 value (self) and return the value of the property.
|
|
439
401
|
|
|
440
402
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
441
|
-
:type get: collections.abc.Callable[[_GenericType1], int] | None
|
|
442
403
|
:param set: Function to be called when this value is written, and the default,
|
|
443
404
|
system-defined storage is not used for this property.
|
|
444
405
|
This function must take 2 values (self, value) and return None.
|
|
445
406
|
|
|
446
407
|
Defining this callback without a matching get one is invalid.
|
|
447
|
-
:type set: collections.abc.Callable[[_GenericType1, int], None] | None
|
|
448
408
|
:param get_transform: Function to be called when this value is read,
|
|
449
409
|
if some additional processing must be performed on the stored value.
|
|
450
410
|
This function must take three arguments (self, the stored value,
|
|
@@ -452,7 +412,6 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
452
412
|
and return the final, transformed value of the property.
|
|
453
413
|
|
|
454
414
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
455
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, bool], int] | None
|
|
456
415
|
:param set_transform: Function to be called when this value is written,
|
|
457
416
|
if some additional processing must be performed on the given value before storing it.
|
|
458
417
|
This function must take four arguments (self, the given value to store,
|
|
@@ -461,7 +420,6 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
461
420
|
and return the final, transformed value of the property.
|
|
462
421
|
|
|
463
422
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
464
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, int, bool], int] | None
|
|
465
423
|
"""
|
|
466
424
|
|
|
467
425
|
def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -478,7 +436,7 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
478
436
|
precision: int | None = 2,
|
|
479
437
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
480
438
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
481
|
-
tags=set(),
|
|
439
|
+
tags: set[str] | None = set(),
|
|
482
440
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
483
441
|
unit: bpy.stub_internal.rna_enums.PropertyUnitItems = "NONE",
|
|
484
442
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -495,48 +453,32 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
495
453
|
"""Returns a new float (single precision) property definition.
|
|
496
454
|
|
|
497
455
|
:param name: Name used in the user interface.
|
|
498
|
-
:type name: str | None
|
|
499
456
|
:param description: Text used for the tooltip and api documentation.
|
|
500
|
-
:type description: str | None
|
|
501
457
|
:param translation_context: Text used as context to disambiguate translations.
|
|
502
|
-
:type translation_context: str | None
|
|
503
458
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
504
|
-
:type min: float | None
|
|
505
459
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
506
|
-
:type max: float | None
|
|
507
460
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
508
|
-
:type soft_min: float | None
|
|
509
461
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
510
|
-
:type soft_max: float | None
|
|
511
462
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
512
|
-
:type step: float | None
|
|
513
463
|
: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.
|
|
514
|
-
:type precision: int | None
|
|
515
464
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
516
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
517
465
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
518
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
519
466
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
520
467
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
521
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
522
468
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
523
|
-
:type unit: bpy.stub_internal.rna_enums.PropertyUnitItems
|
|
524
469
|
:param update: Function to be called when this value is modified,
|
|
525
470
|
This function must take 2 values (self, context) and return None.
|
|
526
471
|
Warning there are no safety checks to avoid infinite recursion.
|
|
527
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
528
472
|
:param get: Function to be called when this value is read, and the default,
|
|
529
473
|
system-defined storage is not used for this property.
|
|
530
474
|
This function must take 1 value (self) and return the value of the property.
|
|
531
475
|
|
|
532
476
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
533
|
-
:type get: collections.abc.Callable[[_GenericType1], float] | None
|
|
534
477
|
:param set: Function to be called when this value is written, and the default,
|
|
535
478
|
system-defined storage is not used for this property.
|
|
536
479
|
This function must take 2 values (self, value) and return None.
|
|
537
480
|
|
|
538
481
|
Defining this callback without a matching get one is invalid.
|
|
539
|
-
:type set: collections.abc.Callable[[_GenericType1, float], None] | None
|
|
540
482
|
:param get_transform: Function to be called when this value is read,
|
|
541
483
|
if some additional processing must be performed on the stored value.
|
|
542
484
|
This function must take three arguments (self, the stored value,
|
|
@@ -544,7 +486,6 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
544
486
|
and return the final, transformed value of the property.
|
|
545
487
|
|
|
546
488
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
547
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, float, bool], float] | None
|
|
548
489
|
:param set_transform: Function to be called when this value is written,
|
|
549
490
|
if some additional processing must be performed on the given value before storing it.
|
|
550
491
|
This function must take four arguments (self, the given value to store,
|
|
@@ -553,7 +494,6 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
553
494
|
and return the final, transformed value of the property.
|
|
554
495
|
|
|
555
496
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
556
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, float, float, bool], float] | None
|
|
557
497
|
"""
|
|
558
498
|
|
|
559
499
|
def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -570,7 +510,7 @@ def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
570
510
|
precision: int | None = 2,
|
|
571
511
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
572
512
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
573
|
-
tags=set(),
|
|
513
|
+
tags: set[str] | None = set(),
|
|
574
514
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
575
515
|
unit: bpy.stub_internal.rna_enums.PropertyUnitItems = "NONE",
|
|
576
516
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
@@ -586,52 +526,34 @@ def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
586
526
|
"""Returns a new vector float property definition.
|
|
587
527
|
|
|
588
528
|
:param name: Name used in the user interface.
|
|
589
|
-
:type name: str | None
|
|
590
529
|
:param description: Text used for the tooltip and api documentation.
|
|
591
|
-
:type description: str | None
|
|
592
530
|
:param translation_context: Text used as context to disambiguate translations.
|
|
593
|
-
:type translation_context: str | None
|
|
594
531
|
:param default: Sequence of floats the length of size.
|
|
595
|
-
:type default: collections.abc.Sequence[float] | None
|
|
596
532
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
597
|
-
:type min: float | None
|
|
598
533
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
599
|
-
:type max: float | None
|
|
600
534
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
601
|
-
:type soft_min: float | None
|
|
602
535
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
603
|
-
:type soft_max: float | None
|
|
604
536
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
605
|
-
:type step: float | None
|
|
606
537
|
: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.
|
|
607
|
-
:type precision: int | None
|
|
608
538
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
609
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
610
539
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
611
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
612
540
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
613
541
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
614
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
615
542
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
616
|
-
:type unit: bpy.stub_internal.rna_enums.PropertyUnitItems
|
|
617
543
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
618
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
619
544
|
:param update: Function to be called when this value is modified,
|
|
620
545
|
This function must take 2 values (self, context) and return None.
|
|
621
546
|
Warning there are no safety checks to avoid infinite recursion.
|
|
622
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
623
547
|
:param get: Function to be called when this value is read, and the default,
|
|
624
548
|
system-defined storage is not used for this property.
|
|
625
549
|
This function must take 1 value (self) and return the value of the property.
|
|
626
550
|
|
|
627
551
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
628
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[float]] | None
|
|
629
552
|
:param set: Function to be called when this value is written, and the default,
|
|
630
553
|
system-defined storage is not used for this property.
|
|
631
554
|
This function must take 2 values (self, value) and return None.
|
|
632
555
|
|
|
633
556
|
Defining this callback without a matching get one is invalid.
|
|
634
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[float]], None] | None
|
|
635
557
|
"""
|
|
636
558
|
|
|
637
559
|
def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -647,7 +569,7 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
647
569
|
step: int | None = 1,
|
|
648
570
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
649
571
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
650
|
-
tags=set(),
|
|
572
|
+
tags: set[str] | None = set(),
|
|
651
573
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
652
574
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
653
575
|
| None = None,
|
|
@@ -661,44 +583,30 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
661
583
|
"""Returns a new int property definition.
|
|
662
584
|
|
|
663
585
|
:param name: Name used in the user interface.
|
|
664
|
-
:type name: str | None
|
|
665
586
|
:param description: Text used for the tooltip and api documentation.
|
|
666
|
-
:type description: str | None
|
|
667
587
|
:param translation_context: Text used as context to disambiguate translations.
|
|
668
|
-
:type translation_context: str | None
|
|
669
588
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
670
|
-
:type min: int | None
|
|
671
589
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
672
|
-
:type max: int | None
|
|
673
590
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
674
|
-
:type soft_min: int | None
|
|
675
591
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
676
|
-
:type soft_max: int | None
|
|
677
592
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
678
|
-
:type step: int | None
|
|
679
593
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
680
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
681
594
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
682
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
683
595
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
684
596
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
685
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
686
597
|
:param update: Function to be called when this value is modified,
|
|
687
598
|
This function must take 2 values (self, context) and return None.
|
|
688
599
|
Warning there are no safety checks to avoid infinite recursion.
|
|
689
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
690
600
|
:param get: Function to be called when this value is read, and the default,
|
|
691
601
|
system-defined storage is not used for this property.
|
|
692
602
|
This function must take 1 value (self) and return the value of the property.
|
|
693
603
|
|
|
694
604
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
695
|
-
:type get: collections.abc.Callable[[_GenericType1], int] | None
|
|
696
605
|
:param set: Function to be called when this value is written, and the default,
|
|
697
606
|
system-defined storage is not used for this property.
|
|
698
607
|
This function must take 2 values (self, value) and return None.
|
|
699
608
|
|
|
700
609
|
Defining this callback without a matching get one is invalid.
|
|
701
|
-
:type set: collections.abc.Callable[[_GenericType1, int], None] | None
|
|
702
610
|
:param get_transform: Function to be called when this value is read,
|
|
703
611
|
if some additional processing must be performed on the stored value.
|
|
704
612
|
This function must take three arguments (self, the stored value,
|
|
@@ -706,7 +614,6 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
706
614
|
and return the final, transformed value of the property.
|
|
707
615
|
|
|
708
616
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
709
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, bool], int] | None
|
|
710
617
|
:param set_transform: Function to be called when this value is written,
|
|
711
618
|
if some additional processing must be performed on the given value before storing it.
|
|
712
619
|
This function must take four arguments (self, the given value to store,
|
|
@@ -715,7 +622,6 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
715
622
|
and return the final, transformed value of the property.
|
|
716
623
|
|
|
717
624
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
718
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, int, bool], int] | None
|
|
719
625
|
"""
|
|
720
626
|
|
|
721
627
|
def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -731,7 +637,7 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
731
637
|
step: int | None = 1,
|
|
732
638
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
733
639
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
734
|
-
tags=set(),
|
|
640
|
+
tags: set[str] | None = set(),
|
|
735
641
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
736
642
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
737
643
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -759,48 +665,32 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
759
665
|
"""Returns a new vector int property definition.
|
|
760
666
|
|
|
761
667
|
:param name: Name used in the user interface.
|
|
762
|
-
:type name: str | None
|
|
763
668
|
:param description: Text used for the tooltip and api documentation.
|
|
764
|
-
:type description: str | None
|
|
765
669
|
:param translation_context: Text used as context to disambiguate translations.
|
|
766
|
-
:type translation_context: str | None
|
|
767
670
|
:param default: sequence of ints the length of size.
|
|
768
|
-
:type default: collections.abc.Sequence[int] | None
|
|
769
671
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
770
|
-
:type min: int | None
|
|
771
672
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
772
|
-
:type max: int | None
|
|
773
673
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
774
|
-
:type soft_min: int | None
|
|
775
674
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
776
|
-
:type soft_max: int | None
|
|
777
675
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
778
|
-
:type step: int | None
|
|
779
676
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
780
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
781
677
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
782
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
783
678
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
784
679
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
785
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
786
680
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
787
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
788
681
|
:param update: Function to be called when this value is modified,
|
|
789
682
|
This function must take 2 values (self, context) and return None.
|
|
790
683
|
Warning there are no safety checks to avoid infinite recursion.
|
|
791
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
792
684
|
:param get: Function to be called when this value is read, and the default,
|
|
793
685
|
system-defined storage is not used for this property.
|
|
794
686
|
This function must take 1 value (self) and return the value of the property.
|
|
795
687
|
|
|
796
688
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
797
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[int]] | None
|
|
798
689
|
:param set: Function to be called when this value is written, and the default,
|
|
799
690
|
system-defined storage is not used for this property.
|
|
800
691
|
This function must take 2 values (self, value) and return None.
|
|
801
692
|
|
|
802
693
|
Defining this callback without a matching get one is invalid.
|
|
803
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[int]], None] | None
|
|
804
694
|
:param get_transform: Function to be called when this value is read,
|
|
805
695
|
if some additional processing must be performed on the stored value.
|
|
806
696
|
This function must take three arguments (self, the stored value,
|
|
@@ -808,7 +698,6 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
808
698
|
and return the final, transformed value of the property.
|
|
809
699
|
|
|
810
700
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
811
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[int], bool], collections.abc.Sequence[int]] | None
|
|
812
701
|
:param set_transform: Function to be called when this value is written,
|
|
813
702
|
if some additional processing must be performed on the given value before storing it.
|
|
814
703
|
This function must take four arguments (self, the given value to store,
|
|
@@ -817,7 +706,6 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
817
706
|
and return the final, transformed value of the property.
|
|
818
707
|
|
|
819
708
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
820
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[int], collections.abc.Sequence[int], bool], collections.abc.Sequence[int]] | None
|
|
821
709
|
"""
|
|
822
710
|
|
|
823
711
|
def PointerProperty[_GenericType1: bpy.types.bpy_struct, _GenericType2: bpy.types.ID](
|
|
@@ -828,7 +716,7 @@ def PointerProperty[_GenericType1: bpy.types.bpy_struct, _GenericType2: bpy.type
|
|
|
828
716
|
translation_context: str | None = "*",
|
|
829
717
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
830
718
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
831
|
-
tags=set(),
|
|
719
|
+
tags: set[str] | None = set(),
|
|
832
720
|
poll: collections.abc.Callable[[_GenericType1, _GenericType2], bool] | None = None,
|
|
833
721
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
834
722
|
| None = None,
|
|
@@ -836,36 +724,26 @@ def PointerProperty[_GenericType1: bpy.types.bpy_struct, _GenericType2: bpy.type
|
|
|
836
724
|
"""Returns a new pointer property definition.
|
|
837
725
|
|
|
838
726
|
:param type: A subclass of PropertyGroup or ID.
|
|
839
|
-
:type type: type[bpy.types.PropertyGroup | bpy.types.ID] | None
|
|
840
727
|
:param name: Name used in the user interface.
|
|
841
|
-
:type name: str | None
|
|
842
728
|
:param description: Text used for the tooltip and api documentation.
|
|
843
|
-
:type description: str | None
|
|
844
729
|
:param translation_context: Text used as context to disambiguate translations.
|
|
845
|
-
:type translation_context: str | None
|
|
846
730
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
847
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
848
731
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
849
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
850
732
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
851
733
|
:param poll: Function that determines whether an item is valid for this property.
|
|
852
734
|
The function must take 2 values (self, object) and return a boolean.
|
|
853
735
|
|
|
854
736
|
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.
|
|
855
|
-
:type poll: collections.abc.Callable[[_GenericType1, _GenericType2], bool] | None
|
|
856
737
|
:param update: Function to be called when this value is modified,
|
|
857
738
|
This function must take 2 values (self, context) and return None.
|
|
858
739
|
Warning there are no safety checks to avoid infinite recursion.
|
|
859
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
860
740
|
"""
|
|
861
741
|
|
|
862
742
|
def RemoveProperty(*, cls: typing.Any | None, attr: str | None) -> None:
|
|
863
743
|
"""Removes a dynamically defined property.
|
|
864
744
|
|
|
865
745
|
:param cls: The class containing the property (must be a positional argument).
|
|
866
|
-
:type cls: typing.Any | None
|
|
867
746
|
:param attr: Property name (must be passed as a keyword).
|
|
868
|
-
:type attr: str | None
|
|
869
747
|
"""
|
|
870
748
|
|
|
871
749
|
def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -877,7 +755,7 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
877
755
|
maxlen: int | None = 0,
|
|
878
756
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
879
757
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
880
|
-
tags=set(),
|
|
758
|
+
tags: set[str] | None = set(),
|
|
881
759
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeStringItems = "NONE",
|
|
882
760
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
883
761
|
| None = None,
|
|
@@ -892,43 +770,32 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
892
770
|
collections.abc.Iterable[str | tuple[str, str]],
|
|
893
771
|
]
|
|
894
772
|
| None = None,
|
|
895
|
-
search_options={"SUGGESTION"},
|
|
773
|
+
search_options: set[str] | None = {"SUGGESTION"},
|
|
896
774
|
) -> None:
|
|
897
775
|
"""Returns a new string property definition.
|
|
898
776
|
|
|
899
777
|
:param name: Name used in the user interface.
|
|
900
|
-
:type name: str | None
|
|
901
778
|
:param description: Text used for the tooltip and api documentation.
|
|
902
|
-
:type description: str | None
|
|
903
779
|
:param translation_context: Text used as context to disambiguate translations.
|
|
904
|
-
:type translation_context: str | None
|
|
905
780
|
:param default: initializer string.
|
|
906
|
-
:type default: str | None
|
|
907
781
|
:param maxlen: maximum length of the string.
|
|
908
|
-
:type maxlen: int | None
|
|
909
782
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
910
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
911
783
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
912
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
913
784
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
914
785
|
:param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
|
|
915
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeStringItems
|
|
916
786
|
:param update: Function to be called when this value is modified,
|
|
917
787
|
This function must take 2 values (self, context) and return None.
|
|
918
788
|
Warning there are no safety checks to avoid infinite recursion.
|
|
919
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
920
789
|
:param get: Function to be called when this value is read, and the default,
|
|
921
790
|
system-defined storage is not used for this property.
|
|
922
791
|
This function must take 1 value (self) and return the value of the property.
|
|
923
792
|
|
|
924
793
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
925
|
-
:type get: collections.abc.Callable[[_GenericType1], str] | None
|
|
926
794
|
:param set: Function to be called when this value is written, and the default,
|
|
927
795
|
system-defined storage is not used for this property.
|
|
928
796
|
This function must take 2 values (self, value) and return None.
|
|
929
797
|
|
|
930
798
|
Defining this callback without a matching get one is invalid.
|
|
931
|
-
:type set: collections.abc.Callable[[_GenericType1, str], None] | None
|
|
932
799
|
:param get_transform: Function to be called when this value is read,
|
|
933
800
|
if some additional processing must be performed on the stored value.
|
|
934
801
|
This function must take three arguments (self, the stored value,
|
|
@@ -936,7 +803,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
936
803
|
and return the final, transformed value of the property.
|
|
937
804
|
|
|
938
805
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
939
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, str, bool], str] | None
|
|
940
806
|
:param set_transform: Function to be called when this value is written,
|
|
941
807
|
if some additional processing must be performed on the given value before storing it.
|
|
942
808
|
This function must take four arguments (self, the given value to store,
|
|
@@ -945,7 +811,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
945
811
|
and return the final, transformed value of the property.
|
|
946
812
|
|
|
947
813
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
948
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, str, str, bool], str] | None
|
|
949
814
|
:param search: Function to be called to show candidates for this string (shown in the UI).
|
|
950
815
|
This function must take 3 values (self, context, edit_text)
|
|
951
816
|
and return a sequence, iterator or generator where each item must be:
|
|
@@ -954,7 +819,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
954
819
|
|
|
955
820
|
A tuple-pair of strings, where the first is a candidate and the second
|
|
956
821
|
is additional information about the candidate.
|
|
957
|
-
:type search: collections.abc.Callable[[_GenericType1, bpy.types.Context, str], collections.abc.Iterable[str | tuple[str, str]]] | None
|
|
958
822
|
:param search_options: Set of strings in:
|
|
959
823
|
|
|
960
824
|
SORT sorts the resulting items.
|