fake-bpy-module 20240516__py3-none-any.whl → 20240517__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

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