fake-bpy-module 20240210__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.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

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