fake-bpy-module 20240516__py3-none-any.whl → 20240517__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 (533) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +2 -2
  2. addon_utils/__init__.pyi +43 -12
  3. animsys_refactor/__init__.pyi +4 -4
  4. aud/__init__.pyi +7 -7
  5. bgl/__init__.pyi +121 -183
  6. bl_app_override/__init__.pyi +5 -5
  7. bl_app_override/helpers/__init__.pyi +3 -1
  8. bl_app_template_utils/__init__.pyi +5 -5
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +5 -5
  14. bl_i18n_utils/settings/__init__.pyi +4 -2
  15. bl_i18n_utils/utils/__init__.pyi +86 -58
  16. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  17. bl_keymap_utils/io/__init__.pyi +4 -4
  18. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  19. bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
  20. bl_operators/add_mesh_torus/__init__.pyi +126 -41
  21. bl_operators/anim/__init__.pyi +1001 -328
  22. bl_operators/assets/__init__.pyi +376 -123
  23. bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
  24. bl_operators/clip/__init__.pyi +1250 -409
  25. bl_operators/console/__init__.pyi +626 -205
  26. bl_operators/constraint/__init__.pyi +502 -165
  27. bl_operators/file/__init__.pyi +376 -123
  28. bl_operators/freestyle/__init__.pyi +501 -164
  29. bl_operators/geometry_nodes/__init__.pyi +501 -164
  30. bl_operators/image/__init__.pyi +621 -200
  31. bl_operators/mesh/__init__.pyi +376 -123
  32. bl_operators/node/__init__.pyi +1243 -402
  33. bl_operators/object/__init__.pyi +1876 -615
  34. bl_operators/object_align/__init__.pyi +126 -41
  35. bl_operators/object_quick_effects/__init__.pyi +502 -165
  36. bl_operators/object_randomize_transform/__init__.pyi +126 -41
  37. bl_operators/presets/__init__.pyi +3069 -1027
  38. bl_operators/rigidbody/__init__.pyi +376 -123
  39. bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
  40. bl_operators/sequencer/__init__.pyi +1009 -331
  41. bl_operators/spreadsheet/__init__.pyi +126 -41
  42. bl_operators/userpref/__init__.pyi +3263 -1078
  43. bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
  44. bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
  45. bl_operators/uvcalc_transform/__init__.pyi +289 -90
  46. bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
  47. bl_operators/view3d/__init__.pyi +868 -279
  48. bl_operators/wm/__init__.pyi +5777 -1934
  49. bl_operators/world/__init__.pyi +126 -41
  50. bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
  51. bl_rna_utils/data_path/__init__.pyi +8 -3
  52. bl_ui/__init__.pyi +338 -131
  53. bl_ui/anim/__init__.pyi +164 -64
  54. bl_ui/asset_shelf/__init__.pyi +129 -42
  55. bl_ui/generic_ui_list/__init__.pyi +412 -135
  56. bl_ui/node_add_menu/__init__.pyi +168 -68
  57. bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
  58. bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
  59. bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
  60. bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
  61. bl_ui/properties_animviz/__init__.pyi +2 -2
  62. bl_ui/properties_collection/__init__.pyi +806 -274
  63. bl_ui/properties_constraint/__init__.pyi +10253 -3458
  64. bl_ui/properties_data_armature/__init__.pyi +1615 -552
  65. bl_ui/properties_data_bone/__init__.pyi +1288 -425
  66. bl_ui/properties_data_camera/__init__.pyi +1854 -631
  67. bl_ui/properties_data_curve/__init__.pyi +1929 -636
  68. bl_ui/properties_data_curves/__init__.pyi +806 -274
  69. bl_ui/properties_data_empty/__init__.pyi +257 -84
  70. bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
  71. bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
  72. bl_ui/properties_data_lattice/__init__.pyi +388 -127
  73. bl_ui/properties_data_light/__init__.pyi +1541 -506
  74. bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
  75. bl_ui/properties_data_mesh/__init__.pyi +2704 -929
  76. bl_ui/properties_data_metaball/__init__.pyi +644 -211
  77. bl_ui/properties_data_modifier/__init__.pyi +1353 -502
  78. bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
  79. bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
  80. bl_ui/properties_data_speaker/__init__.pyi +644 -211
  81. bl_ui/properties_data_volume/__init__.pyi +1030 -339
  82. bl_ui/properties_freestyle/__init__.pyi +3113 -1035
  83. bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
  84. bl_ui/properties_mask_common/__init__.pyi +1101 -420
  85. bl_ui/properties_material/__init__.pyi +2091 -699
  86. bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
  87. bl_ui/properties_object/__init__.pyi +1838 -618
  88. bl_ui/properties_output/__init__.pyi +2414 -831
  89. bl_ui/properties_paint_common/__init__.pyi +412 -289
  90. bl_ui/properties_particle/__init__.pyi +6737 -2241
  91. bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
  92. bl_ui/properties_physics_common/__init__.pyi +129 -42
  93. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
  94. bl_ui/properties_physics_field/__init__.pyi +1283 -422
  95. bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
  96. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
  97. bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
  98. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
  99. bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
  100. bl_ui/properties_render/__init__.pyi +6830 -2263
  101. bl_ui/properties_scene/__init__.pyi +1929 -636
  102. bl_ui/properties_texture/__init__.pyi +3370 -1118
  103. bl_ui/properties_view_layer/__init__.pyi +2346 -782
  104. bl_ui/properties_workspace/__init__.pyi +516 -169
  105. bl_ui/properties_world/__init__.pyi +1284 -421
  106. bl_ui/space_clip/__init__.pyi +10134 -3639
  107. bl_ui/space_console/__init__.pyi +939 -357
  108. bl_ui/space_dopesheet/__init__.pyi +4327 -1562
  109. bl_ui/space_filebrowser/__init__.pyi +4164 -1499
  110. bl_ui/space_graph/__init__.pyi +3108 -1179
  111. bl_ui/space_image/__init__.pyi +9766 -3596
  112. bl_ui/space_info/__init__.pyi +939 -357
  113. bl_ui/space_nla/__init__.pyi +2620 -988
  114. bl_ui/space_node/__init__.pyi +3994 -1434
  115. bl_ui/space_outliner/__init__.pyi +2203 -842
  116. bl_ui/space_properties/__init__.pyi +386 -127
  117. bl_ui/space_sequencer/__init__.pyi +10773 -3878
  118. bl_ui/space_spreadsheet/__init__.pyi +130 -43
  119. bl_ui/space_statusbar/__init__.pyi +129 -42
  120. bl_ui/space_text/__init__.pyi +2458 -925
  121. bl_ui/space_time/__init__.pyi +1033 -378
  122. bl_ui/space_toolsystem_common/__init__.pyi +20 -16
  123. bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
  124. bl_ui/space_topbar/__init__.pyi +3980 -1496
  125. bl_ui/space_userpref/__init__.pyi +11373 -3797
  126. bl_ui/space_view3d/__init__.pyi +40865 -15356
  127. bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
  128. bl_ui/temp_anim_layers/__init__.pyi +129 -42
  129. bl_ui/utils/__init__.pyi +28 -20
  130. bl_ui_utils/bug_report_url/__init__.pyi +1 -1
  131. bl_ui_utils/layout/__init__.pyi +1 -1
  132. blend_render_info/__init__.pyi +1 -1
  133. blf/__init__.pyi +4 -4
  134. bmesh/geometry/__init__.pyi +2 -3
  135. bmesh/ops/__init__.pyi +372 -419
  136. bmesh/types/__init__.pyi +38 -38
  137. bmesh/utils/__init__.pyi +10 -13
  138. bpy/app/__init__.pyi +4 -4
  139. bpy/app/handlers/__init__.pyi +36 -36
  140. bpy/app/icons/__init__.pyi +8 -8
  141. bpy/app/timers/__init__.pyi +10 -10
  142. bpy/app/translations/__init__.pyi +20 -22
  143. bpy/msgbus/__init__.pyi +2 -4
  144. bpy/ops/action/__init__.pyi +316 -394
  145. bpy/ops/anim/__init__.pyi +442 -548
  146. bpy/ops/armature/__init__.pyi +374 -470
  147. bpy/ops/asset/__init__.pyi +152 -184
  148. bpy/ops/bl_pkg/__init__.pyi +221 -272
  149. bpy/ops/boid/__init__.pyi +50 -66
  150. bpy/ops/brush/__init__.pyi +72 -90
  151. bpy/ops/buttons/__init__.pyi +132 -144
  152. bpy/ops/cachefile/__init__.pyi +128 -138
  153. bpy/ops/camera/__init__.pyi +26 -30
  154. bpy/ops/clip/__init__.pyi +777 -964
  155. bpy/ops/cloth/__init__.pyi +12 -14
  156. bpy/ops/collection/__init__.pyi +68 -86
  157. bpy/ops/console/__init__.pyi +158 -200
  158. bpy/ops/constraint/__init__.pyi +178 -214
  159. bpy/ops/curve/__init__.pyi +473 -576
  160. bpy/ops/curves/__init__.pyi +247 -302
  161. bpy/ops/cycles/__init__.pyi +28 -34
  162. bpy/ops/dpaint/__init__.pyi +34 -44
  163. bpy/ops/ed/__init__.pyi +126 -150
  164. bpy/ops/export_anim/__init__.pyi +22 -24
  165. bpy/ops/export_scene/__init__.pyi +302 -336
  166. bpy/ops/file/__init__.pyi +352 -432
  167. bpy/ops/fluid/__init__.pyi +90 -118
  168. bpy/ops/font/__init__.pyi +258 -304
  169. bpy/ops/geometry/__init__.pyi +100 -120
  170. bpy/ops/gizmogroup/__init__.pyi +22 -26
  171. bpy/ops/gpencil/__init__.pyi +1469 -1778
  172. bpy/ops/graph/__init__.pyi +644 -776
  173. bpy/ops/grease_pencil/__init__.pyi +597 -748
  174. bpy/ops/image/__init__.pyi +648 -744
  175. bpy/ops/import_anim/__init__.pyi +30 -32
  176. bpy/ops/import_curve/__init__.pyi +10 -12
  177. bpy/ops/import_scene/__init__.pyi +88 -96
  178. bpy/ops/info/__init__.pyi +60 -74
  179. bpy/ops/lattice/__init__.pyi +64 -80
  180. bpy/ops/marker/__init__.pyi +108 -130
  181. bpy/ops/mask/__init__.pyi +322 -402
  182. bpy/ops/material/__init__.pyi +18 -24
  183. bpy/ops/mball/__init__.pyi +70 -86
  184. bpy/ops/mesh/__init__.pyi +1986 -2322
  185. bpy/ops/nla/__init__.pyi +333 -411
  186. bpy/ops/node/__init__.pyi +886 -1100
  187. bpy/ops/object/__init__.pyi +2585 -3078
  188. bpy/ops/outliner/__init__.pyi +498 -636
  189. bpy/ops/paint/__init__.pyi +565 -680
  190. bpy/ops/paintcurve/__init__.pyi +64 -80
  191. bpy/ops/palette/__init__.pyi +50 -64
  192. bpy/ops/particle/__init__.pyi +267 -340
  193. bpy/ops/pose/__init__.pyi +336 -414
  194. bpy/ops/poselib/__init__.pyi +72 -90
  195. bpy/ops/preferences/__init__.pyi +386 -463
  196. bpy/ops/ptcache/__init__.pyi +46 -60
  197. bpy/ops/render/__init__.pyi +130 -154
  198. bpy/ops/rigidbody/__init__.pyi +102 -128
  199. bpy/ops/scene/__init__.pyi +280 -358
  200. bpy/ops/screen/__init__.pyi +382 -460
  201. bpy/ops/script/__init__.pyi +24 -30
  202. bpy/ops/sculpt/__init__.pyi +458 -532
  203. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  204. bpy/ops/sequencer/__init__.pyi +1066 -1244
  205. bpy/ops/sound/__init__.pyi +216 -230
  206. bpy/ops/spreadsheet/__init__.pyi +30 -38
  207. bpy/ops/surface/__init__.pyi +108 -120
  208. bpy/ops/text/__init__.pyi +390 -476
  209. bpy/ops/text_editor/__init__.pyi +12 -14
  210. bpy/ops/texture/__init__.pyi +26 -34
  211. bpy/ops/transform/__init__.pyi +792 -878
  212. bpy/ops/ui/__init__.pyi +228 -294
  213. bpy/ops/uilist/__init__.pyi +32 -38
  214. bpy/ops/uv/__init__.pyi +602 -704
  215. bpy/ops/view2d/__init__.pyi +156 -184
  216. bpy/ops/view3d/__init__.pyi +582 -718
  217. bpy/ops/wm/__init__.pyi +2680 -2928
  218. bpy/ops/workspace/__init__.pyi +46 -60
  219. bpy/ops/world/__init__.pyi +12 -16
  220. bpy/path/__init__.pyi +179 -75
  221. bpy/props/__init__.pyi +261 -263
  222. bpy/types/__init__.pyi +17056 -21951
  223. bpy/utils/__init__.pyi +242 -118
  224. bpy/utils/previews/__init__.pyi +58 -28
  225. bpy/utils/units/__init__.pyi +20 -20
  226. bpy_extras/anim_utils/__init__.pyi +68 -28
  227. bpy_extras/bmesh_utils/__init__.pyi +8 -2
  228. bpy_extras/extensions/junction_module/__init__.pyi +5 -2
  229. bpy_extras/id_map_utils/__init__.pyi +3 -3
  230. bpy_extras/image_utils/__init__.pyi +44 -11
  231. bpy_extras/io_utils/__init__.pyi +113 -18
  232. bpy_extras/keyconfig_utils/__init__.pyi +2 -2
  233. bpy_extras/mesh_utils/__init__.pyi +71 -19
  234. bpy_extras/node_shader_utils/__init__.pyi +9 -4
  235. bpy_extras/node_utils/__init__.pyi +9 -2
  236. bpy_extras/object_utils/__init__.pyi +71 -12
  237. bpy_extras/view3d_utils/__init__.pyi +80 -10
  238. bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
  239. bpy_types/__init__.pyi +4197 -1333
  240. console_python/__init__.pyi +6 -1
  241. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
  242. fake_bpy_module-20240517.dist-info/RECORD +353 -0
  243. freestyle/chainingiterators/__init__.pyi +4 -4
  244. freestyle/shaders/__init__.pyi +2 -2
  245. freestyle/types/__init__.pyi +84 -96
  246. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  247. freestyle/utils/__init__.pyi +3 -3
  248. gpu/matrix/__init__.pyi +6 -8
  249. gpu/state/__init__.pyi +2 -2
  250. gpu/types/__init__.pyi +12 -12
  251. gpu_extras/presets/__init__.pyi +2 -5
  252. graphviz_export/__init__.pyi +4 -2
  253. idprop/types/__init__.pyi +2 -2
  254. imbuf/__init__.pyi +4 -4
  255. keyingsets_builtins/__init__.pyi +2688 -839
  256. mathutils/__init__.pyi +194 -238
  257. mathutils/bvhtree/__init__.pyi +4 -4
  258. mathutils/geometry/__init__.pyi +153 -155
  259. mathutils/kdtree/__init__.pyi +8 -12
  260. mathutils/noise/__init__.pyi +26 -26
  261. nodeitems_utils/__init__.pyi +1 -1
  262. rna_info/__init__.pyi +17 -15
  263. rna_keymap_ui/__init__.pyi +1 -1
  264. rna_prop_ui/__init__.pyi +16 -14
  265. rna_xml/__init__.pyi +12 -12
  266. _bpy_internal/freedesktop/py.typed +0 -0
  267. bl_app_override/helpers/py.typed +0 -0
  268. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  269. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  270. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  271. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  272. bl_console_utils/autocomplete/py.typed +0 -0
  273. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  274. bl_i18n_utils/merge_po/py.typed +0 -0
  275. bl_i18n_utils/settings/py.typed +0 -0
  276. bl_i18n_utils/utils/py.typed +0 -0
  277. bl_i18n_utils/utils_cli/py.typed +0 -0
  278. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  279. bl_i18n_utils/utils_rtl/py.typed +0 -0
  280. bl_keymap_utils/io/py.typed +0 -0
  281. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  282. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  283. bl_keymap_utils/platform_helpers/py.typed +0 -0
  284. bl_keymap_utils/versioning/py.typed +0 -0
  285. bl_operators/add_mesh_torus/py.typed +0 -0
  286. bl_operators/anim/py.typed +0 -0
  287. bl_operators/assets/py.typed +0 -0
  288. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  289. bl_operators/bmesh/py.typed +0 -0
  290. bl_operators/clip/py.typed +0 -0
  291. bl_operators/console/py.typed +0 -0
  292. bl_operators/constraint/py.typed +0 -0
  293. bl_operators/file/py.typed +0 -0
  294. bl_operators/freestyle/py.typed +0 -0
  295. bl_operators/geometry_nodes/py.typed +0 -0
  296. bl_operators/image/py.typed +0 -0
  297. bl_operators/mesh/py.typed +0 -0
  298. bl_operators/node/py.typed +0 -0
  299. bl_operators/object/py.typed +0 -0
  300. bl_operators/object_align/py.typed +0 -0
  301. bl_operators/object_quick_effects/py.typed +0 -0
  302. bl_operators/object_randomize_transform/py.typed +0 -0
  303. bl_operators/presets/py.typed +0 -0
  304. bl_operators/rigidbody/py.typed +0 -0
  305. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  306. bl_operators/sequencer/py.typed +0 -0
  307. bl_operators/spreadsheet/py.typed +0 -0
  308. bl_operators/userpref/py.typed +0 -0
  309. bl_operators/uvcalc_follow_active/py.typed +0 -0
  310. bl_operators/uvcalc_lightmap/py.typed +0 -0
  311. bl_operators/uvcalc_transform/py.typed +0 -0
  312. bl_operators/vertexpaint_dirt/py.typed +0 -0
  313. bl_operators/view3d/py.typed +0 -0
  314. bl_operators/wm/py.typed +0 -0
  315. bl_operators/world/py.typed +0 -0
  316. bl_previews_utils/bl_previews_render/py.typed +0 -0
  317. bl_rna_utils/data_path/py.typed +0 -0
  318. bl_text_utils/external_editor/py.typed +0 -0
  319. bl_ui/anim/py.typed +0 -0
  320. bl_ui/asset_shelf/py.typed +0 -0
  321. bl_ui/generic_ui_list/py.typed +0 -0
  322. bl_ui/node_add_menu/py.typed +0 -0
  323. bl_ui/node_add_menu_compositor/py.typed +0 -0
  324. bl_ui/node_add_menu_geometry/py.typed +0 -0
  325. bl_ui/node_add_menu_shader/py.typed +0 -0
  326. bl_ui/node_add_menu_texture/py.typed +0 -0
  327. bl_ui/properties_animviz/py.typed +0 -0
  328. bl_ui/properties_collection/py.typed +0 -0
  329. bl_ui/properties_constraint/py.typed +0 -0
  330. bl_ui/properties_data_armature/py.typed +0 -0
  331. bl_ui/properties_data_bone/py.typed +0 -0
  332. bl_ui/properties_data_camera/py.typed +0 -0
  333. bl_ui/properties_data_curve/py.typed +0 -0
  334. bl_ui/properties_data_curves/py.typed +0 -0
  335. bl_ui/properties_data_empty/py.typed +0 -0
  336. bl_ui/properties_data_gpencil/py.typed +0 -0
  337. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  338. bl_ui/properties_data_lattice/py.typed +0 -0
  339. bl_ui/properties_data_light/py.typed +0 -0
  340. bl_ui/properties_data_lightprobe/py.typed +0 -0
  341. bl_ui/properties_data_mesh/py.typed +0 -0
  342. bl_ui/properties_data_metaball/py.typed +0 -0
  343. bl_ui/properties_data_modifier/py.typed +0 -0
  344. bl_ui/properties_data_pointcloud/py.typed +0 -0
  345. bl_ui/properties_data_shaderfx/py.typed +0 -0
  346. bl_ui/properties_data_speaker/py.typed +0 -0
  347. bl_ui/properties_data_volume/py.typed +0 -0
  348. bl_ui/properties_freestyle/py.typed +0 -0
  349. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  350. bl_ui/properties_mask_common/py.typed +0 -0
  351. bl_ui/properties_material/py.typed +0 -0
  352. bl_ui/properties_material_gpencil/py.typed +0 -0
  353. bl_ui/properties_object/py.typed +0 -0
  354. bl_ui/properties_output/py.typed +0 -0
  355. bl_ui/properties_paint_common/py.typed +0 -0
  356. bl_ui/properties_particle/py.typed +0 -0
  357. bl_ui/properties_physics_cloth/py.typed +0 -0
  358. bl_ui/properties_physics_common/py.typed +0 -0
  359. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  360. bl_ui/properties_physics_field/py.typed +0 -0
  361. bl_ui/properties_physics_fluid/py.typed +0 -0
  362. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  363. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  364. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  365. bl_ui/properties_physics_softbody/py.typed +0 -0
  366. bl_ui/properties_render/py.typed +0 -0
  367. bl_ui/properties_scene/py.typed +0 -0
  368. bl_ui/properties_texture/py.typed +0 -0
  369. bl_ui/properties_view_layer/py.typed +0 -0
  370. bl_ui/properties_workspace/py.typed +0 -0
  371. bl_ui/properties_world/py.typed +0 -0
  372. bl_ui/space_clip/py.typed +0 -0
  373. bl_ui/space_console/py.typed +0 -0
  374. bl_ui/space_dopesheet/py.typed +0 -0
  375. bl_ui/space_filebrowser/py.typed +0 -0
  376. bl_ui/space_graph/py.typed +0 -0
  377. bl_ui/space_image/py.typed +0 -0
  378. bl_ui/space_info/py.typed +0 -0
  379. bl_ui/space_nla/py.typed +0 -0
  380. bl_ui/space_node/py.typed +0 -0
  381. bl_ui/space_outliner/py.typed +0 -0
  382. bl_ui/space_properties/py.typed +0 -0
  383. bl_ui/space_sequencer/py.typed +0 -0
  384. bl_ui/space_spreadsheet/py.typed +0 -0
  385. bl_ui/space_statusbar/py.typed +0 -0
  386. bl_ui/space_text/py.typed +0 -0
  387. bl_ui/space_time/py.typed +0 -0
  388. bl_ui/space_toolsystem_common/py.typed +0 -0
  389. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  390. bl_ui/space_topbar/py.typed +0 -0
  391. bl_ui/space_userpref/py.typed +0 -0
  392. bl_ui/space_view3d/py.typed +0 -0
  393. bl_ui/space_view3d_toolbar/py.typed +0 -0
  394. bl_ui/temp_anim_layers/py.typed +0 -0
  395. bl_ui/utils/py.typed +0 -0
  396. bl_ui_utils/bug_report_url/py.typed +0 -0
  397. bl_ui_utils/layout/py.typed +0 -0
  398. bmesh/geometry/py.typed +0 -0
  399. bmesh/ops/py.typed +0 -0
  400. bmesh/types/py.typed +0 -0
  401. bmesh/utils/py.typed +0 -0
  402. bpy/app/handlers/py.typed +0 -0
  403. bpy/app/icons/py.typed +0 -0
  404. bpy/app/py.typed +0 -0
  405. bpy/app/timers/py.typed +0 -0
  406. bpy/app/translations/py.typed +0 -0
  407. bpy/msgbus/py.typed +0 -0
  408. bpy/ops/action/py.typed +0 -0
  409. bpy/ops/anim/py.typed +0 -0
  410. bpy/ops/armature/py.typed +0 -0
  411. bpy/ops/asset/py.typed +0 -0
  412. bpy/ops/bl_pkg/py.typed +0 -0
  413. bpy/ops/boid/py.typed +0 -0
  414. bpy/ops/brush/py.typed +0 -0
  415. bpy/ops/buttons/py.typed +0 -0
  416. bpy/ops/cachefile/py.typed +0 -0
  417. bpy/ops/camera/py.typed +0 -0
  418. bpy/ops/clip/py.typed +0 -0
  419. bpy/ops/cloth/py.typed +0 -0
  420. bpy/ops/collection/py.typed +0 -0
  421. bpy/ops/console/py.typed +0 -0
  422. bpy/ops/constraint/py.typed +0 -0
  423. bpy/ops/curve/py.typed +0 -0
  424. bpy/ops/curves/py.typed +0 -0
  425. bpy/ops/cycles/py.typed +0 -0
  426. bpy/ops/dpaint/py.typed +0 -0
  427. bpy/ops/ed/py.typed +0 -0
  428. bpy/ops/export_anim/py.typed +0 -0
  429. bpy/ops/export_scene/py.typed +0 -0
  430. bpy/ops/file/py.typed +0 -0
  431. bpy/ops/fluid/py.typed +0 -0
  432. bpy/ops/font/py.typed +0 -0
  433. bpy/ops/geometry/py.typed +0 -0
  434. bpy/ops/gizmogroup/py.typed +0 -0
  435. bpy/ops/gpencil/py.typed +0 -0
  436. bpy/ops/graph/py.typed +0 -0
  437. bpy/ops/grease_pencil/py.typed +0 -0
  438. bpy/ops/image/py.typed +0 -0
  439. bpy/ops/import_anim/py.typed +0 -0
  440. bpy/ops/import_curve/py.typed +0 -0
  441. bpy/ops/import_scene/py.typed +0 -0
  442. bpy/ops/info/py.typed +0 -0
  443. bpy/ops/lattice/py.typed +0 -0
  444. bpy/ops/marker/py.typed +0 -0
  445. bpy/ops/mask/py.typed +0 -0
  446. bpy/ops/material/py.typed +0 -0
  447. bpy/ops/mball/py.typed +0 -0
  448. bpy/ops/mesh/py.typed +0 -0
  449. bpy/ops/nla/py.typed +0 -0
  450. bpy/ops/node/py.typed +0 -0
  451. bpy/ops/object/py.typed +0 -0
  452. bpy/ops/outliner/py.typed +0 -0
  453. bpy/ops/paint/py.typed +0 -0
  454. bpy/ops/paintcurve/py.typed +0 -0
  455. bpy/ops/palette/py.typed +0 -0
  456. bpy/ops/particle/py.typed +0 -0
  457. bpy/ops/pose/py.typed +0 -0
  458. bpy/ops/poselib/py.typed +0 -0
  459. bpy/ops/preferences/py.typed +0 -0
  460. bpy/ops/ptcache/py.typed +0 -0
  461. bpy/ops/py.typed +0 -0
  462. bpy/ops/render/py.typed +0 -0
  463. bpy/ops/rigidbody/py.typed +0 -0
  464. bpy/ops/scene/py.typed +0 -0
  465. bpy/ops/screen/py.typed +0 -0
  466. bpy/ops/script/py.typed +0 -0
  467. bpy/ops/sculpt/py.typed +0 -0
  468. bpy/ops/sculpt_curves/py.typed +0 -0
  469. bpy/ops/sequencer/py.typed +0 -0
  470. bpy/ops/sound/py.typed +0 -0
  471. bpy/ops/spreadsheet/py.typed +0 -0
  472. bpy/ops/surface/py.typed +0 -0
  473. bpy/ops/text/py.typed +0 -0
  474. bpy/ops/text_editor/py.typed +0 -0
  475. bpy/ops/texture/py.typed +0 -0
  476. bpy/ops/transform/py.typed +0 -0
  477. bpy/ops/ui/py.typed +0 -0
  478. bpy/ops/uilist/py.typed +0 -0
  479. bpy/ops/uv/py.typed +0 -0
  480. bpy/ops/view2d/py.typed +0 -0
  481. bpy/ops/view3d/py.typed +0 -0
  482. bpy/ops/wm/py.typed +0 -0
  483. bpy/ops/workspace/py.typed +0 -0
  484. bpy/ops/world/py.typed +0 -0
  485. bpy/path/py.typed +0 -0
  486. bpy/props/py.typed +0 -0
  487. bpy/types/py.typed +0 -0
  488. bpy/utils/previews/py.typed +0 -0
  489. bpy/utils/py.typed +0 -0
  490. bpy/utils/units/py.typed +0 -0
  491. bpy_extras/anim_utils/py.typed +0 -0
  492. bpy_extras/asset_utils/py.typed +0 -0
  493. bpy_extras/bmesh_utils/py.typed +0 -0
  494. bpy_extras/extensions/junction_module/py.typed +0 -0
  495. bpy_extras/extensions/py.typed +0 -0
  496. bpy_extras/id_map_utils/py.typed +0 -0
  497. bpy_extras/image_utils/py.typed +0 -0
  498. bpy_extras/io_utils/py.typed +0 -0
  499. bpy_extras/keyconfig_utils/py.typed +0 -0
  500. bpy_extras/mesh_utils/py.typed +0 -0
  501. bpy_extras/node_shader_utils/py.typed +0 -0
  502. bpy_extras/node_utils/py.typed +0 -0
  503. bpy_extras/object_utils/py.typed +0 -0
  504. bpy_extras/view3d_utils/py.typed +0 -0
  505. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  506. bpy_extras/wm_utils/py.typed +0 -0
  507. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  508. freestyle/chainingiterators/py.typed +0 -0
  509. freestyle/functions/py.typed +0 -0
  510. freestyle/predicates/py.typed +0 -0
  511. freestyle/shaders/py.typed +0 -0
  512. freestyle/types/py.typed +0 -0
  513. freestyle/utils/ContextFunctions/py.typed +0 -0
  514. freestyle/utils/py.typed +0 -0
  515. gpu/capabilities/py.typed +0 -0
  516. gpu/matrix/py.typed +0 -0
  517. gpu/platform/py.typed +0 -0
  518. gpu/select/py.typed +0 -0
  519. gpu/shader/py.typed +0 -0
  520. gpu/state/py.typed +0 -0
  521. gpu/texture/py.typed +0 -0
  522. gpu/types/py.typed +0 -0
  523. gpu_extras/batch/py.typed +0 -0
  524. gpu_extras/presets/py.typed +0 -0
  525. idprop/types/py.typed +0 -0
  526. imbuf/types/py.typed +0 -0
  527. mathutils/bvhtree/py.typed +0 -0
  528. mathutils/geometry/py.typed +0 -0
  529. mathutils/interpolate/py.typed +0 -0
  530. mathutils/kdtree/py.typed +0 -0
  531. mathutils/noise/py.typed +0 -0
  532. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/WHEEL +0 -0
  533. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
@@ -1,4 +1,5 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
@@ -47,22 +48,35 @@ class PHYSICS_PT_softbody(bpy_types.Panel, PhysicButtonsPanel, bpy_types._Generi
47
48
  """ """
48
49
 
49
50
  def append(self, draw_func):
50
- """
51
+ """Append a draw function to this menu,
52
+ takes the same arguments as the menus draw function
51
53
 
52
- :param draw_func:
54
+ :param draw_func:
53
55
  """
54
56
  ...
55
57
 
56
- def as_pointer(self):
57
- """ """
58
+ def as_pointer(self) -> int:
59
+ """Returns the memory address which holds a pointer to Blender's internal data
60
+
61
+ :return: int (memory address).
62
+ :rtype: int
63
+ """
58
64
  ...
59
65
 
60
- def bl_rna_get_subclass(self):
61
- """ """
66
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
67
+ """
68
+
69
+ :return: The RNA type or default when not found.
70
+ :rtype: bpy.types.Struct
71
+ """
62
72
  ...
63
73
 
64
- def bl_rna_get_subclass_py(self):
65
- """ """
74
+ def bl_rna_get_subclass_py(self) -> typing.Any:
75
+ """
76
+
77
+ :return: The class or default when not found.
78
+ :rtype: typing.Any
79
+ """
66
80
  ...
67
81
 
68
82
  def draw(self, context):
@@ -72,72 +86,129 @@ class PHYSICS_PT_softbody(bpy_types.Panel, PhysicButtonsPanel, bpy_types._Generi
72
86
  """
73
87
  ...
74
88
 
75
- def driver_add(self):
76
- """ """
89
+ def driver_add(self) -> bpy.types.FCurve:
90
+ """Adds driver(s) to the given property
91
+
92
+ :return: The driver(s) added.
93
+ :rtype: bpy.types.FCurve
94
+ """
77
95
  ...
78
96
 
79
- def driver_remove(self):
80
- """ """
97
+ def driver_remove(self) -> bool:
98
+ """Remove driver(s) from the given property
99
+
100
+ :return: Success of driver removal.
101
+ :rtype: bool
102
+ """
81
103
  ...
82
104
 
83
105
  def get(self):
84
- """ """
106
+ """Returns the value of the custom property assigned to key or default
107
+ when not found (matches Python's dictionary function of the same name).
108
+
109
+ """
85
110
  ...
86
111
 
87
112
  def id_properties_clear(self):
88
- """ """
113
+ """
114
+
115
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
116
+ """
89
117
  ...
90
118
 
91
119
  def id_properties_ensure(self):
92
- """ """
120
+ """
121
+
122
+ :return: the parent group for an RNA struct's custom IDProperties.
123
+ """
93
124
  ...
94
125
 
95
126
  def id_properties_ui(self):
96
- """ """
127
+ """
128
+
129
+ :return: Return an object used to manage an IDProperty's UI data.
130
+ """
97
131
  ...
98
132
 
99
133
  def is_extended(self):
100
134
  """ """
101
135
  ...
102
136
 
103
- def is_property_hidden(self):
104
- """ """
137
+ def is_property_hidden(self) -> bool:
138
+ """Check if a property is hidden.
139
+
140
+ :return: True when the property is hidden.
141
+ :rtype: bool
142
+ """
105
143
  ...
106
144
 
107
- def is_property_overridable_library(self):
108
- """ """
145
+ def is_property_overridable_library(self) -> bool:
146
+ """Check if a property is overridable.
147
+
148
+ :return: True when the property is overridable.
149
+ :rtype: bool
150
+ """
109
151
  ...
110
152
 
111
- def is_property_readonly(self):
112
- """ """
153
+ def is_property_readonly(self) -> bool:
154
+ """Check if a property is readonly.
155
+
156
+ :return: True when the property is readonly (not writable).
157
+ :rtype: bool
158
+ """
113
159
  ...
114
160
 
115
- def is_property_set(self):
116
- """ """
161
+ def is_property_set(self) -> bool:
162
+ """Check if a property is set, use for testing operator properties.
163
+
164
+ :return: True when the property has been set.
165
+ :rtype: bool
166
+ """
117
167
  ...
118
168
 
119
169
  def items(self):
120
- """ """
170
+ """Returns the items of this objects custom properties (matches Python's
171
+ dictionary function of the same name).
172
+
173
+ :return: custom property key, value pairs.
174
+ """
121
175
  ...
122
176
 
123
- def keyframe_delete(self):
124
- """ """
177
+ def keyframe_delete(self) -> bool:
178
+ """Remove a keyframe from this properties fcurve.
179
+
180
+ :return: Success of keyframe deletion.
181
+ :rtype: bool
182
+ """
125
183
  ...
126
184
 
127
- def keyframe_insert(self):
128
- """ """
185
+ def keyframe_insert(self) -> bool:
186
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
187
+
188
+ :return: Success of keyframe insertion.
189
+ :rtype: bool
190
+ """
129
191
  ...
130
192
 
131
193
  def keys(self):
132
- """ """
194
+ """Returns the keys of this objects custom properties (matches Python's
195
+ dictionary function of the same name).
196
+
197
+ :return: custom property keys.
198
+ """
133
199
  ...
134
200
 
135
- def path_from_id(self):
136
- """ """
201
+ def path_from_id(self) -> str:
202
+ """Returns the data path from the ID to this object (string).
203
+
204
+ :return: The path from `bpy.types.bpy_struct.id_data`
205
+ to this struct and property (when given).
206
+ :rtype: str
207
+ """
137
208
  ...
138
209
 
139
210
  def path_resolve(self):
140
- """ """
211
+ """Returns the property from the path, raise an exception when not found."""
141
212
  ...
142
213
 
143
214
  def poll(self, context):
@@ -148,37 +219,53 @@ class PHYSICS_PT_softbody(bpy_types.Panel, PhysicButtonsPanel, bpy_types._Generi
148
219
  ...
149
220
 
150
221
  def pop(self):
151
- """ """
222
+ """Remove and return the value of the custom property assigned to key or default
223
+ when not found (matches Python's dictionary function of the same name).
224
+
225
+ """
152
226
  ...
153
227
 
154
228
  def prepend(self, draw_func):
155
- """
229
+ """Prepend a draw function to this menu, takes the same arguments as
230
+ the menus draw function
156
231
 
157
- :param draw_func:
232
+ :param draw_func:
158
233
  """
159
234
  ...
160
235
 
161
- def property_overridable_library_set(self):
162
- """ """
236
+ def property_overridable_library_set(self) -> bool:
237
+ """Define a property as overridable or not (only for custom properties!).
238
+
239
+ :return: True when the overridable status of the property was successfully set.
240
+ :rtype: bool
241
+ """
163
242
  ...
164
243
 
165
244
  def property_unset(self):
166
- """ """
245
+ """Unset a property, will use default value afterward."""
167
246
  ...
168
247
 
169
248
  def remove(self, draw_func):
170
- """
249
+ """Remove a draw function that has been added to this menu
171
250
 
172
251
  :param draw_func:
173
252
  """
174
253
  ...
175
254
 
176
255
  def type_recast(self):
177
- """ """
256
+ """Return a new instance, this is needed because types
257
+ such as textures can be changed at runtime.
258
+
259
+ :return: a new instance of this object with the type initialized again.
260
+ """
178
261
  ...
179
262
 
180
263
  def values(self):
181
- """ """
264
+ """Returns the values of this objects custom properties (matches Python's
265
+ dictionary function of the same name).
266
+
267
+ :return: custom property values.
268
+ """
182
269
  ...
183
270
 
184
271
  class PHYSICS_PT_softbody_cache(
@@ -214,22 +301,35 @@ class PHYSICS_PT_softbody_cache(
214
301
  """ """
215
302
 
216
303
  def append(self, draw_func):
217
- """
304
+ """Append a draw function to this menu,
305
+ takes the same arguments as the menus draw function
218
306
 
219
- :param draw_func:
307
+ :param draw_func:
220
308
  """
221
309
  ...
222
310
 
223
- def as_pointer(self):
224
- """ """
311
+ def as_pointer(self) -> int:
312
+ """Returns the memory address which holds a pointer to Blender's internal data
313
+
314
+ :return: int (memory address).
315
+ :rtype: int
316
+ """
225
317
  ...
226
318
 
227
- def bl_rna_get_subclass(self):
228
- """ """
319
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
320
+ """
321
+
322
+ :return: The RNA type or default when not found.
323
+ :rtype: bpy.types.Struct
324
+ """
229
325
  ...
230
326
 
231
- def bl_rna_get_subclass_py(self):
232
- """ """
327
+ def bl_rna_get_subclass_py(self) -> typing.Any:
328
+ """
329
+
330
+ :return: The class or default when not found.
331
+ :rtype: typing.Any
332
+ """
233
333
  ...
234
334
 
235
335
  def draw(self, context):
@@ -239,72 +339,129 @@ class PHYSICS_PT_softbody_cache(
239
339
  """
240
340
  ...
241
341
 
242
- def driver_add(self):
243
- """ """
342
+ def driver_add(self) -> bpy.types.FCurve:
343
+ """Adds driver(s) to the given property
344
+
345
+ :return: The driver(s) added.
346
+ :rtype: bpy.types.FCurve
347
+ """
244
348
  ...
245
349
 
246
- def driver_remove(self):
247
- """ """
350
+ def driver_remove(self) -> bool:
351
+ """Remove driver(s) from the given property
352
+
353
+ :return: Success of driver removal.
354
+ :rtype: bool
355
+ """
248
356
  ...
249
357
 
250
358
  def get(self):
251
- """ """
359
+ """Returns the value of the custom property assigned to key or default
360
+ when not found (matches Python's dictionary function of the same name).
361
+
362
+ """
252
363
  ...
253
364
 
254
365
  def id_properties_clear(self):
255
- """ """
366
+ """
367
+
368
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
369
+ """
256
370
  ...
257
371
 
258
372
  def id_properties_ensure(self):
259
- """ """
373
+ """
374
+
375
+ :return: the parent group for an RNA struct's custom IDProperties.
376
+ """
260
377
  ...
261
378
 
262
379
  def id_properties_ui(self):
263
- """ """
380
+ """
381
+
382
+ :return: Return an object used to manage an IDProperty's UI data.
383
+ """
264
384
  ...
265
385
 
266
386
  def is_extended(self):
267
387
  """ """
268
388
  ...
269
389
 
270
- def is_property_hidden(self):
271
- """ """
390
+ def is_property_hidden(self) -> bool:
391
+ """Check if a property is hidden.
392
+
393
+ :return: True when the property is hidden.
394
+ :rtype: bool
395
+ """
272
396
  ...
273
397
 
274
- def is_property_overridable_library(self):
275
- """ """
398
+ def is_property_overridable_library(self) -> bool:
399
+ """Check if a property is overridable.
400
+
401
+ :return: True when the property is overridable.
402
+ :rtype: bool
403
+ """
276
404
  ...
277
405
 
278
- def is_property_readonly(self):
279
- """ """
406
+ def is_property_readonly(self) -> bool:
407
+ """Check if a property is readonly.
408
+
409
+ :return: True when the property is readonly (not writable).
410
+ :rtype: bool
411
+ """
280
412
  ...
281
413
 
282
- def is_property_set(self):
283
- """ """
414
+ def is_property_set(self) -> bool:
415
+ """Check if a property is set, use for testing operator properties.
416
+
417
+ :return: True when the property has been set.
418
+ :rtype: bool
419
+ """
284
420
  ...
285
421
 
286
422
  def items(self):
287
- """ """
423
+ """Returns the items of this objects custom properties (matches Python's
424
+ dictionary function of the same name).
425
+
426
+ :return: custom property key, value pairs.
427
+ """
288
428
  ...
289
429
 
290
- def keyframe_delete(self):
291
- """ """
430
+ def keyframe_delete(self) -> bool:
431
+ """Remove a keyframe from this properties fcurve.
432
+
433
+ :return: Success of keyframe deletion.
434
+ :rtype: bool
435
+ """
292
436
  ...
293
437
 
294
- def keyframe_insert(self):
295
- """ """
438
+ def keyframe_insert(self) -> bool:
439
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
440
+
441
+ :return: Success of keyframe insertion.
442
+ :rtype: bool
443
+ """
296
444
  ...
297
445
 
298
446
  def keys(self):
299
- """ """
447
+ """Returns the keys of this objects custom properties (matches Python's
448
+ dictionary function of the same name).
449
+
450
+ :return: custom property keys.
451
+ """
300
452
  ...
301
453
 
302
- def path_from_id(self):
303
- """ """
454
+ def path_from_id(self) -> str:
455
+ """Returns the data path from the ID to this object (string).
456
+
457
+ :return: The path from `bpy.types.bpy_struct.id_data`
458
+ to this struct and property (when given).
459
+ :rtype: str
460
+ """
304
461
  ...
305
462
 
306
463
  def path_resolve(self):
307
- """ """
464
+ """Returns the property from the path, raise an exception when not found."""
308
465
  ...
309
466
 
310
467
  def poll(self, context):
@@ -315,37 +472,53 @@ class PHYSICS_PT_softbody_cache(
315
472
  ...
316
473
 
317
474
  def pop(self):
318
- """ """
475
+ """Remove and return the value of the custom property assigned to key or default
476
+ when not found (matches Python's dictionary function of the same name).
477
+
478
+ """
319
479
  ...
320
480
 
321
481
  def prepend(self, draw_func):
322
- """
482
+ """Prepend a draw function to this menu, takes the same arguments as
483
+ the menus draw function
323
484
 
324
- :param draw_func:
485
+ :param draw_func:
325
486
  """
326
487
  ...
327
488
 
328
- def property_overridable_library_set(self):
329
- """ """
489
+ def property_overridable_library_set(self) -> bool:
490
+ """Define a property as overridable or not (only for custom properties!).
491
+
492
+ :return: True when the overridable status of the property was successfully set.
493
+ :rtype: bool
494
+ """
330
495
  ...
331
496
 
332
497
  def property_unset(self):
333
- """ """
498
+ """Unset a property, will use default value afterward."""
334
499
  ...
335
500
 
336
501
  def remove(self, draw_func):
337
- """
502
+ """Remove a draw function that has been added to this menu
338
503
 
339
504
  :param draw_func:
340
505
  """
341
506
  ...
342
507
 
343
508
  def type_recast(self):
344
- """ """
509
+ """Return a new instance, this is needed because types
510
+ such as textures can be changed at runtime.
511
+
512
+ :return: a new instance of this object with the type initialized again.
513
+ """
345
514
  ...
346
515
 
347
516
  def values(self):
348
- """ """
517
+ """Returns the values of this objects custom properties (matches Python's
518
+ dictionary function of the same name).
519
+
520
+ :return: custom property values.
521
+ """
349
522
  ...
350
523
 
351
524
  class PHYSICS_PT_softbody_collision(
@@ -381,22 +554,35 @@ class PHYSICS_PT_softbody_collision(
381
554
  """ """
382
555
 
383
556
  def append(self, draw_func):
384
- """
557
+ """Append a draw function to this menu,
558
+ takes the same arguments as the menus draw function
385
559
 
386
- :param draw_func:
560
+ :param draw_func:
387
561
  """
388
562
  ...
389
563
 
390
- def as_pointer(self):
391
- """ """
564
+ def as_pointer(self) -> int:
565
+ """Returns the memory address which holds a pointer to Blender's internal data
566
+
567
+ :return: int (memory address).
568
+ :rtype: int
569
+ """
392
570
  ...
393
571
 
394
- def bl_rna_get_subclass(self):
395
- """ """
572
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
573
+ """
574
+
575
+ :return: The RNA type or default when not found.
576
+ :rtype: bpy.types.Struct
577
+ """
396
578
  ...
397
579
 
398
- def bl_rna_get_subclass_py(self):
399
- """ """
580
+ def bl_rna_get_subclass_py(self) -> typing.Any:
581
+ """
582
+
583
+ :return: The class or default when not found.
584
+ :rtype: typing.Any
585
+ """
400
586
  ...
401
587
 
402
588
  def draw(self, context):
@@ -413,72 +599,129 @@ class PHYSICS_PT_softbody_collision(
413
599
  """
414
600
  ...
415
601
 
416
- def driver_add(self):
417
- """ """
602
+ def driver_add(self) -> bpy.types.FCurve:
603
+ """Adds driver(s) to the given property
604
+
605
+ :return: The driver(s) added.
606
+ :rtype: bpy.types.FCurve
607
+ """
418
608
  ...
419
609
 
420
- def driver_remove(self):
421
- """ """
610
+ def driver_remove(self) -> bool:
611
+ """Remove driver(s) from the given property
612
+
613
+ :return: Success of driver removal.
614
+ :rtype: bool
615
+ """
422
616
  ...
423
617
 
424
618
  def get(self):
425
- """ """
619
+ """Returns the value of the custom property assigned to key or default
620
+ when not found (matches Python's dictionary function of the same name).
621
+
622
+ """
426
623
  ...
427
624
 
428
625
  def id_properties_clear(self):
429
- """ """
626
+ """
627
+
628
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
629
+ """
430
630
  ...
431
631
 
432
632
  def id_properties_ensure(self):
433
- """ """
633
+ """
634
+
635
+ :return: the parent group for an RNA struct's custom IDProperties.
636
+ """
434
637
  ...
435
638
 
436
639
  def id_properties_ui(self):
437
- """ """
640
+ """
641
+
642
+ :return: Return an object used to manage an IDProperty's UI data.
643
+ """
438
644
  ...
439
645
 
440
646
  def is_extended(self):
441
647
  """ """
442
648
  ...
443
649
 
444
- def is_property_hidden(self):
445
- """ """
650
+ def is_property_hidden(self) -> bool:
651
+ """Check if a property is hidden.
652
+
653
+ :return: True when the property is hidden.
654
+ :rtype: bool
655
+ """
446
656
  ...
447
657
 
448
- def is_property_overridable_library(self):
449
- """ """
658
+ def is_property_overridable_library(self) -> bool:
659
+ """Check if a property is overridable.
660
+
661
+ :return: True when the property is overridable.
662
+ :rtype: bool
663
+ """
450
664
  ...
451
665
 
452
- def is_property_readonly(self):
453
- """ """
666
+ def is_property_readonly(self) -> bool:
667
+ """Check if a property is readonly.
668
+
669
+ :return: True when the property is readonly (not writable).
670
+ :rtype: bool
671
+ """
454
672
  ...
455
673
 
456
- def is_property_set(self):
457
- """ """
674
+ def is_property_set(self) -> bool:
675
+ """Check if a property is set, use for testing operator properties.
676
+
677
+ :return: True when the property has been set.
678
+ :rtype: bool
679
+ """
458
680
  ...
459
681
 
460
682
  def items(self):
461
- """ """
683
+ """Returns the items of this objects custom properties (matches Python's
684
+ dictionary function of the same name).
685
+
686
+ :return: custom property key, value pairs.
687
+ """
462
688
  ...
463
689
 
464
- def keyframe_delete(self):
465
- """ """
690
+ def keyframe_delete(self) -> bool:
691
+ """Remove a keyframe from this properties fcurve.
692
+
693
+ :return: Success of keyframe deletion.
694
+ :rtype: bool
695
+ """
466
696
  ...
467
697
 
468
- def keyframe_insert(self):
469
- """ """
698
+ def keyframe_insert(self) -> bool:
699
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
700
+
701
+ :return: Success of keyframe insertion.
702
+ :rtype: bool
703
+ """
470
704
  ...
471
705
 
472
706
  def keys(self):
473
- """ """
707
+ """Returns the keys of this objects custom properties (matches Python's
708
+ dictionary function of the same name).
709
+
710
+ :return: custom property keys.
711
+ """
474
712
  ...
475
713
 
476
- def path_from_id(self):
477
- """ """
714
+ def path_from_id(self) -> str:
715
+ """Returns the data path from the ID to this object (string).
716
+
717
+ :return: The path from `bpy.types.bpy_struct.id_data`
718
+ to this struct and property (when given).
719
+ :rtype: str
720
+ """
478
721
  ...
479
722
 
480
723
  def path_resolve(self):
481
- """ """
724
+ """Returns the property from the path, raise an exception when not found."""
482
725
  ...
483
726
 
484
727
  def poll(self, context):
@@ -489,37 +732,53 @@ class PHYSICS_PT_softbody_collision(
489
732
  ...
490
733
 
491
734
  def pop(self):
492
- """ """
735
+ """Remove and return the value of the custom property assigned to key or default
736
+ when not found (matches Python's dictionary function of the same name).
737
+
738
+ """
493
739
  ...
494
740
 
495
741
  def prepend(self, draw_func):
496
- """
742
+ """Prepend a draw function to this menu, takes the same arguments as
743
+ the menus draw function
497
744
 
498
- :param draw_func:
745
+ :param draw_func:
499
746
  """
500
747
  ...
501
748
 
502
- def property_overridable_library_set(self):
503
- """ """
749
+ def property_overridable_library_set(self) -> bool:
750
+ """Define a property as overridable or not (only for custom properties!).
751
+
752
+ :return: True when the overridable status of the property was successfully set.
753
+ :rtype: bool
754
+ """
504
755
  ...
505
756
 
506
757
  def property_unset(self):
507
- """ """
758
+ """Unset a property, will use default value afterward."""
508
759
  ...
509
760
 
510
761
  def remove(self, draw_func):
511
- """
762
+ """Remove a draw function that has been added to this menu
512
763
 
513
764
  :param draw_func:
514
765
  """
515
766
  ...
516
767
 
517
768
  def type_recast(self):
518
- """ """
769
+ """Return a new instance, this is needed because types
770
+ such as textures can be changed at runtime.
771
+
772
+ :return: a new instance of this object with the type initialized again.
773
+ """
519
774
  ...
520
775
 
521
776
  def values(self):
522
- """ """
777
+ """Returns the values of this objects custom properties (matches Python's
778
+ dictionary function of the same name).
779
+
780
+ :return: custom property values.
781
+ """
523
782
  ...
524
783
 
525
784
  class PHYSICS_PT_softbody_edge(
@@ -555,22 +814,35 @@ class PHYSICS_PT_softbody_edge(
555
814
  """ """
556
815
 
557
816
  def append(self, draw_func):
558
- """
817
+ """Append a draw function to this menu,
818
+ takes the same arguments as the menus draw function
559
819
 
560
- :param draw_func:
820
+ :param draw_func:
561
821
  """
562
822
  ...
563
823
 
564
- def as_pointer(self):
565
- """ """
824
+ def as_pointer(self) -> int:
825
+ """Returns the memory address which holds a pointer to Blender's internal data
826
+
827
+ :return: int (memory address).
828
+ :rtype: int
829
+ """
566
830
  ...
567
831
 
568
- def bl_rna_get_subclass(self):
569
- """ """
832
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
833
+ """
834
+
835
+ :return: The RNA type or default when not found.
836
+ :rtype: bpy.types.Struct
837
+ """
570
838
  ...
571
839
 
572
- def bl_rna_get_subclass_py(self):
573
- """ """
840
+ def bl_rna_get_subclass_py(self) -> typing.Any:
841
+ """
842
+
843
+ :return: The class or default when not found.
844
+ :rtype: typing.Any
845
+ """
574
846
  ...
575
847
 
576
848
  def draw(self, context):
@@ -587,72 +859,129 @@ class PHYSICS_PT_softbody_edge(
587
859
  """
588
860
  ...
589
861
 
590
- def driver_add(self):
591
- """ """
862
+ def driver_add(self) -> bpy.types.FCurve:
863
+ """Adds driver(s) to the given property
864
+
865
+ :return: The driver(s) added.
866
+ :rtype: bpy.types.FCurve
867
+ """
592
868
  ...
593
869
 
594
- def driver_remove(self):
595
- """ """
870
+ def driver_remove(self) -> bool:
871
+ """Remove driver(s) from the given property
872
+
873
+ :return: Success of driver removal.
874
+ :rtype: bool
875
+ """
596
876
  ...
597
877
 
598
878
  def get(self):
599
- """ """
879
+ """Returns the value of the custom property assigned to key or default
880
+ when not found (matches Python's dictionary function of the same name).
881
+
882
+ """
600
883
  ...
601
884
 
602
885
  def id_properties_clear(self):
603
- """ """
886
+ """
887
+
888
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
889
+ """
604
890
  ...
605
891
 
606
892
  def id_properties_ensure(self):
607
- """ """
893
+ """
894
+
895
+ :return: the parent group for an RNA struct's custom IDProperties.
896
+ """
608
897
  ...
609
898
 
610
899
  def id_properties_ui(self):
611
- """ """
900
+ """
901
+
902
+ :return: Return an object used to manage an IDProperty's UI data.
903
+ """
612
904
  ...
613
905
 
614
906
  def is_extended(self):
615
907
  """ """
616
908
  ...
617
909
 
618
- def is_property_hidden(self):
619
- """ """
910
+ def is_property_hidden(self) -> bool:
911
+ """Check if a property is hidden.
912
+
913
+ :return: True when the property is hidden.
914
+ :rtype: bool
915
+ """
620
916
  ...
621
917
 
622
- def is_property_overridable_library(self):
623
- """ """
918
+ def is_property_overridable_library(self) -> bool:
919
+ """Check if a property is overridable.
920
+
921
+ :return: True when the property is overridable.
922
+ :rtype: bool
923
+ """
624
924
  ...
625
925
 
626
- def is_property_readonly(self):
627
- """ """
926
+ def is_property_readonly(self) -> bool:
927
+ """Check if a property is readonly.
928
+
929
+ :return: True when the property is readonly (not writable).
930
+ :rtype: bool
931
+ """
628
932
  ...
629
933
 
630
- def is_property_set(self):
631
- """ """
934
+ def is_property_set(self) -> bool:
935
+ """Check if a property is set, use for testing operator properties.
936
+
937
+ :return: True when the property has been set.
938
+ :rtype: bool
939
+ """
632
940
  ...
633
941
 
634
942
  def items(self):
635
- """ """
943
+ """Returns the items of this objects custom properties (matches Python's
944
+ dictionary function of the same name).
945
+
946
+ :return: custom property key, value pairs.
947
+ """
636
948
  ...
637
949
 
638
- def keyframe_delete(self):
639
- """ """
950
+ def keyframe_delete(self) -> bool:
951
+ """Remove a keyframe from this properties fcurve.
952
+
953
+ :return: Success of keyframe deletion.
954
+ :rtype: bool
955
+ """
640
956
  ...
641
957
 
642
- def keyframe_insert(self):
643
- """ """
958
+ def keyframe_insert(self) -> bool:
959
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
960
+
961
+ :return: Success of keyframe insertion.
962
+ :rtype: bool
963
+ """
644
964
  ...
645
965
 
646
966
  def keys(self):
647
- """ """
967
+ """Returns the keys of this objects custom properties (matches Python's
968
+ dictionary function of the same name).
969
+
970
+ :return: custom property keys.
971
+ """
648
972
  ...
649
973
 
650
- def path_from_id(self):
651
- """ """
974
+ def path_from_id(self) -> str:
975
+ """Returns the data path from the ID to this object (string).
976
+
977
+ :return: The path from `bpy.types.bpy_struct.id_data`
978
+ to this struct and property (when given).
979
+ :rtype: str
980
+ """
652
981
  ...
653
982
 
654
983
  def path_resolve(self):
655
- """ """
984
+ """Returns the property from the path, raise an exception when not found."""
656
985
  ...
657
986
 
658
987
  def poll(self, context):
@@ -663,37 +992,53 @@ class PHYSICS_PT_softbody_edge(
663
992
  ...
664
993
 
665
994
  def pop(self):
666
- """ """
995
+ """Remove and return the value of the custom property assigned to key or default
996
+ when not found (matches Python's dictionary function of the same name).
997
+
998
+ """
667
999
  ...
668
1000
 
669
1001
  def prepend(self, draw_func):
670
- """
1002
+ """Prepend a draw function to this menu, takes the same arguments as
1003
+ the menus draw function
671
1004
 
672
- :param draw_func:
1005
+ :param draw_func:
673
1006
  """
674
1007
  ...
675
1008
 
676
- def property_overridable_library_set(self):
677
- """ """
1009
+ def property_overridable_library_set(self) -> bool:
1010
+ """Define a property as overridable or not (only for custom properties!).
1011
+
1012
+ :return: True when the overridable status of the property was successfully set.
1013
+ :rtype: bool
1014
+ """
678
1015
  ...
679
1016
 
680
1017
  def property_unset(self):
681
- """ """
1018
+ """Unset a property, will use default value afterward."""
682
1019
  ...
683
1020
 
684
1021
  def remove(self, draw_func):
685
- """
1022
+ """Remove a draw function that has been added to this menu
686
1023
 
687
1024
  :param draw_func:
688
1025
  """
689
1026
  ...
690
1027
 
691
1028
  def type_recast(self):
692
- """ """
1029
+ """Return a new instance, this is needed because types
1030
+ such as textures can be changed at runtime.
1031
+
1032
+ :return: a new instance of this object with the type initialized again.
1033
+ """
693
1034
  ...
694
1035
 
695
1036
  def values(self):
696
- """ """
1037
+ """Returns the values of this objects custom properties (matches Python's
1038
+ dictionary function of the same name).
1039
+
1040
+ :return: custom property values.
1041
+ """
697
1042
  ...
698
1043
 
699
1044
  class PHYSICS_PT_softbody_edge_aerodynamics(
@@ -729,22 +1074,35 @@ class PHYSICS_PT_softbody_edge_aerodynamics(
729
1074
  """ """
730
1075
 
731
1076
  def append(self, draw_func):
732
- """
1077
+ """Append a draw function to this menu,
1078
+ takes the same arguments as the menus draw function
733
1079
 
734
- :param draw_func:
1080
+ :param draw_func:
735
1081
  """
736
1082
  ...
737
1083
 
738
- def as_pointer(self):
739
- """ """
1084
+ def as_pointer(self) -> int:
1085
+ """Returns the memory address which holds a pointer to Blender's internal data
1086
+
1087
+ :return: int (memory address).
1088
+ :rtype: int
1089
+ """
740
1090
  ...
741
1091
 
742
- def bl_rna_get_subclass(self):
743
- """ """
1092
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1093
+ """
1094
+
1095
+ :return: The RNA type or default when not found.
1096
+ :rtype: bpy.types.Struct
1097
+ """
744
1098
  ...
745
1099
 
746
- def bl_rna_get_subclass_py(self):
747
- """ """
1100
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1101
+ """
1102
+
1103
+ :return: The class or default when not found.
1104
+ :rtype: typing.Any
1105
+ """
748
1106
  ...
749
1107
 
750
1108
  def draw(self, context):
@@ -754,72 +1112,129 @@ class PHYSICS_PT_softbody_edge_aerodynamics(
754
1112
  """
755
1113
  ...
756
1114
 
757
- def driver_add(self):
758
- """ """
1115
+ def driver_add(self) -> bpy.types.FCurve:
1116
+ """Adds driver(s) to the given property
1117
+
1118
+ :return: The driver(s) added.
1119
+ :rtype: bpy.types.FCurve
1120
+ """
759
1121
  ...
760
1122
 
761
- def driver_remove(self):
762
- """ """
1123
+ def driver_remove(self) -> bool:
1124
+ """Remove driver(s) from the given property
1125
+
1126
+ :return: Success of driver removal.
1127
+ :rtype: bool
1128
+ """
763
1129
  ...
764
1130
 
765
1131
  def get(self):
766
- """ """
1132
+ """Returns the value of the custom property assigned to key or default
1133
+ when not found (matches Python's dictionary function of the same name).
1134
+
1135
+ """
767
1136
  ...
768
1137
 
769
1138
  def id_properties_clear(self):
770
- """ """
1139
+ """
1140
+
1141
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1142
+ """
771
1143
  ...
772
1144
 
773
1145
  def id_properties_ensure(self):
774
- """ """
1146
+ """
1147
+
1148
+ :return: the parent group for an RNA struct's custom IDProperties.
1149
+ """
775
1150
  ...
776
1151
 
777
1152
  def id_properties_ui(self):
778
- """ """
1153
+ """
1154
+
1155
+ :return: Return an object used to manage an IDProperty's UI data.
1156
+ """
779
1157
  ...
780
1158
 
781
1159
  def is_extended(self):
782
1160
  """ """
783
1161
  ...
784
1162
 
785
- def is_property_hidden(self):
786
- """ """
1163
+ def is_property_hidden(self) -> bool:
1164
+ """Check if a property is hidden.
1165
+
1166
+ :return: True when the property is hidden.
1167
+ :rtype: bool
1168
+ """
787
1169
  ...
788
1170
 
789
- def is_property_overridable_library(self):
790
- """ """
1171
+ def is_property_overridable_library(self) -> bool:
1172
+ """Check if a property is overridable.
1173
+
1174
+ :return: True when the property is overridable.
1175
+ :rtype: bool
1176
+ """
791
1177
  ...
792
1178
 
793
- def is_property_readonly(self):
794
- """ """
1179
+ def is_property_readonly(self) -> bool:
1180
+ """Check if a property is readonly.
1181
+
1182
+ :return: True when the property is readonly (not writable).
1183
+ :rtype: bool
1184
+ """
795
1185
  ...
796
1186
 
797
- def is_property_set(self):
798
- """ """
1187
+ def is_property_set(self) -> bool:
1188
+ """Check if a property is set, use for testing operator properties.
1189
+
1190
+ :return: True when the property has been set.
1191
+ :rtype: bool
1192
+ """
799
1193
  ...
800
1194
 
801
1195
  def items(self):
802
- """ """
1196
+ """Returns the items of this objects custom properties (matches Python's
1197
+ dictionary function of the same name).
1198
+
1199
+ :return: custom property key, value pairs.
1200
+ """
803
1201
  ...
804
1202
 
805
- def keyframe_delete(self):
806
- """ """
1203
+ def keyframe_delete(self) -> bool:
1204
+ """Remove a keyframe from this properties fcurve.
1205
+
1206
+ :return: Success of keyframe deletion.
1207
+ :rtype: bool
1208
+ """
807
1209
  ...
808
1210
 
809
- def keyframe_insert(self):
810
- """ """
1211
+ def keyframe_insert(self) -> bool:
1212
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1213
+
1214
+ :return: Success of keyframe insertion.
1215
+ :rtype: bool
1216
+ """
811
1217
  ...
812
1218
 
813
1219
  def keys(self):
814
- """ """
1220
+ """Returns the keys of this objects custom properties (matches Python's
1221
+ dictionary function of the same name).
1222
+
1223
+ :return: custom property keys.
1224
+ """
815
1225
  ...
816
1226
 
817
- def path_from_id(self):
818
- """ """
1227
+ def path_from_id(self) -> str:
1228
+ """Returns the data path from the ID to this object (string).
1229
+
1230
+ :return: The path from `bpy.types.bpy_struct.id_data`
1231
+ to this struct and property (when given).
1232
+ :rtype: str
1233
+ """
819
1234
  ...
820
1235
 
821
1236
  def path_resolve(self):
822
- """ """
1237
+ """Returns the property from the path, raise an exception when not found."""
823
1238
  ...
824
1239
 
825
1240
  def poll(self, context):
@@ -830,37 +1245,53 @@ class PHYSICS_PT_softbody_edge_aerodynamics(
830
1245
  ...
831
1246
 
832
1247
  def pop(self):
833
- """ """
1248
+ """Remove and return the value of the custom property assigned to key or default
1249
+ when not found (matches Python's dictionary function of the same name).
1250
+
1251
+ """
834
1252
  ...
835
1253
 
836
1254
  def prepend(self, draw_func):
837
- """
1255
+ """Prepend a draw function to this menu, takes the same arguments as
1256
+ the menus draw function
838
1257
 
839
- :param draw_func:
1258
+ :param draw_func:
840
1259
  """
841
1260
  ...
842
1261
 
843
- def property_overridable_library_set(self):
844
- """ """
1262
+ def property_overridable_library_set(self) -> bool:
1263
+ """Define a property as overridable or not (only for custom properties!).
1264
+
1265
+ :return: True when the overridable status of the property was successfully set.
1266
+ :rtype: bool
1267
+ """
845
1268
  ...
846
1269
 
847
1270
  def property_unset(self):
848
- """ """
1271
+ """Unset a property, will use default value afterward."""
849
1272
  ...
850
1273
 
851
1274
  def remove(self, draw_func):
852
- """
1275
+ """Remove a draw function that has been added to this menu
853
1276
 
854
1277
  :param draw_func:
855
1278
  """
856
1279
  ...
857
1280
 
858
1281
  def type_recast(self):
859
- """ """
1282
+ """Return a new instance, this is needed because types
1283
+ such as textures can be changed at runtime.
1284
+
1285
+ :return: a new instance of this object with the type initialized again.
1286
+ """
860
1287
  ...
861
1288
 
862
1289
  def values(self):
863
- """ """
1290
+ """Returns the values of this objects custom properties (matches Python's
1291
+ dictionary function of the same name).
1292
+
1293
+ :return: custom property values.
1294
+ """
864
1295
  ...
865
1296
 
866
1297
  class PHYSICS_PT_softbody_edge_stiffness(
@@ -896,22 +1327,35 @@ class PHYSICS_PT_softbody_edge_stiffness(
896
1327
  """ """
897
1328
 
898
1329
  def append(self, draw_func):
899
- """
1330
+ """Append a draw function to this menu,
1331
+ takes the same arguments as the menus draw function
900
1332
 
901
- :param draw_func:
1333
+ :param draw_func:
902
1334
  """
903
1335
  ...
904
1336
 
905
- def as_pointer(self):
906
- """ """
1337
+ def as_pointer(self) -> int:
1338
+ """Returns the memory address which holds a pointer to Blender's internal data
1339
+
1340
+ :return: int (memory address).
1341
+ :rtype: int
1342
+ """
907
1343
  ...
908
1344
 
909
- def bl_rna_get_subclass(self):
910
- """ """
1345
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1346
+ """
1347
+
1348
+ :return: The RNA type or default when not found.
1349
+ :rtype: bpy.types.Struct
1350
+ """
911
1351
  ...
912
1352
 
913
- def bl_rna_get_subclass_py(self):
914
- """ """
1353
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1354
+ """
1355
+
1356
+ :return: The class or default when not found.
1357
+ :rtype: typing.Any
1358
+ """
915
1359
  ...
916
1360
 
917
1361
  def draw(self, context):
@@ -928,72 +1372,129 @@ class PHYSICS_PT_softbody_edge_stiffness(
928
1372
  """
929
1373
  ...
930
1374
 
931
- def driver_add(self):
932
- """ """
1375
+ def driver_add(self) -> bpy.types.FCurve:
1376
+ """Adds driver(s) to the given property
1377
+
1378
+ :return: The driver(s) added.
1379
+ :rtype: bpy.types.FCurve
1380
+ """
933
1381
  ...
934
1382
 
935
- def driver_remove(self):
936
- """ """
1383
+ def driver_remove(self) -> bool:
1384
+ """Remove driver(s) from the given property
1385
+
1386
+ :return: Success of driver removal.
1387
+ :rtype: bool
1388
+ """
937
1389
  ...
938
1390
 
939
1391
  def get(self):
940
- """ """
1392
+ """Returns the value of the custom property assigned to key or default
1393
+ when not found (matches Python's dictionary function of the same name).
1394
+
1395
+ """
941
1396
  ...
942
1397
 
943
1398
  def id_properties_clear(self):
944
- """ """
1399
+ """
1400
+
1401
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1402
+ """
945
1403
  ...
946
1404
 
947
1405
  def id_properties_ensure(self):
948
- """ """
1406
+ """
1407
+
1408
+ :return: the parent group for an RNA struct's custom IDProperties.
1409
+ """
949
1410
  ...
950
1411
 
951
1412
  def id_properties_ui(self):
952
- """ """
1413
+ """
1414
+
1415
+ :return: Return an object used to manage an IDProperty's UI data.
1416
+ """
953
1417
  ...
954
1418
 
955
1419
  def is_extended(self):
956
1420
  """ """
957
1421
  ...
958
1422
 
959
- def is_property_hidden(self):
960
- """ """
1423
+ def is_property_hidden(self) -> bool:
1424
+ """Check if a property is hidden.
1425
+
1426
+ :return: True when the property is hidden.
1427
+ :rtype: bool
1428
+ """
961
1429
  ...
962
1430
 
963
- def is_property_overridable_library(self):
964
- """ """
1431
+ def is_property_overridable_library(self) -> bool:
1432
+ """Check if a property is overridable.
1433
+
1434
+ :return: True when the property is overridable.
1435
+ :rtype: bool
1436
+ """
965
1437
  ...
966
1438
 
967
- def is_property_readonly(self):
968
- """ """
1439
+ def is_property_readonly(self) -> bool:
1440
+ """Check if a property is readonly.
1441
+
1442
+ :return: True when the property is readonly (not writable).
1443
+ :rtype: bool
1444
+ """
969
1445
  ...
970
1446
 
971
- def is_property_set(self):
972
- """ """
1447
+ def is_property_set(self) -> bool:
1448
+ """Check if a property is set, use for testing operator properties.
1449
+
1450
+ :return: True when the property has been set.
1451
+ :rtype: bool
1452
+ """
973
1453
  ...
974
1454
 
975
1455
  def items(self):
976
- """ """
1456
+ """Returns the items of this objects custom properties (matches Python's
1457
+ dictionary function of the same name).
1458
+
1459
+ :return: custom property key, value pairs.
1460
+ """
977
1461
  ...
978
1462
 
979
- def keyframe_delete(self):
980
- """ """
1463
+ def keyframe_delete(self) -> bool:
1464
+ """Remove a keyframe from this properties fcurve.
1465
+
1466
+ :return: Success of keyframe deletion.
1467
+ :rtype: bool
1468
+ """
981
1469
  ...
982
1470
 
983
- def keyframe_insert(self):
984
- """ """
1471
+ def keyframe_insert(self) -> bool:
1472
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1473
+
1474
+ :return: Success of keyframe insertion.
1475
+ :rtype: bool
1476
+ """
985
1477
  ...
986
1478
 
987
1479
  def keys(self):
988
- """ """
1480
+ """Returns the keys of this objects custom properties (matches Python's
1481
+ dictionary function of the same name).
1482
+
1483
+ :return: custom property keys.
1484
+ """
989
1485
  ...
990
1486
 
991
- def path_from_id(self):
992
- """ """
1487
+ def path_from_id(self) -> str:
1488
+ """Returns the data path from the ID to this object (string).
1489
+
1490
+ :return: The path from `bpy.types.bpy_struct.id_data`
1491
+ to this struct and property (when given).
1492
+ :rtype: str
1493
+ """
993
1494
  ...
994
1495
 
995
1496
  def path_resolve(self):
996
- """ """
1497
+ """Returns the property from the path, raise an exception when not found."""
997
1498
  ...
998
1499
 
999
1500
  def poll(self, context):
@@ -1004,37 +1505,53 @@ class PHYSICS_PT_softbody_edge_stiffness(
1004
1505
  ...
1005
1506
 
1006
1507
  def pop(self):
1007
- """ """
1508
+ """Remove and return the value of the custom property assigned to key or default
1509
+ when not found (matches Python's dictionary function of the same name).
1510
+
1511
+ """
1008
1512
  ...
1009
1513
 
1010
1514
  def prepend(self, draw_func):
1011
- """
1515
+ """Prepend a draw function to this menu, takes the same arguments as
1516
+ the menus draw function
1012
1517
 
1013
- :param draw_func:
1518
+ :param draw_func:
1014
1519
  """
1015
1520
  ...
1016
1521
 
1017
- def property_overridable_library_set(self):
1018
- """ """
1522
+ def property_overridable_library_set(self) -> bool:
1523
+ """Define a property as overridable or not (only for custom properties!).
1524
+
1525
+ :return: True when the overridable status of the property was successfully set.
1526
+ :rtype: bool
1527
+ """
1019
1528
  ...
1020
1529
 
1021
1530
  def property_unset(self):
1022
- """ """
1531
+ """Unset a property, will use default value afterward."""
1023
1532
  ...
1024
1533
 
1025
1534
  def remove(self, draw_func):
1026
- """
1535
+ """Remove a draw function that has been added to this menu
1027
1536
 
1028
1537
  :param draw_func:
1029
1538
  """
1030
1539
  ...
1031
1540
 
1032
1541
  def type_recast(self):
1033
- """ """
1542
+ """Return a new instance, this is needed because types
1543
+ such as textures can be changed at runtime.
1544
+
1545
+ :return: a new instance of this object with the type initialized again.
1546
+ """
1034
1547
  ...
1035
1548
 
1036
1549
  def values(self):
1037
- """ """
1550
+ """Returns the values of this objects custom properties (matches Python's
1551
+ dictionary function of the same name).
1552
+
1553
+ :return: custom property values.
1554
+ """
1038
1555
  ...
1039
1556
 
1040
1557
  class PHYSICS_PT_softbody_field_weights(
@@ -1070,22 +1587,35 @@ class PHYSICS_PT_softbody_field_weights(
1070
1587
  """ """
1071
1588
 
1072
1589
  def append(self, draw_func):
1073
- """
1590
+ """Append a draw function to this menu,
1591
+ takes the same arguments as the menus draw function
1074
1592
 
1075
- :param draw_func:
1593
+ :param draw_func:
1076
1594
  """
1077
1595
  ...
1078
1596
 
1079
- def as_pointer(self):
1080
- """ """
1597
+ def as_pointer(self) -> int:
1598
+ """Returns the memory address which holds a pointer to Blender's internal data
1599
+
1600
+ :return: int (memory address).
1601
+ :rtype: int
1602
+ """
1081
1603
  ...
1082
1604
 
1083
- def bl_rna_get_subclass(self):
1084
- """ """
1605
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1606
+ """
1607
+
1608
+ :return: The RNA type or default when not found.
1609
+ :rtype: bpy.types.Struct
1610
+ """
1085
1611
  ...
1086
1612
 
1087
- def bl_rna_get_subclass_py(self):
1088
- """ """
1613
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1614
+ """
1615
+
1616
+ :return: The class or default when not found.
1617
+ :rtype: typing.Any
1618
+ """
1089
1619
  ...
1090
1620
 
1091
1621
  def draw(self, context):
@@ -1095,72 +1625,129 @@ class PHYSICS_PT_softbody_field_weights(
1095
1625
  """
1096
1626
  ...
1097
1627
 
1098
- def driver_add(self):
1099
- """ """
1628
+ def driver_add(self) -> bpy.types.FCurve:
1629
+ """Adds driver(s) to the given property
1630
+
1631
+ :return: The driver(s) added.
1632
+ :rtype: bpy.types.FCurve
1633
+ """
1100
1634
  ...
1101
1635
 
1102
- def driver_remove(self):
1103
- """ """
1636
+ def driver_remove(self) -> bool:
1637
+ """Remove driver(s) from the given property
1638
+
1639
+ :return: Success of driver removal.
1640
+ :rtype: bool
1641
+ """
1104
1642
  ...
1105
1643
 
1106
1644
  def get(self):
1107
- """ """
1645
+ """Returns the value of the custom property assigned to key or default
1646
+ when not found (matches Python's dictionary function of the same name).
1647
+
1648
+ """
1108
1649
  ...
1109
1650
 
1110
1651
  def id_properties_clear(self):
1111
- """ """
1652
+ """
1653
+
1654
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1655
+ """
1112
1656
  ...
1113
1657
 
1114
1658
  def id_properties_ensure(self):
1115
- """ """
1659
+ """
1660
+
1661
+ :return: the parent group for an RNA struct's custom IDProperties.
1662
+ """
1116
1663
  ...
1117
1664
 
1118
1665
  def id_properties_ui(self):
1119
- """ """
1666
+ """
1667
+
1668
+ :return: Return an object used to manage an IDProperty's UI data.
1669
+ """
1120
1670
  ...
1121
1671
 
1122
1672
  def is_extended(self):
1123
1673
  """ """
1124
1674
  ...
1125
1675
 
1126
- def is_property_hidden(self):
1127
- """ """
1128
- ...
1676
+ def is_property_hidden(self) -> bool:
1677
+ """Check if a property is hidden.
1129
1678
 
1130
- def is_property_overridable_library(self):
1131
- """ """
1679
+ :return: True when the property is hidden.
1680
+ :rtype: bool
1681
+ """
1132
1682
  ...
1133
1683
 
1134
- def is_property_readonly(self):
1135
- """ """
1684
+ def is_property_overridable_library(self) -> bool:
1685
+ """Check if a property is overridable.
1686
+
1687
+ :return: True when the property is overridable.
1688
+ :rtype: bool
1689
+ """
1136
1690
  ...
1137
1691
 
1138
- def is_property_set(self):
1139
- """ """
1692
+ def is_property_readonly(self) -> bool:
1693
+ """Check if a property is readonly.
1694
+
1695
+ :return: True when the property is readonly (not writable).
1696
+ :rtype: bool
1697
+ """
1698
+ ...
1699
+
1700
+ def is_property_set(self) -> bool:
1701
+ """Check if a property is set, use for testing operator properties.
1702
+
1703
+ :return: True when the property has been set.
1704
+ :rtype: bool
1705
+ """
1140
1706
  ...
1141
1707
 
1142
1708
  def items(self):
1143
- """ """
1709
+ """Returns the items of this objects custom properties (matches Python's
1710
+ dictionary function of the same name).
1711
+
1712
+ :return: custom property key, value pairs.
1713
+ """
1144
1714
  ...
1145
1715
 
1146
- def keyframe_delete(self):
1147
- """ """
1716
+ def keyframe_delete(self) -> bool:
1717
+ """Remove a keyframe from this properties fcurve.
1718
+
1719
+ :return: Success of keyframe deletion.
1720
+ :rtype: bool
1721
+ """
1148
1722
  ...
1149
1723
 
1150
- def keyframe_insert(self):
1151
- """ """
1724
+ def keyframe_insert(self) -> bool:
1725
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1726
+
1727
+ :return: Success of keyframe insertion.
1728
+ :rtype: bool
1729
+ """
1152
1730
  ...
1153
1731
 
1154
1732
  def keys(self):
1155
- """ """
1733
+ """Returns the keys of this objects custom properties (matches Python's
1734
+ dictionary function of the same name).
1735
+
1736
+ :return: custom property keys.
1737
+ """
1156
1738
  ...
1157
1739
 
1158
- def path_from_id(self):
1159
- """ """
1740
+ def path_from_id(self) -> str:
1741
+ """Returns the data path from the ID to this object (string).
1742
+
1743
+ :return: The path from `bpy.types.bpy_struct.id_data`
1744
+ to this struct and property (when given).
1745
+ :rtype: str
1746
+ """
1160
1747
  ...
1161
1748
 
1162
1749
  def path_resolve(self):
1163
- """ """
1750
+ """Returns the property from the path, raise an exception when not found."""
1164
1751
  ...
1165
1752
 
1166
1753
  def poll(self, context):
@@ -1171,37 +1758,53 @@ class PHYSICS_PT_softbody_field_weights(
1171
1758
  ...
1172
1759
 
1173
1760
  def pop(self):
1174
- """ """
1761
+ """Remove and return the value of the custom property assigned to key or default
1762
+ when not found (matches Python's dictionary function of the same name).
1763
+
1764
+ """
1175
1765
  ...
1176
1766
 
1177
1767
  def prepend(self, draw_func):
1178
- """
1768
+ """Prepend a draw function to this menu, takes the same arguments as
1769
+ the menus draw function
1179
1770
 
1180
- :param draw_func:
1771
+ :param draw_func:
1181
1772
  """
1182
1773
  ...
1183
1774
 
1184
- def property_overridable_library_set(self):
1185
- """ """
1775
+ def property_overridable_library_set(self) -> bool:
1776
+ """Define a property as overridable or not (only for custom properties!).
1777
+
1778
+ :return: True when the overridable status of the property was successfully set.
1779
+ :rtype: bool
1780
+ """
1186
1781
  ...
1187
1782
 
1188
1783
  def property_unset(self):
1189
- """ """
1784
+ """Unset a property, will use default value afterward."""
1190
1785
  ...
1191
1786
 
1192
1787
  def remove(self, draw_func):
1193
- """
1788
+ """Remove a draw function that has been added to this menu
1194
1789
 
1195
1790
  :param draw_func:
1196
1791
  """
1197
1792
  ...
1198
1793
 
1199
1794
  def type_recast(self):
1200
- """ """
1795
+ """Return a new instance, this is needed because types
1796
+ such as textures can be changed at runtime.
1797
+
1798
+ :return: a new instance of this object with the type initialized again.
1799
+ """
1201
1800
  ...
1202
1801
 
1203
1802
  def values(self):
1204
- """ """
1803
+ """Returns the values of this objects custom properties (matches Python's
1804
+ dictionary function of the same name).
1805
+
1806
+ :return: custom property values.
1807
+ """
1205
1808
  ...
1206
1809
 
1207
1810
  class PHYSICS_PT_softbody_goal(
@@ -1237,22 +1840,35 @@ class PHYSICS_PT_softbody_goal(
1237
1840
  """ """
1238
1841
 
1239
1842
  def append(self, draw_func):
1240
- """
1843
+ """Append a draw function to this menu,
1844
+ takes the same arguments as the menus draw function
1241
1845
 
1242
- :param draw_func:
1846
+ :param draw_func:
1243
1847
  """
1244
1848
  ...
1245
1849
 
1246
- def as_pointer(self):
1247
- """ """
1850
+ def as_pointer(self) -> int:
1851
+ """Returns the memory address which holds a pointer to Blender's internal data
1852
+
1853
+ :return: int (memory address).
1854
+ :rtype: int
1855
+ """
1248
1856
  ...
1249
1857
 
1250
- def bl_rna_get_subclass(self):
1251
- """ """
1858
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1859
+ """
1860
+
1861
+ :return: The RNA type or default when not found.
1862
+ :rtype: bpy.types.Struct
1863
+ """
1252
1864
  ...
1253
1865
 
1254
- def bl_rna_get_subclass_py(self):
1255
- """ """
1866
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1867
+ """
1868
+
1869
+ :return: The class or default when not found.
1870
+ :rtype: typing.Any
1871
+ """
1256
1872
  ...
1257
1873
 
1258
1874
  def draw(self, context):
@@ -1269,72 +1885,129 @@ class PHYSICS_PT_softbody_goal(
1269
1885
  """
1270
1886
  ...
1271
1887
 
1272
- def driver_add(self):
1273
- """ """
1888
+ def driver_add(self) -> bpy.types.FCurve:
1889
+ """Adds driver(s) to the given property
1890
+
1891
+ :return: The driver(s) added.
1892
+ :rtype: bpy.types.FCurve
1893
+ """
1274
1894
  ...
1275
1895
 
1276
- def driver_remove(self):
1277
- """ """
1896
+ def driver_remove(self) -> bool:
1897
+ """Remove driver(s) from the given property
1898
+
1899
+ :return: Success of driver removal.
1900
+ :rtype: bool
1901
+ """
1278
1902
  ...
1279
1903
 
1280
1904
  def get(self):
1281
- """ """
1905
+ """Returns the value of the custom property assigned to key or default
1906
+ when not found (matches Python's dictionary function of the same name).
1907
+
1908
+ """
1282
1909
  ...
1283
1910
 
1284
1911
  def id_properties_clear(self):
1285
- """ """
1912
+ """
1913
+
1914
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1915
+ """
1286
1916
  ...
1287
1917
 
1288
1918
  def id_properties_ensure(self):
1289
- """ """
1919
+ """
1920
+
1921
+ :return: the parent group for an RNA struct's custom IDProperties.
1922
+ """
1290
1923
  ...
1291
1924
 
1292
1925
  def id_properties_ui(self):
1293
- """ """
1926
+ """
1927
+
1928
+ :return: Return an object used to manage an IDProperty's UI data.
1929
+ """
1294
1930
  ...
1295
1931
 
1296
1932
  def is_extended(self):
1297
1933
  """ """
1298
1934
  ...
1299
1935
 
1300
- def is_property_hidden(self):
1301
- """ """
1936
+ def is_property_hidden(self) -> bool:
1937
+ """Check if a property is hidden.
1938
+
1939
+ :return: True when the property is hidden.
1940
+ :rtype: bool
1941
+ """
1302
1942
  ...
1303
1943
 
1304
- def is_property_overridable_library(self):
1305
- """ """
1944
+ def is_property_overridable_library(self) -> bool:
1945
+ """Check if a property is overridable.
1946
+
1947
+ :return: True when the property is overridable.
1948
+ :rtype: bool
1949
+ """
1306
1950
  ...
1307
1951
 
1308
- def is_property_readonly(self):
1309
- """ """
1952
+ def is_property_readonly(self) -> bool:
1953
+ """Check if a property is readonly.
1954
+
1955
+ :return: True when the property is readonly (not writable).
1956
+ :rtype: bool
1957
+ """
1310
1958
  ...
1311
1959
 
1312
- def is_property_set(self):
1313
- """ """
1960
+ def is_property_set(self) -> bool:
1961
+ """Check if a property is set, use for testing operator properties.
1962
+
1963
+ :return: True when the property has been set.
1964
+ :rtype: bool
1965
+ """
1314
1966
  ...
1315
1967
 
1316
1968
  def items(self):
1317
- """ """
1969
+ """Returns the items of this objects custom properties (matches Python's
1970
+ dictionary function of the same name).
1971
+
1972
+ :return: custom property key, value pairs.
1973
+ """
1318
1974
  ...
1319
1975
 
1320
- def keyframe_delete(self):
1321
- """ """
1976
+ def keyframe_delete(self) -> bool:
1977
+ """Remove a keyframe from this properties fcurve.
1978
+
1979
+ :return: Success of keyframe deletion.
1980
+ :rtype: bool
1981
+ """
1322
1982
  ...
1323
1983
 
1324
- def keyframe_insert(self):
1325
- """ """
1984
+ def keyframe_insert(self) -> bool:
1985
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1986
+
1987
+ :return: Success of keyframe insertion.
1988
+ :rtype: bool
1989
+ """
1326
1990
  ...
1327
1991
 
1328
1992
  def keys(self):
1329
- """ """
1993
+ """Returns the keys of this objects custom properties (matches Python's
1994
+ dictionary function of the same name).
1995
+
1996
+ :return: custom property keys.
1997
+ """
1330
1998
  ...
1331
1999
 
1332
- def path_from_id(self):
1333
- """ """
2000
+ def path_from_id(self) -> str:
2001
+ """Returns the data path from the ID to this object (string).
2002
+
2003
+ :return: The path from `bpy.types.bpy_struct.id_data`
2004
+ to this struct and property (when given).
2005
+ :rtype: str
2006
+ """
1334
2007
  ...
1335
2008
 
1336
2009
  def path_resolve(self):
1337
- """ """
2010
+ """Returns the property from the path, raise an exception when not found."""
1338
2011
  ...
1339
2012
 
1340
2013
  def poll(self, context):
@@ -1345,37 +2018,53 @@ class PHYSICS_PT_softbody_goal(
1345
2018
  ...
1346
2019
 
1347
2020
  def pop(self):
1348
- """ """
2021
+ """Remove and return the value of the custom property assigned to key or default
2022
+ when not found (matches Python's dictionary function of the same name).
2023
+
2024
+ """
1349
2025
  ...
1350
2026
 
1351
2027
  def prepend(self, draw_func):
1352
- """
2028
+ """Prepend a draw function to this menu, takes the same arguments as
2029
+ the menus draw function
1353
2030
 
1354
- :param draw_func:
2031
+ :param draw_func:
1355
2032
  """
1356
2033
  ...
1357
2034
 
1358
- def property_overridable_library_set(self):
1359
- """ """
2035
+ def property_overridable_library_set(self) -> bool:
2036
+ """Define a property as overridable or not (only for custom properties!).
2037
+
2038
+ :return: True when the overridable status of the property was successfully set.
2039
+ :rtype: bool
2040
+ """
1360
2041
  ...
1361
2042
 
1362
2043
  def property_unset(self):
1363
- """ """
2044
+ """Unset a property, will use default value afterward."""
1364
2045
  ...
1365
2046
 
1366
2047
  def remove(self, draw_func):
1367
- """
2048
+ """Remove a draw function that has been added to this menu
1368
2049
 
1369
2050
  :param draw_func:
1370
2051
  """
1371
2052
  ...
1372
2053
 
1373
2054
  def type_recast(self):
1374
- """ """
2055
+ """Return a new instance, this is needed because types
2056
+ such as textures can be changed at runtime.
2057
+
2058
+ :return: a new instance of this object with the type initialized again.
2059
+ """
1375
2060
  ...
1376
2061
 
1377
2062
  def values(self):
1378
- """ """
2063
+ """Returns the values of this objects custom properties (matches Python's
2064
+ dictionary function of the same name).
2065
+
2066
+ :return: custom property values.
2067
+ """
1379
2068
  ...
1380
2069
 
1381
2070
  class PHYSICS_PT_softbody_goal_settings(
@@ -1411,22 +2100,35 @@ class PHYSICS_PT_softbody_goal_settings(
1411
2100
  """ """
1412
2101
 
1413
2102
  def append(self, draw_func):
1414
- """
2103
+ """Append a draw function to this menu,
2104
+ takes the same arguments as the menus draw function
1415
2105
 
1416
- :param draw_func:
2106
+ :param draw_func:
1417
2107
  """
1418
2108
  ...
1419
2109
 
1420
- def as_pointer(self):
1421
- """ """
2110
+ def as_pointer(self) -> int:
2111
+ """Returns the memory address which holds a pointer to Blender's internal data
2112
+
2113
+ :return: int (memory address).
2114
+ :rtype: int
2115
+ """
1422
2116
  ...
1423
2117
 
1424
- def bl_rna_get_subclass(self):
1425
- """ """
2118
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2119
+ """
2120
+
2121
+ :return: The RNA type or default when not found.
2122
+ :rtype: bpy.types.Struct
2123
+ """
1426
2124
  ...
1427
2125
 
1428
- def bl_rna_get_subclass_py(self):
1429
- """ """
2126
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2127
+ """
2128
+
2129
+ :return: The class or default when not found.
2130
+ :rtype: typing.Any
2131
+ """
1430
2132
  ...
1431
2133
 
1432
2134
  def draw(self, context):
@@ -1436,72 +2138,129 @@ class PHYSICS_PT_softbody_goal_settings(
1436
2138
  """
1437
2139
  ...
1438
2140
 
1439
- def driver_add(self):
1440
- """ """
2141
+ def driver_add(self) -> bpy.types.FCurve:
2142
+ """Adds driver(s) to the given property
2143
+
2144
+ :return: The driver(s) added.
2145
+ :rtype: bpy.types.FCurve
2146
+ """
1441
2147
  ...
1442
2148
 
1443
- def driver_remove(self):
1444
- """ """
2149
+ def driver_remove(self) -> bool:
2150
+ """Remove driver(s) from the given property
2151
+
2152
+ :return: Success of driver removal.
2153
+ :rtype: bool
2154
+ """
1445
2155
  ...
1446
2156
 
1447
2157
  def get(self):
1448
- """ """
2158
+ """Returns the value of the custom property assigned to key or default
2159
+ when not found (matches Python's dictionary function of the same name).
2160
+
2161
+ """
1449
2162
  ...
1450
2163
 
1451
2164
  def id_properties_clear(self):
1452
- """ """
2165
+ """
2166
+
2167
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2168
+ """
1453
2169
  ...
1454
2170
 
1455
2171
  def id_properties_ensure(self):
1456
- """ """
2172
+ """
2173
+
2174
+ :return: the parent group for an RNA struct's custom IDProperties.
2175
+ """
1457
2176
  ...
1458
2177
 
1459
2178
  def id_properties_ui(self):
1460
- """ """
2179
+ """
2180
+
2181
+ :return: Return an object used to manage an IDProperty's UI data.
2182
+ """
1461
2183
  ...
1462
2184
 
1463
2185
  def is_extended(self):
1464
2186
  """ """
1465
2187
  ...
1466
2188
 
1467
- def is_property_hidden(self):
1468
- """ """
2189
+ def is_property_hidden(self) -> bool:
2190
+ """Check if a property is hidden.
2191
+
2192
+ :return: True when the property is hidden.
2193
+ :rtype: bool
2194
+ """
1469
2195
  ...
1470
2196
 
1471
- def is_property_overridable_library(self):
1472
- """ """
2197
+ def is_property_overridable_library(self) -> bool:
2198
+ """Check if a property is overridable.
2199
+
2200
+ :return: True when the property is overridable.
2201
+ :rtype: bool
2202
+ """
1473
2203
  ...
1474
2204
 
1475
- def is_property_readonly(self):
1476
- """ """
2205
+ def is_property_readonly(self) -> bool:
2206
+ """Check if a property is readonly.
2207
+
2208
+ :return: True when the property is readonly (not writable).
2209
+ :rtype: bool
2210
+ """
1477
2211
  ...
1478
2212
 
1479
- def is_property_set(self):
1480
- """ """
2213
+ def is_property_set(self) -> bool:
2214
+ """Check if a property is set, use for testing operator properties.
2215
+
2216
+ :return: True when the property has been set.
2217
+ :rtype: bool
2218
+ """
1481
2219
  ...
1482
2220
 
1483
2221
  def items(self):
1484
- """ """
2222
+ """Returns the items of this objects custom properties (matches Python's
2223
+ dictionary function of the same name).
2224
+
2225
+ :return: custom property key, value pairs.
2226
+ """
1485
2227
  ...
1486
2228
 
1487
- def keyframe_delete(self):
1488
- """ """
2229
+ def keyframe_delete(self) -> bool:
2230
+ """Remove a keyframe from this properties fcurve.
2231
+
2232
+ :return: Success of keyframe deletion.
2233
+ :rtype: bool
2234
+ """
1489
2235
  ...
1490
2236
 
1491
- def keyframe_insert(self):
1492
- """ """
2237
+ def keyframe_insert(self) -> bool:
2238
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2239
+
2240
+ :return: Success of keyframe insertion.
2241
+ :rtype: bool
2242
+ """
1493
2243
  ...
1494
2244
 
1495
2245
  def keys(self):
1496
- """ """
2246
+ """Returns the keys of this objects custom properties (matches Python's
2247
+ dictionary function of the same name).
2248
+
2249
+ :return: custom property keys.
2250
+ """
1497
2251
  ...
1498
2252
 
1499
- def path_from_id(self):
1500
- """ """
2253
+ def path_from_id(self) -> str:
2254
+ """Returns the data path from the ID to this object (string).
2255
+
2256
+ :return: The path from `bpy.types.bpy_struct.id_data`
2257
+ to this struct and property (when given).
2258
+ :rtype: str
2259
+ """
1501
2260
  ...
1502
2261
 
1503
2262
  def path_resolve(self):
1504
- """ """
2263
+ """Returns the property from the path, raise an exception when not found."""
1505
2264
  ...
1506
2265
 
1507
2266
  def poll(self, context):
@@ -1512,37 +2271,53 @@ class PHYSICS_PT_softbody_goal_settings(
1512
2271
  ...
1513
2272
 
1514
2273
  def pop(self):
1515
- """ """
2274
+ """Remove and return the value of the custom property assigned to key or default
2275
+ when not found (matches Python's dictionary function of the same name).
2276
+
2277
+ """
1516
2278
  ...
1517
2279
 
1518
2280
  def prepend(self, draw_func):
1519
- """
2281
+ """Prepend a draw function to this menu, takes the same arguments as
2282
+ the menus draw function
1520
2283
 
1521
- :param draw_func:
2284
+ :param draw_func:
1522
2285
  """
1523
2286
  ...
1524
2287
 
1525
- def property_overridable_library_set(self):
1526
- """ """
2288
+ def property_overridable_library_set(self) -> bool:
2289
+ """Define a property as overridable or not (only for custom properties!).
2290
+
2291
+ :return: True when the overridable status of the property was successfully set.
2292
+ :rtype: bool
2293
+ """
1527
2294
  ...
1528
2295
 
1529
2296
  def property_unset(self):
1530
- """ """
2297
+ """Unset a property, will use default value afterward."""
1531
2298
  ...
1532
2299
 
1533
2300
  def remove(self, draw_func):
1534
- """
2301
+ """Remove a draw function that has been added to this menu
1535
2302
 
1536
2303
  :param draw_func:
1537
2304
  """
1538
2305
  ...
1539
2306
 
1540
2307
  def type_recast(self):
1541
- """ """
2308
+ """Return a new instance, this is needed because types
2309
+ such as textures can be changed at runtime.
2310
+
2311
+ :return: a new instance of this object with the type initialized again.
2312
+ """
1542
2313
  ...
1543
2314
 
1544
2315
  def values(self):
1545
- """ """
2316
+ """Returns the values of this objects custom properties (matches Python's
2317
+ dictionary function of the same name).
2318
+
2319
+ :return: custom property values.
2320
+ """
1546
2321
  ...
1547
2322
 
1548
2323
  class PHYSICS_PT_softbody_goal_strengths(
@@ -1578,22 +2353,35 @@ class PHYSICS_PT_softbody_goal_strengths(
1578
2353
  """ """
1579
2354
 
1580
2355
  def append(self, draw_func):
1581
- """
2356
+ """Append a draw function to this menu,
2357
+ takes the same arguments as the menus draw function
1582
2358
 
1583
- :param draw_func:
2359
+ :param draw_func:
1584
2360
  """
1585
2361
  ...
1586
2362
 
1587
- def as_pointer(self):
1588
- """ """
2363
+ def as_pointer(self) -> int:
2364
+ """Returns the memory address which holds a pointer to Blender's internal data
2365
+
2366
+ :return: int (memory address).
2367
+ :rtype: int
2368
+ """
1589
2369
  ...
1590
2370
 
1591
- def bl_rna_get_subclass(self):
1592
- """ """
2371
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2372
+ """
2373
+
2374
+ :return: The RNA type or default when not found.
2375
+ :rtype: bpy.types.Struct
2376
+ """
1593
2377
  ...
1594
2378
 
1595
- def bl_rna_get_subclass_py(self):
1596
- """ """
2379
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2380
+ """
2381
+
2382
+ :return: The class or default when not found.
2383
+ :rtype: typing.Any
2384
+ """
1597
2385
  ...
1598
2386
 
1599
2387
  def draw(self, context):
@@ -1603,72 +2391,129 @@ class PHYSICS_PT_softbody_goal_strengths(
1603
2391
  """
1604
2392
  ...
1605
2393
 
1606
- def driver_add(self):
1607
- """ """
2394
+ def driver_add(self) -> bpy.types.FCurve:
2395
+ """Adds driver(s) to the given property
2396
+
2397
+ :return: The driver(s) added.
2398
+ :rtype: bpy.types.FCurve
2399
+ """
1608
2400
  ...
1609
2401
 
1610
- def driver_remove(self):
1611
- """ """
2402
+ def driver_remove(self) -> bool:
2403
+ """Remove driver(s) from the given property
2404
+
2405
+ :return: Success of driver removal.
2406
+ :rtype: bool
2407
+ """
1612
2408
  ...
1613
2409
 
1614
2410
  def get(self):
1615
- """ """
2411
+ """Returns the value of the custom property assigned to key or default
2412
+ when not found (matches Python's dictionary function of the same name).
2413
+
2414
+ """
1616
2415
  ...
1617
2416
 
1618
2417
  def id_properties_clear(self):
1619
- """ """
2418
+ """
2419
+
2420
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2421
+ """
1620
2422
  ...
1621
2423
 
1622
2424
  def id_properties_ensure(self):
1623
- """ """
2425
+ """
2426
+
2427
+ :return: the parent group for an RNA struct's custom IDProperties.
2428
+ """
1624
2429
  ...
1625
2430
 
1626
2431
  def id_properties_ui(self):
1627
- """ """
2432
+ """
2433
+
2434
+ :return: Return an object used to manage an IDProperty's UI data.
2435
+ """
1628
2436
  ...
1629
2437
 
1630
2438
  def is_extended(self):
1631
2439
  """ """
1632
2440
  ...
1633
2441
 
1634
- def is_property_hidden(self):
1635
- """ """
2442
+ def is_property_hidden(self) -> bool:
2443
+ """Check if a property is hidden.
2444
+
2445
+ :return: True when the property is hidden.
2446
+ :rtype: bool
2447
+ """
1636
2448
  ...
1637
2449
 
1638
- def is_property_overridable_library(self):
1639
- """ """
2450
+ def is_property_overridable_library(self) -> bool:
2451
+ """Check if a property is overridable.
2452
+
2453
+ :return: True when the property is overridable.
2454
+ :rtype: bool
2455
+ """
1640
2456
  ...
1641
2457
 
1642
- def is_property_readonly(self):
1643
- """ """
2458
+ def is_property_readonly(self) -> bool:
2459
+ """Check if a property is readonly.
2460
+
2461
+ :return: True when the property is readonly (not writable).
2462
+ :rtype: bool
2463
+ """
1644
2464
  ...
1645
2465
 
1646
- def is_property_set(self):
1647
- """ """
2466
+ def is_property_set(self) -> bool:
2467
+ """Check if a property is set, use for testing operator properties.
2468
+
2469
+ :return: True when the property has been set.
2470
+ :rtype: bool
2471
+ """
1648
2472
  ...
1649
2473
 
1650
2474
  def items(self):
1651
- """ """
2475
+ """Returns the items of this objects custom properties (matches Python's
2476
+ dictionary function of the same name).
2477
+
2478
+ :return: custom property key, value pairs.
2479
+ """
1652
2480
  ...
1653
2481
 
1654
- def keyframe_delete(self):
1655
- """ """
2482
+ def keyframe_delete(self) -> bool:
2483
+ """Remove a keyframe from this properties fcurve.
2484
+
2485
+ :return: Success of keyframe deletion.
2486
+ :rtype: bool
2487
+ """
1656
2488
  ...
1657
2489
 
1658
- def keyframe_insert(self):
1659
- """ """
2490
+ def keyframe_insert(self) -> bool:
2491
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2492
+
2493
+ :return: Success of keyframe insertion.
2494
+ :rtype: bool
2495
+ """
1660
2496
  ...
1661
2497
 
1662
2498
  def keys(self):
1663
- """ """
2499
+ """Returns the keys of this objects custom properties (matches Python's
2500
+ dictionary function of the same name).
2501
+
2502
+ :return: custom property keys.
2503
+ """
1664
2504
  ...
1665
2505
 
1666
- def path_from_id(self):
1667
- """ """
2506
+ def path_from_id(self) -> str:
2507
+ """Returns the data path from the ID to this object (string).
2508
+
2509
+ :return: The path from `bpy.types.bpy_struct.id_data`
2510
+ to this struct and property (when given).
2511
+ :rtype: str
2512
+ """
1668
2513
  ...
1669
2514
 
1670
2515
  def path_resolve(self):
1671
- """ """
2516
+ """Returns the property from the path, raise an exception when not found."""
1672
2517
  ...
1673
2518
 
1674
2519
  def poll(self, context):
@@ -1679,37 +2524,53 @@ class PHYSICS_PT_softbody_goal_strengths(
1679
2524
  ...
1680
2525
 
1681
2526
  def pop(self):
1682
- """ """
2527
+ """Remove and return the value of the custom property assigned to key or default
2528
+ when not found (matches Python's dictionary function of the same name).
2529
+
2530
+ """
1683
2531
  ...
1684
2532
 
1685
2533
  def prepend(self, draw_func):
1686
- """
2534
+ """Prepend a draw function to this menu, takes the same arguments as
2535
+ the menus draw function
1687
2536
 
1688
- :param draw_func:
2537
+ :param draw_func:
1689
2538
  """
1690
2539
  ...
1691
2540
 
1692
- def property_overridable_library_set(self):
1693
- """ """
2541
+ def property_overridable_library_set(self) -> bool:
2542
+ """Define a property as overridable or not (only for custom properties!).
2543
+
2544
+ :return: True when the overridable status of the property was successfully set.
2545
+ :rtype: bool
2546
+ """
1694
2547
  ...
1695
2548
 
1696
2549
  def property_unset(self):
1697
- """ """
2550
+ """Unset a property, will use default value afterward."""
1698
2551
  ...
1699
2552
 
1700
2553
  def remove(self, draw_func):
1701
- """
2554
+ """Remove a draw function that has been added to this menu
1702
2555
 
1703
2556
  :param draw_func:
1704
2557
  """
1705
2558
  ...
1706
2559
 
1707
2560
  def type_recast(self):
1708
- """ """
2561
+ """Return a new instance, this is needed because types
2562
+ such as textures can be changed at runtime.
2563
+
2564
+ :return: a new instance of this object with the type initialized again.
2565
+ """
1709
2566
  ...
1710
2567
 
1711
2568
  def values(self):
1712
- """ """
2569
+ """Returns the values of this objects custom properties (matches Python's
2570
+ dictionary function of the same name).
2571
+
2572
+ :return: custom property values.
2573
+ """
1713
2574
  ...
1714
2575
 
1715
2576
  class PHYSICS_PT_softbody_object(
@@ -1745,22 +2606,35 @@ class PHYSICS_PT_softbody_object(
1745
2606
  """ """
1746
2607
 
1747
2608
  def append(self, draw_func):
1748
- """
2609
+ """Append a draw function to this menu,
2610
+ takes the same arguments as the menus draw function
1749
2611
 
1750
- :param draw_func:
2612
+ :param draw_func:
1751
2613
  """
1752
2614
  ...
1753
2615
 
1754
- def as_pointer(self):
1755
- """ """
2616
+ def as_pointer(self) -> int:
2617
+ """Returns the memory address which holds a pointer to Blender's internal data
2618
+
2619
+ :return: int (memory address).
2620
+ :rtype: int
2621
+ """
1756
2622
  ...
1757
2623
 
1758
- def bl_rna_get_subclass(self):
1759
- """ """
2624
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2625
+ """
2626
+
2627
+ :return: The RNA type or default when not found.
2628
+ :rtype: bpy.types.Struct
2629
+ """
1760
2630
  ...
1761
2631
 
1762
- def bl_rna_get_subclass_py(self):
1763
- """ """
2632
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2633
+ """
2634
+
2635
+ :return: The class or default when not found.
2636
+ :rtype: typing.Any
2637
+ """
1764
2638
  ...
1765
2639
 
1766
2640
  def draw(self, context):
@@ -1770,72 +2644,129 @@ class PHYSICS_PT_softbody_object(
1770
2644
  """
1771
2645
  ...
1772
2646
 
1773
- def driver_add(self):
1774
- """ """
2647
+ def driver_add(self) -> bpy.types.FCurve:
2648
+ """Adds driver(s) to the given property
2649
+
2650
+ :return: The driver(s) added.
2651
+ :rtype: bpy.types.FCurve
2652
+ """
1775
2653
  ...
1776
2654
 
1777
- def driver_remove(self):
1778
- """ """
2655
+ def driver_remove(self) -> bool:
2656
+ """Remove driver(s) from the given property
2657
+
2658
+ :return: Success of driver removal.
2659
+ :rtype: bool
2660
+ """
1779
2661
  ...
1780
2662
 
1781
2663
  def get(self):
1782
- """ """
2664
+ """Returns the value of the custom property assigned to key or default
2665
+ when not found (matches Python's dictionary function of the same name).
2666
+
2667
+ """
1783
2668
  ...
1784
2669
 
1785
2670
  def id_properties_clear(self):
1786
- """ """
2671
+ """
2672
+
2673
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2674
+ """
1787
2675
  ...
1788
2676
 
1789
2677
  def id_properties_ensure(self):
1790
- """ """
2678
+ """
2679
+
2680
+ :return: the parent group for an RNA struct's custom IDProperties.
2681
+ """
1791
2682
  ...
1792
2683
 
1793
2684
  def id_properties_ui(self):
1794
- """ """
2685
+ """
2686
+
2687
+ :return: Return an object used to manage an IDProperty's UI data.
2688
+ """
1795
2689
  ...
1796
2690
 
1797
2691
  def is_extended(self):
1798
2692
  """ """
1799
2693
  ...
1800
2694
 
1801
- def is_property_hidden(self):
1802
- """ """
2695
+ def is_property_hidden(self) -> bool:
2696
+ """Check if a property is hidden.
2697
+
2698
+ :return: True when the property is hidden.
2699
+ :rtype: bool
2700
+ """
1803
2701
  ...
1804
2702
 
1805
- def is_property_overridable_library(self):
1806
- """ """
2703
+ def is_property_overridable_library(self) -> bool:
2704
+ """Check if a property is overridable.
2705
+
2706
+ :return: True when the property is overridable.
2707
+ :rtype: bool
2708
+ """
1807
2709
  ...
1808
2710
 
1809
- def is_property_readonly(self):
1810
- """ """
2711
+ def is_property_readonly(self) -> bool:
2712
+ """Check if a property is readonly.
2713
+
2714
+ :return: True when the property is readonly (not writable).
2715
+ :rtype: bool
2716
+ """
1811
2717
  ...
1812
2718
 
1813
- def is_property_set(self):
1814
- """ """
2719
+ def is_property_set(self) -> bool:
2720
+ """Check if a property is set, use for testing operator properties.
2721
+
2722
+ :return: True when the property has been set.
2723
+ :rtype: bool
2724
+ """
1815
2725
  ...
1816
2726
 
1817
2727
  def items(self):
1818
- """ """
2728
+ """Returns the items of this objects custom properties (matches Python's
2729
+ dictionary function of the same name).
2730
+
2731
+ :return: custom property key, value pairs.
2732
+ """
1819
2733
  ...
1820
2734
 
1821
- def keyframe_delete(self):
1822
- """ """
2735
+ def keyframe_delete(self) -> bool:
2736
+ """Remove a keyframe from this properties fcurve.
2737
+
2738
+ :return: Success of keyframe deletion.
2739
+ :rtype: bool
2740
+ """
1823
2741
  ...
1824
2742
 
1825
- def keyframe_insert(self):
1826
- """ """
2743
+ def keyframe_insert(self) -> bool:
2744
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2745
+
2746
+ :return: Success of keyframe insertion.
2747
+ :rtype: bool
2748
+ """
1827
2749
  ...
1828
2750
 
1829
2751
  def keys(self):
1830
- """ """
2752
+ """Returns the keys of this objects custom properties (matches Python's
2753
+ dictionary function of the same name).
2754
+
2755
+ :return: custom property keys.
2756
+ """
1831
2757
  ...
1832
2758
 
1833
- def path_from_id(self):
1834
- """ """
2759
+ def path_from_id(self) -> str:
2760
+ """Returns the data path from the ID to this object (string).
2761
+
2762
+ :return: The path from `bpy.types.bpy_struct.id_data`
2763
+ to this struct and property (when given).
2764
+ :rtype: str
2765
+ """
1835
2766
  ...
1836
2767
 
1837
2768
  def path_resolve(self):
1838
- """ """
2769
+ """Returns the property from the path, raise an exception when not found."""
1839
2770
  ...
1840
2771
 
1841
2772
  def poll(self, context):
@@ -1846,37 +2777,53 @@ class PHYSICS_PT_softbody_object(
1846
2777
  ...
1847
2778
 
1848
2779
  def pop(self):
1849
- """ """
2780
+ """Remove and return the value of the custom property assigned to key or default
2781
+ when not found (matches Python's dictionary function of the same name).
2782
+
2783
+ """
1850
2784
  ...
1851
2785
 
1852
2786
  def prepend(self, draw_func):
1853
- """
2787
+ """Prepend a draw function to this menu, takes the same arguments as
2788
+ the menus draw function
1854
2789
 
1855
- :param draw_func:
2790
+ :param draw_func:
1856
2791
  """
1857
2792
  ...
1858
2793
 
1859
- def property_overridable_library_set(self):
1860
- """ """
2794
+ def property_overridable_library_set(self) -> bool:
2795
+ """Define a property as overridable or not (only for custom properties!).
2796
+
2797
+ :return: True when the overridable status of the property was successfully set.
2798
+ :rtype: bool
2799
+ """
1861
2800
  ...
1862
2801
 
1863
2802
  def property_unset(self):
1864
- """ """
2803
+ """Unset a property, will use default value afterward."""
1865
2804
  ...
1866
2805
 
1867
2806
  def remove(self, draw_func):
1868
- """
2807
+ """Remove a draw function that has been added to this menu
1869
2808
 
1870
2809
  :param draw_func:
1871
2810
  """
1872
2811
  ...
1873
2812
 
1874
2813
  def type_recast(self):
1875
- """ """
2814
+ """Return a new instance, this is needed because types
2815
+ such as textures can be changed at runtime.
2816
+
2817
+ :return: a new instance of this object with the type initialized again.
2818
+ """
1876
2819
  ...
1877
2820
 
1878
2821
  def values(self):
1879
- """ """
2822
+ """Returns the values of this objects custom properties (matches Python's
2823
+ dictionary function of the same name).
2824
+
2825
+ :return: custom property values.
2826
+ """
1880
2827
  ...
1881
2828
 
1882
2829
  class PHYSICS_PT_softbody_simulation(
@@ -1912,22 +2859,35 @@ class PHYSICS_PT_softbody_simulation(
1912
2859
  """ """
1913
2860
 
1914
2861
  def append(self, draw_func):
1915
- """
2862
+ """Append a draw function to this menu,
2863
+ takes the same arguments as the menus draw function
1916
2864
 
1917
- :param draw_func:
2865
+ :param draw_func:
1918
2866
  """
1919
2867
  ...
1920
2868
 
1921
- def as_pointer(self):
1922
- """ """
2869
+ def as_pointer(self) -> int:
2870
+ """Returns the memory address which holds a pointer to Blender's internal data
2871
+
2872
+ :return: int (memory address).
2873
+ :rtype: int
2874
+ """
1923
2875
  ...
1924
2876
 
1925
- def bl_rna_get_subclass(self):
1926
- """ """
2877
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2878
+ """
2879
+
2880
+ :return: The RNA type or default when not found.
2881
+ :rtype: bpy.types.Struct
2882
+ """
1927
2883
  ...
1928
2884
 
1929
- def bl_rna_get_subclass_py(self):
1930
- """ """
2885
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2886
+ """
2887
+
2888
+ :return: The class or default when not found.
2889
+ :rtype: typing.Any
2890
+ """
1931
2891
  ...
1932
2892
 
1933
2893
  def draw(self, context):
@@ -1937,72 +2897,129 @@ class PHYSICS_PT_softbody_simulation(
1937
2897
  """
1938
2898
  ...
1939
2899
 
1940
- def driver_add(self):
1941
- """ """
2900
+ def driver_add(self) -> bpy.types.FCurve:
2901
+ """Adds driver(s) to the given property
2902
+
2903
+ :return: The driver(s) added.
2904
+ :rtype: bpy.types.FCurve
2905
+ """
1942
2906
  ...
1943
2907
 
1944
- def driver_remove(self):
1945
- """ """
2908
+ def driver_remove(self) -> bool:
2909
+ """Remove driver(s) from the given property
2910
+
2911
+ :return: Success of driver removal.
2912
+ :rtype: bool
2913
+ """
1946
2914
  ...
1947
2915
 
1948
2916
  def get(self):
1949
- """ """
2917
+ """Returns the value of the custom property assigned to key or default
2918
+ when not found (matches Python's dictionary function of the same name).
2919
+
2920
+ """
1950
2921
  ...
1951
2922
 
1952
2923
  def id_properties_clear(self):
1953
- """ """
2924
+ """
2925
+
2926
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2927
+ """
1954
2928
  ...
1955
2929
 
1956
2930
  def id_properties_ensure(self):
1957
- """ """
2931
+ """
2932
+
2933
+ :return: the parent group for an RNA struct's custom IDProperties.
2934
+ """
1958
2935
  ...
1959
2936
 
1960
2937
  def id_properties_ui(self):
1961
- """ """
2938
+ """
2939
+
2940
+ :return: Return an object used to manage an IDProperty's UI data.
2941
+ """
1962
2942
  ...
1963
2943
 
1964
2944
  def is_extended(self):
1965
2945
  """ """
1966
2946
  ...
1967
2947
 
1968
- def is_property_hidden(self):
1969
- """ """
2948
+ def is_property_hidden(self) -> bool:
2949
+ """Check if a property is hidden.
2950
+
2951
+ :return: True when the property is hidden.
2952
+ :rtype: bool
2953
+ """
1970
2954
  ...
1971
2955
 
1972
- def is_property_overridable_library(self):
1973
- """ """
2956
+ def is_property_overridable_library(self) -> bool:
2957
+ """Check if a property is overridable.
2958
+
2959
+ :return: True when the property is overridable.
2960
+ :rtype: bool
2961
+ """
1974
2962
  ...
1975
2963
 
1976
- def is_property_readonly(self):
1977
- """ """
2964
+ def is_property_readonly(self) -> bool:
2965
+ """Check if a property is readonly.
2966
+
2967
+ :return: True when the property is readonly (not writable).
2968
+ :rtype: bool
2969
+ """
1978
2970
  ...
1979
2971
 
1980
- def is_property_set(self):
1981
- """ """
2972
+ def is_property_set(self) -> bool:
2973
+ """Check if a property is set, use for testing operator properties.
2974
+
2975
+ :return: True when the property has been set.
2976
+ :rtype: bool
2977
+ """
1982
2978
  ...
1983
2979
 
1984
2980
  def items(self):
1985
- """ """
2981
+ """Returns the items of this objects custom properties (matches Python's
2982
+ dictionary function of the same name).
2983
+
2984
+ :return: custom property key, value pairs.
2985
+ """
1986
2986
  ...
1987
2987
 
1988
- def keyframe_delete(self):
1989
- """ """
2988
+ def keyframe_delete(self) -> bool:
2989
+ """Remove a keyframe from this properties fcurve.
2990
+
2991
+ :return: Success of keyframe deletion.
2992
+ :rtype: bool
2993
+ """
1990
2994
  ...
1991
2995
 
1992
- def keyframe_insert(self):
1993
- """ """
2996
+ def keyframe_insert(self) -> bool:
2997
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2998
+
2999
+ :return: Success of keyframe insertion.
3000
+ :rtype: bool
3001
+ """
3002
+ ...
3003
+
3004
+ def keys(self):
3005
+ """Returns the keys of this objects custom properties (matches Python's
3006
+ dictionary function of the same name).
3007
+
3008
+ :return: custom property keys.
3009
+ """
1994
3010
  ...
1995
3011
 
1996
- def keys(self):
1997
- """ """
1998
- ...
3012
+ def path_from_id(self) -> str:
3013
+ """Returns the data path from the ID to this object (string).
1999
3014
 
2000
- def path_from_id(self):
2001
- """ """
3015
+ :return: The path from `bpy.types.bpy_struct.id_data`
3016
+ to this struct and property (when given).
3017
+ :rtype: str
3018
+ """
2002
3019
  ...
2003
3020
 
2004
3021
  def path_resolve(self):
2005
- """ """
3022
+ """Returns the property from the path, raise an exception when not found."""
2006
3023
  ...
2007
3024
 
2008
3025
  def poll(self, context):
@@ -2013,37 +3030,53 @@ class PHYSICS_PT_softbody_simulation(
2013
3030
  ...
2014
3031
 
2015
3032
  def pop(self):
2016
- """ """
3033
+ """Remove and return the value of the custom property assigned to key or default
3034
+ when not found (matches Python's dictionary function of the same name).
3035
+
3036
+ """
2017
3037
  ...
2018
3038
 
2019
3039
  def prepend(self, draw_func):
2020
- """
3040
+ """Prepend a draw function to this menu, takes the same arguments as
3041
+ the menus draw function
2021
3042
 
2022
- :param draw_func:
3043
+ :param draw_func:
2023
3044
  """
2024
3045
  ...
2025
3046
 
2026
- def property_overridable_library_set(self):
2027
- """ """
3047
+ def property_overridable_library_set(self) -> bool:
3048
+ """Define a property as overridable or not (only for custom properties!).
3049
+
3050
+ :return: True when the overridable status of the property was successfully set.
3051
+ :rtype: bool
3052
+ """
2028
3053
  ...
2029
3054
 
2030
3055
  def property_unset(self):
2031
- """ """
3056
+ """Unset a property, will use default value afterward."""
2032
3057
  ...
2033
3058
 
2034
3059
  def remove(self, draw_func):
2035
- """
3060
+ """Remove a draw function that has been added to this menu
2036
3061
 
2037
3062
  :param draw_func:
2038
3063
  """
2039
3064
  ...
2040
3065
 
2041
3066
  def type_recast(self):
2042
- """ """
3067
+ """Return a new instance, this is needed because types
3068
+ such as textures can be changed at runtime.
3069
+
3070
+ :return: a new instance of this object with the type initialized again.
3071
+ """
2043
3072
  ...
2044
3073
 
2045
3074
  def values(self):
2046
- """ """
3075
+ """Returns the values of this objects custom properties (matches Python's
3076
+ dictionary function of the same name).
3077
+
3078
+ :return: custom property values.
3079
+ """
2047
3080
  ...
2048
3081
 
2049
3082
  class PHYSICS_PT_softbody_solver(
@@ -2079,22 +3112,35 @@ class PHYSICS_PT_softbody_solver(
2079
3112
  """ """
2080
3113
 
2081
3114
  def append(self, draw_func):
2082
- """
3115
+ """Append a draw function to this menu,
3116
+ takes the same arguments as the menus draw function
2083
3117
 
2084
- :param draw_func:
3118
+ :param draw_func:
2085
3119
  """
2086
3120
  ...
2087
3121
 
2088
- def as_pointer(self):
2089
- """ """
3122
+ def as_pointer(self) -> int:
3123
+ """Returns the memory address which holds a pointer to Blender's internal data
3124
+
3125
+ :return: int (memory address).
3126
+ :rtype: int
3127
+ """
2090
3128
  ...
2091
3129
 
2092
- def bl_rna_get_subclass(self):
2093
- """ """
3130
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3131
+ """
3132
+
3133
+ :return: The RNA type or default when not found.
3134
+ :rtype: bpy.types.Struct
3135
+ """
2094
3136
  ...
2095
3137
 
2096
- def bl_rna_get_subclass_py(self):
2097
- """ """
3138
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3139
+ """
3140
+
3141
+ :return: The class or default when not found.
3142
+ :rtype: typing.Any
3143
+ """
2098
3144
  ...
2099
3145
 
2100
3146
  def draw(self, context):
@@ -2104,72 +3150,129 @@ class PHYSICS_PT_softbody_solver(
2104
3150
  """
2105
3151
  ...
2106
3152
 
2107
- def driver_add(self):
2108
- """ """
3153
+ def driver_add(self) -> bpy.types.FCurve:
3154
+ """Adds driver(s) to the given property
3155
+
3156
+ :return: The driver(s) added.
3157
+ :rtype: bpy.types.FCurve
3158
+ """
2109
3159
  ...
2110
3160
 
2111
- def driver_remove(self):
2112
- """ """
3161
+ def driver_remove(self) -> bool:
3162
+ """Remove driver(s) from the given property
3163
+
3164
+ :return: Success of driver removal.
3165
+ :rtype: bool
3166
+ """
2113
3167
  ...
2114
3168
 
2115
3169
  def get(self):
2116
- """ """
3170
+ """Returns the value of the custom property assigned to key or default
3171
+ when not found (matches Python's dictionary function of the same name).
3172
+
3173
+ """
2117
3174
  ...
2118
3175
 
2119
3176
  def id_properties_clear(self):
2120
- """ """
3177
+ """
3178
+
3179
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3180
+ """
2121
3181
  ...
2122
3182
 
2123
3183
  def id_properties_ensure(self):
2124
- """ """
3184
+ """
3185
+
3186
+ :return: the parent group for an RNA struct's custom IDProperties.
3187
+ """
2125
3188
  ...
2126
3189
 
2127
3190
  def id_properties_ui(self):
2128
- """ """
3191
+ """
3192
+
3193
+ :return: Return an object used to manage an IDProperty's UI data.
3194
+ """
2129
3195
  ...
2130
3196
 
2131
3197
  def is_extended(self):
2132
3198
  """ """
2133
3199
  ...
2134
3200
 
2135
- def is_property_hidden(self):
2136
- """ """
3201
+ def is_property_hidden(self) -> bool:
3202
+ """Check if a property is hidden.
3203
+
3204
+ :return: True when the property is hidden.
3205
+ :rtype: bool
3206
+ """
2137
3207
  ...
2138
3208
 
2139
- def is_property_overridable_library(self):
2140
- """ """
3209
+ def is_property_overridable_library(self) -> bool:
3210
+ """Check if a property is overridable.
3211
+
3212
+ :return: True when the property is overridable.
3213
+ :rtype: bool
3214
+ """
2141
3215
  ...
2142
3216
 
2143
- def is_property_readonly(self):
2144
- """ """
3217
+ def is_property_readonly(self) -> bool:
3218
+ """Check if a property is readonly.
3219
+
3220
+ :return: True when the property is readonly (not writable).
3221
+ :rtype: bool
3222
+ """
2145
3223
  ...
2146
3224
 
2147
- def is_property_set(self):
2148
- """ """
3225
+ def is_property_set(self) -> bool:
3226
+ """Check if a property is set, use for testing operator properties.
3227
+
3228
+ :return: True when the property has been set.
3229
+ :rtype: bool
3230
+ """
2149
3231
  ...
2150
3232
 
2151
3233
  def items(self):
2152
- """ """
3234
+ """Returns the items of this objects custom properties (matches Python's
3235
+ dictionary function of the same name).
3236
+
3237
+ :return: custom property key, value pairs.
3238
+ """
2153
3239
  ...
2154
3240
 
2155
- def keyframe_delete(self):
2156
- """ """
3241
+ def keyframe_delete(self) -> bool:
3242
+ """Remove a keyframe from this properties fcurve.
3243
+
3244
+ :return: Success of keyframe deletion.
3245
+ :rtype: bool
3246
+ """
2157
3247
  ...
2158
3248
 
2159
- def keyframe_insert(self):
2160
- """ """
3249
+ def keyframe_insert(self) -> bool:
3250
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3251
+
3252
+ :return: Success of keyframe insertion.
3253
+ :rtype: bool
3254
+ """
2161
3255
  ...
2162
3256
 
2163
3257
  def keys(self):
2164
- """ """
3258
+ """Returns the keys of this objects custom properties (matches Python's
3259
+ dictionary function of the same name).
3260
+
3261
+ :return: custom property keys.
3262
+ """
2165
3263
  ...
2166
3264
 
2167
- def path_from_id(self):
2168
- """ """
3265
+ def path_from_id(self) -> str:
3266
+ """Returns the data path from the ID to this object (string).
3267
+
3268
+ :return: The path from `bpy.types.bpy_struct.id_data`
3269
+ to this struct and property (when given).
3270
+ :rtype: str
3271
+ """
2169
3272
  ...
2170
3273
 
2171
3274
  def path_resolve(self):
2172
- """ """
3275
+ """Returns the property from the path, raise an exception when not found."""
2173
3276
  ...
2174
3277
 
2175
3278
  def poll(self, context):
@@ -2180,37 +3283,53 @@ class PHYSICS_PT_softbody_solver(
2180
3283
  ...
2181
3284
 
2182
3285
  def pop(self):
2183
- """ """
3286
+ """Remove and return the value of the custom property assigned to key or default
3287
+ when not found (matches Python's dictionary function of the same name).
3288
+
3289
+ """
2184
3290
  ...
2185
3291
 
2186
3292
  def prepend(self, draw_func):
2187
- """
3293
+ """Prepend a draw function to this menu, takes the same arguments as
3294
+ the menus draw function
2188
3295
 
2189
- :param draw_func:
3296
+ :param draw_func:
2190
3297
  """
2191
3298
  ...
2192
3299
 
2193
- def property_overridable_library_set(self):
2194
- """ """
3300
+ def property_overridable_library_set(self) -> bool:
3301
+ """Define a property as overridable or not (only for custom properties!).
3302
+
3303
+ :return: True when the overridable status of the property was successfully set.
3304
+ :rtype: bool
3305
+ """
2195
3306
  ...
2196
3307
 
2197
3308
  def property_unset(self):
2198
- """ """
3309
+ """Unset a property, will use default value afterward."""
2199
3310
  ...
2200
3311
 
2201
3312
  def remove(self, draw_func):
2202
- """
3313
+ """Remove a draw function that has been added to this menu
2203
3314
 
2204
3315
  :param draw_func:
2205
3316
  """
2206
3317
  ...
2207
3318
 
2208
3319
  def type_recast(self):
2209
- """ """
3320
+ """Return a new instance, this is needed because types
3321
+ such as textures can be changed at runtime.
3322
+
3323
+ :return: a new instance of this object with the type initialized again.
3324
+ """
2210
3325
  ...
2211
3326
 
2212
3327
  def values(self):
2213
- """ """
3328
+ """Returns the values of this objects custom properties (matches Python's
3329
+ dictionary function of the same name).
3330
+
3331
+ :return: custom property values.
3332
+ """
2214
3333
  ...
2215
3334
 
2216
3335
  class PHYSICS_PT_softbody_solver_diagnostics(
@@ -2246,22 +3365,35 @@ class PHYSICS_PT_softbody_solver_diagnostics(
2246
3365
  """ """
2247
3366
 
2248
3367
  def append(self, draw_func):
2249
- """
3368
+ """Append a draw function to this menu,
3369
+ takes the same arguments as the menus draw function
2250
3370
 
2251
- :param draw_func:
3371
+ :param draw_func:
2252
3372
  """
2253
3373
  ...
2254
3374
 
2255
- def as_pointer(self):
2256
- """ """
3375
+ def as_pointer(self) -> int:
3376
+ """Returns the memory address which holds a pointer to Blender's internal data
3377
+
3378
+ :return: int (memory address).
3379
+ :rtype: int
3380
+ """
2257
3381
  ...
2258
3382
 
2259
- def bl_rna_get_subclass(self):
2260
- """ """
3383
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3384
+ """
3385
+
3386
+ :return: The RNA type or default when not found.
3387
+ :rtype: bpy.types.Struct
3388
+ """
2261
3389
  ...
2262
3390
 
2263
- def bl_rna_get_subclass_py(self):
2264
- """ """
3391
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3392
+ """
3393
+
3394
+ :return: The class or default when not found.
3395
+ :rtype: typing.Any
3396
+ """
2265
3397
  ...
2266
3398
 
2267
3399
  def draw(self, context):
@@ -2271,72 +3403,129 @@ class PHYSICS_PT_softbody_solver_diagnostics(
2271
3403
  """
2272
3404
  ...
2273
3405
 
2274
- def driver_add(self):
2275
- """ """
3406
+ def driver_add(self) -> bpy.types.FCurve:
3407
+ """Adds driver(s) to the given property
3408
+
3409
+ :return: The driver(s) added.
3410
+ :rtype: bpy.types.FCurve
3411
+ """
2276
3412
  ...
2277
3413
 
2278
- def driver_remove(self):
2279
- """ """
3414
+ def driver_remove(self) -> bool:
3415
+ """Remove driver(s) from the given property
3416
+
3417
+ :return: Success of driver removal.
3418
+ :rtype: bool
3419
+ """
2280
3420
  ...
2281
3421
 
2282
3422
  def get(self):
2283
- """ """
3423
+ """Returns the value of the custom property assigned to key or default
3424
+ when not found (matches Python's dictionary function of the same name).
3425
+
3426
+ """
2284
3427
  ...
2285
3428
 
2286
3429
  def id_properties_clear(self):
2287
- """ """
3430
+ """
3431
+
3432
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3433
+ """
2288
3434
  ...
2289
3435
 
2290
3436
  def id_properties_ensure(self):
2291
- """ """
3437
+ """
3438
+
3439
+ :return: the parent group for an RNA struct's custom IDProperties.
3440
+ """
2292
3441
  ...
2293
3442
 
2294
3443
  def id_properties_ui(self):
2295
- """ """
3444
+ """
3445
+
3446
+ :return: Return an object used to manage an IDProperty's UI data.
3447
+ """
2296
3448
  ...
2297
3449
 
2298
3450
  def is_extended(self):
2299
3451
  """ """
2300
3452
  ...
2301
3453
 
2302
- def is_property_hidden(self):
2303
- """ """
3454
+ def is_property_hidden(self) -> bool:
3455
+ """Check if a property is hidden.
3456
+
3457
+ :return: True when the property is hidden.
3458
+ :rtype: bool
3459
+ """
2304
3460
  ...
2305
3461
 
2306
- def is_property_overridable_library(self):
2307
- """ """
3462
+ def is_property_overridable_library(self) -> bool:
3463
+ """Check if a property is overridable.
3464
+
3465
+ :return: True when the property is overridable.
3466
+ :rtype: bool
3467
+ """
2308
3468
  ...
2309
3469
 
2310
- def is_property_readonly(self):
2311
- """ """
3470
+ def is_property_readonly(self) -> bool:
3471
+ """Check if a property is readonly.
3472
+
3473
+ :return: True when the property is readonly (not writable).
3474
+ :rtype: bool
3475
+ """
2312
3476
  ...
2313
3477
 
2314
- def is_property_set(self):
2315
- """ """
3478
+ def is_property_set(self) -> bool:
3479
+ """Check if a property is set, use for testing operator properties.
3480
+
3481
+ :return: True when the property has been set.
3482
+ :rtype: bool
3483
+ """
2316
3484
  ...
2317
3485
 
2318
3486
  def items(self):
2319
- """ """
3487
+ """Returns the items of this objects custom properties (matches Python's
3488
+ dictionary function of the same name).
3489
+
3490
+ :return: custom property key, value pairs.
3491
+ """
2320
3492
  ...
2321
3493
 
2322
- def keyframe_delete(self):
2323
- """ """
3494
+ def keyframe_delete(self) -> bool:
3495
+ """Remove a keyframe from this properties fcurve.
3496
+
3497
+ :return: Success of keyframe deletion.
3498
+ :rtype: bool
3499
+ """
2324
3500
  ...
2325
3501
 
2326
- def keyframe_insert(self):
2327
- """ """
3502
+ def keyframe_insert(self) -> bool:
3503
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3504
+
3505
+ :return: Success of keyframe insertion.
3506
+ :rtype: bool
3507
+ """
2328
3508
  ...
2329
3509
 
2330
3510
  def keys(self):
2331
- """ """
3511
+ """Returns the keys of this objects custom properties (matches Python's
3512
+ dictionary function of the same name).
3513
+
3514
+ :return: custom property keys.
3515
+ """
2332
3516
  ...
2333
3517
 
2334
- def path_from_id(self):
2335
- """ """
3518
+ def path_from_id(self) -> str:
3519
+ """Returns the data path from the ID to this object (string).
3520
+
3521
+ :return: The path from `bpy.types.bpy_struct.id_data`
3522
+ to this struct and property (when given).
3523
+ :rtype: str
3524
+ """
2336
3525
  ...
2337
3526
 
2338
3527
  def path_resolve(self):
2339
- """ """
3528
+ """Returns the property from the path, raise an exception when not found."""
2340
3529
  ...
2341
3530
 
2342
3531
  def poll(self, context):
@@ -2347,37 +3536,53 @@ class PHYSICS_PT_softbody_solver_diagnostics(
2347
3536
  ...
2348
3537
 
2349
3538
  def pop(self):
2350
- """ """
3539
+ """Remove and return the value of the custom property assigned to key or default
3540
+ when not found (matches Python's dictionary function of the same name).
3541
+
3542
+ """
2351
3543
  ...
2352
3544
 
2353
3545
  def prepend(self, draw_func):
2354
- """
3546
+ """Prepend a draw function to this menu, takes the same arguments as
3547
+ the menus draw function
2355
3548
 
2356
- :param draw_func:
3549
+ :param draw_func:
2357
3550
  """
2358
3551
  ...
2359
3552
 
2360
- def property_overridable_library_set(self):
2361
- """ """
3553
+ def property_overridable_library_set(self) -> bool:
3554
+ """Define a property as overridable or not (only for custom properties!).
3555
+
3556
+ :return: True when the overridable status of the property was successfully set.
3557
+ :rtype: bool
3558
+ """
2362
3559
  ...
2363
3560
 
2364
3561
  def property_unset(self):
2365
- """ """
3562
+ """Unset a property, will use default value afterward."""
2366
3563
  ...
2367
3564
 
2368
3565
  def remove(self, draw_func):
2369
- """
3566
+ """Remove a draw function that has been added to this menu
2370
3567
 
2371
3568
  :param draw_func:
2372
3569
  """
2373
3570
  ...
2374
3571
 
2375
3572
  def type_recast(self):
2376
- """ """
3573
+ """Return a new instance, this is needed because types
3574
+ such as textures can be changed at runtime.
3575
+
3576
+ :return: a new instance of this object with the type initialized again.
3577
+ """
2377
3578
  ...
2378
3579
 
2379
3580
  def values(self):
2380
- """ """
3581
+ """Returns the values of this objects custom properties (matches Python's
3582
+ dictionary function of the same name).
3583
+
3584
+ :return: custom property values.
3585
+ """
2381
3586
  ...
2382
3587
 
2383
3588
  class PHYSICS_PT_softbody_solver_helpers(
@@ -2413,22 +3618,35 @@ class PHYSICS_PT_softbody_solver_helpers(
2413
3618
  """ """
2414
3619
 
2415
3620
  def append(self, draw_func):
2416
- """
3621
+ """Append a draw function to this menu,
3622
+ takes the same arguments as the menus draw function
2417
3623
 
2418
- :param draw_func:
3624
+ :param draw_func:
2419
3625
  """
2420
3626
  ...
2421
3627
 
2422
- def as_pointer(self):
2423
- """ """
3628
+ def as_pointer(self) -> int:
3629
+ """Returns the memory address which holds a pointer to Blender's internal data
3630
+
3631
+ :return: int (memory address).
3632
+ :rtype: int
3633
+ """
2424
3634
  ...
2425
3635
 
2426
- def bl_rna_get_subclass(self):
2427
- """ """
3636
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3637
+ """
3638
+
3639
+ :return: The RNA type or default when not found.
3640
+ :rtype: bpy.types.Struct
3641
+ """
2428
3642
  ...
2429
3643
 
2430
- def bl_rna_get_subclass_py(self):
2431
- """ """
3644
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3645
+ """
3646
+
3647
+ :return: The class or default when not found.
3648
+ :rtype: typing.Any
3649
+ """
2432
3650
  ...
2433
3651
 
2434
3652
  def draw(self, context):
@@ -2438,72 +3656,129 @@ class PHYSICS_PT_softbody_solver_helpers(
2438
3656
  """
2439
3657
  ...
2440
3658
 
2441
- def driver_add(self):
2442
- """ """
3659
+ def driver_add(self) -> bpy.types.FCurve:
3660
+ """Adds driver(s) to the given property
3661
+
3662
+ :return: The driver(s) added.
3663
+ :rtype: bpy.types.FCurve
3664
+ """
2443
3665
  ...
2444
3666
 
2445
- def driver_remove(self):
2446
- """ """
3667
+ def driver_remove(self) -> bool:
3668
+ """Remove driver(s) from the given property
3669
+
3670
+ :return: Success of driver removal.
3671
+ :rtype: bool
3672
+ """
2447
3673
  ...
2448
3674
 
2449
3675
  def get(self):
2450
- """ """
3676
+ """Returns the value of the custom property assigned to key or default
3677
+ when not found (matches Python's dictionary function of the same name).
3678
+
3679
+ """
2451
3680
  ...
2452
3681
 
2453
3682
  def id_properties_clear(self):
2454
- """ """
3683
+ """
3684
+
3685
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3686
+ """
2455
3687
  ...
2456
3688
 
2457
3689
  def id_properties_ensure(self):
2458
- """ """
3690
+ """
3691
+
3692
+ :return: the parent group for an RNA struct's custom IDProperties.
3693
+ """
2459
3694
  ...
2460
3695
 
2461
3696
  def id_properties_ui(self):
2462
- """ """
3697
+ """
3698
+
3699
+ :return: Return an object used to manage an IDProperty's UI data.
3700
+ """
2463
3701
  ...
2464
3702
 
2465
3703
  def is_extended(self):
2466
3704
  """ """
2467
3705
  ...
2468
3706
 
2469
- def is_property_hidden(self):
2470
- """ """
3707
+ def is_property_hidden(self) -> bool:
3708
+ """Check if a property is hidden.
3709
+
3710
+ :return: True when the property is hidden.
3711
+ :rtype: bool
3712
+ """
2471
3713
  ...
2472
3714
 
2473
- def is_property_overridable_library(self):
2474
- """ """
3715
+ def is_property_overridable_library(self) -> bool:
3716
+ """Check if a property is overridable.
3717
+
3718
+ :return: True when the property is overridable.
3719
+ :rtype: bool
3720
+ """
2475
3721
  ...
2476
3722
 
2477
- def is_property_readonly(self):
2478
- """ """
3723
+ def is_property_readonly(self) -> bool:
3724
+ """Check if a property is readonly.
3725
+
3726
+ :return: True when the property is readonly (not writable).
3727
+ :rtype: bool
3728
+ """
2479
3729
  ...
2480
3730
 
2481
- def is_property_set(self):
2482
- """ """
3731
+ def is_property_set(self) -> bool:
3732
+ """Check if a property is set, use for testing operator properties.
3733
+
3734
+ :return: True when the property has been set.
3735
+ :rtype: bool
3736
+ """
2483
3737
  ...
2484
3738
 
2485
3739
  def items(self):
2486
- """ """
3740
+ """Returns the items of this objects custom properties (matches Python's
3741
+ dictionary function of the same name).
3742
+
3743
+ :return: custom property key, value pairs.
3744
+ """
2487
3745
  ...
2488
3746
 
2489
- def keyframe_delete(self):
2490
- """ """
3747
+ def keyframe_delete(self) -> bool:
3748
+ """Remove a keyframe from this properties fcurve.
3749
+
3750
+ :return: Success of keyframe deletion.
3751
+ :rtype: bool
3752
+ """
2491
3753
  ...
2492
3754
 
2493
- def keyframe_insert(self):
2494
- """ """
3755
+ def keyframe_insert(self) -> bool:
3756
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3757
+
3758
+ :return: Success of keyframe insertion.
3759
+ :rtype: bool
3760
+ """
2495
3761
  ...
2496
3762
 
2497
3763
  def keys(self):
2498
- """ """
3764
+ """Returns the keys of this objects custom properties (matches Python's
3765
+ dictionary function of the same name).
3766
+
3767
+ :return: custom property keys.
3768
+ """
2499
3769
  ...
2500
3770
 
2501
- def path_from_id(self):
2502
- """ """
3771
+ def path_from_id(self) -> str:
3772
+ """Returns the data path from the ID to this object (string).
3773
+
3774
+ :return: The path from `bpy.types.bpy_struct.id_data`
3775
+ to this struct and property (when given).
3776
+ :rtype: str
3777
+ """
2503
3778
  ...
2504
3779
 
2505
3780
  def path_resolve(self):
2506
- """ """
3781
+ """Returns the property from the path, raise an exception when not found."""
2507
3782
  ...
2508
3783
 
2509
3784
  def poll(self, context):
@@ -2514,37 +3789,53 @@ class PHYSICS_PT_softbody_solver_helpers(
2514
3789
  ...
2515
3790
 
2516
3791
  def pop(self):
2517
- """ """
3792
+ """Remove and return the value of the custom property assigned to key or default
3793
+ when not found (matches Python's dictionary function of the same name).
3794
+
3795
+ """
2518
3796
  ...
2519
3797
 
2520
3798
  def prepend(self, draw_func):
2521
- """
3799
+ """Prepend a draw function to this menu, takes the same arguments as
3800
+ the menus draw function
2522
3801
 
2523
- :param draw_func:
3802
+ :param draw_func:
2524
3803
  """
2525
3804
  ...
2526
3805
 
2527
- def property_overridable_library_set(self):
2528
- """ """
3806
+ def property_overridable_library_set(self) -> bool:
3807
+ """Define a property as overridable or not (only for custom properties!).
3808
+
3809
+ :return: True when the overridable status of the property was successfully set.
3810
+ :rtype: bool
3811
+ """
2529
3812
  ...
2530
3813
 
2531
3814
  def property_unset(self):
2532
- """ """
3815
+ """Unset a property, will use default value afterward."""
2533
3816
  ...
2534
3817
 
2535
3818
  def remove(self, draw_func):
2536
- """
3819
+ """Remove a draw function that has been added to this menu
2537
3820
 
2538
3821
  :param draw_func:
2539
3822
  """
2540
3823
  ...
2541
3824
 
2542
3825
  def type_recast(self):
2543
- """ """
3826
+ """Return a new instance, this is needed because types
3827
+ such as textures can be changed at runtime.
3828
+
3829
+ :return: a new instance of this object with the type initialized again.
3830
+ """
2544
3831
  ...
2545
3832
 
2546
3833
  def values(self):
2547
- """ """
3834
+ """Returns the values of this objects custom properties (matches Python's
3835
+ dictionary function of the same name).
3836
+
3837
+ :return: custom property values.
3838
+ """
2548
3839
  ...
2549
3840
 
2550
3841
  def softbody_panel_enabled(md):