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