fake-bpy-module-latest 20250927__py3-none-any.whl → 20260122__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 → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
- {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
- {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +2 -0
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- _bpy_internal/__init__.pyi +3 -1
- _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
- _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
- _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
- _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
- _bpy_internal/filesystem/__init__.pyi +5 -0
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_types/__init__.pyi +18 -123
- {rna_info → _rna_info}/__init__.pyi +0 -1
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +55 -131
- bl_math/__init__.pyi +2 -12
- bl_operators/__init__.pyi +1 -0
- bl_operators/add_mesh_torus/__init__.pyi +0 -2
- bl_operators/anim/__init__.pyi +47 -24
- 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 +261 -0
- 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 +51 -47
- bl_operators/object/__init__.pyi +0 -37
- 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 +1 -3
- bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
- bl_operators/uvcalc_transform/__init__.pyi +21 -12
- 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 +3 -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 +13 -16
- bl_ui/node_add_menu_compositor/__init__.pyi +71 -53
- bl_ui/node_add_menu_geometry/__init__.pyi +81 -193
- bl_ui/node_add_menu_shader/__init__.pyi +21 -39
- bl_ui/node_add_menu_texture/__init__.pyi +1 -17
- bl_ui/properties_collection/__init__.pyi +0 -14
- bl_ui/properties_constraint/__init__.pyi +64 -150
- 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 +12 -19
- 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 +35 -42
- bl_ui/properties_output/__init__.pyi +0 -40
- bl_ui/properties_paint_common/__init__.pyi +23 -12
- 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 +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +0 -54
- bl_ui/properties_view_layer/__init__.pyi +7 -28
- bl_ui/properties_workspace/__init__.pyi +0 -8
- bl_ui/properties_world/__init__.pyi +0 -22
- bl_ui/space_clip/__init__.pyi +1 -150
- bl_ui/space_console/__init__.pyi +0 -12
- bl_ui/space_dopesheet/__init__.pyi +52 -60
- bl_ui/space_filebrowser/__init__.pyi +0 -60
- bl_ui/space_graph/__init__.pyi +0 -44
- bl_ui/space_image/__init__.pyi +2 -144
- bl_ui/space_info/__init__.pyi +0 -12
- bl_ui/space_nla/__init__.pyi +0 -36
- bl_ui/space_node/__init__.pyi +29 -137
- bl_ui/space_outliner/__init__.pyi +0 -30
- bl_ui/space_properties/__init__.pyi +29 -6
- bl_ui/space_sequencer/__init__.pyi +46 -912
- 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 +7 -41
- bl_ui/space_topbar/__init__.pyi +7 -52
- bl_ui/space_userpref/__init__.pyi +7 -188
- bl_ui/space_view3d/__init__.pyi +36 -544
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +2 -163
- blf/__init__.pyi +6 -50
- bmesh/__init__.pyi +0 -7
- bmesh/geometry/__init__.pyi +0 -3
- bmesh/ops/__init__.pyi +2 -450
- bmesh/types/__init__.pyi +294 -634
- bmesh/utils/__init__.pyi +16 -43
- bpy/app/__init__.pyi +60 -59
- bpy/app/handlers/__init__.pyi +4 -0
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +0 -6
- bpy/app/translations/__init__.pyi +1 -16
- bpy/msgbus/__init__.pyi +1 -4
- bpy/ops/action/__init__.pyi +15 -165
- bpy/ops/anim/__init__.pyi +38 -279
- bpy/ops/armature/__init__.pyi +18 -192
- bpy/ops/asset/__init__.pyi +11 -97
- bpy/ops/boid/__init__.pyi +7 -38
- bpy/ops/brush/__init__.pyi +3 -104
- 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 +3 -35
- 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 +17 -166
- 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 +2 -10
- bpy/ops/export_scene/__init__.pyi +1 -155
- 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 -124
- 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 +61 -522
- bpy/ops/image/__init__.pyi +19 -379
- bpy/ops/import_anim/__init__.pyi +2 -16
- 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 +32 -915
- bpy/ops/nla/__init__.pyi +20 -184
- bpy/ops/node/__init__.pyi +306 -666
- bpy/ops/object/__init__.pyi +139 -1254
- bpy/ops/outliner/__init__.pyi +47 -327
- bpy/ops/paint/__init__.pyi +43 -282
- 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 +28 -233
- bpy/ops/poselib/__init__.pyi +4 -69
- bpy/ops/preferences/__init__.pyi +23 -177
- bpy/ops/ptcache/__init__.pyi +5 -31
- bpy/ops/render/__init__.pyi +10 -74
- bpy/ops/rigidbody/__init__.pyi +6 -56
- bpy/ops/scene/__init__.pyi +22 -167
- bpy/ops/screen/__init__.pyi +36 -202
- bpy/ops/script/__init__.pyi +1 -12
- bpy/ops/sculpt/__init__.pyi +41 -312
- bpy/ops/sculpt_curves/__init__.pyi +6 -21
- bpy/ops/sequencer/__init__.pyi +92 -669
- 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 +27 -225
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +3 -18
- bpy/ops/transform/__init__.pyi +10 -382
- bpy/ops/ui/__init__.pyi +21 -158
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +52 -305
- bpy/ops/view2d/__init__.pyi +3 -73
- bpy/ops/view3d/__init__.pyi +37 -339
- bpy/ops/wm/__init__.pyi +116 -1316
- bpy/ops/workspace/__init__.pyi +7 -39
- bpy/ops/world/__init__.pyi +2 -10
- bpy/path/__init__.pyi +0 -34
- bpy/props/__init__.pyi +15 -157
- bpy/stub_internal/rna_enums/__init__.pyi +65 -33
- bpy/types/__init__.pyi +21798 -58228
- bpy/utils/__init__.pyi +4 -75
- bpy/utils/previews/__init__.pyi +1 -10
- bpy/utils/units/__init__.pyi +0 -12
- bpy_extras/anim_utils/__init__.pyi +24 -16
- bpy_extras/bmesh_utils/__init__.pyi +0 -1
- bpy_extras/id_map_utils/__init__.pyi +14 -6
- bpy_extras/image_utils/__init__.pyi +0 -9
- bpy_extras/io_utils/__init__.pyi +2 -22
- bpy_extras/keyconfig_utils/__init__.pyi +1 -1
- 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-20250927.dist-info → fake_bpy_module_latest-20260122.dist-info}/METADATA +4 -1
- fake_bpy_module_latest-20260122.dist-info/RECORD +385 -0
- {fake_bpy_module_latest-20250927.dist-info → fake_bpy_module_latest-20260122.dist-info}/WHEEL +1 -1
- {fake_bpy_module_latest-20250927.dist-info → fake_bpy_module_latest-20260122.dist-info}/top_level.txt +14 -14
- 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 +1 -7
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +1 -10
- gpu/platform/__init__.pyi +0 -5
- gpu/shader/__init__.pyi +22 -6
- gpu/state/__init__.pyi +59 -38
- gpu/texture/__init__.pyi +0 -2
- gpu/types/__init__.pyi +162 -230
- gpu_extras/batch/__init__.pyi +0 -4
- gpu_extras/presets/__init__.pyi +6 -8
- idprop/__init__.pyi +16 -0
- idprop/types/__init__.pyi +5 -5
- imbuf/__init__.pyi +2 -9
- imbuf/types/__init__.pyi +5 -25
- keyingsets_builtins/__init__.pyi +1 -45
- mathutils/__init__.pyi +82 -2172
- mathutils/bvhtree/__init__.pyi +4 -24
- mathutils/geometry/__init__.pyi +41 -133
- mathutils/interpolate/__init__.pyi +3 -4
- mathutils/kdtree/__init__.pyi +0 -11
- mathutils/noise/__init__.pyi +0 -62
- fake_bpy_module_latest-20250927.dist-info/RECORD +0 -373
- {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
- {animsys_refactor → _animsys_refactor}/py.typed +0 -0
- {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
- {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
- {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/py.typed +0 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
- {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
- /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
- {console_python → _console_python}/__init__.pyi +0 -0
- {console_python → _console_python}/py.typed +0 -0
- {console_shell → _console_shell}/__init__.pyi +0 -0
- {console_shell → _console_shell}/py.typed +0 -0
- {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
- {graphviz_export → _graphviz_export}/py.typed +0 -0
- {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
- {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
- {rna_info → _rna_info}/py.typed +0 -0
- {rna_xml → _rna_xml}/__init__.pyi +0 -0
- {rna_xml → _rna_xml}/py.typed +0 -0
bpy/props/__init__.pyi
CHANGED
|
@@ -140,12 +140,6 @@ in data, caused e.g. by an update
|
|
|
140
140
|
Pointer properties do not support storing references to embedded IDs (e.g. bpy.types.Scene.collection, bpy.types.Material.node_tree).
|
|
141
141
|
These should exclusively be referenced and accessed through their owner ID (e.g. the scene or material).
|
|
142
142
|
|
|
143
|
-
[NOTE]
|
|
144
|
-
Typically this function doesn't need to be accessed directly.
|
|
145
|
-
Instead use del cls.attr
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
143
|
"""
|
|
150
144
|
|
|
151
145
|
import typing
|
|
@@ -163,7 +157,7 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
163
157
|
default=False,
|
|
164
158
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
165
159
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
166
|
-
tags=set(),
|
|
160
|
+
tags: set[str] | None = set(),
|
|
167
161
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
168
162
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
169
163
|
| None = None,
|
|
@@ -179,34 +173,25 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
179
173
|
"""Returns a new boolean property definition.
|
|
180
174
|
|
|
181
175
|
:param name: Name used in the user interface.
|
|
182
|
-
:type name: str | None
|
|
183
176
|
:param description: Text used for the tooltip and api documentation.
|
|
184
|
-
:type description: str | None
|
|
185
177
|
:param translation_context: Text used as context to disambiguate translations.
|
|
186
|
-
:type translation_context: str | None
|
|
187
178
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
188
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
189
179
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
190
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
191
180
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
192
181
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
193
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
194
182
|
:param update: Function to be called when this value is modified,
|
|
195
183
|
This function must take 2 values (self, context) and return None.
|
|
196
184
|
Warning there are no safety checks to avoid infinite recursion.
|
|
197
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
198
185
|
:param get: Function to be called when this value is read, and the default,
|
|
199
186
|
system-defined storage is not used for this property.
|
|
200
187
|
This function must take 1 value (self) and return the value of the property.
|
|
201
188
|
|
|
202
189
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
203
|
-
:type get: collections.abc.Callable[[_GenericType1], bool] | None
|
|
204
190
|
:param set: Function to be called when this value is written, and the default,
|
|
205
191
|
system-defined storage is not used for this property.
|
|
206
192
|
This function must take 2 values (self, value) and return None.
|
|
207
193
|
|
|
208
194
|
Defining this callback without a matching get one is invalid.
|
|
209
|
-
:type set: collections.abc.Callable[[_GenericType1, bool], None] | None
|
|
210
195
|
:param get_transform: Function to be called when this value is read,
|
|
211
196
|
if some additional processing must be performed on the stored value.
|
|
212
197
|
This function must take three arguments (self, the stored value,
|
|
@@ -214,7 +199,6 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
214
199
|
and return the final, transformed value of the property.
|
|
215
200
|
|
|
216
201
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
217
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, bool, bool], bool] | None
|
|
218
202
|
:param set_transform: Function to be called when this value is written,
|
|
219
203
|
if some additional processing must be performed on the given value before storing it.
|
|
220
204
|
This function must take four arguments (self, the given value to store,
|
|
@@ -223,7 +207,6 @@ def BoolProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
223
207
|
and return the final, transformed value of the property.
|
|
224
208
|
|
|
225
209
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
226
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, bool, bool, bool], bool] | None
|
|
227
210
|
"""
|
|
228
211
|
|
|
229
212
|
def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -234,7 +217,7 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
234
217
|
default: collections.abc.Sequence[bool] | None = (False, False, False),
|
|
235
218
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
236
219
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
237
|
-
tags=set(),
|
|
220
|
+
tags: set[str] | None = set(),
|
|
238
221
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
239
222
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
240
223
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -262,38 +245,27 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
262
245
|
"""Returns a new vector boolean property definition.
|
|
263
246
|
|
|
264
247
|
:param name: Name used in the user interface.
|
|
265
|
-
:type name: str | None
|
|
266
248
|
:param description: Text used for the tooltip and api documentation.
|
|
267
|
-
:type description: str | None
|
|
268
249
|
:param translation_context: Text used as context to disambiguate translations.
|
|
269
|
-
:type translation_context: str | None
|
|
270
250
|
:param default: sequence of booleans the length of size.
|
|
271
|
-
:type default: collections.abc.Sequence[bool] | None
|
|
272
251
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
273
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
274
252
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
275
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
276
253
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
277
254
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
278
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
279
255
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
280
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
281
256
|
:param update: Function to be called when this value is modified,
|
|
282
257
|
This function must take 2 values (self, context) and return None.
|
|
283
258
|
Warning there are no safety checks to avoid infinite recursion.
|
|
284
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
285
259
|
:param get: Function to be called when this value is read, and the default,
|
|
286
260
|
system-defined storage is not used for this property.
|
|
287
261
|
This function must take 1 value (self) and return the value of the property.
|
|
288
262
|
|
|
289
263
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
290
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[bool]] | None
|
|
291
264
|
:param set: Function to be called when this value is written, and the default,
|
|
292
265
|
system-defined storage is not used for this property.
|
|
293
266
|
This function must take 2 values (self, value) and return None.
|
|
294
267
|
|
|
295
268
|
Defining this callback without a matching get one is invalid.
|
|
296
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[bool]], None] | None
|
|
297
269
|
:param get_transform: Function to be called when this value is read,
|
|
298
270
|
if some additional processing must be performed on the stored value.
|
|
299
271
|
This function must take three arguments (self, the stored value,
|
|
@@ -301,7 +273,6 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
301
273
|
and return the final, transformed value of the property.
|
|
302
274
|
|
|
303
275
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
304
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[bool], bool], collections.abc.Sequence[bool]] | None
|
|
305
276
|
:param set_transform: Function to be called when this value is written,
|
|
306
277
|
if some additional processing must be performed on the given value before storing it.
|
|
307
278
|
This function must take four arguments (self, the given value to store,
|
|
@@ -310,7 +281,6 @@ def BoolVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
310
281
|
and return the final, transformed value of the property.
|
|
311
282
|
|
|
312
283
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
313
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[bool], collections.abc.Sequence[bool], bool], collections.abc.Sequence[bool]] | None
|
|
314
284
|
"""
|
|
315
285
|
|
|
316
286
|
def CollectionProperty(
|
|
@@ -323,22 +293,16 @@ def CollectionProperty(
|
|
|
323
293
|
override: set[
|
|
324
294
|
bpy.stub_internal.rna_enums.PropertyOverrideFlagCollectionItems
|
|
325
295
|
] = set(),
|
|
326
|
-
tags=set(),
|
|
296
|
+
tags: set[str] | None = set(),
|
|
327
297
|
) -> None:
|
|
328
298
|
"""Returns a new collection property definition.
|
|
329
299
|
|
|
330
300
|
:param type: A subclass of a property group.
|
|
331
|
-
:type type: type[bpy.types.PropertyGroup] | None
|
|
332
301
|
:param name: Name used in the user interface.
|
|
333
|
-
:type name: str | None
|
|
334
302
|
:param description: Text used for the tooltip and api documentation.
|
|
335
|
-
:type description: str | None
|
|
336
303
|
:param translation_context: Text used as context to disambiguate translations.
|
|
337
|
-
:type translation_context: str | None
|
|
338
304
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
339
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
340
305
|
:param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
|
|
341
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagCollectionItems]
|
|
342
306
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
343
307
|
"""
|
|
344
308
|
|
|
@@ -362,10 +326,10 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
362
326
|
name: str | None = "",
|
|
363
327
|
description: str | None = "",
|
|
364
328
|
translation_context: str | None = "*",
|
|
365
|
-
default: int | str | None = None,
|
|
329
|
+
default: int | set[str] | str | None = None,
|
|
366
330
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagEnumItems] = {"ANIMATABLE"},
|
|
367
331
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
368
|
-
tags=set(),
|
|
332
|
+
tags: set[str] | None = set(),
|
|
369
333
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
370
334
|
| None = None,
|
|
371
335
|
get: collections.abc.Callable[[_GenericType1], int] | None = None,
|
|
@@ -418,39 +382,29 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
418
382
|
There is a known bug with using a callback,
|
|
419
383
|
Python must keep a reference to the strings returned by the callback or Blender
|
|
420
384
|
will misbehave or even crash.
|
|
421
|
-
: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]]
|
|
422
385
|
:param name: Name used in the user interface.
|
|
423
|
-
:type name: str | None
|
|
424
386
|
:param description: Text used for the tooltip and api documentation.
|
|
425
|
-
:type description: str | None
|
|
426
387
|
:param translation_context: Text used as context to disambiguate translations.
|
|
427
|
-
:type translation_context: str | None
|
|
428
388
|
:param default: The default value for this enum, a string from the identifiers used in items, or integer matching an item number.
|
|
429
389
|
If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
|
|
430
390
|
WARNING: Strings cannot be specified for dynamic enums
|
|
431
391
|
(i.e. if a callback function is given as items parameter).
|
|
432
|
-
:type default: int | str | None
|
|
433
392
|
:param options: Enumerator in `rna_enum_property_flag_enum_items`.
|
|
434
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagEnumItems]
|
|
435
393
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
436
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
437
394
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
438
395
|
:param update: Function to be called when this value is modified,
|
|
439
396
|
This function must take 2 values (self, context) and return None.
|
|
440
397
|
Warning there are no safety checks to avoid infinite recursion.
|
|
441
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
442
398
|
:param get: Function to be called when this value is read, and the default,
|
|
443
399
|
system-defined storage is not used for this property.
|
|
444
400
|
This function must take 1 value (self) and return the value of the property.
|
|
445
401
|
|
|
446
402
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
447
|
-
:type get: collections.abc.Callable[[_GenericType1], int] | None
|
|
448
403
|
:param set: Function to be called when this value is written, and the default,
|
|
449
404
|
system-defined storage is not used for this property.
|
|
450
405
|
This function must take 2 values (self, value) and return None.
|
|
451
406
|
|
|
452
407
|
Defining this callback without a matching get one is invalid.
|
|
453
|
-
:type set: collections.abc.Callable[[_GenericType1, int], None] | None
|
|
454
408
|
:param get_transform: Function to be called when this value is read,
|
|
455
409
|
if some additional processing must be performed on the stored value.
|
|
456
410
|
This function must take three arguments (self, the stored value,
|
|
@@ -458,7 +412,6 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
458
412
|
and return the final, transformed value of the property.
|
|
459
413
|
|
|
460
414
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
461
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, bool], int] | None
|
|
462
415
|
:param set_transform: Function to be called when this value is written,
|
|
463
416
|
if some additional processing must be performed on the given value before storing it.
|
|
464
417
|
This function must take four arguments (self, the given value to store,
|
|
@@ -467,7 +420,6 @@ def EnumProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
467
420
|
and return the final, transformed value of the property.
|
|
468
421
|
|
|
469
422
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
470
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, int, bool], int] | None
|
|
471
423
|
"""
|
|
472
424
|
|
|
473
425
|
def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -480,11 +432,11 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
480
432
|
max: float | None = 3.402823e38,
|
|
481
433
|
soft_min: float | None = -3.402823e38,
|
|
482
434
|
soft_max: float | None = 3.402823e38,
|
|
483
|
-
step:
|
|
435
|
+
step: float | None = 3,
|
|
484
436
|
precision: int | None = 2,
|
|
485
437
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
486
438
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
487
|
-
tags=set(),
|
|
439
|
+
tags: set[str] | None = set(),
|
|
488
440
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
489
441
|
unit: bpy.stub_internal.rna_enums.PropertyUnitItems = "NONE",
|
|
490
442
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -501,48 +453,32 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
501
453
|
"""Returns a new float (single precision) property definition.
|
|
502
454
|
|
|
503
455
|
:param name: Name used in the user interface.
|
|
504
|
-
:type name: str | None
|
|
505
456
|
:param description: Text used for the tooltip and api documentation.
|
|
506
|
-
:type description: str | None
|
|
507
457
|
:param translation_context: Text used as context to disambiguate translations.
|
|
508
|
-
:type translation_context: str | None
|
|
509
458
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
510
|
-
:type min: float | None
|
|
511
459
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
512
|
-
:type max: float | None
|
|
513
460
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
514
|
-
:type soft_min: float | None
|
|
515
461
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
516
|
-
:type soft_max: float | None
|
|
517
462
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
518
|
-
:type step: int | None
|
|
519
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.
|
|
520
|
-
:type precision: int | None
|
|
521
464
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
522
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
523
465
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
524
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
525
466
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
526
467
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
527
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
528
468
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
529
|
-
:type unit: bpy.stub_internal.rna_enums.PropertyUnitItems
|
|
530
469
|
:param update: Function to be called when this value is modified,
|
|
531
470
|
This function must take 2 values (self, context) and return None.
|
|
532
471
|
Warning there are no safety checks to avoid infinite recursion.
|
|
533
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
534
472
|
:param get: Function to be called when this value is read, and the default,
|
|
535
473
|
system-defined storage is not used for this property.
|
|
536
474
|
This function must take 1 value (self) and return the value of the property.
|
|
537
475
|
|
|
538
476
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
539
|
-
:type get: collections.abc.Callable[[_GenericType1], float] | None
|
|
540
477
|
:param set: Function to be called when this value is written, and the default,
|
|
541
478
|
system-defined storage is not used for this property.
|
|
542
479
|
This function must take 2 values (self, value) and return None.
|
|
543
480
|
|
|
544
481
|
Defining this callback without a matching get one is invalid.
|
|
545
|
-
:type set: collections.abc.Callable[[_GenericType1, float], None] | None
|
|
546
482
|
:param get_transform: Function to be called when this value is read,
|
|
547
483
|
if some additional processing must be performed on the stored value.
|
|
548
484
|
This function must take three arguments (self, the stored value,
|
|
@@ -550,7 +486,6 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
550
486
|
and return the final, transformed value of the property.
|
|
551
487
|
|
|
552
488
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
553
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, float, bool], float] | None
|
|
554
489
|
:param set_transform: Function to be called when this value is written,
|
|
555
490
|
if some additional processing must be performed on the given value before storing it.
|
|
556
491
|
This function must take four arguments (self, the given value to store,
|
|
@@ -559,7 +494,6 @@ def FloatProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
559
494
|
and return the final, transformed value of the property.
|
|
560
495
|
|
|
561
496
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
562
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, float, float, bool], float] | None
|
|
563
497
|
"""
|
|
564
498
|
|
|
565
499
|
def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -572,11 +506,11 @@ def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
572
506
|
max: float | None = sys.float_info.max,
|
|
573
507
|
soft_min: float | None = sys.float_info.min,
|
|
574
508
|
soft_max: float | None = sys.float_info.max,
|
|
575
|
-
step:
|
|
509
|
+
step: float | None = 3,
|
|
576
510
|
precision: int | None = 2,
|
|
577
511
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
578
512
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
579
|
-
tags=set(),
|
|
513
|
+
tags: set[str] | None = set(),
|
|
580
514
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
581
515
|
unit: bpy.stub_internal.rna_enums.PropertyUnitItems = "NONE",
|
|
582
516
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
@@ -592,52 +526,34 @@ def FloatVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
592
526
|
"""Returns a new vector float property definition.
|
|
593
527
|
|
|
594
528
|
:param name: Name used in the user interface.
|
|
595
|
-
:type name: str | None
|
|
596
529
|
:param description: Text used for the tooltip and api documentation.
|
|
597
|
-
:type description: str | None
|
|
598
530
|
:param translation_context: Text used as context to disambiguate translations.
|
|
599
|
-
:type translation_context: str | None
|
|
600
531
|
:param default: Sequence of floats the length of size.
|
|
601
|
-
:type default: collections.abc.Sequence[float] | None
|
|
602
532
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
603
|
-
:type min: float | None
|
|
604
533
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
605
|
-
:type max: float | None
|
|
606
534
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
607
|
-
:type soft_min: float | None
|
|
608
535
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
609
|
-
:type soft_max: float | None
|
|
610
536
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
611
|
-
:type step: int | None
|
|
612
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.
|
|
613
|
-
:type precision: int | None
|
|
614
538
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
615
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
616
539
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
617
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
618
540
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
619
541
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
620
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
621
542
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
622
|
-
:type unit: bpy.stub_internal.rna_enums.PropertyUnitItems
|
|
623
543
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
624
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
625
544
|
:param update: Function to be called when this value is modified,
|
|
626
545
|
This function must take 2 values (self, context) and return None.
|
|
627
546
|
Warning there are no safety checks to avoid infinite recursion.
|
|
628
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
629
547
|
:param get: Function to be called when this value is read, and the default,
|
|
630
548
|
system-defined storage is not used for this property.
|
|
631
549
|
This function must take 1 value (self) and return the value of the property.
|
|
632
550
|
|
|
633
551
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
634
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[float]] | None
|
|
635
552
|
:param set: Function to be called when this value is written, and the default,
|
|
636
553
|
system-defined storage is not used for this property.
|
|
637
554
|
This function must take 2 values (self, value) and return None.
|
|
638
555
|
|
|
639
556
|
Defining this callback without a matching get one is invalid.
|
|
640
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[float]], None] | None
|
|
641
557
|
"""
|
|
642
558
|
|
|
643
559
|
def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -653,7 +569,7 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
653
569
|
step: int | None = 1,
|
|
654
570
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
655
571
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
656
|
-
tags=set(),
|
|
572
|
+
tags: set[str] | None = set(),
|
|
657
573
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems = "NONE",
|
|
658
574
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
659
575
|
| None = None,
|
|
@@ -667,44 +583,30 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
667
583
|
"""Returns a new int property definition.
|
|
668
584
|
|
|
669
585
|
:param name: Name used in the user interface.
|
|
670
|
-
:type name: str | None
|
|
671
586
|
:param description: Text used for the tooltip and api documentation.
|
|
672
|
-
:type description: str | None
|
|
673
587
|
:param translation_context: Text used as context to disambiguate translations.
|
|
674
|
-
:type translation_context: str | None
|
|
675
588
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
676
|
-
:type min: int | None
|
|
677
589
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
678
|
-
:type max: int | None
|
|
679
590
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
680
|
-
:type soft_min: int | None
|
|
681
591
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
682
|
-
:type soft_max: int | None
|
|
683
592
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
684
|
-
:type step: int | None
|
|
685
593
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
686
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
687
594
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
688
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
689
595
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
690
596
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
691
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberItems
|
|
692
597
|
:param update: Function to be called when this value is modified,
|
|
693
598
|
This function must take 2 values (self, context) and return None.
|
|
694
599
|
Warning there are no safety checks to avoid infinite recursion.
|
|
695
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
696
600
|
:param get: Function to be called when this value is read, and the default,
|
|
697
601
|
system-defined storage is not used for this property.
|
|
698
602
|
This function must take 1 value (self) and return the value of the property.
|
|
699
603
|
|
|
700
604
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
701
|
-
:type get: collections.abc.Callable[[_GenericType1], int] | None
|
|
702
605
|
:param set: Function to be called when this value is written, and the default,
|
|
703
606
|
system-defined storage is not used for this property.
|
|
704
607
|
This function must take 2 values (self, value) and return None.
|
|
705
608
|
|
|
706
609
|
Defining this callback without a matching get one is invalid.
|
|
707
|
-
:type set: collections.abc.Callable[[_GenericType1, int], None] | None
|
|
708
610
|
:param get_transform: Function to be called when this value is read,
|
|
709
611
|
if some additional processing must be performed on the stored value.
|
|
710
612
|
This function must take three arguments (self, the stored value,
|
|
@@ -712,7 +614,6 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
712
614
|
and return the final, transformed value of the property.
|
|
713
615
|
|
|
714
616
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
715
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, bool], int] | None
|
|
716
617
|
:param set_transform: Function to be called when this value is written,
|
|
717
618
|
if some additional processing must be performed on the given value before storing it.
|
|
718
619
|
This function must take four arguments (self, the given value to store,
|
|
@@ -721,7 +622,6 @@ def IntProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
721
622
|
and return the final, transformed value of the property.
|
|
722
623
|
|
|
723
624
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
724
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, int, int, bool], int] | None
|
|
725
625
|
"""
|
|
726
626
|
|
|
727
627
|
def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -737,7 +637,7 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
737
637
|
step: int | None = 1,
|
|
738
638
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
739
639
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
740
|
-
tags=set(),
|
|
640
|
+
tags: set[str] | None = set(),
|
|
741
641
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems = "NONE",
|
|
742
642
|
size: collections.abc.Sequence[int] | int | None = 3,
|
|
743
643
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
@@ -765,48 +665,32 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
765
665
|
"""Returns a new vector int property definition.
|
|
766
666
|
|
|
767
667
|
:param name: Name used in the user interface.
|
|
768
|
-
:type name: str | None
|
|
769
668
|
:param description: Text used for the tooltip and api documentation.
|
|
770
|
-
:type description: str | None
|
|
771
669
|
:param translation_context: Text used as context to disambiguate translations.
|
|
772
|
-
:type translation_context: str | None
|
|
773
670
|
:param default: sequence of ints the length of size.
|
|
774
|
-
:type default: collections.abc.Sequence[int] | None
|
|
775
671
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
776
|
-
:type min: int | None
|
|
777
672
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
778
|
-
:type max: int | None
|
|
779
673
|
:param soft_min: Soft minimum (>= min), user wont be able to drag the widget below this value in the UI.
|
|
780
|
-
:type soft_min: int | None
|
|
781
674
|
:param soft_max: Soft maximum (<= max), user wont be able to drag the widget above this value in the UI.
|
|
782
|
-
:type soft_max: int | None
|
|
783
675
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
784
|
-
:type step: int | None
|
|
785
676
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
786
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
787
677
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
788
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
789
678
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
790
679
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
791
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeNumberArrayItems
|
|
792
680
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
793
|
-
:type size: collections.abc.Sequence[int] | int | None
|
|
794
681
|
:param update: Function to be called when this value is modified,
|
|
795
682
|
This function must take 2 values (self, context) and return None.
|
|
796
683
|
Warning there are no safety checks to avoid infinite recursion.
|
|
797
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
798
684
|
:param get: Function to be called when this value is read, and the default,
|
|
799
685
|
system-defined storage is not used for this property.
|
|
800
686
|
This function must take 1 value (self) and return the value of the property.
|
|
801
687
|
|
|
802
688
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
803
|
-
:type get: collections.abc.Callable[[_GenericType1], collections.abc.Sequence[int]] | None
|
|
804
689
|
:param set: Function to be called when this value is written, and the default,
|
|
805
690
|
system-defined storage is not used for this property.
|
|
806
691
|
This function must take 2 values (self, value) and return None.
|
|
807
692
|
|
|
808
693
|
Defining this callback without a matching get one is invalid.
|
|
809
|
-
:type set: collections.abc.Callable[[_GenericType1, collections.abc.Sequence[int]], None] | None
|
|
810
694
|
:param get_transform: Function to be called when this value is read,
|
|
811
695
|
if some additional processing must be performed on the stored value.
|
|
812
696
|
This function must take three arguments (self, the stored value,
|
|
@@ -814,7 +698,6 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
814
698
|
and return the final, transformed value of the property.
|
|
815
699
|
|
|
816
700
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
817
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[int], bool], collections.abc.Sequence[int]] | None
|
|
818
701
|
:param set_transform: Function to be called when this value is written,
|
|
819
702
|
if some additional processing must be performed on the given value before storing it.
|
|
820
703
|
This function must take four arguments (self, the given value to store,
|
|
@@ -823,7 +706,6 @@ def IntVectorProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
823
706
|
and return the final, transformed value of the property.
|
|
824
707
|
|
|
825
708
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
826
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, collections.abc.Sequence[int], collections.abc.Sequence[int], bool], collections.abc.Sequence[int]] | None
|
|
827
709
|
"""
|
|
828
710
|
|
|
829
711
|
def PointerProperty[_GenericType1: bpy.types.bpy_struct, _GenericType2: bpy.types.ID](
|
|
@@ -834,44 +716,34 @@ def PointerProperty[_GenericType1: bpy.types.bpy_struct, _GenericType2: bpy.type
|
|
|
834
716
|
translation_context: str | None = "*",
|
|
835
717
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
836
718
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
837
|
-
tags=set(),
|
|
719
|
+
tags: set[str] | None = set(),
|
|
838
720
|
poll: collections.abc.Callable[[_GenericType1, _GenericType2], bool] | None = None,
|
|
839
721
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
840
722
|
| None = None,
|
|
841
723
|
) -> None:
|
|
842
724
|
"""Returns a new pointer property definition.
|
|
843
725
|
|
|
844
|
-
:param type: A subclass of
|
|
845
|
-
:type type: type[bpy.types.PropertyGroup | bpy.types.ID] | None
|
|
726
|
+
:param type: A subclass of PropertyGroup or ID.
|
|
846
727
|
:param name: Name used in the user interface.
|
|
847
|
-
:type name: str | None
|
|
848
728
|
:param description: Text used for the tooltip and api documentation.
|
|
849
|
-
:type description: str | None
|
|
850
729
|
:param translation_context: Text used as context to disambiguate translations.
|
|
851
|
-
:type translation_context: str | None
|
|
852
730
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
853
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
854
731
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
855
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
856
732
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
857
733
|
:param poll: Function that determines whether an item is valid for this property.
|
|
858
734
|
The function must take 2 values (self, object) and return a boolean.
|
|
859
735
|
|
|
860
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.
|
|
861
|
-
:type poll: collections.abc.Callable[[_GenericType1, _GenericType2], bool] | None
|
|
862
737
|
:param update: Function to be called when this value is modified,
|
|
863
738
|
This function must take 2 values (self, context) and return None.
|
|
864
739
|
Warning there are no safety checks to avoid infinite recursion.
|
|
865
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
866
740
|
"""
|
|
867
741
|
|
|
868
742
|
def RemoveProperty(*, cls: typing.Any | None, attr: str | None) -> None:
|
|
869
743
|
"""Removes a dynamically defined property.
|
|
870
744
|
|
|
871
745
|
:param cls: The class containing the property (must be a positional argument).
|
|
872
|
-
:type cls: typing.Any | None
|
|
873
746
|
:param attr: Property name (must be passed as a keyword).
|
|
874
|
-
:type attr: str | None
|
|
875
747
|
"""
|
|
876
748
|
|
|
877
749
|
def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
@@ -883,7 +755,7 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
883
755
|
maxlen: int | None = 0,
|
|
884
756
|
options: set[bpy.stub_internal.rna_enums.PropertyFlagItems] = {"ANIMATABLE"},
|
|
885
757
|
override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems] = set(),
|
|
886
|
-
tags=set(),
|
|
758
|
+
tags: set[str] | None = set(),
|
|
887
759
|
subtype: bpy.stub_internal.rna_enums.PropertySubtypeStringItems = "NONE",
|
|
888
760
|
update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None]
|
|
889
761
|
| None = None,
|
|
@@ -898,43 +770,32 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
898
770
|
collections.abc.Iterable[str | tuple[str, str]],
|
|
899
771
|
]
|
|
900
772
|
| None = None,
|
|
901
|
-
search_options={"SUGGESTION"},
|
|
773
|
+
search_options: set[str] | None = {"SUGGESTION"},
|
|
902
774
|
) -> None:
|
|
903
775
|
"""Returns a new string property definition.
|
|
904
776
|
|
|
905
777
|
:param name: Name used in the user interface.
|
|
906
|
-
:type name: str | None
|
|
907
778
|
:param description: Text used for the tooltip and api documentation.
|
|
908
|
-
:type description: str | None
|
|
909
779
|
:param translation_context: Text used as context to disambiguate translations.
|
|
910
|
-
:type translation_context: str | None
|
|
911
780
|
:param default: initializer string.
|
|
912
|
-
:type default: str | None
|
|
913
781
|
:param maxlen: maximum length of the string.
|
|
914
|
-
:type maxlen: int | None
|
|
915
782
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
916
|
-
:type options: set[bpy.stub_internal.rna_enums.PropertyFlagItems]
|
|
917
783
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
918
|
-
:type override: set[bpy.stub_internal.rna_enums.PropertyOverrideFlagItems]
|
|
919
784
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
920
785
|
:param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
|
|
921
|
-
:type subtype: bpy.stub_internal.rna_enums.PropertySubtypeStringItems
|
|
922
786
|
:param update: Function to be called when this value is modified,
|
|
923
787
|
This function must take 2 values (self, context) and return None.
|
|
924
788
|
Warning there are no safety checks to avoid infinite recursion.
|
|
925
|
-
:type update: collections.abc.Callable[[_GenericType1, bpy.types.Context], None] | None
|
|
926
789
|
:param get: Function to be called when this value is read, and the default,
|
|
927
790
|
system-defined storage is not used for this property.
|
|
928
791
|
This function must take 1 value (self) and return the value of the property.
|
|
929
792
|
|
|
930
793
|
Defining this callback without a matching set one will make the property read-only (even if READ_ONLY option is not set).
|
|
931
|
-
:type get: collections.abc.Callable[[_GenericType1], str] | None
|
|
932
794
|
:param set: Function to be called when this value is written, and the default,
|
|
933
795
|
system-defined storage is not used for this property.
|
|
934
796
|
This function must take 2 values (self, value) and return None.
|
|
935
797
|
|
|
936
798
|
Defining this callback without a matching get one is invalid.
|
|
937
|
-
:type set: collections.abc.Callable[[_GenericType1, str], None] | None
|
|
938
799
|
:param get_transform: Function to be called when this value is read,
|
|
939
800
|
if some additional processing must be performed on the stored value.
|
|
940
801
|
This function must take three arguments (self, the stored value,
|
|
@@ -942,7 +803,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
942
803
|
and return the final, transformed value of the property.
|
|
943
804
|
|
|
944
805
|
The callback is responsible to ensure that value limits of the property (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
945
|
-
:type get_transform: collections.abc.Callable[[bpy.types.bpy_struct, str, bool], str] | None
|
|
946
806
|
:param set_transform: Function to be called when this value is written,
|
|
947
807
|
if some additional processing must be performed on the given value before storing it.
|
|
948
808
|
This function must take four arguments (self, the given value to store,
|
|
@@ -951,7 +811,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
951
811
|
and return the final, transformed value of the property.
|
|
952
812
|
|
|
953
813
|
The callback is responsible to ensure that value limits (min/max, length...) are respected. Otherwise a ValueError exception is raised.
|
|
954
|
-
:type set_transform: collections.abc.Callable[[bpy.types.bpy_struct, str, str, bool], str] | None
|
|
955
814
|
:param search: Function to be called to show candidates for this string (shown in the UI).
|
|
956
815
|
This function must take 3 values (self, context, edit_text)
|
|
957
816
|
and return a sequence, iterator or generator where each item must be:
|
|
@@ -960,7 +819,6 @@ def StringProperty[_GenericType1: bpy.types.bpy_struct](
|
|
|
960
819
|
|
|
961
820
|
A tuple-pair of strings, where the first is a candidate and the second
|
|
962
821
|
is additional information about the candidate.
|
|
963
|
-
:type search: collections.abc.Callable[[_GenericType1, bpy.types.Context, str], collections.abc.Iterable[str | tuple[str, str]]] | None
|
|
964
822
|
:param search_options: Set of strings in:
|
|
965
823
|
|
|
966
824
|
SORT sorts the resulting items.
|