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