fake-bpy-module 20240321__py3-none-any.whl → 20240322__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 (285) hide show
  1. addon_utils/__init__.pyi +54 -10
  2. animsys_refactor/__init__.pyi +27 -11
  3. aud/__init__.pyi +130 -123
  4. bgl/__init__.pyi +1831 -216
  5. bl_app_override/__init__.pyi +14 -3
  6. bl_app_override/helpers/__init__.pyi +19 -10
  7. bl_app_template_utils/__init__.pyi +19 -4
  8. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +24 -5
  9. bl_console_utils/autocomplete/complete_import/__init__.pyi +14 -3
  10. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +24 -5
  11. bl_console_utils/autocomplete/intellisense/__init__.pyi +9 -2
  12. bl_i18n_utils/bl_extract_messages/__init__.pyi +74 -15
  13. bl_i18n_utils/merge_po/__init__.pyi +4 -1
  14. bl_i18n_utils/settings/__init__.pyi +19 -23
  15. bl_i18n_utils/utils/__init__.pyi +81 -143
  16. bl_i18n_utils/utils_cli/__init__.pyi +29 -6
  17. bl_i18n_utils/utils_languages_menu/__init__.pyi +4 -1
  18. bl_i18n_utils/utils_rtl/__init__.pyi +9 -2
  19. bl_keymap_utils/io/__init__.pyi +44 -9
  20. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +4 -1
  21. bl_keymap_utils/keymap_hierarchy/__init__.pyi +4 -1
  22. bl_keymap_utils/platform_helpers/__init__.pyi +9 -2
  23. bl_keymap_utils/versioning/__init__.pyi +4 -1
  24. bl_math/__init__.pyi +3 -3
  25. bl_operators/__init__.pyi +9 -2
  26. bl_operators/add_mesh_torus/__init__.pyi +120 -49
  27. bl_operators/anim/__init__.pyi +903 -297
  28. bl_operators/assets/__init__.pyi +348 -123
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +44 -9
  30. bl_operators/clip/__init__.pyi +1262 -470
  31. bl_operators/console/__init__.pyi +542 -160
  32. bl_operators/constraint/__init__.pyi +452 -140
  33. bl_operators/file/__init__.pyi +339 -114
  34. bl_operators/freestyle/__init__.pyi +440 -132
  35. bl_operators/geometry_nodes/__init__.pyi +2131 -842
  36. bl_operators/image/__init__.pyi +330 -97
  37. bl_operators/mesh/__init__.pyi +339 -109
  38. bl_operators/node/__init__.pyi +1506 -621
  39. bl_operators/object/__init__.pyi +1828 -668
  40. bl_operators/object_align/__init__.pyi +124 -35
  41. bl_operators/object_quick_effects/__init__.pyi +470 -149
  42. bl_operators/object_randomize_transform/__init__.pyi +114 -35
  43. bl_operators/presets/__init__.pyi +3056 -1374
  44. bl_operators/rigidbody/__init__.pyi +336 -106
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +115 -33
  46. bl_operators/sequencer/__init__.pyi +579 -204
  47. bl_operators/spreadsheet/__init__.pyi +110 -38
  48. bl_operators/userpref/__init__.pyi +3201 -1236
  49. bl_operators/uvcalc_follow_active/__init__.pyi +119 -38
  50. bl_operators/uvcalc_lightmap/__init__.pyi +137 -54
  51. bl_operators/uvcalc_transform/__init__.pyi +295 -83
  52. bl_operators/vertexpaint_dirt/__init__.pyi +119 -34
  53. bl_operators/view3d/__init__.pyi +542 -184
  54. bl_operators/wm/__init__.pyi +5554 -2159
  55. bl_previews_utils/bl_previews_render/__init__.pyi +34 -7
  56. bl_rna_utils/data_path/__init__.pyi +12 -2
  57. bl_text_utils/external_editor/__init__.pyi +4 -1
  58. bl_ui/__init__.pyi +346 -146
  59. bl_ui/anim/__init__.pyi +107 -47
  60. bl_ui/asset_shelf/__init__.pyi +111 -33
  61. bl_ui/generic_ui_list/__init__.pyi +349 -146
  62. bl_ui/node_add_menu/__init__.pyi +138 -53
  63. bl_ui/node_add_menu_compositor/__init__.pyi +2134 -1016
  64. bl_ui/node_add_menu_geometry/__init__.pyi +5833 -2855
  65. bl_ui/node_add_menu_shader/__init__.pyi +1162 -511
  66. bl_ui/node_add_menu_texture/__init__.pyi +1008 -450
  67. bl_ui/properties_animviz/__init__.pyi +14 -12
  68. bl_ui/properties_collection/__init__.pyi +601 -218
  69. bl_ui/properties_constraint/__init__.pyi +10115 -10647
  70. bl_ui/properties_data_armature/__init__.pyi +1550 -648
  71. bl_ui/properties_data_bone/__init__.pyi +1317 -511
  72. bl_ui/properties_data_camera/__init__.pyi +1852 -719
  73. bl_ui/properties_data_curve/__init__.pyi +2015 -781
  74. bl_ui/properties_data_curves/__init__.pyi +713 -262
  75. bl_ui/properties_data_empty/__init__.pyi +252 -84
  76. bl_ui/properties_data_gpencil/__init__.pyi +2505 -1105
  77. bl_ui/properties_data_grease_pencil/__init__.pyi +1350 -594
  78. bl_ui/properties_data_lattice/__init__.pyi +374 -123
  79. bl_ui/properties_data_light/__init__.pyi +1319 -489
  80. bl_ui/properties_data_lightprobe/__init__.pyi +734 -241
  81. bl_ui/properties_data_mesh/__init__.pyi +2652 -1189
  82. bl_ui/properties_data_metaball/__init__.pyi +610 -197
  83. bl_ui/properties_data_modifier/__init__.pyi +1143 -506
  84. bl_ui/properties_data_pointcloud/__init__.pyi +670 -303
  85. bl_ui/properties_data_shaderfx/__init__.pyi +126 -36
  86. bl_ui/properties_data_speaker/__init__.pyi +618 -195
  87. bl_ui/properties_data_volume/__init__.pyi +1052 -408
  88. bl_ui/properties_freestyle/__init__.pyi +3366 -1450
  89. bl_ui/properties_grease_pencil_common/__init__.pyi +1634 -776
  90. bl_ui/properties_mask_common/__init__.pyi +803 -371
  91. bl_ui/properties_material/__init__.pyi +2038 -831
  92. bl_ui/properties_material_gpencil/__init__.pyi +1272 -523
  93. bl_ui/properties_object/__init__.pyi +1863 -745
  94. bl_ui/properties_output/__init__.pyi +2482 -1071
  95. bl_ui/properties_paint_common/__init__.pyi +317 -424
  96. bl_ui/properties_particle/__init__.pyi +7235 -2942
  97. bl_ui/properties_physics_cloth/__init__.pyi +1903 -758
  98. bl_ui/properties_physics_common/__init__.pyi +164 -51
  99. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2787 -1114
  100. bl_ui/properties_physics_field/__init__.pyi +1294 -486
  101. bl_ui/properties_physics_fluid/__init__.pyi +3631 -1545
  102. bl_ui/properties_physics_geometry_nodes/__init__.pyi +115 -34
  103. bl_ui/properties_physics_rigidbody/__init__.pyi +983 -312
  104. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1718 -656
  105. bl_ui/properties_physics_softbody/__init__.pyi +2091 -836
  106. bl_ui/properties_render/__init__.pyi +7177 -2939
  107. bl_ui/properties_scene/__init__.pyi +1881 -760
  108. bl_ui/properties_texture/__init__.pyi +3539 -1399
  109. bl_ui/properties_view_layer/__init__.pyi +2368 -940
  110. bl_ui/properties_workspace/__init__.pyi +517 -202
  111. bl_ui/properties_world/__init__.pyi +862 -269
  112. bl_ui/space_clip/__init__.pyi +9127 -4137
  113. bl_ui/space_console/__init__.pyi +666 -286
  114. bl_ui/space_dopesheet/__init__.pyi +3287 -1504
  115. bl_ui/space_filebrowser/__init__.pyi +3958 -1935
  116. bl_ui/space_graph/__init__.pyi +2406 -1142
  117. bl_ui/space_image/__init__.pyi +9242 -4526
  118. bl_ui/space_info/__init__.pyi +664 -285
  119. bl_ui/space_nla/__init__.pyi +2014 -932
  120. bl_ui/space_node/__init__.pyi +4549 -1949
  121. bl_ui/space_outliner/__init__.pyi +1619 -745
  122. bl_ui/space_properties/__init__.pyi +340 -105
  123. bl_ui/space_sequencer/__init__.pyi +9396 -4264
  124. bl_ui/space_spreadsheet/__init__.pyi +110 -60
  125. bl_ui/space_statusbar/__init__.pyi +107 -32
  126. bl_ui/space_text/__init__.pyi +1907 -872
  127. bl_ui/space_time/__init__.pyi +812 -327
  128. bl_ui/space_toolsystem_common/__init__.pyi +203 -99
  129. bl_ui/space_toolsystem_toolbar/__init__.pyi +845 -289
  130. bl_ui/space_topbar/__init__.pyi +3131 -1437
  131. bl_ui/space_userpref/__init__.pyi +11510 -4926
  132. bl_ui/space_view3d/__init__.pyi +31358 -14417
  133. bl_ui/space_view3d_toolbar/__init__.pyi +12401 -6163
  134. bl_ui/utils/__init__.pyi +7 -16
  135. bl_ui_utils/bug_report_url/__init__.pyi +4 -1
  136. bl_ui_utils/layout/__init__.pyi +4 -1
  137. blend_render_info/__init__.pyi +13 -3
  138. blf/__init__.pyi +5 -7
  139. bmesh/__init__.pyi +7 -7
  140. bmesh/geometry/__init__.pyi +5 -5
  141. bmesh/ops/__init__.pyi +490 -504
  142. bmesh/types/__init__.pyi +253 -247
  143. bmesh/utils/__init__.pyi +54 -54
  144. bpy/__init__.pyi +2 -2
  145. bpy/app/__init__.pyi +4 -5
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -10
  148. bpy/app/timers/__init__.pyi +9 -11
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +3 -12
  151. bpy/ops/action/__init__.pyi +316 -415
  152. bpy/ops/anim/__init__.pyi +428 -566
  153. bpy/ops/armature/__init__.pyi +360 -488
  154. bpy/ops/asset/__init__.pyi +146 -183
  155. bpy/ops/boid/__init__.pyi +50 -67
  156. bpy/ops/brush/__init__.pyi +72 -96
  157. bpy/ops/buttons/__init__.pyi +128 -142
  158. bpy/ops/cachefile/__init__.pyi +124 -137
  159. bpy/ops/camera/__init__.pyi +22 -28
  160. bpy/ops/clip/__init__.pyi +768 -1005
  161. bpy/ops/cloth/__init__.pyi +10 -13
  162. bpy/ops/collection/__init__.pyi +36 -50
  163. bpy/ops/console/__init__.pyi +150 -203
  164. bpy/ops/constraint/__init__.pyi +150 -201
  165. bpy/ops/curve/__init__.pyi +474 -607
  166. bpy/ops/curves/__init__.pyi +170 -221
  167. bpy/ops/cycles/__init__.pyi +18 -26
  168. bpy/ops/dpaint/__init__.pyi +34 -46
  169. bpy/ops/ed/__init__.pyi +122 -149
  170. bpy/ops/export_anim/__init__.pyi +18 -21
  171. bpy/ops/export_mesh/__init__.pyi +26 -29
  172. bpy/ops/export_scene/__init__.pyi +307 -342
  173. bpy/ops/file/__init__.pyi +342 -436
  174. bpy/ops/fluid/__init__.pyi +88 -117
  175. bpy/ops/font/__init__.pyi +252 -311
  176. bpy/ops/geometry/__init__.pyi +86 -113
  177. bpy/ops/gizmogroup/__init__.pyi +22 -27
  178. bpy/ops/gpencil/__init__.pyi +1444 -1864
  179. bpy/ops/graph/__init__.pyi +642 -822
  180. bpy/ops/grease_pencil/__init__.pyi +426 -576
  181. bpy/ops/image/__init__.pyi +612 -733
  182. bpy/ops/import_anim/__init__.pyi +26 -29
  183. bpy/ops/import_curve/__init__.pyi +6 -9
  184. bpy/ops/import_mesh/__init__.pyi +18 -23
  185. bpy/ops/import_scene/__init__.pyi +86 -101
  186. bpy/ops/info/__init__.pyi +60 -77
  187. bpy/ops/lattice/__init__.pyi +64 -85
  188. bpy/ops/marker/__init__.pyi +106 -137
  189. bpy/ops/mask/__init__.pyi +318 -420
  190. bpy/ops/material/__init__.pyi +18 -24
  191. bpy/ops/mball/__init__.pyi +70 -93
  192. bpy/ops/mesh/__init__.pyi +1988 -2460
  193. bpy/ops/nla/__init__.pyi +330 -428
  194. bpy/ops/node/__init__.pyi +852 -1115
  195. bpy/ops/object/__init__.pyi +2420 -3081
  196. bpy/ops/outliner/__init__.pyi +498 -661
  197. bpy/ops/paint/__init__.pyi +518 -667
  198. bpy/ops/paintcurve/__init__.pyi +64 -84
  199. bpy/ops/palette/__init__.pyi +48 -66
  200. bpy/ops/particle/__init__.pyi +264 -355
  201. bpy/ops/pose/__init__.pyi +336 -438
  202. bpy/ops/poselib/__init__.pyi +70 -92
  203. bpy/ops/preferences/__init__.pyi +336 -440
  204. bpy/ops/ptcache/__init__.pyi +46 -62
  205. bpy/ops/render/__init__.pyi +114 -147
  206. bpy/ops/rigidbody/__init__.pyi +102 -135
  207. bpy/ops/scene/__init__.pyi +270 -364
  208. bpy/ops/screen/__init__.pyi +378 -477
  209. bpy/ops/script/__init__.pyi +18 -26
  210. bpy/ops/sculpt/__init__.pyi +400 -488
  211. bpy/ops/sculpt_curves/__init__.pyi +40 -53
  212. bpy/ops/sequencer/__init__.pyi +1040 -1279
  213. bpy/ops/sound/__init__.pyi +208 -226
  214. bpy/ops/spreadsheet/__init__.pyi +30 -40
  215. bpy/ops/surface/__init__.pyi +108 -126
  216. bpy/ops/text/__init__.pyi +382 -486
  217. bpy/ops/text_editor/__init__.pyi +10 -13
  218. bpy/ops/texture/__init__.pyi +26 -35
  219. bpy/ops/transform/__init__.pyi +790 -905
  220. bpy/ops/ui/__init__.pyi +216 -291
  221. bpy/ops/uilist/__init__.pyi +20 -29
  222. bpy/ops/uv/__init__.pyi +600 -742
  223. bpy/ops/view2d/__init__.pyi +156 -195
  224. bpy/ops/view3d/__init__.pyi +576 -742
  225. bpy/ops/wm/__init__.pyi +2360 -2702
  226. bpy/ops/workspace/__init__.pyi +42 -57
  227. bpy/ops/world/__init__.pyi +6 -8
  228. bpy/path/__init__.pyi +110 -81
  229. bpy/props/__init__.pyi +263 -267
  230. bpy/types/__init__.pyi +86353 -87337
  231. bpy/utils/__init__.pyi +242 -154
  232. bpy/utils/previews/__init__.pyi +57 -57
  233. bpy/utils/units/__init__.pyi +19 -22
  234. bpy_extras/anim_utils/__init__.pyi +11 -31
  235. bpy_extras/asset_utils/__init__.pyi +4 -1
  236. bpy_extras/image_utils/__init__.pyi +2 -2
  237. bpy_extras/io_utils/__init__.pyi +30 -27
  238. bpy_extras/keyconfig_utils/__init__.pyi +4 -1
  239. bpy_extras/mesh_utils/__init__.pyi +18 -18
  240. bpy_extras/node_utils/__init__.pyi +4 -1
  241. bpy_extras/object_utils/__init__.pyi +25 -26
  242. bpy_extras/view3d_utils/__init__.pyi +33 -38
  243. bpy_restrict_state/__init__.pyi +14 -1
  244. bpy_types/__init__.pyi +3748 -1248
  245. console_python/__init__.pyi +41 -7
  246. console_shell/__init__.pyi +24 -5
  247. {fake_bpy_module-20240321.dist-info → fake_bpy_module-20240322.dist-info}/METADATA +1 -1
  248. fake_bpy_module-20240322.dist-info/RECORD +343 -0
  249. freestyle/chainingiterators/__init__.pyi +50 -52
  250. freestyle/functions/__init__.pyi +303 -207
  251. freestyle/predicates/__init__.pyi +299 -115
  252. freestyle/shaders/__init__.pyi +49 -80
  253. freestyle/types/__init__.pyi +463 -470
  254. freestyle/utils/ContextFunctions/__init__.pyi +9 -9
  255. freestyle/utils/__init__.pyi +27 -17
  256. gpu/capabilities/__init__.pyi +19 -20
  257. gpu/matrix/__init__.pyi +14 -16
  258. gpu/platform/__init__.pyi +5 -5
  259. gpu/shader/__init__.pyi +2 -5
  260. gpu/state/__init__.pyi +1 -1
  261. gpu/texture/__init__.pyi +3 -3
  262. gpu/types/__init__.pyi +54 -85
  263. gpu_extras/batch/__init__.pyi +26 -6
  264. gpu_extras/presets/__init__.pyi +51 -16
  265. graphviz_export/__init__.pyi +9 -2
  266. idprop/types/__init__.pyi +36 -12
  267. imbuf/__init__.pyi +8 -9
  268. imbuf/types/__init__.pyi +8 -15
  269. keyingsets_builtins/__init__.pyi +2520 -1085
  270. keyingsets_utils/__init__.pyi +69 -14
  271. mathutils/__init__.pyi +491 -423
  272. mathutils/bvhtree/__init__.pyi +26 -31
  273. mathutils/geometry/__init__.pyi +176 -185
  274. mathutils/kdtree/__init__.pyi +14 -17
  275. mathutils/noise/__init__.pyi +47 -48
  276. nodeitems_builtins/__init__.pyi +37 -15
  277. nodeitems_utils/__init__.pyi +45 -13
  278. rna_info/__init__.pyi +177 -76
  279. rna_keymap_ui/__init__.pyi +29 -6
  280. rna_prop_ui/__init__.pyi +56 -14
  281. rna_xml/__init__.pyi +29 -6
  282. sys_info/__init__.pyi +4 -1
  283. fake_bpy_module-20240321.dist-info/RECORD +0 -343
  284. {fake_bpy_module-20240321.dist-info → fake_bpy_module-20240322.dist-info}/WHEEL +0 -0
  285. {fake_bpy_module-20240321.dist-info → fake_bpy_module-20240322.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: typing.Optional[str] = "",
7
- description: typing.Optional[str] = "",
8
- translation_context: typing.Optional[str] = "*",
6
+ name: str = "",
7
+ description: str = "",
8
+ translation_context: str = "*",
9
9
  default=False,
10
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
11
- override: typing.Optional[typing.Set] = None(),
12
- tags: typing.Optional[typing.Set] = None(),
13
- subtype: typing.Optional[str] = "NONE",
14
- update: typing.Optional[typing.Any] = None,
15
- get: typing.Optional[typing.Any] = None,
16
- 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,
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: typing.Optional[str]
21
+ :type name: str
22
22
  :param description: Text used for the tooltip and api documentation.
23
- :type description: typing.Optional[str]
23
+ :type description: str
24
24
  :param translation_context: Text used as context to disambiguate translations.
25
- :type translation_context: typing.Optional[str]
25
+ :type translation_context: str
26
26
  :param options: Enumerator in `rna_enum_property_flag_items`.
27
- :type options: typing.Optional[typing.Set]
27
+ :type options: set
28
28
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
29
- :type override: typing.Optional[typing.Set]
29
+ :type override: set
30
30
  :param tags: Enumerator of tags that are defined by parent class.
31
- :type tags: typing.Optional[typing.Set]
31
+ :type tags: set
32
32
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
33
- :type subtype: typing.Optional[str]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
43
+ :type set: typing.Any
44
44
  """
45
45
 
46
46
  ...
47
47
 
48
48
  def BoolVectorProperty(
49
- name: typing.Optional[str] = "",
50
- description: typing.Optional[str] = "",
51
- translation_context: typing.Optional[str] = "*",
52
- default: typing.Optional[typing.Sequence] = (False, False, False),
53
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
54
- override: typing.Optional[typing.Set] = None(),
55
- tags: typing.Optional[typing.Set] = None(),
56
- subtype: typing.Optional[str] = "NONE",
57
- size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
58
- update: typing.Optional[typing.Any] = None,
59
- get: typing.Optional[typing.Any] = None,
60
- 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,
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: typing.Optional[str]
65
+ :type name: str
66
66
  :param description: Text used for the tooltip and api documentation.
67
- :type description: typing.Optional[str]
67
+ :type description: str
68
68
  :param translation_context: Text used as context to disambiguate translations.
69
- :type translation_context: typing.Optional[str]
69
+ :type translation_context: str
70
70
  :param default: sequence of booleans the length of size.
71
- :type default: typing.Optional[typing.Sequence]
71
+ :type default: typing.Sequence
72
72
  :param options: Enumerator in `rna_enum_property_flag_items`.
73
- :type options: typing.Optional[typing.Set]
73
+ :type options: set
74
74
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
75
- :type override: typing.Optional[typing.Set]
75
+ :type override: set
76
76
  :param tags: Enumerator of tags that are defined by parent class.
77
- :type tags: typing.Optional[typing.Set]
77
+ :type tags: set
78
78
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
79
- :type subtype: typing.Optional[str]
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.Optional[typing.Union[int, typing.Sequence[int]]]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
91
+ :type set: typing.Any
92
92
  """
93
93
 
94
94
  ...
95
95
 
96
96
  def CollectionProperty(
97
- type: typing.Optional[typing.Any] = None,
98
- name: typing.Optional[str] = "",
99
- description: typing.Optional[str] = "",
100
- translation_context: typing.Optional[str] = "*",
101
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
102
- override: typing.Optional[typing.Set] = None(),
103
- tags: typing.Optional[typing.Set] = None(),
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: typing.Optional[str]
109
+ :type name: str
111
110
  :param description: Text used for the tooltip and api documentation.
112
- :type description: typing.Optional[str]
111
+ :type description: str
113
112
  :param translation_context: Text used as context to disambiguate translations.
114
- :type translation_context: typing.Optional[str]
113
+ :type translation_context: str
115
114
  :param options: Enumerator in `rna_enum_property_flag_items`.
116
- :type options: typing.Optional[typing.Set]
115
+ :type options: set
117
116
  :param override: Enumerator in `rna_enum_property_override_flag_collection_items`.
118
- :type override: typing.Optional[typing.Set]
117
+ :type override: set
119
118
  :param tags: Enumerator of tags that are defined by parent class.
120
- :type tags: typing.Optional[typing.Set]
119
+ :type tags: set
121
120
  """
122
121
 
123
122
  ...
124
123
 
125
124
  def EnumProperty(
126
- items: typing.Optional[
127
- typing.Union[typing.Callable, typing.Iterable[typing.Iterable[str]]]
128
- ],
129
- name: typing.Optional[str] = "",
130
- description: typing.Optional[str] = "",
131
- translation_context: typing.Optional[str] = "*",
132
- default: typing.Optional[typing.Union[str, typing.Set]] = None,
133
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
134
- override: typing.Optional[typing.Set] = None(),
135
- tags: typing.Optional[typing.Set] = None(),
136
- update: typing.Optional[typing.Any] = None,
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.Optional[typing.Union[typing.Callable, typing.Iterable[typing.Iterable[str]]]]
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: typing.Optional[str]
179
+ :type name: str
183
180
  :param description: Text used for the tooltip and api documentation.
184
- :type description: typing.Optional[str]
181
+ :type description: str
185
182
  :param translation_context: Text used as context to disambiguate translations.
186
- :type translation_context: typing.Optional[str]
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.Optional[typing.Union[str, typing.Set]]
188
+ :type default: typing.Union[str, set]
192
189
  :param options: Enumerator in `rna_enum_property_flag_enum_items`.
193
- :type options: typing.Optional[typing.Set]
190
+ :type options: set
194
191
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
195
- :type override: typing.Optional[typing.Set]
192
+ :type override: set
196
193
  :param tags: Enumerator of tags that are defined by parent class.
197
- :type tags: typing.Optional[typing.Set]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
204
+ :type set: typing.Any
208
205
  """
209
206
 
210
207
  ...
211
208
 
212
209
  def FloatProperty(
213
- name: typing.Optional[str] = "",
214
- description: typing.Optional[str] = "",
215
- translation_context: typing.Optional[str] = "*",
210
+ name: str = "",
211
+ description: str = "",
212
+ translation_context: str = "*",
216
213
  default=0.0,
217
- min: typing.Optional[float] = -3.402823e38,
218
- max: typing.Optional[float] = 3.402823e38,
219
- soft_min: typing.Optional[float] = -3.402823e38,
220
- soft_max: typing.Optional[float] = 3.402823e38,
221
- step: typing.Optional[int] = 3,
222
- precision: typing.Optional[int] = 2,
223
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
224
- override: typing.Optional[typing.Set] = None(),
225
- tags: typing.Optional[typing.Set] = None(),
226
- subtype: typing.Optional[str] = "NONE",
227
- unit: typing.Optional[str] = "NONE",
228
- update: typing.Optional[typing.Any] = None,
229
- get: typing.Optional[typing.Any] = None,
230
- 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,
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: typing.Optional[str]
232
+ :type name: str
236
233
  :param description: Text used for the tooltip and api documentation.
237
- :type description: typing.Optional[str]
234
+ :type description: str
238
235
  :param translation_context: Text used as context to disambiguate translations.
239
- :type translation_context: typing.Optional[str]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[int]
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: typing.Optional[int]
248
+ :type precision: int
252
249
  :param options: Enumerator in `rna_enum_property_flag_items`.
253
- :type options: typing.Optional[typing.Set]
250
+ :type options: set
254
251
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
255
- :type override: typing.Optional[typing.Set]
252
+ :type override: set
256
253
  :param tags: Enumerator of tags that are defined by parent class.
257
- :type tags: typing.Optional[typing.Set]
254
+ :type tags: set
258
255
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
259
- :type subtype: typing.Optional[str]
256
+ :type subtype: str
260
257
  :param unit: Enumerator in `rna_enum_property_unit_items`.
261
- :type unit: typing.Optional[str]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
268
+ :type set: typing.Any
272
269
  """
273
270
 
274
271
  ...
275
272
 
276
273
  def FloatVectorProperty(
277
- name: typing.Optional[str] = "",
278
- description: typing.Optional[str] = "",
279
- translation_context: typing.Optional[str] = "*",
280
- default: typing.Optional[typing.Sequence] = (0.0, 0.0, 0.0),
281
- min: typing.Optional[float] = None,
282
- max: typing.Optional[float] = None,
283
- soft_min: typing.Optional[float] = None,
284
- soft_max: typing.Optional[float] = None,
285
- step: typing.Optional[int] = 3,
286
- precision: typing.Optional[int] = 2,
287
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
288
- override: typing.Optional[typing.Set] = None(),
289
- tags: typing.Optional[typing.Set] = None(),
290
- subtype: typing.Optional[str] = "NONE",
291
- unit: typing.Optional[str] = "NONE",
292
- size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
293
- update: typing.Optional[typing.Any] = None,
294
- get: typing.Optional[typing.Any] = None,
295
- 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,
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: typing.Optional[str]
297
+ :type name: str
301
298
  :param description: Text used for the tooltip and api documentation.
302
- :type description: typing.Optional[str]
299
+ :type description: str
303
300
  :param translation_context: Text used as context to disambiguate translations.
304
- :type translation_context: typing.Optional[str]
301
+ :type translation_context: str
305
302
  :param default: sequence of floats the length of size.
306
- :type default: typing.Optional[typing.Sequence]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[float]
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: typing.Optional[int]
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: typing.Optional[int]
315
+ :type precision: int
319
316
  :param options: Enumerator in `rna_enum_property_flag_items`.
320
- :type options: typing.Optional[typing.Set]
317
+ :type options: set
321
318
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
322
- :type override: typing.Optional[typing.Set]
319
+ :type override: set
323
320
  :param tags: Enumerator of tags that are defined by parent class.
324
- :type tags: typing.Optional[typing.Set]
321
+ :type tags: set
325
322
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
326
- :type subtype: typing.Optional[str]
323
+ :type subtype: str
327
324
  :param unit: Enumerator in `rna_enum_property_unit_items`.
328
- :type unit: typing.Optional[str]
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.Optional[typing.Union[int, typing.Sequence[int]]]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
337
+ :type set: typing.Any
341
338
  """
342
339
 
343
340
  ...
344
341
 
345
342
  def IntProperty(
346
- name: typing.Optional[str] = "",
347
- description: typing.Optional[str] = "",
348
- translation_context: typing.Optional[str] = "*",
343
+ name: str = "",
344
+ description: str = "",
345
+ translation_context: str = "*",
349
346
  default=0,
350
- min: typing.Optional[int] = None,
351
- max: typing.Optional[int] = None,
352
- soft_min: typing.Optional[int] = None,
353
- soft_max: typing.Optional[int] = None,
354
- step: typing.Optional[int] = 1,
355
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
356
- override: typing.Optional[typing.Set] = None(),
357
- tags: typing.Optional[typing.Set] = None(),
358
- subtype: typing.Optional[str] = "NONE",
359
- update: typing.Optional[typing.Any] = None,
360
- get: typing.Optional[typing.Any] = None,
361
- 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,
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: typing.Optional[str]
363
+ :type name: str
367
364
  :param description: Text used for the tooltip and api documentation.
368
- :type description: typing.Optional[str]
365
+ :type description: str
369
366
  :param translation_context: Text used as context to disambiguate translations.
370
- :type translation_context: typing.Optional[str]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
377
+ :type step: int
381
378
  :param options: Enumerator in `rna_enum_property_flag_items`.
382
- :type options: typing.Optional[typing.Set]
379
+ :type options: set
383
380
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
384
- :type override: typing.Optional[typing.Set]
381
+ :type override: set
385
382
  :param tags: Enumerator of tags that are defined by parent class.
386
- :type tags: typing.Optional[typing.Set]
383
+ :type tags: set
387
384
  :param subtype: Enumerator in `rna_enum_property_subtype_number_items`.
388
- :type subtype: typing.Optional[str]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
395
+ :type set: typing.Any
399
396
  """
400
397
 
401
398
  ...
402
399
 
403
400
  def IntVectorProperty(
404
- name: typing.Optional[str] = "",
405
- description: typing.Optional[str] = "",
406
- translation_context: typing.Optional[str] = "*",
407
- default: typing.Optional[typing.Sequence] = (0, 0, 0),
408
- min: typing.Optional[int] = None,
409
- max: typing.Optional[int] = None,
410
- soft_min: typing.Optional[int] = None,
411
- soft_max: typing.Optional[int] = None,
412
- step: typing.Optional[int] = 1,
413
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
414
- override: typing.Optional[typing.Set] = None(),
415
- tags: typing.Optional[typing.Set] = None(),
416
- subtype: typing.Optional[str] = "NONE",
417
- size: typing.Optional[typing.Union[int, typing.Sequence[int]]] = 3,
418
- update: typing.Optional[typing.Any] = None,
419
- get: typing.Optional[typing.Any] = None,
420
- 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,
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: typing.Optional[str]
422
+ :type name: str
426
423
  :param description: Text used for the tooltip and api documentation.
427
- :type description: typing.Optional[str]
424
+ :type description: str
428
425
  :param translation_context: Text used as context to disambiguate translations.
429
- :type translation_context: typing.Optional[str]
426
+ :type translation_context: str
430
427
  :param default: sequence of ints the length of size.
431
- :type default: typing.Optional[typing.Sequence]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
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: typing.Optional[int]
438
+ :type step: int
442
439
  :param options: Enumerator in `rna_enum_property_flag_items`.
443
- :type options: typing.Optional[typing.Set]
440
+ :type options: set
444
441
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
445
- :type override: typing.Optional[typing.Set]
442
+ :type override: set
446
443
  :param tags: Enumerator of tags that are defined by parent class.
447
- :type tags: typing.Optional[typing.Set]
444
+ :type tags: set
448
445
  :param subtype: Enumerator in `rna_enum_property_subtype_number_array_items`.
449
- :type subtype: typing.Optional[str]
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.Optional[typing.Union[int, typing.Sequence[int]]]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
458
+ :type set: typing.Any
462
459
  """
463
460
 
464
461
  ...
465
462
 
466
463
  def PointerProperty(
467
- type: typing.Optional[typing.Any] = None,
468
- name: typing.Optional[str] = "",
469
- description: typing.Optional[str] = "",
470
- translation_context: typing.Optional[str] = "*",
471
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
472
- override: typing.Optional[typing.Set] = None(),
473
- tags: typing.Optional[typing.Set] = None(),
474
- poll: typing.Optional[typing.Any] = None,
475
- 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,
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: typing.Optional[str]
478
+ :type name: str
483
479
  :param description: Text used for the tooltip and api documentation.
484
- :type description: typing.Optional[str]
480
+ :type description: str
485
481
  :param translation_context: Text used as context to disambiguate translations.
486
- :type translation_context: typing.Optional[str]
482
+ :type translation_context: str
487
483
  :param options: Enumerator in `rna_enum_property_flag_items`.
488
- :type options: typing.Optional[typing.Set]
484
+ :type options: set
489
485
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
490
- :type override: typing.Optional[typing.Set]
486
+ :type override: set
491
487
  :param tags: Enumerator of tags that are defined by parent class.
492
- :type tags: typing.Optional[typing.Set]
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.Optional[typing.Any]
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.Optional[typing.Any]
495
+ :type update: typing.Any
500
496
  """
501
497
 
502
498
  ...
503
499
 
504
- def RemoveProperty(cls: typing.Optional[typing.Any], attr: typing.Optional[str]):
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.Optional[typing.Any]
504
+ :type cls: typing.Any
509
505
  :param attr: Property name (must be passed as a keyword).
510
- :type attr: typing.Optional[str]
506
+ :type attr: str
511
507
  """
512
508
 
513
509
  ...
514
510
 
515
511
  def StringProperty(
516
- name: typing.Optional[str] = "",
517
- description: typing.Optional[str] = "",
518
- translation_context: typing.Optional[str] = "*",
519
- default: typing.Optional[str] = "",
520
- maxlen: typing.Optional[int] = 0,
521
- options: typing.Optional[typing.Set] = {'"ANIMATABLE"'},
522
- override: typing.Optional[typing.Set] = None(),
523
- tags: typing.Optional[typing.Set] = None(),
524
- subtype: typing.Optional[str] = "NONE",
525
- update: typing.Optional[typing.Any] = None,
526
- get: typing.Optional[typing.Any] = None,
527
- set: typing.Optional[typing.Any] = None,
528
- search: typing.Optional[typing.Any] = None,
529
- 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"'},
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: typing.Optional[str]
530
+ :type name: str
535
531
  :param description: Text used for the tooltip and api documentation.
536
- :type description: typing.Optional[str]
532
+ :type description: str
537
533
  :param translation_context: Text used as context to disambiguate translations.
538
- :type translation_context: typing.Optional[str]
534
+ :type translation_context: str
539
535
  :param default: initializer string.
540
- :type default: typing.Optional[str]
536
+ :type default: str
541
537
  :param maxlen: maximum length of the string.
542
- :type maxlen: typing.Optional[int]
538
+ :type maxlen: int
543
539
  :param options: Enumerator in `rna_enum_property_flag_items`.
544
- :type options: typing.Optional[typing.Set]
540
+ :type options: set
545
541
  :param override: Enumerator in `rna_enum_property_override_flag_items`.
546
- :type override: typing.Optional[typing.Set]
542
+ :type override: set
547
543
  :param tags: Enumerator of tags that are defined by parent class.
548
- :type tags: typing.Optional[typing.Set]
544
+ :type tags: set
549
545
  :param subtype: Enumerator in `rna_enum_property_subtype_string_items`.
550
- :type subtype: typing.Optional[str]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
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.Optional[typing.Any]
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: typing.Optional[typing.Set]
573
+ :type search_options: set
578
574
  """
579
575
 
580
576
  ...