fake-bpy-module 20240224__py3-none-any.whl → 20240326__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- addon_utils/__init__.pyi +54 -10
- animsys_refactor/__init__.pyi +36 -6
- aud/__init__.pyi +132 -125
- bgl/__init__.pyi +2545 -546
- bl_app_override/__init__.pyi +14 -3
- bl_app_override/helpers/__init__.pyi +24 -2
- bl_app_template_utils/__init__.pyi +19 -4
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -5
- bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -3
- bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -5
- bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -2
- bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -15
- bl_i18n_utils/merge_po/__init__.pyi +4 -1
- bl_i18n_utils/settings/__init__.pyi +53 -6
- bl_i18n_utils/utils/__init__.pyi +332 -44
- bl_i18n_utils/utils_cli/__init__.pyi +29 -6
- bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -1
- bl_i18n_utils/utils_rtl/__init__.pyi +9 -2
- bl_keymap_utils/io/__init__.pyi +44 -9
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -1
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -1
- bl_keymap_utils/platform_helpers/__init__.pyi +9 -2
- bl_keymap_utils/versioning/__init__.pyi +4 -1
- bl_math/__init__.pyi +3 -3
- bl_operators/__init__.pyi +9 -2
- bl_operators/add_mesh_torus/__init__.pyi +171 -37
- bl_operators/anim/__init__.pyi +1065 -226
- bl_operators/assets/__init__.pyi +427 -92
- bl_operators/bmesh/find_adjacent/__init__.pyi +44 -9
- bl_operators/clip/__init__.pyi +1342 -287
- bl_operators/console/__init__.pyi +647 -140
- bl_operators/constraint/__init__.pyi +524 -112
- bl_operators/file/__init__.pyi +396 -84
- bl_operators/freestyle/__init__.pyi +532 -113
- bl_operators/geometry_nodes/__init__.pyi +2412 -596
- bl_operators/image/__init__.pyi +380 -82
- bl_operators/mesh/__init__.pyi +401 -85
- bl_operators/node/__init__.pyi +1756 -384
- bl_operators/object/__init__.pyi +2022 -552
- bl_operators/object_align/__init__.pyi +145 -31
- bl_operators/object_quick_effects/__init__.pyi +555 -124
- bl_operators/object_randomize_transform/__init__.pyi +136 -32
- bl_operators/presets/__init__.pyi +3516 -708
- bl_operators/rigidbody/__init__.pyi +401 -85
- bl_operators/screen_play_rendered_anim/__init__.pyi +129 -29
- bl_operators/sequencer/__init__.pyi +731 -149
- bl_operators/spreadsheet/__init__.pyi +145 -30
- bl_operators/userpref/__init__.pyi +3416 -824
- bl_operators/uvcalc_follow_active/__init__.pyi +149 -32
- bl_operators/uvcalc_lightmap/__init__.pyi +187 -34
- bl_operators/uvcalc_transform/__init__.pyi +344 -73
- bl_operators/vertexpaint_dirt/__init__.pyi +140 -30
- bl_operators/view3d/__init__.pyi +697 -146
- bl_operators/wm/__init__.pyi +6287 -1533
- bl_previews_utils/bl_previews_render/__init__.pyi +34 -7
- bl_rna_utils/data_path/__init__.pyi +12 -2
- bl_text_utils/external_editor/__init__.pyi +4 -1
- bl_ui/__init__.pyi +504 -106
- bl_ui/anim/__init__.pyi +164 -33
- bl_ui/asset_shelf/__init__.pyi +146 -31
- bl_ui/generic_ui_list/__init__.pyi +471 -99
- bl_ui/node_add_menu/__init__.pyi +196 -40
- bl_ui/node_add_menu_compositor/__init__.pyi +3017 -621
- bl_ui/node_add_menu_geometry/__init__.pyi +8060 -1625
- bl_ui/node_add_menu_shader/__init__.pyi +1709 -348
- bl_ui/node_add_menu_texture/__init__.pyi +1502 -305
- bl_ui/properties_animviz/__init__.pyi +32 -2
- bl_ui/properties_collection/__init__.pyi +787 -179
- bl_ui/properties_constraint/__init__.pyi +28635 -5523
- bl_ui/properties_data_armature/__init__.pyi +1905 -448
- bl_ui/properties_data_bone/__init__.pyi +1560 -336
- bl_ui/properties_data_camera/__init__.pyi +2269 -494
- bl_ui/properties_data_curve/__init__.pyi +2362 -534
- bl_ui/properties_data_curves/__init__.pyi +951 -203
- bl_ui/properties_data_empty/__init__.pyi +317 -69
- bl_ui/properties_data_gpencil/__init__.pyi +2924 -734
- bl_ui/properties_data_grease_pencil/__init__.pyi +1631 -188
- bl_ui/properties_data_lattice/__init__.pyi +472 -104
- bl_ui/properties_data_light/__init__.pyi +1570 -337
- bl_ui/properties_data_lightprobe/__init__.pyi +938 -208
- bl_ui/properties_data_mesh/__init__.pyi +3205 -767
- bl_ui/properties_data_metaball/__init__.pyi +774 -170
- bl_ui/properties_data_modifier/__init__.pyi +1554 -328
- bl_ui/properties_data_pointcloud/__init__.pyi +821 -194
- bl_ui/properties_data_shaderfx/__init__.pyi +154 -34
- bl_ui/properties_data_speaker/__init__.pyi +782 -168
- bl_ui/properties_data_volume/__init__.pyi +1243 -281
- bl_ui/properties_freestyle/__init__.pyi +4071 -1030
- bl_ui/properties_grease_pencil_common/__init__.pyi +2399 -483
- bl_ui/properties_mask_common/__init__.pyi +1256 -249
- bl_ui/properties_material/__init__.pyi +2351 -542
- bl_ui/properties_material_gpencil/__init__.pyi +1590 -365
- bl_ui/properties_object/__init__.pyi +2179 -512
- bl_ui/properties_output/__init__.pyi +2956 -705
- bl_ui/properties_paint_common/__init__.pyi +947 -140
- bl_ui/properties_particle/__init__.pyi +8322 -1970
- bl_ui/properties_physics_cloth/__init__.pyi +2254 -508
- bl_ui/properties_physics_common/__init__.pyi +200 -44
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +4454 -965
- bl_ui/properties_physics_field/__init__.pyi +1695 -364
- bl_ui/properties_physics_fluid/__init__.pyi +6127 -1280
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +157 -32
- bl_ui/properties_physics_rigidbody/__init__.pyi +1254 -278
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +2053 -483
- bl_ui/properties_physics_softbody/__init__.pyi +2394 -542
- bl_ui/properties_render/__init__.pyi +8312 -1933
- bl_ui/properties_scene/__init__.pyi +2211 -539
- bl_ui/properties_texture/__init__.pyi +4185 -1013
- bl_ui/properties_view_layer/__init__.pyi +2803 -664
- bl_ui/properties_workspace/__init__.pyi +626 -148
- bl_ui/properties_world/__init__.pyi +1092 -234
- bl_ui/space_clip/__init__.pyi +11475 -2805
- bl_ui/space_console/__init__.pyi +967 -202
- bl_ui/space_dopesheet/__init__.pyi +4260 -966
- bl_ui/space_filebrowser/__init__.pyi +4852 -1187
- bl_ui/space_graph/__init__.pyi +3251 -702
- bl_ui/space_image/__init__.pyi +12219 -2968
- bl_ui/space_info/__init__.pyi +964 -200
- bl_ui/space_nla/__init__.pyi +2756 -584
- bl_ui/space_node/__init__.pyi +5661 -1265
- bl_ui/space_outliner/__init__.pyi +2294 -478
- bl_ui/space_properties/__init__.pyi +417 -92
- bl_ui/space_sequencer/__init__.pyi +12436 -3009
- bl_ui/space_spreadsheet/__init__.pyi +184 -36
- bl_ui/space_statusbar/__init__.pyi +135 -30
- bl_ui/space_text/__init__.pyi +2556 -542
- bl_ui/space_time/__init__.pyi +1151 -243
- bl_ui/space_toolsystem_common/__init__.pyi +368 -66
- bl_ui/space_toolsystem_toolbar/__init__.pyi +1378 -228
- bl_ui/space_topbar/__init__.pyi +4214 -887
- bl_ui/space_userpref/__init__.pyi +13920 -3468
- bl_ui/space_view3d/__init__.pyi +43701 -10599
- bl_ui/space_view3d_toolbar/__init__.pyi +16380 -3860
- bl_ui/utils/__init__.pyi +42 -4
- bl_ui_utils/bug_report_url/__init__.pyi +4 -1
- bl_ui_utils/layout/__init__.pyi +4 -1
- blend_render_info/__init__.pyi +13 -3
- blf/__init__.pyi +5 -7
- bmesh/__init__.pyi +7 -7
- bmesh/geometry/__init__.pyi +5 -5
- bmesh/ops/__init__.pyi +490 -504
- bmesh/types/__init__.pyi +268 -262
- bmesh/utils/__init__.pyi +55 -55
- bpy/__init__.pyi +2 -2
- bpy/app/__init__.pyi +4 -5
- bpy/app/handlers/__init__.pyi +36 -36
- bpy/app/icons/__init__.pyi +8 -10
- bpy/app/timers/__init__.pyi +9 -11
- bpy/app/translations/__init__.pyi +20 -22
- bpy/msgbus/__init__.pyi +3 -12
- bpy/ops/action/__init__.pyi +350 -305
- bpy/ops/anim/__init__.pyi +464 -426
- bpy/ops/armature/__init__.pyi +392 -360
- bpy/ops/asset/__init__.pyi +166 -129
- bpy/ops/boid/__init__.pyi +64 -37
- bpy/ops/brush/__init__.pyi +78 -72
- bpy/ops/buttons/__init__.pyi +136 -122
- bpy/ops/cachefile/__init__.pyi +128 -123
- bpy/ops/camera/__init__.pyi +22 -24
- bpy/ops/clip/__init__.pyi +844 -735
- bpy/ops/cloth/__init__.pyi +10 -11
- bpy/ops/collection/__init__.pyi +38 -38
- bpy/ops/console/__init__.pyi +170 -141
- bpy/ops/constraint/__init__.pyi +156 -159
- bpy/ops/curve/__init__.pyi +518 -461
- bpy/ops/curves/__init__.pyi +188 -159
- bpy/ops/cycles/__init__.pyi +20 -18
- bpy/ops/dpaint/__init__.pyi +40 -30
- bpy/ops/ed/__init__.pyi +136 -107
- bpy/ops/export_anim/__init__.pyi +18 -19
- bpy/ops/export_mesh/__init__.pyi +26 -27
- bpy/ops/export_scene/__init__.pyi +313 -334
- bpy/ops/file/__init__.pyi +394 -304
- bpy/ops/fluid/__init__.pyi +114 -63
- bpy/ops/font/__init__.pyi +272 -245
- bpy/ops/geometry/__init__.pyi +92 -87
- bpy/ops/gizmogroup/__init__.pyi +24 -21
- bpy/ops/gpencil/__init__.pyi +1530 -1476
- bpy/ops/graph/__init__.pyi +680 -659
- bpy/ops/grease_pencil/__init__.pyi +510 -390
- bpy/ops/image/__init__.pyi +650 -603
- bpy/ops/import_anim/__init__.pyi +26 -27
- bpy/ops/import_curve/__init__.pyi +6 -7
- bpy/ops/import_mesh/__init__.pyi +18 -21
- bpy/ops/import_scene/__init__.pyi +86 -95
- bpy/ops/info/__init__.pyi +68 -55
- bpy/ops/lattice/__init__.pyi +70 -63
- bpy/ops/marker/__init__.pyi +110 -111
- bpy/ops/mask/__init__.pyi +352 -308
- bpy/ops/material/__init__.pyi +24 -12
- bpy/ops/mball/__init__.pyi +72 -75
- bpy/ops/mesh/__init__.pyi +2052 -2088
- bpy/ops/nla/__init__.pyi +369 -313
- bpy/ops/node/__init__.pyi +944 -805
- bpy/ops/object/__init__.pyi +2662 -2461
- bpy/ops/outliner/__init__.pyi +582 -431
- bpy/ops/paint/__init__.pyi +605 -516
- bpy/ops/paintcurve/__init__.pyi +72 -60
- bpy/ops/palette/__init__.pyi +54 -46
- bpy/ops/particle/__init__.pyi +302 -245
- bpy/ops/pose/__init__.pyi +366 -330
- bpy/ops/poselib/__init__.pyi +78 -64
- bpy/ops/preferences/__init__.pyi +361 -341
- bpy/ops/ptcache/__init__.pyi +56 -38
- bpy/ops/render/__init__.pyi +120 -117
- bpy/ops/rigidbody/__init__.pyi +114 -97
- bpy/ops/scene/__init__.pyi +302 -240
- bpy/ops/screen/__init__.pyi +414 -363
- bpy/ops/script/__init__.pyi +20 -18
- bpy/ops/sculpt/__init__.pyi +414 -452
- bpy/ops/sculpt_curves/__init__.pyi +42 -43
- bpy/ops/sequencer/__init__.pyi +1094 -1053
- bpy/ops/sound/__init__.pyi +214 -206
- bpy/ops/spreadsheet/__init__.pyi +34 -28
- bpy/ops/surface/__init__.pyi +108 -114
- bpy/ops/text/__init__.pyi +432 -350
- bpy/ops/text_editor/__init__.pyi +10 -11
- bpy/ops/texture/__init__.pyi +32 -21
- bpy/ops/transform/__init__.pyi +801 -854
- bpy/ops/ui/__init__.pyi +254 -185
- bpy/ops/uilist/__init__.pyi +20 -23
- bpy/ops/uv/__init__.pyi +618 -626
- bpy/ops/view2d/__init__.pyi +162 -161
- bpy/ops/view3d/__init__.pyi +669 -658
- bpy/ops/wm/__init__.pyi +2433 -2415
- bpy/ops/workspace/__init__.pyi +54 -31
- bpy/ops/world/__init__.pyi +8 -4
- bpy/path/__init__.pyi +111 -68
- bpy/props/__init__.pyi +263 -267
- bpy/types/__init__.pyi +86789 -85719
- bpy/utils/__init__.pyi +265 -123
- bpy/utils/previews/__init__.pyi +103 -17
- bpy/utils/units/__init__.pyi +19 -22
- bpy_extras/__init__.pyi +0 -4
- bpy_extras/anim_utils/__init__.pyi +11 -46
- bpy_extras/asset_utils/__init__.pyi +3 -12
- bpy_extras/id_map_utils/__init__.pyi +0 -2
- bpy_extras/image_utils/__init__.pyi +2 -2
- bpy_extras/io_utils/__init__.pyi +30 -27
- bpy_extras/keyconfig_utils/__init__.pyi +4 -1
- bpy_extras/mesh_utils/__init__.pyi +18 -18
- bpy_extras/node_utils/__init__.pyi +4 -3
- bpy_extras/object_utils/__init__.pyi +25 -26
- bpy_extras/view3d_utils/__init__.pyi +33 -38
- bpy_restrict_state/__init__.pyi +14 -1
- bpy_types/__init__.pyi +3873 -997
- console_python/__init__.pyi +41 -7
- console_shell/__init__.pyi +24 -5
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/METADATA +1 -1
- fake_bpy_module-20240326.dist-info/RECORD +343 -0
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/WHEEL +1 -1
- freestyle/chainingiterators/__init__.pyi +50 -52
- freestyle/functions/__init__.pyi +303 -207
- freestyle/predicates/__init__.pyi +299 -115
- freestyle/shaders/__init__.pyi +49 -80
- freestyle/types/__init__.pyi +465 -472
- freestyle/utils/ContextFunctions/__init__.pyi +9 -9
- freestyle/utils/__init__.pyi +28 -18
- gpu/capabilities/__init__.pyi +27 -19
- gpu/matrix/__init__.pyi +14 -16
- gpu/platform/__init__.pyi +5 -5
- gpu/shader/__init__.pyi +2 -5
- gpu/state/__init__.pyi +1 -1
- gpu/texture/__init__.pyi +3 -3
- gpu/types/__init__.pyi +54 -85
- gpu_extras/batch/__init__.pyi +27 -5
- gpu_extras/presets/__init__.pyi +52 -14
- graphviz_export/__init__.pyi +9 -2
- idprop/types/__init__.pyi +36 -12
- imbuf/__init__.pyi +8 -9
- imbuf/types/__init__.pyi +8 -15
- keyingsets_builtins/__init__.pyi +3149 -701
- keyingsets_utils/__init__.pyi +69 -14
- mathutils/__init__.pyi +502 -427
- mathutils/bvhtree/__init__.pyi +28 -32
- mathutils/geometry/__init__.pyi +177 -186
- mathutils/kdtree/__init__.pyi +16 -18
- mathutils/noise/__init__.pyi +47 -48
- nodeitems_builtins/__init__.pyi +50 -10
- nodeitems_utils/__init__.pyi +58 -10
- rna_info/__init__.pyi +230 -26
- rna_keymap_ui/__init__.pyi +29 -6
- rna_prop_ui/__init__.pyi +69 -12
- rna_xml/__init__.pyi +29 -6
- sys_info/__init__.pyi +4 -1
- bpy_extras/bmesh_utils/__init__.pyi +0 -6
- bpy_extras/extensions/__init__.pyi +0 -4
- bpy_extras/extensions/junction_module/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +0 -131
- bpy_extras/wm_utils/__init__.pyi +0 -4
- bpy_extras/wm_utils/progress_report/__init__.pyi +0 -29
- fake_bpy_module-20240224.dist-info/RECORD +0 -349
- {fake_bpy_module-20240224.dist-info → fake_bpy_module-20240326.dist-info}/top_level.txt +0 -0
bpy/props/__init__.pyi
CHANGED
|
@@ -3,139 +3,136 @@ import typing
|
|
|
3
3
|
GenericType = typing.TypeVar("GenericType")
|
|
4
4
|
|
|
5
5
|
def BoolProperty(
|
|
6
|
-
name:
|
|
7
|
-
description:
|
|
8
|
-
translation_context:
|
|
6
|
+
name: str = "",
|
|
7
|
+
description: str = "",
|
|
8
|
+
translation_context: str = "*",
|
|
9
9
|
default=False,
|
|
10
|
-
options:
|
|
11
|
-
override:
|
|
12
|
-
tags:
|
|
13
|
-
subtype:
|
|
14
|
-
update: typing.
|
|
15
|
-
get: typing.
|
|
16
|
-
set: typing.
|
|
10
|
+
options: set = {'"ANIMATABLE"'},
|
|
11
|
+
override: set = None(),
|
|
12
|
+
tags: set = None(),
|
|
13
|
+
subtype: str = "NONE",
|
|
14
|
+
update: typing.Any = None,
|
|
15
|
+
get: typing.Any = None,
|
|
16
|
+
set: typing.Any = None,
|
|
17
17
|
):
|
|
18
18
|
"""Returns a new boolean property definition.
|
|
19
19
|
|
|
20
20
|
:param name: Name used in the user interface.
|
|
21
|
-
:type name:
|
|
21
|
+
:type name: str
|
|
22
22
|
:param description: Text used for the tooltip and api documentation.
|
|
23
|
-
:type description:
|
|
23
|
+
:type description: str
|
|
24
24
|
:param translation_context: Text used as context to disambiguate translations.
|
|
25
|
-
:type translation_context:
|
|
25
|
+
:type translation_context: str
|
|
26
26
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
27
|
-
:type options:
|
|
27
|
+
:type options: set
|
|
28
28
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
29
|
-
:type override:
|
|
29
|
+
:type override: set
|
|
30
30
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
31
|
-
:type tags:
|
|
31
|
+
:type tags: set
|
|
32
32
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
33
|
-
:type subtype:
|
|
33
|
+
:type subtype: str
|
|
34
34
|
:param update: Function to be called when this value is modified,
|
|
35
35
|
This function must take 2 values (self, context) and return None.
|
|
36
36
|
Warning there are no safety checks to avoid infinite recursion.
|
|
37
|
-
:type update: typing.
|
|
37
|
+
:type update: typing.Any
|
|
38
38
|
:param get: Function to be called when this value is 'read',
|
|
39
39
|
This function must take 1 value (self) and return the value of the property.
|
|
40
|
-
:type get: typing.
|
|
40
|
+
:type get: typing.Any
|
|
41
41
|
:param set: Function to be called when this value is 'written',
|
|
42
42
|
This function must take 2 values (self, value) and return None.
|
|
43
|
-
:type set: typing.
|
|
43
|
+
:type set: typing.Any
|
|
44
44
|
"""
|
|
45
45
|
|
|
46
46
|
...
|
|
47
47
|
|
|
48
48
|
def BoolVectorProperty(
|
|
49
|
-
name:
|
|
50
|
-
description:
|
|
51
|
-
translation_context:
|
|
52
|
-
default: typing.
|
|
53
|
-
options:
|
|
54
|
-
override:
|
|
55
|
-
tags:
|
|
56
|
-
subtype:
|
|
57
|
-
size: typing.
|
|
58
|
-
update: typing.
|
|
59
|
-
get: typing.
|
|
60
|
-
set: typing.
|
|
49
|
+
name: str = "",
|
|
50
|
+
description: str = "",
|
|
51
|
+
translation_context: str = "*",
|
|
52
|
+
default: typing.Sequence = (False, False, False),
|
|
53
|
+
options: set = {'"ANIMATABLE"'},
|
|
54
|
+
override: set = None(),
|
|
55
|
+
tags: set = None(),
|
|
56
|
+
subtype: str = "NONE",
|
|
57
|
+
size: typing.Union[int, typing.Sequence[int]] = 3,
|
|
58
|
+
update: typing.Any = None,
|
|
59
|
+
get: typing.Any = None,
|
|
60
|
+
set: typing.Any = None,
|
|
61
61
|
):
|
|
62
62
|
"""Returns a new vector boolean property definition.
|
|
63
63
|
|
|
64
64
|
:param name: Name used in the user interface.
|
|
65
|
-
:type name:
|
|
65
|
+
:type name: str
|
|
66
66
|
:param description: Text used for the tooltip and api documentation.
|
|
67
|
-
:type description:
|
|
67
|
+
:type description: str
|
|
68
68
|
:param translation_context: Text used as context to disambiguate translations.
|
|
69
|
-
:type translation_context:
|
|
69
|
+
:type translation_context: str
|
|
70
70
|
:param default: sequence of booleans the length of size.
|
|
71
|
-
:type default: typing.
|
|
71
|
+
:type default: typing.Sequence
|
|
72
72
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
73
|
-
:type options:
|
|
73
|
+
:type options: set
|
|
74
74
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
75
|
-
:type override:
|
|
75
|
+
:type override: set
|
|
76
76
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
77
|
-
:type tags:
|
|
77
|
+
:type tags: set
|
|
78
78
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
79
|
-
:type subtype:
|
|
79
|
+
:type subtype: str
|
|
80
80
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
81
|
-
:type size: typing.
|
|
81
|
+
:type size: typing.Union[int, typing.Sequence[int]]
|
|
82
82
|
:param update: Function to be called when this value is modified,
|
|
83
83
|
This function must take 2 values (self, context) and return None.
|
|
84
84
|
Warning there are no safety checks to avoid infinite recursion.
|
|
85
|
-
:type update: typing.
|
|
85
|
+
:type update: typing.Any
|
|
86
86
|
:param get: Function to be called when this value is 'read',
|
|
87
87
|
This function must take 1 value (self) and return the value of the property.
|
|
88
|
-
:type get: typing.
|
|
88
|
+
:type get: typing.Any
|
|
89
89
|
:param set: Function to be called when this value is 'written',
|
|
90
90
|
This function must take 2 values (self, value) and return None.
|
|
91
|
-
:type set: typing.
|
|
91
|
+
:type set: typing.Any
|
|
92
92
|
"""
|
|
93
93
|
|
|
94
94
|
...
|
|
95
95
|
|
|
96
96
|
def CollectionProperty(
|
|
97
|
-
type
|
|
98
|
-
name:
|
|
99
|
-
description:
|
|
100
|
-
translation_context:
|
|
101
|
-
options:
|
|
102
|
-
override:
|
|
103
|
-
tags:
|
|
97
|
+
type=None,
|
|
98
|
+
name: str = "",
|
|
99
|
+
description: str = "",
|
|
100
|
+
translation_context: str = "*",
|
|
101
|
+
options: set = {'"ANIMATABLE"'},
|
|
102
|
+
override: set = None(),
|
|
103
|
+
tags: set = None(),
|
|
104
104
|
):
|
|
105
105
|
"""Returns a new collection property definition.
|
|
106
106
|
|
|
107
107
|
:param type: A subclass of `bpy.types.PropertyGroup`.
|
|
108
|
-
:type type: typing.Optional[typing.Any]
|
|
109
108
|
:param name: Name used in the user interface.
|
|
110
|
-
:type name:
|
|
109
|
+
:type name: str
|
|
111
110
|
:param description: Text used for the tooltip and api documentation.
|
|
112
|
-
:type description:
|
|
111
|
+
:type description: str
|
|
113
112
|
:param translation_context: Text used as context to disambiguate translations.
|
|
114
|
-
:type translation_context:
|
|
113
|
+
:type translation_context: str
|
|
115
114
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
116
|
-
:type options:
|
|
115
|
+
:type options: set
|
|
117
116
|
:param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
|
|
118
|
-
:type override:
|
|
117
|
+
:type override: set
|
|
119
118
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
120
|
-
:type tags:
|
|
119
|
+
:type tags: set
|
|
121
120
|
"""
|
|
122
121
|
|
|
123
122
|
...
|
|
124
123
|
|
|
125
124
|
def EnumProperty(
|
|
126
|
-
items: typing.
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
get: typing.Optional[typing.Any] = None,
|
|
138
|
-
set: typing.Optional[typing.Any] = None,
|
|
125
|
+
items: typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable],
|
|
126
|
+
name: str = "",
|
|
127
|
+
description: str = "",
|
|
128
|
+
translation_context: str = "*",
|
|
129
|
+
default: typing.Union[str, set] = None,
|
|
130
|
+
options: set = {'"ANIMATABLE"'},
|
|
131
|
+
override: set = None(),
|
|
132
|
+
tags: set = None(),
|
|
133
|
+
update: typing.Any = None,
|
|
134
|
+
get: typing.Any = None,
|
|
135
|
+
set: typing.Any = None,
|
|
139
136
|
):
|
|
140
137
|
"""Returns a new enumerator property definition.
|
|
141
138
|
|
|
@@ -177,387 +174,386 @@ def EnumProperty(
|
|
|
177
174
|
There is a known bug with using a callback,
|
|
178
175
|
Python must keep a reference to the strings returned by the callback or Blender
|
|
179
176
|
will misbehave or even crash.
|
|
180
|
-
:type items: typing.
|
|
177
|
+
:type items: typing.Union[typing.Iterable[typing.Iterable[str]], typing.Callable]
|
|
181
178
|
:param name: Name used in the user interface.
|
|
182
|
-
:type name:
|
|
179
|
+
:type name: str
|
|
183
180
|
:param description: Text used for the tooltip and api documentation.
|
|
184
|
-
:type description:
|
|
181
|
+
:type description: str
|
|
185
182
|
:param translation_context: Text used as context to disambiguate translations.
|
|
186
|
-
:type translation_context:
|
|
183
|
+
:type translation_context: str
|
|
187
184
|
:param default: The default value for this enum, a string from the identifiers used in items, or integer matching an item number.
|
|
188
185
|
If the ENUM_FLAG option is used this must be a set of such string identifiers instead.
|
|
189
186
|
WARNING: Strings cannot be specified for dynamic enums
|
|
190
187
|
(i.e. if a callback function is given as items parameter).
|
|
191
|
-
:type default: typing.
|
|
188
|
+
:type default: typing.Union[str, set]
|
|
192
189
|
:param options: Enumerator in `rna_enum_property_flag_enum_items`.
|
|
193
|
-
:type options:
|
|
190
|
+
:type options: set
|
|
194
191
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
195
|
-
:type override:
|
|
192
|
+
:type override: set
|
|
196
193
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
197
|
-
:type tags:
|
|
194
|
+
:type tags: set
|
|
198
195
|
:param update: Function to be called when this value is modified,
|
|
199
196
|
This function must take 2 values (self, context) and return None.
|
|
200
197
|
Warning there are no safety checks to avoid infinite recursion.
|
|
201
|
-
:type update: typing.
|
|
198
|
+
:type update: typing.Any
|
|
202
199
|
:param get: Function to be called when this value is 'read',
|
|
203
200
|
This function must take 1 value (self) and return the value of the property.
|
|
204
|
-
:type get: typing.
|
|
201
|
+
:type get: typing.Any
|
|
205
202
|
:param set: Function to be called when this value is 'written',
|
|
206
203
|
This function must take 2 values (self, value) and return None.
|
|
207
|
-
:type set: typing.
|
|
204
|
+
:type set: typing.Any
|
|
208
205
|
"""
|
|
209
206
|
|
|
210
207
|
...
|
|
211
208
|
|
|
212
209
|
def FloatProperty(
|
|
213
|
-
name:
|
|
214
|
-
description:
|
|
215
|
-
translation_context:
|
|
210
|
+
name: str = "",
|
|
211
|
+
description: str = "",
|
|
212
|
+
translation_context: str = "*",
|
|
216
213
|
default=0.0,
|
|
217
|
-
min:
|
|
218
|
-
max:
|
|
219
|
-
soft_min:
|
|
220
|
-
soft_max:
|
|
221
|
-
step:
|
|
222
|
-
precision:
|
|
223
|
-
options:
|
|
224
|
-
override:
|
|
225
|
-
tags:
|
|
226
|
-
subtype:
|
|
227
|
-
unit:
|
|
228
|
-
update: typing.
|
|
229
|
-
get: typing.
|
|
230
|
-
set: typing.
|
|
214
|
+
min: float = -3.402823e38,
|
|
215
|
+
max: float = 3.402823e38,
|
|
216
|
+
soft_min: float = -3.402823e38,
|
|
217
|
+
soft_max: float = 3.402823e38,
|
|
218
|
+
step: int = 3,
|
|
219
|
+
precision: int = 2,
|
|
220
|
+
options: set = {'"ANIMATABLE"'},
|
|
221
|
+
override: set = None(),
|
|
222
|
+
tags: set = None(),
|
|
223
|
+
subtype: str = "NONE",
|
|
224
|
+
unit: str = "NONE",
|
|
225
|
+
update: typing.Any = None,
|
|
226
|
+
get: typing.Any = None,
|
|
227
|
+
set: typing.Any = None,
|
|
231
228
|
):
|
|
232
229
|
"""Returns a new float (single precision) property definition.
|
|
233
230
|
|
|
234
231
|
:param name: Name used in the user interface.
|
|
235
|
-
:type name:
|
|
232
|
+
:type name: str
|
|
236
233
|
:param description: Text used for the tooltip and api documentation.
|
|
237
|
-
:type description:
|
|
234
|
+
:type description: str
|
|
238
235
|
:param translation_context: Text used as context to disambiguate translations.
|
|
239
|
-
:type translation_context:
|
|
236
|
+
:type translation_context: str
|
|
240
237
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
241
|
-
:type min:
|
|
238
|
+
:type min: float
|
|
242
239
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
243
|
-
:type max:
|
|
240
|
+
:type max: float
|
|
244
241
|
:param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
|
|
245
|
-
:type soft_min:
|
|
242
|
+
:type soft_min: float
|
|
246
243
|
:param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
|
|
247
|
-
:type soft_max:
|
|
244
|
+
:type soft_max: float
|
|
248
245
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
249
|
-
:type step:
|
|
246
|
+
:type step: int
|
|
250
247
|
: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.
|
|
251
|
-
:type precision:
|
|
248
|
+
:type precision: int
|
|
252
249
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
253
|
-
:type options:
|
|
250
|
+
:type options: set
|
|
254
251
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
255
|
-
:type override:
|
|
252
|
+
:type override: set
|
|
256
253
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
257
|
-
:type tags:
|
|
254
|
+
:type tags: set
|
|
258
255
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
259
|
-
:type subtype:
|
|
256
|
+
:type subtype: str
|
|
260
257
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
261
|
-
:type unit:
|
|
258
|
+
:type unit: str
|
|
262
259
|
:param update: Function to be called when this value is modified,
|
|
263
260
|
This function must take 2 values (self, context) and return None.
|
|
264
261
|
Warning there are no safety checks to avoid infinite recursion.
|
|
265
|
-
:type update: typing.
|
|
262
|
+
:type update: typing.Any
|
|
266
263
|
:param get: Function to be called when this value is 'read',
|
|
267
264
|
This function must take 1 value (self) and return the value of the property.
|
|
268
|
-
:type get: typing.
|
|
265
|
+
:type get: typing.Any
|
|
269
266
|
:param set: Function to be called when this value is 'written',
|
|
270
267
|
This function must take 2 values (self, value) and return None.
|
|
271
|
-
:type set: typing.
|
|
268
|
+
:type set: typing.Any
|
|
272
269
|
"""
|
|
273
270
|
|
|
274
271
|
...
|
|
275
272
|
|
|
276
273
|
def FloatVectorProperty(
|
|
277
|
-
name:
|
|
278
|
-
description:
|
|
279
|
-
translation_context:
|
|
280
|
-
default: typing.
|
|
281
|
-
min:
|
|
282
|
-
max:
|
|
283
|
-
soft_min:
|
|
284
|
-
soft_max:
|
|
285
|
-
step:
|
|
286
|
-
precision:
|
|
287
|
-
options:
|
|
288
|
-
override:
|
|
289
|
-
tags:
|
|
290
|
-
subtype:
|
|
291
|
-
unit:
|
|
292
|
-
size: typing.
|
|
293
|
-
update: typing.
|
|
294
|
-
get: typing.
|
|
295
|
-
set: typing.
|
|
274
|
+
name: str = "",
|
|
275
|
+
description: str = "",
|
|
276
|
+
translation_context: str = "*",
|
|
277
|
+
default: typing.Sequence = (0.0, 0.0, 0.0),
|
|
278
|
+
min: float = None,
|
|
279
|
+
max: float = None,
|
|
280
|
+
soft_min: float = None,
|
|
281
|
+
soft_max: float = None,
|
|
282
|
+
step: int = 3,
|
|
283
|
+
precision: int = 2,
|
|
284
|
+
options: set = {'"ANIMATABLE"'},
|
|
285
|
+
override: set = None(),
|
|
286
|
+
tags: set = None(),
|
|
287
|
+
subtype: str = "NONE",
|
|
288
|
+
unit: str = "NONE",
|
|
289
|
+
size: typing.Union[int, typing.Sequence[int]] = 3,
|
|
290
|
+
update: typing.Any = None,
|
|
291
|
+
get: typing.Any = None,
|
|
292
|
+
set: typing.Any = None,
|
|
296
293
|
):
|
|
297
294
|
"""Returns a new vector float property definition.
|
|
298
295
|
|
|
299
296
|
:param name: Name used in the user interface.
|
|
300
|
-
:type name:
|
|
297
|
+
:type name: str
|
|
301
298
|
:param description: Text used for the tooltip and api documentation.
|
|
302
|
-
:type description:
|
|
299
|
+
:type description: str
|
|
303
300
|
:param translation_context: Text used as context to disambiguate translations.
|
|
304
|
-
:type translation_context:
|
|
301
|
+
:type translation_context: str
|
|
305
302
|
:param default: sequence of floats the length of size.
|
|
306
|
-
:type default: typing.
|
|
303
|
+
:type default: typing.Sequence
|
|
307
304
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
308
|
-
:type min:
|
|
305
|
+
:type min: float
|
|
309
306
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
310
|
-
:type max:
|
|
307
|
+
:type max: float
|
|
311
308
|
:param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
|
|
312
|
-
:type soft_min:
|
|
309
|
+
:type soft_min: float
|
|
313
310
|
:param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
|
|
314
|
-
:type soft_max:
|
|
311
|
+
:type soft_max: float
|
|
315
312
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual value is /100).
|
|
316
|
-
:type step:
|
|
313
|
+
:type step: int
|
|
317
314
|
: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.
|
|
318
|
-
:type precision:
|
|
315
|
+
:type precision: int
|
|
319
316
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
320
|
-
:type options:
|
|
317
|
+
:type options: set
|
|
321
318
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
322
|
-
:type override:
|
|
319
|
+
:type override: set
|
|
323
320
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
324
|
-
:type tags:
|
|
321
|
+
:type tags: set
|
|
325
322
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
326
|
-
:type subtype:
|
|
323
|
+
:type subtype: str
|
|
327
324
|
:param unit: Enumerator in `rna_enum_property_unit_items`.
|
|
328
|
-
:type unit:
|
|
325
|
+
:type unit: str
|
|
329
326
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
330
|
-
:type size: typing.
|
|
327
|
+
:type size: typing.Union[int, typing.Sequence[int]]
|
|
331
328
|
:param update: Function to be called when this value is modified,
|
|
332
329
|
This function must take 2 values (self, context) and return None.
|
|
333
330
|
Warning there are no safety checks to avoid infinite recursion.
|
|
334
|
-
:type update: typing.
|
|
331
|
+
:type update: typing.Any
|
|
335
332
|
:param get: Function to be called when this value is 'read',
|
|
336
333
|
This function must take 1 value (self) and return the value of the property.
|
|
337
|
-
:type get: typing.
|
|
334
|
+
:type get: typing.Any
|
|
338
335
|
:param set: Function to be called when this value is 'written',
|
|
339
336
|
This function must take 2 values (self, value) and return None.
|
|
340
|
-
:type set: typing.
|
|
337
|
+
:type set: typing.Any
|
|
341
338
|
"""
|
|
342
339
|
|
|
343
340
|
...
|
|
344
341
|
|
|
345
342
|
def IntProperty(
|
|
346
|
-
name:
|
|
347
|
-
description:
|
|
348
|
-
translation_context:
|
|
343
|
+
name: str = "",
|
|
344
|
+
description: str = "",
|
|
345
|
+
translation_context: str = "*",
|
|
349
346
|
default=0,
|
|
350
|
-
min:
|
|
351
|
-
max:
|
|
352
|
-
soft_min:
|
|
353
|
-
soft_max:
|
|
354
|
-
step:
|
|
355
|
-
options:
|
|
356
|
-
override:
|
|
357
|
-
tags:
|
|
358
|
-
subtype:
|
|
359
|
-
update: typing.
|
|
360
|
-
get: typing.
|
|
361
|
-
set: typing.
|
|
347
|
+
min: int = None,
|
|
348
|
+
max: int = None,
|
|
349
|
+
soft_min: int = None,
|
|
350
|
+
soft_max: int = None,
|
|
351
|
+
step: int = 1,
|
|
352
|
+
options: set = {'"ANIMATABLE"'},
|
|
353
|
+
override: set = None(),
|
|
354
|
+
tags: set = None(),
|
|
355
|
+
subtype: str = "NONE",
|
|
356
|
+
update: typing.Any = None,
|
|
357
|
+
get: typing.Any = None,
|
|
358
|
+
set: typing.Any = None,
|
|
362
359
|
):
|
|
363
360
|
"""Returns a new int property definition.
|
|
364
361
|
|
|
365
362
|
:param name: Name used in the user interface.
|
|
366
|
-
:type name:
|
|
363
|
+
:type name: str
|
|
367
364
|
:param description: Text used for the tooltip and api documentation.
|
|
368
|
-
:type description:
|
|
365
|
+
:type description: str
|
|
369
366
|
:param translation_context: Text used as context to disambiguate translations.
|
|
370
|
-
:type translation_context:
|
|
367
|
+
:type translation_context: str
|
|
371
368
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
372
|
-
:type min:
|
|
369
|
+
:type min: int
|
|
373
370
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
374
|
-
:type max:
|
|
371
|
+
:type max: int
|
|
375
372
|
:param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
|
|
376
|
-
:type soft_min:
|
|
373
|
+
:type soft_min: int
|
|
377
374
|
:param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
|
|
378
|
-
:type soft_max:
|
|
375
|
+
:type soft_max: int
|
|
379
376
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
380
|
-
:type step:
|
|
377
|
+
:type step: int
|
|
381
378
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
382
|
-
:type options:
|
|
379
|
+
:type options: set
|
|
383
380
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
384
|
-
:type override:
|
|
381
|
+
:type override: set
|
|
385
382
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
386
|
-
:type tags:
|
|
383
|
+
:type tags: set
|
|
387
384
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
|
|
388
|
-
:type subtype:
|
|
385
|
+
:type subtype: str
|
|
389
386
|
:param update: Function to be called when this value is modified,
|
|
390
387
|
This function must take 2 values (self, context) and return None.
|
|
391
388
|
Warning there are no safety checks to avoid infinite recursion.
|
|
392
|
-
:type update: typing.
|
|
389
|
+
:type update: typing.Any
|
|
393
390
|
:param get: Function to be called when this value is 'read',
|
|
394
391
|
This function must take 1 value (self) and return the value of the property.
|
|
395
|
-
:type get: typing.
|
|
392
|
+
:type get: typing.Any
|
|
396
393
|
:param set: Function to be called when this value is 'written',
|
|
397
394
|
This function must take 2 values (self, value) and return None.
|
|
398
|
-
:type set: typing.
|
|
395
|
+
:type set: typing.Any
|
|
399
396
|
"""
|
|
400
397
|
|
|
401
398
|
...
|
|
402
399
|
|
|
403
400
|
def IntVectorProperty(
|
|
404
|
-
name:
|
|
405
|
-
description:
|
|
406
|
-
translation_context:
|
|
407
|
-
default: typing.
|
|
408
|
-
min:
|
|
409
|
-
max:
|
|
410
|
-
soft_min:
|
|
411
|
-
soft_max:
|
|
412
|
-
step:
|
|
413
|
-
options:
|
|
414
|
-
override:
|
|
415
|
-
tags:
|
|
416
|
-
subtype:
|
|
417
|
-
size: typing.
|
|
418
|
-
update: typing.
|
|
419
|
-
get: typing.
|
|
420
|
-
set: typing.
|
|
401
|
+
name: str = "",
|
|
402
|
+
description: str = "",
|
|
403
|
+
translation_context: str = "*",
|
|
404
|
+
default: typing.Sequence = (0, 0, 0),
|
|
405
|
+
min: int = None,
|
|
406
|
+
max: int = None,
|
|
407
|
+
soft_min: int = None,
|
|
408
|
+
soft_max: int = None,
|
|
409
|
+
step: int = 1,
|
|
410
|
+
options: set = {'"ANIMATABLE"'},
|
|
411
|
+
override: set = None(),
|
|
412
|
+
tags: set = None(),
|
|
413
|
+
subtype: str = "NONE",
|
|
414
|
+
size: typing.Union[int, typing.Sequence[int]] = 3,
|
|
415
|
+
update: typing.Any = None,
|
|
416
|
+
get: typing.Any = None,
|
|
417
|
+
set: typing.Any = None,
|
|
421
418
|
):
|
|
422
419
|
"""Returns a new vector int property definition.
|
|
423
420
|
|
|
424
421
|
:param name: Name used in the user interface.
|
|
425
|
-
:type name:
|
|
422
|
+
:type name: str
|
|
426
423
|
:param description: Text used for the tooltip and api documentation.
|
|
427
|
-
:type description:
|
|
424
|
+
:type description: str
|
|
428
425
|
:param translation_context: Text used as context to disambiguate translations.
|
|
429
|
-
:type translation_context:
|
|
426
|
+
:type translation_context: str
|
|
430
427
|
:param default: sequence of ints the length of size.
|
|
431
|
-
:type default: typing.
|
|
428
|
+
:type default: typing.Sequence
|
|
432
429
|
:param min: Hard minimum, trying to assign a value below will silently assign this minimum instead.
|
|
433
|
-
:type min:
|
|
430
|
+
:type min: int
|
|
434
431
|
:param max: Hard maximum, trying to assign a value above will silently assign this maximum instead.
|
|
435
|
-
:type max:
|
|
432
|
+
:type max: int
|
|
436
433
|
:param soft_min: Soft minimum (>= min), user won't be able to drag the widget below this value in the UI.
|
|
437
|
-
:type soft_min:
|
|
434
|
+
:type soft_min: int
|
|
438
435
|
:param soft_max: Soft maximum (<= max), user won't be able to drag the widget above this value in the UI.
|
|
439
|
-
:type soft_max:
|
|
436
|
+
:type soft_max: int
|
|
440
437
|
:param step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused currently!).
|
|
441
|
-
:type step:
|
|
438
|
+
:type step: int
|
|
442
439
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
443
|
-
:type options:
|
|
440
|
+
:type options: set
|
|
444
441
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
445
|
-
:type override:
|
|
442
|
+
:type override: set
|
|
446
443
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
447
|
-
:type tags:
|
|
444
|
+
:type tags: set
|
|
448
445
|
:param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
|
|
449
|
-
:type subtype:
|
|
446
|
+
:type subtype: str
|
|
450
447
|
:param size: Vector dimensions in [1, 32]. An int sequence can be used to define multi-dimension arrays.
|
|
451
|
-
:type size: typing.
|
|
448
|
+
:type size: typing.Union[int, typing.Sequence[int]]
|
|
452
449
|
:param update: Function to be called when this value is modified,
|
|
453
450
|
This function must take 2 values (self, context) and return None.
|
|
454
451
|
Warning there are no safety checks to avoid infinite recursion.
|
|
455
|
-
:type update: typing.
|
|
452
|
+
:type update: typing.Any
|
|
456
453
|
:param get: Function to be called when this value is 'read',
|
|
457
454
|
This function must take 1 value (self) and return the value of the property.
|
|
458
|
-
:type get: typing.
|
|
455
|
+
:type get: typing.Any
|
|
459
456
|
:param set: Function to be called when this value is 'written',
|
|
460
457
|
This function must take 2 values (self, value) and return None.
|
|
461
|
-
:type set: typing.
|
|
458
|
+
:type set: typing.Any
|
|
462
459
|
"""
|
|
463
460
|
|
|
464
461
|
...
|
|
465
462
|
|
|
466
463
|
def PointerProperty(
|
|
467
|
-
type
|
|
468
|
-
name:
|
|
469
|
-
description:
|
|
470
|
-
translation_context:
|
|
471
|
-
options:
|
|
472
|
-
override:
|
|
473
|
-
tags:
|
|
474
|
-
poll: typing.
|
|
475
|
-
update: typing.
|
|
464
|
+
type=None,
|
|
465
|
+
name: str = "",
|
|
466
|
+
description: str = "",
|
|
467
|
+
translation_context: str = "*",
|
|
468
|
+
options: set = {'"ANIMATABLE"'},
|
|
469
|
+
override: set = None(),
|
|
470
|
+
tags: set = None(),
|
|
471
|
+
poll: typing.Any = None,
|
|
472
|
+
update: typing.Any = None,
|
|
476
473
|
):
|
|
477
474
|
"""Returns a new pointer property definition.
|
|
478
475
|
|
|
479
476
|
:param type: A subclass of `bpy.types.PropertyGroup` or `bpy.types.ID`.
|
|
480
|
-
:type type: typing.Optional[typing.Any]
|
|
481
477
|
:param name: Name used in the user interface.
|
|
482
|
-
:type name:
|
|
478
|
+
:type name: str
|
|
483
479
|
:param description: Text used for the tooltip and api documentation.
|
|
484
|
-
:type description:
|
|
480
|
+
:type description: str
|
|
485
481
|
:param translation_context: Text used as context to disambiguate translations.
|
|
486
|
-
:type translation_context:
|
|
482
|
+
:type translation_context: str
|
|
487
483
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
488
|
-
:type options:
|
|
484
|
+
:type options: set
|
|
489
485
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
490
|
-
:type override:
|
|
486
|
+
:type override: set
|
|
491
487
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
492
|
-
:type tags:
|
|
488
|
+
:type tags: set
|
|
493
489
|
:param poll: function to be called to determine whether an item is valid for this property.
|
|
494
490
|
The function must take 2 values (self, object) and return Bool.
|
|
495
|
-
:type poll: typing.
|
|
491
|
+
:type poll: typing.Any
|
|
496
492
|
:param update: Function to be called when this value is modified,
|
|
497
493
|
This function must take 2 values (self, context) and return None.
|
|
498
494
|
Warning there are no safety checks to avoid infinite recursion.
|
|
499
|
-
:type update: typing.
|
|
495
|
+
:type update: typing.Any
|
|
500
496
|
"""
|
|
501
497
|
|
|
502
498
|
...
|
|
503
499
|
|
|
504
|
-
def RemoveProperty(cls: typing.
|
|
500
|
+
def RemoveProperty(cls: typing.Any, attr: str):
|
|
505
501
|
"""Removes a dynamically defined property.
|
|
506
502
|
|
|
507
503
|
:param cls: The class containing the property (must be a positional argument).
|
|
508
|
-
:type cls: typing.
|
|
504
|
+
:type cls: typing.Any
|
|
509
505
|
:param attr: Property name (must be passed as a keyword).
|
|
510
|
-
:type attr:
|
|
506
|
+
:type attr: str
|
|
511
507
|
"""
|
|
512
508
|
|
|
513
509
|
...
|
|
514
510
|
|
|
515
511
|
def StringProperty(
|
|
516
|
-
name:
|
|
517
|
-
description:
|
|
518
|
-
translation_context:
|
|
519
|
-
default:
|
|
520
|
-
maxlen:
|
|
521
|
-
options:
|
|
522
|
-
override:
|
|
523
|
-
tags:
|
|
524
|
-
subtype:
|
|
525
|
-
update: typing.
|
|
526
|
-
get: typing.
|
|
527
|
-
set: typing.
|
|
528
|
-
search: typing.
|
|
529
|
-
search_options:
|
|
512
|
+
name: str = "",
|
|
513
|
+
description: str = "",
|
|
514
|
+
translation_context: str = "*",
|
|
515
|
+
default: str = "",
|
|
516
|
+
maxlen: int = 0,
|
|
517
|
+
options: set = {'"ANIMATABLE"'},
|
|
518
|
+
override: set = None(),
|
|
519
|
+
tags: set = None(),
|
|
520
|
+
subtype: str = "NONE",
|
|
521
|
+
update: typing.Any = None,
|
|
522
|
+
get: typing.Any = None,
|
|
523
|
+
set: typing.Any = None,
|
|
524
|
+
search: typing.Any = None,
|
|
525
|
+
search_options: set = {'"SUGGESTION"'},
|
|
530
526
|
):
|
|
531
527
|
"""Returns a new string property definition.
|
|
532
528
|
|
|
533
529
|
:param name: Name used in the user interface.
|
|
534
|
-
:type name:
|
|
530
|
+
:type name: str
|
|
535
531
|
:param description: Text used for the tooltip and api documentation.
|
|
536
|
-
:type description:
|
|
532
|
+
:type description: str
|
|
537
533
|
:param translation_context: Text used as context to disambiguate translations.
|
|
538
|
-
:type translation_context:
|
|
534
|
+
:type translation_context: str
|
|
539
535
|
:param default: initializer string.
|
|
540
|
-
:type default:
|
|
536
|
+
:type default: str
|
|
541
537
|
:param maxlen: maximum length of the string.
|
|
542
|
-
:type maxlen:
|
|
538
|
+
:type maxlen: int
|
|
543
539
|
:param options: Enumerator in `rna_enum_property_flag_items`.
|
|
544
|
-
:type options:
|
|
540
|
+
:type options: set
|
|
545
541
|
:param override: Enumerator in `rna_enum_property_override_flag_items`.
|
|
546
|
-
:type override:
|
|
542
|
+
:type override: set
|
|
547
543
|
:param tags: Enumerator of tags that are defined by parent class.
|
|
548
|
-
:type tags:
|
|
544
|
+
:type tags: set
|
|
549
545
|
:param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
|
|
550
|
-
:type subtype:
|
|
546
|
+
:type subtype: str
|
|
551
547
|
:param update: Function to be called when this value is modified,
|
|
552
548
|
This function must take 2 values (self, context) and return None.
|
|
553
549
|
Warning there are no safety checks to avoid infinite recursion.
|
|
554
|
-
:type update: typing.
|
|
550
|
+
:type update: typing.Any
|
|
555
551
|
:param get: Function to be called when this value is 'read',
|
|
556
552
|
This function must take 1 value (self) and return the value of the property.
|
|
557
|
-
:type get: typing.
|
|
553
|
+
:type get: typing.Any
|
|
558
554
|
:param set: Function to be called when this value is 'written',
|
|
559
555
|
This function must take 2 values (self, value) and return None.
|
|
560
|
-
:type set: typing.
|
|
556
|
+
:type set: typing.Any
|
|
561
557
|
:param search: Function to be called to show candidates for this string (shown in the UI).
|
|
562
558
|
This function must take 3 values (self, context, edit_text)
|
|
563
559
|
and return a sequence, iterator or generator where each item must be:
|
|
@@ -566,7 +562,7 @@ def StringProperty(
|
|
|
566
562
|
|
|
567
563
|
A tuple-pair of strings, where the first is a candidate and the second
|
|
568
564
|
is additional information about the candidate.
|
|
569
|
-
:type search: typing.
|
|
565
|
+
:type search: typing.Any
|
|
570
566
|
:param search_options: Set of strings in:
|
|
571
567
|
|
|
572
568
|
'SORT' sorts the resulting items.
|
|
@@ -574,7 +570,7 @@ def StringProperty(
|
|
|
574
570
|
'SUGGESTION' lets the user enter values not found in search candidates.
|
|
575
571
|
WARNING disabling this flag causes the search callback to run on redraw,
|
|
576
572
|
so only disable this flag if it's not likely to cause performance issues.
|
|
577
|
-
:type search_options:
|
|
573
|
+
:type search_options: set
|
|
578
574
|
"""
|
|
579
575
|
|
|
580
576
|
...
|