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

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

Potentially problematic release.


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

Files changed (549) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +17 -84
  2. addon_utils/__init__.pyi +44 -38
  3. animsys_refactor/__init__.pyi +7 -27
  4. aud/__init__.pyi +8 -11
  5. bgl/__init__.pyi +121 -1812
  6. bl_app_override/__init__.pyi +8 -19
  7. bl_app_override/helpers/__init__.pyi +5 -23
  8. bl_app_template_utils/__init__.pyi +5 -17
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
  14. bl_i18n_utils/merge_po/__init__.pyi +1 -4
  15. bl_i18n_utils/settings/__init__.pyi +6 -24
  16. bl_i18n_utils/utils/__init__.pyi +93 -122
  17. bl_i18n_utils/utils_cli/__init__.pyi +6 -29
  18. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
  19. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  20. bl_keymap_utils/io/__init__.pyi +9 -40
  21. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  22. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
  23. bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
  24. bl_keymap_utils/versioning/__init__.pyi +1 -4
  25. bl_operators/__init__.pyi +2 -9
  26. bl_operators/add_mesh_torus/__init__.pyi +128 -59
  27. bl_operators/anim/__init__.pyi +1001 -398
  28. bl_operators/assets/__init__.pyi +376 -152
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
  30. bl_operators/clip/__init__.pyi +1264 -532
  31. bl_operators/console/__init__.pyi +626 -242
  32. bl_operators/constraint/__init__.pyi +502 -201
  33. bl_operators/file/__init__.pyi +376 -150
  34. bl_operators/freestyle/__init__.pyi +501 -200
  35. bl_operators/geometry_nodes/__init__.pyi +514 -266
  36. bl_operators/image/__init__.pyi +621 -251
  37. bl_operators/mesh/__init__.pyi +376 -150
  38. bl_operators/node/__init__.pyi +1253 -516
  39. bl_operators/object/__init__.pyi +1879 -755
  40. bl_operators/object_align/__init__.pyi +129 -64
  41. bl_operators/object_quick_effects/__init__.pyi +504 -213
  42. bl_operators/object_randomize_transform/__init__.pyi +129 -54
  43. bl_operators/presets/__init__.pyi +3072 -1403
  44. bl_operators/rigidbody/__init__.pyi +376 -150
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
  46. bl_operators/sequencer/__init__.pyi +1010 -434
  47. bl_operators/spreadsheet/__init__.pyi +126 -50
  48. bl_operators/userpref/__init__.pyi +3253 -1267
  49. bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
  50. bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
  51. bl_operators/uvcalc_transform/__init__.pyi +297 -159
  52. bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
  53. bl_operators/view3d/__init__.pyi +868 -342
  54. bl_operators/wm/__init__.pyi +5795 -2388
  55. bl_operators/world/__init__.pyi +126 -50
  56. bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
  57. bl_rna_utils/data_path/__init__.pyi +8 -4
  58. bl_text_utils/external_editor/__init__.pyi +1 -4
  59. bl_ui/__init__.pyi +366 -269
  60. bl_ui/anim/__init__.pyi +164 -74
  61. bl_ui/asset_shelf/__init__.pyi +129 -56
  62. bl_ui/generic_ui_list/__init__.pyi +412 -163
  63. bl_ui/node_add_menu/__init__.pyi +171 -94
  64. bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
  65. bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
  66. bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
  67. bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
  68. bl_ui/properties_animviz/__init__.pyi +2 -16
  69. bl_ui/properties_collection/__init__.pyi +807 -379
  70. bl_ui/properties_constraint/__init__.pyi +10292 -4941
  71. bl_ui/properties_data_armature/__init__.pyi +1615 -753
  72. bl_ui/properties_data_bone/__init__.pyi +1284 -608
  73. bl_ui/properties_data_camera/__init__.pyi +1854 -927
  74. bl_ui/properties_data_curve/__init__.pyi +1927 -937
  75. bl_ui/properties_data_curves/__init__.pyi +806 -375
  76. bl_ui/properties_data_empty/__init__.pyi +257 -125
  77. bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
  79. bl_ui/properties_data_lattice/__init__.pyi +388 -188
  80. bl_ui/properties_data_light/__init__.pyi +1540 -756
  81. bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
  82. bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
  83. bl_ui/properties_data_metaball/__init__.pyi +644 -308
  84. bl_ui/properties_data_modifier/__init__.pyi +1353 -671
  85. bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
  86. bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
  87. bl_ui/properties_data_speaker/__init__.pyi +644 -316
  88. bl_ui/properties_data_volume/__init__.pyi +1028 -484
  89. bl_ui/properties_freestyle/__init__.pyi +3112 -1619
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
  91. bl_ui/properties_mask_common/__init__.pyi +1102 -523
  92. bl_ui/properties_material/__init__.pyi +2089 -1009
  93. bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
  94. bl_ui/properties_object/__init__.pyi +1832 -873
  95. bl_ui/properties_output/__init__.pyi +2405 -1173
  96. bl_ui/properties_paint_common/__init__.pyi +416 -386
  97. bl_ui/properties_particle/__init__.pyi +6740 -3346
  98. bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
  99. bl_ui/properties_physics_common/__init__.pyi +135 -98
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
  101. bl_ui/properties_physics_field/__init__.pyi +1282 -627
  102. bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
  106. bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
  107. bl_ui/properties_render/__init__.pyi +6843 -3367
  108. bl_ui/properties_scene/__init__.pyi +1924 -913
  109. bl_ui/properties_texture/__init__.pyi +3371 -1667
  110. bl_ui/properties_view_layer/__init__.pyi +2344 -1107
  111. bl_ui/properties_workspace/__init__.pyi +516 -244
  112. bl_ui/properties_world/__init__.pyi +1284 -630
  113. bl_ui/space_clip/__init__.pyi +10172 -4695
  114. bl_ui/space_console/__init__.pyi +940 -423
  115. bl_ui/space_dopesheet/__init__.pyi +4325 -2013
  116. bl_ui/space_filebrowser/__init__.pyi +4172 -1903
  117. bl_ui/space_graph/__init__.pyi +3107 -1394
  118. bl_ui/space_image/__init__.pyi +9764 -4614
  119. bl_ui/space_info/__init__.pyi +939 -421
  120. bl_ui/space_nla/__init__.pyi +2623 -1183
  121. bl_ui/space_node/__init__.pyi +3995 -1840
  122. bl_ui/space_outliner/__init__.pyi +2203 -991
  123. bl_ui/space_properties/__init__.pyi +386 -165
  124. bl_ui/space_sequencer/__init__.pyi +10809 -4978
  125. bl_ui/space_spreadsheet/__init__.pyi +130 -53
  126. bl_ui/space_statusbar/__init__.pyi +129 -52
  127. bl_ui/space_text/__init__.pyi +2457 -1100
  128. bl_ui/space_time/__init__.pyi +1034 -481
  129. bl_ui/space_toolsystem_common/__init__.pyi +56 -211
  130. bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
  131. bl_ui/space_topbar/__init__.pyi +3982 -1805
  132. bl_ui/space_userpref/__init__.pyi +11383 -5290
  133. bl_ui/space_view3d/__init__.pyi +40873 -18532
  134. bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
  135. bl_ui/temp_anim_layers/__init__.pyi +130 -62
  136. bl_ui/utils/__init__.pyi +28 -27
  137. bl_ui_utils/bug_report_url/__init__.pyi +1 -4
  138. bl_ui_utils/layout/__init__.pyi +1 -1
  139. blend_render_info/__init__.pyi +3 -10
  140. blf/__init__.pyi +4 -4
  141. bmesh/geometry/__init__.pyi +2 -3
  142. bmesh/ops/__init__.pyi +372 -419
  143. bmesh/types/__init__.pyi +39 -56
  144. bmesh/utils/__init__.pyi +10 -13
  145. bpy/app/__init__.pyi +4 -4
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -8
  148. bpy/app/timers/__init__.pyi +10 -10
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +2 -4
  151. bpy/ops/action/__init__.pyi +316 -394
  152. bpy/ops/anim/__init__.pyi +442 -548
  153. bpy/ops/armature/__init__.pyi +374 -470
  154. bpy/ops/asset/__init__.pyi +152 -184
  155. bpy/ops/bl_pkg/__init__.pyi +221 -272
  156. bpy/ops/boid/__init__.pyi +50 -66
  157. bpy/ops/brush/__init__.pyi +72 -90
  158. bpy/ops/buttons/__init__.pyi +132 -144
  159. bpy/ops/cachefile/__init__.pyi +128 -138
  160. bpy/ops/camera/__init__.pyi +26 -30
  161. bpy/ops/clip/__init__.pyi +777 -964
  162. bpy/ops/cloth/__init__.pyi +12 -14
  163. bpy/ops/collection/__init__.pyi +68 -86
  164. bpy/ops/console/__init__.pyi +158 -200
  165. bpy/ops/constraint/__init__.pyi +178 -214
  166. bpy/ops/curve/__init__.pyi +473 -576
  167. bpy/ops/curves/__init__.pyi +247 -302
  168. bpy/ops/cycles/__init__.pyi +28 -34
  169. bpy/ops/dpaint/__init__.pyi +34 -44
  170. bpy/ops/ed/__init__.pyi +126 -150
  171. bpy/ops/export_anim/__init__.pyi +22 -24
  172. bpy/ops/export_scene/__init__.pyi +302 -336
  173. bpy/ops/file/__init__.pyi +352 -432
  174. bpy/ops/fluid/__init__.pyi +90 -118
  175. bpy/ops/font/__init__.pyi +258 -304
  176. bpy/ops/geometry/__init__.pyi +100 -120
  177. bpy/ops/gizmogroup/__init__.pyi +22 -26
  178. bpy/ops/gpencil/__init__.pyi +1469 -1778
  179. bpy/ops/graph/__init__.pyi +644 -776
  180. bpy/ops/grease_pencil/__init__.pyi +597 -748
  181. bpy/ops/image/__init__.pyi +648 -744
  182. bpy/ops/import_anim/__init__.pyi +30 -32
  183. bpy/ops/import_curve/__init__.pyi +10 -12
  184. bpy/ops/import_scene/__init__.pyi +88 -96
  185. bpy/ops/info/__init__.pyi +60 -74
  186. bpy/ops/lattice/__init__.pyi +64 -80
  187. bpy/ops/marker/__init__.pyi +108 -130
  188. bpy/ops/mask/__init__.pyi +322 -402
  189. bpy/ops/material/__init__.pyi +18 -24
  190. bpy/ops/mball/__init__.pyi +70 -86
  191. bpy/ops/mesh/__init__.pyi +1986 -2322
  192. bpy/ops/nla/__init__.pyi +333 -411
  193. bpy/ops/node/__init__.pyi +886 -1100
  194. bpy/ops/object/__init__.pyi +2585 -3078
  195. bpy/ops/outliner/__init__.pyi +498 -636
  196. bpy/ops/paint/__init__.pyi +565 -680
  197. bpy/ops/paintcurve/__init__.pyi +64 -80
  198. bpy/ops/palette/__init__.pyi +50 -64
  199. bpy/ops/particle/__init__.pyi +267 -340
  200. bpy/ops/pose/__init__.pyi +336 -414
  201. bpy/ops/poselib/__init__.pyi +72 -90
  202. bpy/ops/preferences/__init__.pyi +386 -463
  203. bpy/ops/ptcache/__init__.pyi +46 -60
  204. bpy/ops/render/__init__.pyi +130 -154
  205. bpy/ops/rigidbody/__init__.pyi +102 -128
  206. bpy/ops/scene/__init__.pyi +280 -358
  207. bpy/ops/screen/__init__.pyi +382 -460
  208. bpy/ops/script/__init__.pyi +24 -30
  209. bpy/ops/sculpt/__init__.pyi +458 -532
  210. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  211. bpy/ops/sequencer/__init__.pyi +1066 -1244
  212. bpy/ops/sound/__init__.pyi +216 -230
  213. bpy/ops/spreadsheet/__init__.pyi +30 -38
  214. bpy/ops/surface/__init__.pyi +108 -120
  215. bpy/ops/text/__init__.pyi +390 -476
  216. bpy/ops/text_editor/__init__.pyi +12 -14
  217. bpy/ops/texture/__init__.pyi +26 -34
  218. bpy/ops/transform/__init__.pyi +792 -878
  219. bpy/ops/ui/__init__.pyi +228 -294
  220. bpy/ops/uilist/__init__.pyi +32 -38
  221. bpy/ops/uv/__init__.pyi +602 -704
  222. bpy/ops/view2d/__init__.pyi +156 -184
  223. bpy/ops/view3d/__init__.pyi +582 -718
  224. bpy/ops/wm/__init__.pyi +2683 -2928
  225. bpy/ops/workspace/__init__.pyi +46 -60
  226. bpy/ops/world/__init__.pyi +12 -16
  227. bpy/path/__init__.pyi +179 -75
  228. bpy/props/__init__.pyi +261 -263
  229. bpy/types/__init__.pyi +17058 -26311
  230. bpy/utils/__init__.pyi +247 -179
  231. bpy/utils/previews/__init__.pyi +58 -28
  232. bpy/utils/units/__init__.pyi +20 -20
  233. bpy_extras/anim_utils/__init__.pyi +68 -29
  234. bpy_extras/asset_utils/__init__.pyi +0 -10
  235. bpy_extras/bmesh_utils/__init__.pyi +9 -6
  236. bpy_extras/extensions/junction_module/__init__.pyi +6 -8
  237. bpy_extras/id_map_utils/__init__.pyi +3 -3
  238. bpy_extras/image_utils/__init__.pyi +44 -11
  239. bpy_extras/io_utils/__init__.pyi +116 -41
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -11
  241. bpy_extras/mesh_utils/__init__.pyi +71 -19
  242. bpy_extras/node_shader_utils/__init__.pyi +52 -288
  243. bpy_extras/node_utils/__init__.pyi +10 -10
  244. bpy_extras/object_utils/__init__.pyi +71 -14
  245. bpy_extras/view3d_utils/__init__.pyi +80 -10
  246. bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
  247. bpy_restrict_state/__init__.pyi +1 -14
  248. bpy_types/__init__.pyi +4203 -1605
  249. console_python/__init__.pyi +12 -37
  250. console_shell/__init__.pyi +5 -24
  251. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20240518.dist-info/RECORD +353 -0
  253. freestyle/chainingiterators/__init__.pyi +14 -44
  254. freestyle/functions/__init__.pyi +7 -33
  255. freestyle/predicates/__init__.pyi +44 -217
  256. freestyle/shaders/__init__.pyi +2 -12
  257. freestyle/types/__init__.pyi +84 -96
  258. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  259. freestyle/utils/__init__.pyi +6 -18
  260. gpu/matrix/__init__.pyi +6 -8
  261. gpu/state/__init__.pyi +2 -2
  262. gpu/types/__init__.pyi +12 -12
  263. gpu_extras/presets/__init__.pyi +2 -5
  264. graphviz_export/__init__.pyi +4 -9
  265. idprop/types/__init__.pyi +8 -35
  266. imbuf/__init__.pyi +4 -4
  267. imbuf/types/__init__.pyi +0 -2
  268. keyingsets_builtins/__init__.pyi +2692 -997
  269. keyingsets_utils/__init__.pyi +14 -69
  270. mathutils/__init__.pyi +194 -238
  271. mathutils/bvhtree/__init__.pyi +4 -6
  272. mathutils/geometry/__init__.pyi +153 -155
  273. mathutils/kdtree/__init__.pyi +8 -12
  274. mathutils/noise/__init__.pyi +26 -26
  275. nodeitems_builtins/__init__.pyi +5 -30
  276. nodeitems_utils/__init__.pyi +8 -45
  277. rna_info/__init__.pyi +39 -215
  278. rna_keymap_ui/__init__.pyi +6 -29
  279. rna_prop_ui/__init__.pyi +24 -62
  280. rna_xml/__init__.pyi +16 -39
  281. sys_info/__init__.pyi +1 -4
  282. _bpy_internal/freedesktop/py.typed +0 -0
  283. bl_app_override/helpers/py.typed +0 -0
  284. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  285. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  286. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  287. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  288. bl_console_utils/autocomplete/py.typed +0 -0
  289. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  290. bl_i18n_utils/merge_po/py.typed +0 -0
  291. bl_i18n_utils/settings/py.typed +0 -0
  292. bl_i18n_utils/utils/py.typed +0 -0
  293. bl_i18n_utils/utils_cli/py.typed +0 -0
  294. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  295. bl_i18n_utils/utils_rtl/py.typed +0 -0
  296. bl_keymap_utils/io/py.typed +0 -0
  297. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  298. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  299. bl_keymap_utils/platform_helpers/py.typed +0 -0
  300. bl_keymap_utils/versioning/py.typed +0 -0
  301. bl_operators/add_mesh_torus/py.typed +0 -0
  302. bl_operators/anim/py.typed +0 -0
  303. bl_operators/assets/py.typed +0 -0
  304. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  305. bl_operators/bmesh/py.typed +0 -0
  306. bl_operators/clip/py.typed +0 -0
  307. bl_operators/console/py.typed +0 -0
  308. bl_operators/constraint/py.typed +0 -0
  309. bl_operators/file/py.typed +0 -0
  310. bl_operators/freestyle/py.typed +0 -0
  311. bl_operators/geometry_nodes/py.typed +0 -0
  312. bl_operators/image/py.typed +0 -0
  313. bl_operators/mesh/py.typed +0 -0
  314. bl_operators/node/py.typed +0 -0
  315. bl_operators/object/py.typed +0 -0
  316. bl_operators/object_align/py.typed +0 -0
  317. bl_operators/object_quick_effects/py.typed +0 -0
  318. bl_operators/object_randomize_transform/py.typed +0 -0
  319. bl_operators/presets/py.typed +0 -0
  320. bl_operators/rigidbody/py.typed +0 -0
  321. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  322. bl_operators/sequencer/py.typed +0 -0
  323. bl_operators/spreadsheet/py.typed +0 -0
  324. bl_operators/userpref/py.typed +0 -0
  325. bl_operators/uvcalc_follow_active/py.typed +0 -0
  326. bl_operators/uvcalc_lightmap/py.typed +0 -0
  327. bl_operators/uvcalc_transform/py.typed +0 -0
  328. bl_operators/vertexpaint_dirt/py.typed +0 -0
  329. bl_operators/view3d/py.typed +0 -0
  330. bl_operators/wm/py.typed +0 -0
  331. bl_operators/world/py.typed +0 -0
  332. bl_previews_utils/bl_previews_render/py.typed +0 -0
  333. bl_rna_utils/data_path/py.typed +0 -0
  334. bl_text_utils/external_editor/py.typed +0 -0
  335. bl_ui/anim/py.typed +0 -0
  336. bl_ui/asset_shelf/py.typed +0 -0
  337. bl_ui/generic_ui_list/py.typed +0 -0
  338. bl_ui/node_add_menu/py.typed +0 -0
  339. bl_ui/node_add_menu_compositor/py.typed +0 -0
  340. bl_ui/node_add_menu_geometry/py.typed +0 -0
  341. bl_ui/node_add_menu_shader/py.typed +0 -0
  342. bl_ui/node_add_menu_texture/py.typed +0 -0
  343. bl_ui/properties_animviz/py.typed +0 -0
  344. bl_ui/properties_collection/py.typed +0 -0
  345. bl_ui/properties_constraint/py.typed +0 -0
  346. bl_ui/properties_data_armature/py.typed +0 -0
  347. bl_ui/properties_data_bone/py.typed +0 -0
  348. bl_ui/properties_data_camera/py.typed +0 -0
  349. bl_ui/properties_data_curve/py.typed +0 -0
  350. bl_ui/properties_data_curves/py.typed +0 -0
  351. bl_ui/properties_data_empty/py.typed +0 -0
  352. bl_ui/properties_data_gpencil/py.typed +0 -0
  353. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  354. bl_ui/properties_data_lattice/py.typed +0 -0
  355. bl_ui/properties_data_light/py.typed +0 -0
  356. bl_ui/properties_data_lightprobe/py.typed +0 -0
  357. bl_ui/properties_data_mesh/py.typed +0 -0
  358. bl_ui/properties_data_metaball/py.typed +0 -0
  359. bl_ui/properties_data_modifier/py.typed +0 -0
  360. bl_ui/properties_data_pointcloud/py.typed +0 -0
  361. bl_ui/properties_data_shaderfx/py.typed +0 -0
  362. bl_ui/properties_data_speaker/py.typed +0 -0
  363. bl_ui/properties_data_volume/py.typed +0 -0
  364. bl_ui/properties_freestyle/py.typed +0 -0
  365. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  366. bl_ui/properties_mask_common/py.typed +0 -0
  367. bl_ui/properties_material/py.typed +0 -0
  368. bl_ui/properties_material_gpencil/py.typed +0 -0
  369. bl_ui/properties_object/py.typed +0 -0
  370. bl_ui/properties_output/py.typed +0 -0
  371. bl_ui/properties_paint_common/py.typed +0 -0
  372. bl_ui/properties_particle/py.typed +0 -0
  373. bl_ui/properties_physics_cloth/py.typed +0 -0
  374. bl_ui/properties_physics_common/py.typed +0 -0
  375. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  376. bl_ui/properties_physics_field/py.typed +0 -0
  377. bl_ui/properties_physics_fluid/py.typed +0 -0
  378. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  379. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  380. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  381. bl_ui/properties_physics_softbody/py.typed +0 -0
  382. bl_ui/properties_render/py.typed +0 -0
  383. bl_ui/properties_scene/py.typed +0 -0
  384. bl_ui/properties_texture/py.typed +0 -0
  385. bl_ui/properties_view_layer/py.typed +0 -0
  386. bl_ui/properties_workspace/py.typed +0 -0
  387. bl_ui/properties_world/py.typed +0 -0
  388. bl_ui/space_clip/py.typed +0 -0
  389. bl_ui/space_console/py.typed +0 -0
  390. bl_ui/space_dopesheet/py.typed +0 -0
  391. bl_ui/space_filebrowser/py.typed +0 -0
  392. bl_ui/space_graph/py.typed +0 -0
  393. bl_ui/space_image/py.typed +0 -0
  394. bl_ui/space_info/py.typed +0 -0
  395. bl_ui/space_nla/py.typed +0 -0
  396. bl_ui/space_node/py.typed +0 -0
  397. bl_ui/space_outliner/py.typed +0 -0
  398. bl_ui/space_properties/py.typed +0 -0
  399. bl_ui/space_sequencer/py.typed +0 -0
  400. bl_ui/space_spreadsheet/py.typed +0 -0
  401. bl_ui/space_statusbar/py.typed +0 -0
  402. bl_ui/space_text/py.typed +0 -0
  403. bl_ui/space_time/py.typed +0 -0
  404. bl_ui/space_toolsystem_common/py.typed +0 -0
  405. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  406. bl_ui/space_topbar/py.typed +0 -0
  407. bl_ui/space_userpref/py.typed +0 -0
  408. bl_ui/space_view3d/py.typed +0 -0
  409. bl_ui/space_view3d_toolbar/py.typed +0 -0
  410. bl_ui/temp_anim_layers/py.typed +0 -0
  411. bl_ui/utils/py.typed +0 -0
  412. bl_ui_utils/bug_report_url/py.typed +0 -0
  413. bl_ui_utils/layout/py.typed +0 -0
  414. bmesh/geometry/py.typed +0 -0
  415. bmesh/ops/py.typed +0 -0
  416. bmesh/types/py.typed +0 -0
  417. bmesh/utils/py.typed +0 -0
  418. bpy/app/handlers/py.typed +0 -0
  419. bpy/app/icons/py.typed +0 -0
  420. bpy/app/py.typed +0 -0
  421. bpy/app/timers/py.typed +0 -0
  422. bpy/app/translations/py.typed +0 -0
  423. bpy/msgbus/py.typed +0 -0
  424. bpy/ops/action/py.typed +0 -0
  425. bpy/ops/anim/py.typed +0 -0
  426. bpy/ops/armature/py.typed +0 -0
  427. bpy/ops/asset/py.typed +0 -0
  428. bpy/ops/bl_pkg/py.typed +0 -0
  429. bpy/ops/boid/py.typed +0 -0
  430. bpy/ops/brush/py.typed +0 -0
  431. bpy/ops/buttons/py.typed +0 -0
  432. bpy/ops/cachefile/py.typed +0 -0
  433. bpy/ops/camera/py.typed +0 -0
  434. bpy/ops/clip/py.typed +0 -0
  435. bpy/ops/cloth/py.typed +0 -0
  436. bpy/ops/collection/py.typed +0 -0
  437. bpy/ops/console/py.typed +0 -0
  438. bpy/ops/constraint/py.typed +0 -0
  439. bpy/ops/curve/py.typed +0 -0
  440. bpy/ops/curves/py.typed +0 -0
  441. bpy/ops/cycles/py.typed +0 -0
  442. bpy/ops/dpaint/py.typed +0 -0
  443. bpy/ops/ed/py.typed +0 -0
  444. bpy/ops/export_anim/py.typed +0 -0
  445. bpy/ops/export_scene/py.typed +0 -0
  446. bpy/ops/file/py.typed +0 -0
  447. bpy/ops/fluid/py.typed +0 -0
  448. bpy/ops/font/py.typed +0 -0
  449. bpy/ops/geometry/py.typed +0 -0
  450. bpy/ops/gizmogroup/py.typed +0 -0
  451. bpy/ops/gpencil/py.typed +0 -0
  452. bpy/ops/graph/py.typed +0 -0
  453. bpy/ops/grease_pencil/py.typed +0 -0
  454. bpy/ops/image/py.typed +0 -0
  455. bpy/ops/import_anim/py.typed +0 -0
  456. bpy/ops/import_curve/py.typed +0 -0
  457. bpy/ops/import_scene/py.typed +0 -0
  458. bpy/ops/info/py.typed +0 -0
  459. bpy/ops/lattice/py.typed +0 -0
  460. bpy/ops/marker/py.typed +0 -0
  461. bpy/ops/mask/py.typed +0 -0
  462. bpy/ops/material/py.typed +0 -0
  463. bpy/ops/mball/py.typed +0 -0
  464. bpy/ops/mesh/py.typed +0 -0
  465. bpy/ops/nla/py.typed +0 -0
  466. bpy/ops/node/py.typed +0 -0
  467. bpy/ops/object/py.typed +0 -0
  468. bpy/ops/outliner/py.typed +0 -0
  469. bpy/ops/paint/py.typed +0 -0
  470. bpy/ops/paintcurve/py.typed +0 -0
  471. bpy/ops/palette/py.typed +0 -0
  472. bpy/ops/particle/py.typed +0 -0
  473. bpy/ops/pose/py.typed +0 -0
  474. bpy/ops/poselib/py.typed +0 -0
  475. bpy/ops/preferences/py.typed +0 -0
  476. bpy/ops/ptcache/py.typed +0 -0
  477. bpy/ops/py.typed +0 -0
  478. bpy/ops/render/py.typed +0 -0
  479. bpy/ops/rigidbody/py.typed +0 -0
  480. bpy/ops/scene/py.typed +0 -0
  481. bpy/ops/screen/py.typed +0 -0
  482. bpy/ops/script/py.typed +0 -0
  483. bpy/ops/sculpt/py.typed +0 -0
  484. bpy/ops/sculpt_curves/py.typed +0 -0
  485. bpy/ops/sequencer/py.typed +0 -0
  486. bpy/ops/sound/py.typed +0 -0
  487. bpy/ops/spreadsheet/py.typed +0 -0
  488. bpy/ops/surface/py.typed +0 -0
  489. bpy/ops/text/py.typed +0 -0
  490. bpy/ops/text_editor/py.typed +0 -0
  491. bpy/ops/texture/py.typed +0 -0
  492. bpy/ops/transform/py.typed +0 -0
  493. bpy/ops/ui/py.typed +0 -0
  494. bpy/ops/uilist/py.typed +0 -0
  495. bpy/ops/uv/py.typed +0 -0
  496. bpy/ops/view2d/py.typed +0 -0
  497. bpy/ops/view3d/py.typed +0 -0
  498. bpy/ops/wm/py.typed +0 -0
  499. bpy/ops/workspace/py.typed +0 -0
  500. bpy/ops/world/py.typed +0 -0
  501. bpy/path/py.typed +0 -0
  502. bpy/props/py.typed +0 -0
  503. bpy/types/py.typed +0 -0
  504. bpy/utils/previews/py.typed +0 -0
  505. bpy/utils/py.typed +0 -0
  506. bpy/utils/units/py.typed +0 -0
  507. bpy_extras/anim_utils/py.typed +0 -0
  508. bpy_extras/asset_utils/py.typed +0 -0
  509. bpy_extras/bmesh_utils/py.typed +0 -0
  510. bpy_extras/extensions/junction_module/py.typed +0 -0
  511. bpy_extras/extensions/py.typed +0 -0
  512. bpy_extras/id_map_utils/py.typed +0 -0
  513. bpy_extras/image_utils/py.typed +0 -0
  514. bpy_extras/io_utils/py.typed +0 -0
  515. bpy_extras/keyconfig_utils/py.typed +0 -0
  516. bpy_extras/mesh_utils/py.typed +0 -0
  517. bpy_extras/node_shader_utils/py.typed +0 -0
  518. bpy_extras/node_utils/py.typed +0 -0
  519. bpy_extras/object_utils/py.typed +0 -0
  520. bpy_extras/view3d_utils/py.typed +0 -0
  521. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  522. bpy_extras/wm_utils/py.typed +0 -0
  523. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  524. freestyle/chainingiterators/py.typed +0 -0
  525. freestyle/functions/py.typed +0 -0
  526. freestyle/predicates/py.typed +0 -0
  527. freestyle/shaders/py.typed +0 -0
  528. freestyle/types/py.typed +0 -0
  529. freestyle/utils/ContextFunctions/py.typed +0 -0
  530. freestyle/utils/py.typed +0 -0
  531. gpu/capabilities/py.typed +0 -0
  532. gpu/matrix/py.typed +0 -0
  533. gpu/platform/py.typed +0 -0
  534. gpu/select/py.typed +0 -0
  535. gpu/shader/py.typed +0 -0
  536. gpu/state/py.typed +0 -0
  537. gpu/texture/py.typed +0 -0
  538. gpu/types/py.typed +0 -0
  539. gpu_extras/batch/py.typed +0 -0
  540. gpu_extras/presets/py.typed +0 -0
  541. idprop/types/py.typed +0 -0
  542. imbuf/types/py.typed +0 -0
  543. mathutils/bvhtree/py.typed +0 -0
  544. mathutils/geometry/py.typed +0 -0
  545. mathutils/interpolate/py.typed +0 -0
  546. mathutils/kdtree/py.typed +0 -0
  547. mathutils/noise/py.typed +0 -0
  548. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
  549. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
@@ -1,19 +1,13 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
5
6
 
6
7
  class PhysicButtonsPanel:
7
- """ """
8
-
9
8
  bl_context: typing.Any
10
- """ """
11
-
12
9
  bl_region_type: typing.Any
13
- """ """
14
-
15
10
  bl_space_type: typing.Any
16
- """ """
17
11
 
18
12
  def poll_collision(self, context):
19
13
  """
@@ -30,46 +24,44 @@ class PhysicButtonsPanel:
30
24
  ...
31
25
 
32
26
  class PHYSICS_PT_collision(bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI):
33
- """ """
34
-
35
27
  COMPAT_ENGINES: typing.Any
36
- """ """
37
-
38
28
  bl_context: typing.Any
39
- """ """
40
-
41
29
  bl_label: typing.Any
42
- """ """
43
-
44
30
  bl_region_type: typing.Any
45
- """ """
46
-
47
31
  bl_rna: typing.Any
48
- """ """
49
-
50
32
  bl_space_type: typing.Any
51
- """ """
52
-
53
33
  id_data: typing.Any
54
- """ """
55
34
 
56
35
  def append(self, draw_func):
57
- """
36
+ """Append a draw function to this menu,
37
+ takes the same arguments as the menus draw function
58
38
 
59
- :param draw_func:
39
+ :param draw_func:
60
40
  """
61
41
  ...
62
42
 
63
- def as_pointer(self):
64
- """ """
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
+ """
65
49
  ...
66
50
 
67
- def bl_rna_get_subclass(self):
68
- """ """
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
+ """
69
57
  ...
70
58
 
71
- def bl_rna_get_subclass_py(self):
72
- """ """
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
+ """
73
65
  ...
74
66
 
75
67
  def draw(self, context):
@@ -79,72 +71,126 @@ class PHYSICS_PT_collision(bpy_types.Panel, PhysicButtonsPanel, bpy_types._Gener
79
71
  """
80
72
  ...
81
73
 
82
- def driver_add(self):
83
- """ """
74
+ def driver_add(self) -> bpy.types.FCurve:
75
+ """Adds driver(s) to the given property
76
+
77
+ :return: The driver(s) added.
78
+ :rtype: bpy.types.FCurve
79
+ """
84
80
  ...
85
81
 
86
- def driver_remove(self):
87
- """ """
82
+ def driver_remove(self) -> bool:
83
+ """Remove driver(s) from the given property
84
+
85
+ :return: Success of driver removal.
86
+ :rtype: bool
87
+ """
88
88
  ...
89
89
 
90
90
  def get(self):
91
- """ """
91
+ """Returns the value of the custom property assigned to key or default
92
+ when not found (matches Python's dictionary function of the same name).
93
+
94
+ """
92
95
  ...
93
96
 
94
97
  def id_properties_clear(self):
95
- """ """
98
+ """
99
+
100
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
101
+ """
96
102
  ...
97
103
 
98
104
  def id_properties_ensure(self):
99
- """ """
105
+ """
106
+
107
+ :return: the parent group for an RNA struct's custom IDProperties.
108
+ """
100
109
  ...
101
110
 
102
111
  def id_properties_ui(self):
103
- """ """
104
- ...
112
+ """
105
113
 
106
- def is_extended(self):
107
- """ """
114
+ :return: Return an object used to manage an IDProperty's UI data.
115
+ """
108
116
  ...
109
117
 
110
- def is_property_hidden(self):
111
- """ """
118
+ def is_extended(self): ...
119
+ def is_property_hidden(self) -> bool:
120
+ """Check if a property is hidden.
121
+
122
+ :return: True when the property is hidden.
123
+ :rtype: bool
124
+ """
112
125
  ...
113
126
 
114
- def is_property_overridable_library(self):
115
- """ """
127
+ def is_property_overridable_library(self) -> bool:
128
+ """Check if a property is overridable.
129
+
130
+ :return: True when the property is overridable.
131
+ :rtype: bool
132
+ """
116
133
  ...
117
134
 
118
- def is_property_readonly(self):
119
- """ """
135
+ def is_property_readonly(self) -> bool:
136
+ """Check if a property is readonly.
137
+
138
+ :return: True when the property is readonly (not writable).
139
+ :rtype: bool
140
+ """
120
141
  ...
121
142
 
122
- def is_property_set(self):
123
- """ """
143
+ def is_property_set(self) -> bool:
144
+ """Check if a property is set, use for testing operator properties.
145
+
146
+ :return: True when the property has been set.
147
+ :rtype: bool
148
+ """
124
149
  ...
125
150
 
126
151
  def items(self):
127
- """ """
152
+ """Returns the items of this objects custom properties (matches Python's
153
+ dictionary function of the same name).
154
+
155
+ :return: custom property key, value pairs.
156
+ """
128
157
  ...
129
158
 
130
- def keyframe_delete(self):
131
- """ """
159
+ def keyframe_delete(self) -> bool:
160
+ """Remove a keyframe from this properties fcurve.
161
+
162
+ :return: Success of keyframe deletion.
163
+ :rtype: bool
164
+ """
132
165
  ...
133
166
 
134
- def keyframe_insert(self):
135
- """ """
167
+ def keyframe_insert(self) -> bool:
168
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
169
+
170
+ :return: Success of keyframe insertion.
171
+ :rtype: bool
172
+ """
136
173
  ...
137
174
 
138
175
  def keys(self):
139
- """ """
176
+ """Returns the keys of this objects custom properties (matches Python's
177
+ dictionary function of the same name).
178
+
179
+ :return: custom property keys.
180
+ """
140
181
  ...
141
182
 
142
- def path_from_id(self):
143
- """ """
183
+ def path_from_id(self) -> str:
184
+ """Returns the data path from the ID to this object (string).
185
+
186
+ :return: The path from `bpy.types.bpy_struct.id_data`
187
+ to this struct and property (when given).
188
+ :rtype: str
189
+ """
144
190
  ...
145
191
 
146
192
  def path_resolve(self):
147
- """ """
193
+ """Returns the property from the path, raise an exception when not found."""
148
194
  ...
149
195
 
150
196
  def poll(self, context):
@@ -169,85 +215,97 @@ class PHYSICS_PT_collision(bpy_types.Panel, PhysicButtonsPanel, bpy_types._Gener
169
215
  ...
170
216
 
171
217
  def pop(self):
172
- """ """
218
+ """Remove and return the value of the custom property assigned to key or default
219
+ when not found (matches Python's dictionary function of the same name).
220
+
221
+ """
173
222
  ...
174
223
 
175
224
  def prepend(self, draw_func):
176
- """
225
+ """Prepend a draw function to this menu, takes the same arguments as
226
+ the menus draw function
177
227
 
178
- :param draw_func:
228
+ :param draw_func:
179
229
  """
180
230
  ...
181
231
 
182
- def property_overridable_library_set(self):
183
- """ """
232
+ def property_overridable_library_set(self) -> bool:
233
+ """Define a property as overridable or not (only for custom properties!).
234
+
235
+ :return: True when the overridable status of the property was successfully set.
236
+ :rtype: bool
237
+ """
184
238
  ...
185
239
 
186
240
  def property_unset(self):
187
- """ """
241
+ """Unset a property, will use default value afterward."""
188
242
  ...
189
243
 
190
244
  def remove(self, draw_func):
191
- """
245
+ """Remove a draw function that has been added to this menu
192
246
 
193
247
  :param draw_func:
194
248
  """
195
249
  ...
196
250
 
197
251
  def type_recast(self):
198
- """ """
252
+ """Return a new instance, this is needed because types
253
+ such as textures can be changed at runtime.
254
+
255
+ :return: a new instance of this object with the type initialized again.
256
+ """
199
257
  ...
200
258
 
201
259
  def values(self):
202
- """ """
260
+ """Returns the values of this objects custom properties (matches Python's
261
+ dictionary function of the same name).
262
+
263
+ :return: custom property values.
264
+ """
203
265
  ...
204
266
 
205
267
  class PHYSICS_PT_collision_particle(
206
268
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
207
269
  ):
208
- """ """
209
-
210
270
  COMPAT_ENGINES: typing.Any
211
- """ """
212
-
213
271
  bl_context: typing.Any
214
- """ """
215
-
216
272
  bl_label: typing.Any
217
- """ """
218
-
219
273
  bl_parent_id: typing.Any
220
- """ """
221
-
222
274
  bl_region_type: typing.Any
223
- """ """
224
-
225
275
  bl_rna: typing.Any
226
- """ """
227
-
228
276
  bl_space_type: typing.Any
229
- """ """
230
-
231
277
  id_data: typing.Any
232
- """ """
233
278
 
234
279
  def append(self, draw_func):
235
- """
280
+ """Append a draw function to this menu,
281
+ takes the same arguments as the menus draw function
236
282
 
237
- :param draw_func:
283
+ :param draw_func:
238
284
  """
239
285
  ...
240
286
 
241
- def as_pointer(self):
242
- """ """
287
+ def as_pointer(self) -> int:
288
+ """Returns the memory address which holds a pointer to Blender's internal data
289
+
290
+ :return: int (memory address).
291
+ :rtype: int
292
+ """
243
293
  ...
244
294
 
245
- def bl_rna_get_subclass(self):
246
- """ """
295
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
296
+ """
297
+
298
+ :return: The RNA type or default when not found.
299
+ :rtype: bpy.types.Struct
300
+ """
247
301
  ...
248
302
 
249
- def bl_rna_get_subclass_py(self):
250
- """ """
303
+ def bl_rna_get_subclass_py(self) -> typing.Any:
304
+ """
305
+
306
+ :return: The class or default when not found.
307
+ :rtype: typing.Any
308
+ """
251
309
  ...
252
310
 
253
311
  def draw(self, context):
@@ -257,72 +315,126 @@ class PHYSICS_PT_collision_particle(
257
315
  """
258
316
  ...
259
317
 
260
- def driver_add(self):
261
- """ """
318
+ def driver_add(self) -> bpy.types.FCurve:
319
+ """Adds driver(s) to the given property
320
+
321
+ :return: The driver(s) added.
322
+ :rtype: bpy.types.FCurve
323
+ """
262
324
  ...
263
325
 
264
- def driver_remove(self):
265
- """ """
326
+ def driver_remove(self) -> bool:
327
+ """Remove driver(s) from the given property
328
+
329
+ :return: Success of driver removal.
330
+ :rtype: bool
331
+ """
266
332
  ...
267
333
 
268
334
  def get(self):
269
- """ """
335
+ """Returns the value of the custom property assigned to key or default
336
+ when not found (matches Python's dictionary function of the same name).
337
+
338
+ """
270
339
  ...
271
340
 
272
341
  def id_properties_clear(self):
273
- """ """
342
+ """
343
+
344
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
345
+ """
274
346
  ...
275
347
 
276
348
  def id_properties_ensure(self):
277
- """ """
349
+ """
350
+
351
+ :return: the parent group for an RNA struct's custom IDProperties.
352
+ """
278
353
  ...
279
354
 
280
355
  def id_properties_ui(self):
281
- """ """
282
- ...
356
+ """
283
357
 
284
- def is_extended(self):
285
- """ """
358
+ :return: Return an object used to manage an IDProperty's UI data.
359
+ """
286
360
  ...
287
361
 
288
- def is_property_hidden(self):
289
- """ """
362
+ def is_extended(self): ...
363
+ def is_property_hidden(self) -> bool:
364
+ """Check if a property is hidden.
365
+
366
+ :return: True when the property is hidden.
367
+ :rtype: bool
368
+ """
290
369
  ...
291
370
 
292
- def is_property_overridable_library(self):
293
- """ """
371
+ def is_property_overridable_library(self) -> bool:
372
+ """Check if a property is overridable.
373
+
374
+ :return: True when the property is overridable.
375
+ :rtype: bool
376
+ """
294
377
  ...
295
378
 
296
- def is_property_readonly(self):
297
- """ """
379
+ def is_property_readonly(self) -> bool:
380
+ """Check if a property is readonly.
381
+
382
+ :return: True when the property is readonly (not writable).
383
+ :rtype: bool
384
+ """
298
385
  ...
299
386
 
300
- def is_property_set(self):
301
- """ """
387
+ def is_property_set(self) -> bool:
388
+ """Check if a property is set, use for testing operator properties.
389
+
390
+ :return: True when the property has been set.
391
+ :rtype: bool
392
+ """
302
393
  ...
303
394
 
304
395
  def items(self):
305
- """ """
396
+ """Returns the items of this objects custom properties (matches Python's
397
+ dictionary function of the same name).
398
+
399
+ :return: custom property key, value pairs.
400
+ """
306
401
  ...
307
402
 
308
- def keyframe_delete(self):
309
- """ """
403
+ def keyframe_delete(self) -> bool:
404
+ """Remove a keyframe from this properties fcurve.
405
+
406
+ :return: Success of keyframe deletion.
407
+ :rtype: bool
408
+ """
310
409
  ...
311
410
 
312
- def keyframe_insert(self):
313
- """ """
411
+ def keyframe_insert(self) -> bool:
412
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
413
+
414
+ :return: Success of keyframe insertion.
415
+ :rtype: bool
416
+ """
314
417
  ...
315
418
 
316
419
  def keys(self):
317
- """ """
420
+ """Returns the keys of this objects custom properties (matches Python's
421
+ dictionary function of the same name).
422
+
423
+ :return: custom property keys.
424
+ """
318
425
  ...
319
426
 
320
- def path_from_id(self):
321
- """ """
427
+ def path_from_id(self) -> str:
428
+ """Returns the data path from the ID to this object (string).
429
+
430
+ :return: The path from `bpy.types.bpy_struct.id_data`
431
+ to this struct and property (when given).
432
+ :rtype: str
433
+ """
322
434
  ...
323
435
 
324
436
  def path_resolve(self):
325
- """ """
437
+ """Returns the property from the path, raise an exception when not found."""
326
438
  ...
327
439
 
328
440
  def poll(self, context):
@@ -347,85 +459,97 @@ class PHYSICS_PT_collision_particle(
347
459
  ...
348
460
 
349
461
  def pop(self):
350
- """ """
462
+ """Remove and return the value of the custom property assigned to key or default
463
+ when not found (matches Python's dictionary function of the same name).
464
+
465
+ """
351
466
  ...
352
467
 
353
468
  def prepend(self, draw_func):
354
- """
469
+ """Prepend a draw function to this menu, takes the same arguments as
470
+ the menus draw function
355
471
 
356
- :param draw_func:
472
+ :param draw_func:
357
473
  """
358
474
  ...
359
475
 
360
- def property_overridable_library_set(self):
361
- """ """
476
+ def property_overridable_library_set(self) -> bool:
477
+ """Define a property as overridable or not (only for custom properties!).
478
+
479
+ :return: True when the overridable status of the property was successfully set.
480
+ :rtype: bool
481
+ """
362
482
  ...
363
483
 
364
484
  def property_unset(self):
365
- """ """
485
+ """Unset a property, will use default value afterward."""
366
486
  ...
367
487
 
368
488
  def remove(self, draw_func):
369
- """
489
+ """Remove a draw function that has been added to this menu
370
490
 
371
491
  :param draw_func:
372
492
  """
373
493
  ...
374
494
 
375
495
  def type_recast(self):
376
- """ """
496
+ """Return a new instance, this is needed because types
497
+ such as textures can be changed at runtime.
498
+
499
+ :return: a new instance of this object with the type initialized again.
500
+ """
377
501
  ...
378
502
 
379
503
  def values(self):
380
- """ """
504
+ """Returns the values of this objects custom properties (matches Python's
505
+ dictionary function of the same name).
506
+
507
+ :return: custom property values.
508
+ """
381
509
  ...
382
510
 
383
511
  class PHYSICS_PT_collision_softbody(
384
512
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
385
513
  ):
386
- """ """
387
-
388
514
  COMPAT_ENGINES: typing.Any
389
- """ """
390
-
391
515
  bl_context: typing.Any
392
- """ """
393
-
394
516
  bl_label: typing.Any
395
- """ """
396
-
397
517
  bl_parent_id: typing.Any
398
- """ """
399
-
400
518
  bl_region_type: typing.Any
401
- """ """
402
-
403
519
  bl_rna: typing.Any
404
- """ """
405
-
406
520
  bl_space_type: typing.Any
407
- """ """
408
-
409
521
  id_data: typing.Any
410
- """ """
411
522
 
412
523
  def append(self, draw_func):
413
- """
524
+ """Append a draw function to this menu,
525
+ takes the same arguments as the menus draw function
414
526
 
415
- :param draw_func:
527
+ :param draw_func:
416
528
  """
417
529
  ...
418
530
 
419
- def as_pointer(self):
420
- """ """
531
+ def as_pointer(self) -> int:
532
+ """Returns the memory address which holds a pointer to Blender's internal data
533
+
534
+ :return: int (memory address).
535
+ :rtype: int
536
+ """
421
537
  ...
422
538
 
423
- def bl_rna_get_subclass(self):
424
- """ """
539
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
540
+ """
541
+
542
+ :return: The RNA type or default when not found.
543
+ :rtype: bpy.types.Struct
544
+ """
425
545
  ...
426
546
 
427
- def bl_rna_get_subclass_py(self):
428
- """ """
547
+ def bl_rna_get_subclass_py(self) -> typing.Any:
548
+ """
549
+
550
+ :return: The class or default when not found.
551
+ :rtype: typing.Any
552
+ """
429
553
  ...
430
554
 
431
555
  def draw(self, context):
@@ -435,72 +559,126 @@ class PHYSICS_PT_collision_softbody(
435
559
  """
436
560
  ...
437
561
 
438
- def driver_add(self):
439
- """ """
562
+ def driver_add(self) -> bpy.types.FCurve:
563
+ """Adds driver(s) to the given property
564
+
565
+ :return: The driver(s) added.
566
+ :rtype: bpy.types.FCurve
567
+ """
440
568
  ...
441
569
 
442
- def driver_remove(self):
443
- """ """
570
+ def driver_remove(self) -> bool:
571
+ """Remove driver(s) from the given property
572
+
573
+ :return: Success of driver removal.
574
+ :rtype: bool
575
+ """
444
576
  ...
445
577
 
446
578
  def get(self):
447
- """ """
579
+ """Returns the value of the custom property assigned to key or default
580
+ when not found (matches Python's dictionary function of the same name).
581
+
582
+ """
448
583
  ...
449
584
 
450
585
  def id_properties_clear(self):
451
- """ """
586
+ """
587
+
588
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
589
+ """
452
590
  ...
453
591
 
454
592
  def id_properties_ensure(self):
455
- """ """
593
+ """
594
+
595
+ :return: the parent group for an RNA struct's custom IDProperties.
596
+ """
456
597
  ...
457
598
 
458
599
  def id_properties_ui(self):
459
- """ """
460
- ...
600
+ """
461
601
 
462
- def is_extended(self):
463
- """ """
602
+ :return: Return an object used to manage an IDProperty's UI data.
603
+ """
464
604
  ...
465
605
 
466
- def is_property_hidden(self):
467
- """ """
606
+ def is_extended(self): ...
607
+ def is_property_hidden(self) -> bool:
608
+ """Check if a property is hidden.
609
+
610
+ :return: True when the property is hidden.
611
+ :rtype: bool
612
+ """
468
613
  ...
469
614
 
470
- def is_property_overridable_library(self):
471
- """ """
615
+ def is_property_overridable_library(self) -> bool:
616
+ """Check if a property is overridable.
617
+
618
+ :return: True when the property is overridable.
619
+ :rtype: bool
620
+ """
472
621
  ...
473
622
 
474
- def is_property_readonly(self):
475
- """ """
623
+ def is_property_readonly(self) -> bool:
624
+ """Check if a property is readonly.
625
+
626
+ :return: True when the property is readonly (not writable).
627
+ :rtype: bool
628
+ """
476
629
  ...
477
630
 
478
- def is_property_set(self):
479
- """ """
631
+ def is_property_set(self) -> bool:
632
+ """Check if a property is set, use for testing operator properties.
633
+
634
+ :return: True when the property has been set.
635
+ :rtype: bool
636
+ """
480
637
  ...
481
638
 
482
639
  def items(self):
483
- """ """
640
+ """Returns the items of this objects custom properties (matches Python's
641
+ dictionary function of the same name).
642
+
643
+ :return: custom property key, value pairs.
644
+ """
484
645
  ...
485
646
 
486
- def keyframe_delete(self):
487
- """ """
647
+ def keyframe_delete(self) -> bool:
648
+ """Remove a keyframe from this properties fcurve.
649
+
650
+ :return: Success of keyframe deletion.
651
+ :rtype: bool
652
+ """
488
653
  ...
489
654
 
490
- def keyframe_insert(self):
491
- """ """
655
+ def keyframe_insert(self) -> bool:
656
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
657
+
658
+ :return: Success of keyframe insertion.
659
+ :rtype: bool
660
+ """
492
661
  ...
493
662
 
494
663
  def keys(self):
495
- """ """
664
+ """Returns the keys of this objects custom properties (matches Python's
665
+ dictionary function of the same name).
666
+
667
+ :return: custom property keys.
668
+ """
496
669
  ...
497
670
 
498
- def path_from_id(self):
499
- """ """
671
+ def path_from_id(self) -> str:
672
+ """Returns the data path from the ID to this object (string).
673
+
674
+ :return: The path from `bpy.types.bpy_struct.id_data`
675
+ to this struct and property (when given).
676
+ :rtype: str
677
+ """
500
678
  ...
501
679
 
502
680
  def path_resolve(self):
503
- """ """
681
+ """Returns the property from the path, raise an exception when not found."""
504
682
  ...
505
683
 
506
684
  def poll(self, context):
@@ -525,80 +703,94 @@ class PHYSICS_PT_collision_softbody(
525
703
  ...
526
704
 
527
705
  def pop(self):
528
- """ """
706
+ """Remove and return the value of the custom property assigned to key or default
707
+ when not found (matches Python's dictionary function of the same name).
708
+
709
+ """
529
710
  ...
530
711
 
531
712
  def prepend(self, draw_func):
532
- """
713
+ """Prepend a draw function to this menu, takes the same arguments as
714
+ the menus draw function
533
715
 
534
- :param draw_func:
716
+ :param draw_func:
535
717
  """
536
718
  ...
537
719
 
538
- def property_overridable_library_set(self):
539
- """ """
720
+ def property_overridable_library_set(self) -> bool:
721
+ """Define a property as overridable or not (only for custom properties!).
722
+
723
+ :return: True when the overridable status of the property was successfully set.
724
+ :rtype: bool
725
+ """
540
726
  ...
541
727
 
542
728
  def property_unset(self):
543
- """ """
729
+ """Unset a property, will use default value afterward."""
544
730
  ...
545
731
 
546
732
  def remove(self, draw_func):
547
- """
733
+ """Remove a draw function that has been added to this menu
548
734
 
549
735
  :param draw_func:
550
736
  """
551
737
  ...
552
738
 
553
739
  def type_recast(self):
554
- """ """
740
+ """Return a new instance, this is needed because types
741
+ such as textures can be changed at runtime.
742
+
743
+ :return: a new instance of this object with the type initialized again.
744
+ """
555
745
  ...
556
746
 
557
747
  def values(self):
558
- """ """
748
+ """Returns the values of this objects custom properties (matches Python's
749
+ dictionary function of the same name).
750
+
751
+ :return: custom property values.
752
+ """
559
753
  ...
560
754
 
561
755
  class PHYSICS_PT_field(bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI):
562
- """ """
563
-
564
756
  COMPAT_ENGINES: typing.Any
565
- """ """
566
-
567
757
  bl_context: typing.Any
568
- """ """
569
-
570
758
  bl_label: typing.Any
571
- """ """
572
-
573
759
  bl_region_type: typing.Any
574
- """ """
575
-
576
760
  bl_rna: typing.Any
577
- """ """
578
-
579
761
  bl_space_type: typing.Any
580
- """ """
581
-
582
762
  id_data: typing.Any
583
- """ """
584
763
 
585
764
  def append(self, draw_func):
586
- """
765
+ """Append a draw function to this menu,
766
+ takes the same arguments as the menus draw function
587
767
 
588
- :param draw_func:
768
+ :param draw_func:
589
769
  """
590
770
  ...
591
771
 
592
- def as_pointer(self):
593
- """ """
772
+ def as_pointer(self) -> int:
773
+ """Returns the memory address which holds a pointer to Blender's internal data
774
+
775
+ :return: int (memory address).
776
+ :rtype: int
777
+ """
594
778
  ...
595
779
 
596
- def bl_rna_get_subclass(self):
597
- """ """
780
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
781
+ """
782
+
783
+ :return: The RNA type or default when not found.
784
+ :rtype: bpy.types.Struct
785
+ """
598
786
  ...
599
787
 
600
- def bl_rna_get_subclass_py(self):
601
- """ """
788
+ def bl_rna_get_subclass_py(self) -> typing.Any:
789
+ """
790
+
791
+ :return: The class or default when not found.
792
+ :rtype: typing.Any
793
+ """
602
794
  ...
603
795
 
604
796
  def draw(self, context):
@@ -608,72 +800,126 @@ class PHYSICS_PT_field(bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
608
800
  """
609
801
  ...
610
802
 
611
- def driver_add(self):
612
- """ """
803
+ def driver_add(self) -> bpy.types.FCurve:
804
+ """Adds driver(s) to the given property
805
+
806
+ :return: The driver(s) added.
807
+ :rtype: bpy.types.FCurve
808
+ """
613
809
  ...
614
810
 
615
- def driver_remove(self):
616
- """ """
811
+ def driver_remove(self) -> bool:
812
+ """Remove driver(s) from the given property
813
+
814
+ :return: Success of driver removal.
815
+ :rtype: bool
816
+ """
617
817
  ...
618
818
 
619
819
  def get(self):
620
- """ """
820
+ """Returns the value of the custom property assigned to key or default
821
+ when not found (matches Python's dictionary function of the same name).
822
+
823
+ """
621
824
  ...
622
825
 
623
826
  def id_properties_clear(self):
624
- """ """
827
+ """
828
+
829
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
830
+ """
625
831
  ...
626
832
 
627
833
  def id_properties_ensure(self):
628
- """ """
834
+ """
835
+
836
+ :return: the parent group for an RNA struct's custom IDProperties.
837
+ """
629
838
  ...
630
839
 
631
840
  def id_properties_ui(self):
632
- """ """
633
- ...
841
+ """
634
842
 
635
- def is_extended(self):
636
- """ """
843
+ :return: Return an object used to manage an IDProperty's UI data.
844
+ """
637
845
  ...
638
846
 
639
- def is_property_hidden(self):
640
- """ """
847
+ def is_extended(self): ...
848
+ def is_property_hidden(self) -> bool:
849
+ """Check if a property is hidden.
850
+
851
+ :return: True when the property is hidden.
852
+ :rtype: bool
853
+ """
641
854
  ...
642
855
 
643
- def is_property_overridable_library(self):
644
- """ """
856
+ def is_property_overridable_library(self) -> bool:
857
+ """Check if a property is overridable.
858
+
859
+ :return: True when the property is overridable.
860
+ :rtype: bool
861
+ """
645
862
  ...
646
863
 
647
- def is_property_readonly(self):
648
- """ """
864
+ def is_property_readonly(self) -> bool:
865
+ """Check if a property is readonly.
866
+
867
+ :return: True when the property is readonly (not writable).
868
+ :rtype: bool
869
+ """
649
870
  ...
650
871
 
651
- def is_property_set(self):
652
- """ """
872
+ def is_property_set(self) -> bool:
873
+ """Check if a property is set, use for testing operator properties.
874
+
875
+ :return: True when the property has been set.
876
+ :rtype: bool
877
+ """
653
878
  ...
654
879
 
655
880
  def items(self):
656
- """ """
881
+ """Returns the items of this objects custom properties (matches Python's
882
+ dictionary function of the same name).
883
+
884
+ :return: custom property key, value pairs.
885
+ """
657
886
  ...
658
887
 
659
- def keyframe_delete(self):
660
- """ """
888
+ def keyframe_delete(self) -> bool:
889
+ """Remove a keyframe from this properties fcurve.
890
+
891
+ :return: Success of keyframe deletion.
892
+ :rtype: bool
893
+ """
661
894
  ...
662
895
 
663
- def keyframe_insert(self):
664
- """ """
896
+ def keyframe_insert(self) -> bool:
897
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
898
+
899
+ :return: Success of keyframe insertion.
900
+ :rtype: bool
901
+ """
665
902
  ...
666
903
 
667
904
  def keys(self):
668
- """ """
905
+ """Returns the keys of this objects custom properties (matches Python's
906
+ dictionary function of the same name).
907
+
908
+ :return: custom property keys.
909
+ """
669
910
  ...
670
911
 
671
- def path_from_id(self):
672
- """ """
912
+ def path_from_id(self) -> str:
913
+ """Returns the data path from the ID to this object (string).
914
+
915
+ :return: The path from `bpy.types.bpy_struct.id_data`
916
+ to this struct and property (when given).
917
+ :rtype: str
918
+ """
673
919
  ...
674
920
 
675
921
  def path_resolve(self):
676
- """ """
922
+ """Returns the property from the path, raise an exception when not found."""
677
923
  ...
678
924
 
679
925
  def poll(self, context):
@@ -698,85 +944,97 @@ class PHYSICS_PT_field(bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
698
944
  ...
699
945
 
700
946
  def pop(self):
701
- """ """
947
+ """Remove and return the value of the custom property assigned to key or default
948
+ when not found (matches Python's dictionary function of the same name).
949
+
950
+ """
702
951
  ...
703
952
 
704
953
  def prepend(self, draw_func):
705
- """
954
+ """Prepend a draw function to this menu, takes the same arguments as
955
+ the menus draw function
706
956
 
707
- :param draw_func:
957
+ :param draw_func:
708
958
  """
709
959
  ...
710
960
 
711
- def property_overridable_library_set(self):
712
- """ """
961
+ def property_overridable_library_set(self) -> bool:
962
+ """Define a property as overridable or not (only for custom properties!).
963
+
964
+ :return: True when the overridable status of the property was successfully set.
965
+ :rtype: bool
966
+ """
713
967
  ...
714
968
 
715
969
  def property_unset(self):
716
- """ """
970
+ """Unset a property, will use default value afterward."""
717
971
  ...
718
972
 
719
973
  def remove(self, draw_func):
720
- """
974
+ """Remove a draw function that has been added to this menu
721
975
 
722
976
  :param draw_func:
723
977
  """
724
978
  ...
725
979
 
726
980
  def type_recast(self):
727
- """ """
981
+ """Return a new instance, this is needed because types
982
+ such as textures can be changed at runtime.
983
+
984
+ :return: a new instance of this object with the type initialized again.
985
+ """
728
986
  ...
729
987
 
730
988
  def values(self):
731
- """ """
989
+ """Returns the values of this objects custom properties (matches Python's
990
+ dictionary function of the same name).
991
+
992
+ :return: custom property values.
993
+ """
732
994
  ...
733
995
 
734
996
  class PHYSICS_PT_field_falloff(
735
997
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
736
998
  ):
737
- """ """
738
-
739
999
  COMPAT_ENGINES: typing.Any
740
- """ """
741
-
742
1000
  bl_context: typing.Any
743
- """ """
744
-
745
1001
  bl_label: typing.Any
746
- """ """
747
-
748
1002
  bl_parent_id: typing.Any
749
- """ """
750
-
751
1003
  bl_region_type: typing.Any
752
- """ """
753
-
754
1004
  bl_rna: typing.Any
755
- """ """
756
-
757
1005
  bl_space_type: typing.Any
758
- """ """
759
-
760
1006
  id_data: typing.Any
761
- """ """
762
1007
 
763
1008
  def append(self, draw_func):
764
- """
1009
+ """Append a draw function to this menu,
1010
+ takes the same arguments as the menus draw function
765
1011
 
766
- :param draw_func:
1012
+ :param draw_func:
767
1013
  """
768
1014
  ...
769
1015
 
770
- def as_pointer(self):
771
- """ """
1016
+ def as_pointer(self) -> int:
1017
+ """Returns the memory address which holds a pointer to Blender's internal data
1018
+
1019
+ :return: int (memory address).
1020
+ :rtype: int
1021
+ """
772
1022
  ...
773
1023
 
774
- def bl_rna_get_subclass(self):
775
- """ """
1024
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1025
+ """
1026
+
1027
+ :return: The RNA type or default when not found.
1028
+ :rtype: bpy.types.Struct
1029
+ """
776
1030
  ...
777
1031
 
778
- def bl_rna_get_subclass_py(self):
779
- """ """
1032
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1033
+ """
1034
+
1035
+ :return: The class or default when not found.
1036
+ :rtype: typing.Any
1037
+ """
780
1038
  ...
781
1039
 
782
1040
  def draw(self, context):
@@ -786,72 +1044,126 @@ class PHYSICS_PT_field_falloff(
786
1044
  """
787
1045
  ...
788
1046
 
789
- def driver_add(self):
790
- """ """
1047
+ def driver_add(self) -> bpy.types.FCurve:
1048
+ """Adds driver(s) to the given property
1049
+
1050
+ :return: The driver(s) added.
1051
+ :rtype: bpy.types.FCurve
1052
+ """
791
1053
  ...
792
1054
 
793
- def driver_remove(self):
794
- """ """
1055
+ def driver_remove(self) -> bool:
1056
+ """Remove driver(s) from the given property
1057
+
1058
+ :return: Success of driver removal.
1059
+ :rtype: bool
1060
+ """
795
1061
  ...
796
1062
 
797
1063
  def get(self):
798
- """ """
1064
+ """Returns the value of the custom property assigned to key or default
1065
+ when not found (matches Python's dictionary function of the same name).
1066
+
1067
+ """
799
1068
  ...
800
1069
 
801
1070
  def id_properties_clear(self):
802
- """ """
1071
+ """
1072
+
1073
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1074
+ """
803
1075
  ...
804
1076
 
805
1077
  def id_properties_ensure(self):
806
- """ """
1078
+ """
1079
+
1080
+ :return: the parent group for an RNA struct's custom IDProperties.
1081
+ """
807
1082
  ...
808
1083
 
809
1084
  def id_properties_ui(self):
810
- """ """
811
- ...
1085
+ """
812
1086
 
813
- def is_extended(self):
814
- """ """
1087
+ :return: Return an object used to manage an IDProperty's UI data.
1088
+ """
815
1089
  ...
816
1090
 
817
- def is_property_hidden(self):
818
- """ """
1091
+ def is_extended(self): ...
1092
+ def is_property_hidden(self) -> bool:
1093
+ """Check if a property is hidden.
1094
+
1095
+ :return: True when the property is hidden.
1096
+ :rtype: bool
1097
+ """
819
1098
  ...
820
1099
 
821
- def is_property_overridable_library(self):
822
- """ """
1100
+ def is_property_overridable_library(self) -> bool:
1101
+ """Check if a property is overridable.
1102
+
1103
+ :return: True when the property is overridable.
1104
+ :rtype: bool
1105
+ """
823
1106
  ...
824
1107
 
825
- def is_property_readonly(self):
826
- """ """
1108
+ def is_property_readonly(self) -> bool:
1109
+ """Check if a property is readonly.
1110
+
1111
+ :return: True when the property is readonly (not writable).
1112
+ :rtype: bool
1113
+ """
827
1114
  ...
828
1115
 
829
- def is_property_set(self):
830
- """ """
1116
+ def is_property_set(self) -> bool:
1117
+ """Check if a property is set, use for testing operator properties.
1118
+
1119
+ :return: True when the property has been set.
1120
+ :rtype: bool
1121
+ """
831
1122
  ...
832
1123
 
833
1124
  def items(self):
834
- """ """
1125
+ """Returns the items of this objects custom properties (matches Python's
1126
+ dictionary function of the same name).
1127
+
1128
+ :return: custom property key, value pairs.
1129
+ """
835
1130
  ...
836
1131
 
837
- def keyframe_delete(self):
838
- """ """
1132
+ def keyframe_delete(self) -> bool:
1133
+ """Remove a keyframe from this properties fcurve.
1134
+
1135
+ :return: Success of keyframe deletion.
1136
+ :rtype: bool
1137
+ """
839
1138
  ...
840
1139
 
841
- def keyframe_insert(self):
842
- """ """
1140
+ def keyframe_insert(self) -> bool:
1141
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1142
+
1143
+ :return: Success of keyframe insertion.
1144
+ :rtype: bool
1145
+ """
843
1146
  ...
844
1147
 
845
1148
  def keys(self):
846
- """ """
1149
+ """Returns the keys of this objects custom properties (matches Python's
1150
+ dictionary function of the same name).
1151
+
1152
+ :return: custom property keys.
1153
+ """
847
1154
  ...
848
1155
 
849
- def path_from_id(self):
850
- """ """
1156
+ def path_from_id(self) -> str:
1157
+ """Returns the data path from the ID to this object (string).
1158
+
1159
+ :return: The path from `bpy.types.bpy_struct.id_data`
1160
+ to this struct and property (when given).
1161
+ :rtype: str
1162
+ """
851
1163
  ...
852
1164
 
853
1165
  def path_resolve(self):
854
- """ """
1166
+ """Returns the property from the path, raise an exception when not found."""
855
1167
  ...
856
1168
 
857
1169
  def poll(self, context):
@@ -876,85 +1188,97 @@ class PHYSICS_PT_field_falloff(
876
1188
  ...
877
1189
 
878
1190
  def pop(self):
879
- """ """
1191
+ """Remove and return the value of the custom property assigned to key or default
1192
+ when not found (matches Python's dictionary function of the same name).
1193
+
1194
+ """
880
1195
  ...
881
1196
 
882
1197
  def prepend(self, draw_func):
883
- """
1198
+ """Prepend a draw function to this menu, takes the same arguments as
1199
+ the menus draw function
884
1200
 
885
- :param draw_func:
1201
+ :param draw_func:
886
1202
  """
887
1203
  ...
888
1204
 
889
- def property_overridable_library_set(self):
890
- """ """
1205
+ def property_overridable_library_set(self) -> bool:
1206
+ """Define a property as overridable or not (only for custom properties!).
1207
+
1208
+ :return: True when the overridable status of the property was successfully set.
1209
+ :rtype: bool
1210
+ """
891
1211
  ...
892
1212
 
893
1213
  def property_unset(self):
894
- """ """
1214
+ """Unset a property, will use default value afterward."""
895
1215
  ...
896
1216
 
897
1217
  def remove(self, draw_func):
898
- """
1218
+ """Remove a draw function that has been added to this menu
899
1219
 
900
1220
  :param draw_func:
901
1221
  """
902
1222
  ...
903
1223
 
904
1224
  def type_recast(self):
905
- """ """
1225
+ """Return a new instance, this is needed because types
1226
+ such as textures can be changed at runtime.
1227
+
1228
+ :return: a new instance of this object with the type initialized again.
1229
+ """
906
1230
  ...
907
1231
 
908
1232
  def values(self):
909
- """ """
1233
+ """Returns the values of this objects custom properties (matches Python's
1234
+ dictionary function of the same name).
1235
+
1236
+ :return: custom property values.
1237
+ """
910
1238
  ...
911
1239
 
912
1240
  class PHYSICS_PT_field_falloff_angular(
913
1241
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
914
1242
  ):
915
- """ """
916
-
917
1243
  COMPAT_ENGINES: typing.Any
918
- """ """
919
-
920
1244
  bl_context: typing.Any
921
- """ """
922
-
923
1245
  bl_label: typing.Any
924
- """ """
925
-
926
1246
  bl_parent_id: typing.Any
927
- """ """
928
-
929
1247
  bl_region_type: typing.Any
930
- """ """
931
-
932
1248
  bl_rna: typing.Any
933
- """ """
934
-
935
1249
  bl_space_type: typing.Any
936
- """ """
937
-
938
1250
  id_data: typing.Any
939
- """ """
940
1251
 
941
1252
  def append(self, draw_func):
942
- """
1253
+ """Append a draw function to this menu,
1254
+ takes the same arguments as the menus draw function
943
1255
 
944
- :param draw_func:
1256
+ :param draw_func:
945
1257
  """
946
1258
  ...
947
1259
 
948
- def as_pointer(self):
949
- """ """
1260
+ def as_pointer(self) -> int:
1261
+ """Returns the memory address which holds a pointer to Blender's internal data
1262
+
1263
+ :return: int (memory address).
1264
+ :rtype: int
1265
+ """
950
1266
  ...
951
1267
 
952
- def bl_rna_get_subclass(self):
953
- """ """
1268
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1269
+ """
1270
+
1271
+ :return: The RNA type or default when not found.
1272
+ :rtype: bpy.types.Struct
1273
+ """
954
1274
  ...
955
1275
 
956
- def bl_rna_get_subclass_py(self):
957
- """ """
1276
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1277
+ """
1278
+
1279
+ :return: The class or default when not found.
1280
+ :rtype: typing.Any
1281
+ """
958
1282
  ...
959
1283
 
960
1284
  def draw(self, context):
@@ -964,72 +1288,126 @@ class PHYSICS_PT_field_falloff_angular(
964
1288
  """
965
1289
  ...
966
1290
 
967
- def driver_add(self):
968
- """ """
1291
+ def driver_add(self) -> bpy.types.FCurve:
1292
+ """Adds driver(s) to the given property
1293
+
1294
+ :return: The driver(s) added.
1295
+ :rtype: bpy.types.FCurve
1296
+ """
969
1297
  ...
970
1298
 
971
- def driver_remove(self):
972
- """ """
1299
+ def driver_remove(self) -> bool:
1300
+ """Remove driver(s) from the given property
1301
+
1302
+ :return: Success of driver removal.
1303
+ :rtype: bool
1304
+ """
973
1305
  ...
974
1306
 
975
1307
  def get(self):
976
- """ """
1308
+ """Returns the value of the custom property assigned to key or default
1309
+ when not found (matches Python's dictionary function of the same name).
1310
+
1311
+ """
977
1312
  ...
978
1313
 
979
1314
  def id_properties_clear(self):
980
- """ """
1315
+ """
1316
+
1317
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1318
+ """
981
1319
  ...
982
1320
 
983
1321
  def id_properties_ensure(self):
984
- """ """
1322
+ """
1323
+
1324
+ :return: the parent group for an RNA struct's custom IDProperties.
1325
+ """
985
1326
  ...
986
1327
 
987
1328
  def id_properties_ui(self):
988
- """ """
989
- ...
1329
+ """
990
1330
 
991
- def is_extended(self):
992
- """ """
1331
+ :return: Return an object used to manage an IDProperty's UI data.
1332
+ """
993
1333
  ...
994
1334
 
995
- def is_property_hidden(self):
996
- """ """
1335
+ def is_extended(self): ...
1336
+ def is_property_hidden(self) -> bool:
1337
+ """Check if a property is hidden.
1338
+
1339
+ :return: True when the property is hidden.
1340
+ :rtype: bool
1341
+ """
997
1342
  ...
998
1343
 
999
- def is_property_overridable_library(self):
1000
- """ """
1344
+ def is_property_overridable_library(self) -> bool:
1345
+ """Check if a property is overridable.
1346
+
1347
+ :return: True when the property is overridable.
1348
+ :rtype: bool
1349
+ """
1001
1350
  ...
1002
1351
 
1003
- def is_property_readonly(self):
1004
- """ """
1352
+ def is_property_readonly(self) -> bool:
1353
+ """Check if a property is readonly.
1354
+
1355
+ :return: True when the property is readonly (not writable).
1356
+ :rtype: bool
1357
+ """
1005
1358
  ...
1006
1359
 
1007
- def is_property_set(self):
1008
- """ """
1360
+ def is_property_set(self) -> bool:
1361
+ """Check if a property is set, use for testing operator properties.
1362
+
1363
+ :return: True when the property has been set.
1364
+ :rtype: bool
1365
+ """
1009
1366
  ...
1010
1367
 
1011
1368
  def items(self):
1012
- """ """
1369
+ """Returns the items of this objects custom properties (matches Python's
1370
+ dictionary function of the same name).
1371
+
1372
+ :return: custom property key, value pairs.
1373
+ """
1013
1374
  ...
1014
1375
 
1015
- def keyframe_delete(self):
1016
- """ """
1376
+ def keyframe_delete(self) -> bool:
1377
+ """Remove a keyframe from this properties fcurve.
1378
+
1379
+ :return: Success of keyframe deletion.
1380
+ :rtype: bool
1381
+ """
1017
1382
  ...
1018
1383
 
1019
- def keyframe_insert(self):
1020
- """ """
1384
+ def keyframe_insert(self) -> bool:
1385
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1386
+
1387
+ :return: Success of keyframe insertion.
1388
+ :rtype: bool
1389
+ """
1021
1390
  ...
1022
1391
 
1023
1392
  def keys(self):
1024
- """ """
1393
+ """Returns the keys of this objects custom properties (matches Python's
1394
+ dictionary function of the same name).
1395
+
1396
+ :return: custom property keys.
1397
+ """
1025
1398
  ...
1026
1399
 
1027
- def path_from_id(self):
1028
- """ """
1400
+ def path_from_id(self) -> str:
1401
+ """Returns the data path from the ID to this object (string).
1402
+
1403
+ :return: The path from `bpy.types.bpy_struct.id_data`
1404
+ to this struct and property (when given).
1405
+ :rtype: str
1406
+ """
1029
1407
  ...
1030
1408
 
1031
1409
  def path_resolve(self):
1032
- """ """
1410
+ """Returns the property from the path, raise an exception when not found."""
1033
1411
  ...
1034
1412
 
1035
1413
  def poll(self, context):
@@ -1054,85 +1432,97 @@ class PHYSICS_PT_field_falloff_angular(
1054
1432
  ...
1055
1433
 
1056
1434
  def pop(self):
1057
- """ """
1435
+ """Remove and return the value of the custom property assigned to key or default
1436
+ when not found (matches Python's dictionary function of the same name).
1437
+
1438
+ """
1058
1439
  ...
1059
1440
 
1060
1441
  def prepend(self, draw_func):
1061
- """
1442
+ """Prepend a draw function to this menu, takes the same arguments as
1443
+ the menus draw function
1062
1444
 
1063
- :param draw_func:
1445
+ :param draw_func:
1064
1446
  """
1065
1447
  ...
1066
1448
 
1067
- def property_overridable_library_set(self):
1068
- """ """
1449
+ def property_overridable_library_set(self) -> bool:
1450
+ """Define a property as overridable or not (only for custom properties!).
1451
+
1452
+ :return: True when the overridable status of the property was successfully set.
1453
+ :rtype: bool
1454
+ """
1069
1455
  ...
1070
1456
 
1071
1457
  def property_unset(self):
1072
- """ """
1458
+ """Unset a property, will use default value afterward."""
1073
1459
  ...
1074
1460
 
1075
1461
  def remove(self, draw_func):
1076
- """
1462
+ """Remove a draw function that has been added to this menu
1077
1463
 
1078
1464
  :param draw_func:
1079
1465
  """
1080
1466
  ...
1081
1467
 
1082
1468
  def type_recast(self):
1083
- """ """
1469
+ """Return a new instance, this is needed because types
1470
+ such as textures can be changed at runtime.
1471
+
1472
+ :return: a new instance of this object with the type initialized again.
1473
+ """
1084
1474
  ...
1085
1475
 
1086
1476
  def values(self):
1087
- """ """
1477
+ """Returns the values of this objects custom properties (matches Python's
1478
+ dictionary function of the same name).
1479
+
1480
+ :return: custom property values.
1481
+ """
1088
1482
  ...
1089
1483
 
1090
1484
  class PHYSICS_PT_field_falloff_radial(
1091
1485
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
1092
1486
  ):
1093
- """ """
1094
-
1095
1487
  COMPAT_ENGINES: typing.Any
1096
- """ """
1097
-
1098
1488
  bl_context: typing.Any
1099
- """ """
1100
-
1101
1489
  bl_label: typing.Any
1102
- """ """
1103
-
1104
1490
  bl_parent_id: typing.Any
1105
- """ """
1106
-
1107
1491
  bl_region_type: typing.Any
1108
- """ """
1109
-
1110
1492
  bl_rna: typing.Any
1111
- """ """
1112
-
1113
1493
  bl_space_type: typing.Any
1114
- """ """
1115
-
1116
1494
  id_data: typing.Any
1117
- """ """
1118
1495
 
1119
1496
  def append(self, draw_func):
1120
- """
1497
+ """Append a draw function to this menu,
1498
+ takes the same arguments as the menus draw function
1121
1499
 
1122
- :param draw_func:
1500
+ :param draw_func:
1123
1501
  """
1124
1502
  ...
1125
1503
 
1126
- def as_pointer(self):
1127
- """ """
1504
+ def as_pointer(self) -> int:
1505
+ """Returns the memory address which holds a pointer to Blender's internal data
1506
+
1507
+ :return: int (memory address).
1508
+ :rtype: int
1509
+ """
1128
1510
  ...
1129
1511
 
1130
- def bl_rna_get_subclass(self):
1131
- """ """
1512
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1513
+ """
1514
+
1515
+ :return: The RNA type or default when not found.
1516
+ :rtype: bpy.types.Struct
1517
+ """
1132
1518
  ...
1133
1519
 
1134
- def bl_rna_get_subclass_py(self):
1135
- """ """
1520
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1521
+ """
1522
+
1523
+ :return: The class or default when not found.
1524
+ :rtype: typing.Any
1525
+ """
1136
1526
  ...
1137
1527
 
1138
1528
  def draw(self, context):
@@ -1142,72 +1532,126 @@ class PHYSICS_PT_field_falloff_radial(
1142
1532
  """
1143
1533
  ...
1144
1534
 
1145
- def driver_add(self):
1146
- """ """
1535
+ def driver_add(self) -> bpy.types.FCurve:
1536
+ """Adds driver(s) to the given property
1537
+
1538
+ :return: The driver(s) added.
1539
+ :rtype: bpy.types.FCurve
1540
+ """
1147
1541
  ...
1148
1542
 
1149
- def driver_remove(self):
1150
- """ """
1543
+ def driver_remove(self) -> bool:
1544
+ """Remove driver(s) from the given property
1545
+
1546
+ :return: Success of driver removal.
1547
+ :rtype: bool
1548
+ """
1151
1549
  ...
1152
1550
 
1153
1551
  def get(self):
1154
- """ """
1552
+ """Returns the value of the custom property assigned to key or default
1553
+ when not found (matches Python's dictionary function of the same name).
1554
+
1555
+ """
1155
1556
  ...
1156
1557
 
1157
1558
  def id_properties_clear(self):
1158
- """ """
1559
+ """
1560
+
1561
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1562
+ """
1159
1563
  ...
1160
1564
 
1161
1565
  def id_properties_ensure(self):
1162
- """ """
1566
+ """
1567
+
1568
+ :return: the parent group for an RNA struct's custom IDProperties.
1569
+ """
1163
1570
  ...
1164
1571
 
1165
1572
  def id_properties_ui(self):
1166
- """ """
1167
- ...
1573
+ """
1168
1574
 
1169
- def is_extended(self):
1170
- """ """
1575
+ :return: Return an object used to manage an IDProperty's UI data.
1576
+ """
1171
1577
  ...
1172
1578
 
1173
- def is_property_hidden(self):
1174
- """ """
1579
+ def is_extended(self): ...
1580
+ def is_property_hidden(self) -> bool:
1581
+ """Check if a property is hidden.
1582
+
1583
+ :return: True when the property is hidden.
1584
+ :rtype: bool
1585
+ """
1175
1586
  ...
1176
1587
 
1177
- def is_property_overridable_library(self):
1178
- """ """
1588
+ def is_property_overridable_library(self) -> bool:
1589
+ """Check if a property is overridable.
1590
+
1591
+ :return: True when the property is overridable.
1592
+ :rtype: bool
1593
+ """
1179
1594
  ...
1180
1595
 
1181
- def is_property_readonly(self):
1182
- """ """
1596
+ def is_property_readonly(self) -> bool:
1597
+ """Check if a property is readonly.
1598
+
1599
+ :return: True when the property is readonly (not writable).
1600
+ :rtype: bool
1601
+ """
1183
1602
  ...
1184
1603
 
1185
- def is_property_set(self):
1186
- """ """
1604
+ def is_property_set(self) -> bool:
1605
+ """Check if a property is set, use for testing operator properties.
1606
+
1607
+ :return: True when the property has been set.
1608
+ :rtype: bool
1609
+ """
1187
1610
  ...
1188
1611
 
1189
1612
  def items(self):
1190
- """ """
1613
+ """Returns the items of this objects custom properties (matches Python's
1614
+ dictionary function of the same name).
1615
+
1616
+ :return: custom property key, value pairs.
1617
+ """
1191
1618
  ...
1192
1619
 
1193
- def keyframe_delete(self):
1194
- """ """
1620
+ def keyframe_delete(self) -> bool:
1621
+ """Remove a keyframe from this properties fcurve.
1622
+
1623
+ :return: Success of keyframe deletion.
1624
+ :rtype: bool
1625
+ """
1195
1626
  ...
1196
1627
 
1197
- def keyframe_insert(self):
1198
- """ """
1628
+ def keyframe_insert(self) -> bool:
1629
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1630
+
1631
+ :return: Success of keyframe insertion.
1632
+ :rtype: bool
1633
+ """
1199
1634
  ...
1200
1635
 
1201
1636
  def keys(self):
1202
- """ """
1637
+ """Returns the keys of this objects custom properties (matches Python's
1638
+ dictionary function of the same name).
1639
+
1640
+ :return: custom property keys.
1641
+ """
1203
1642
  ...
1204
1643
 
1205
- def path_from_id(self):
1206
- """ """
1644
+ def path_from_id(self) -> str:
1645
+ """Returns the data path from the ID to this object (string).
1646
+
1647
+ :return: The path from `bpy.types.bpy_struct.id_data`
1648
+ to this struct and property (when given).
1649
+ :rtype: str
1650
+ """
1207
1651
  ...
1208
1652
 
1209
1653
  def path_resolve(self):
1210
- """ """
1654
+ """Returns the property from the path, raise an exception when not found."""
1211
1655
  ...
1212
1656
 
1213
1657
  def poll(self, context):
@@ -1232,85 +1676,97 @@ class PHYSICS_PT_field_falloff_radial(
1232
1676
  ...
1233
1677
 
1234
1678
  def pop(self):
1235
- """ """
1679
+ """Remove and return the value of the custom property assigned to key or default
1680
+ when not found (matches Python's dictionary function of the same name).
1681
+
1682
+ """
1236
1683
  ...
1237
1684
 
1238
1685
  def prepend(self, draw_func):
1239
- """
1686
+ """Prepend a draw function to this menu, takes the same arguments as
1687
+ the menus draw function
1240
1688
 
1241
- :param draw_func:
1689
+ :param draw_func:
1242
1690
  """
1243
1691
  ...
1244
1692
 
1245
- def property_overridable_library_set(self):
1246
- """ """
1693
+ def property_overridable_library_set(self) -> bool:
1694
+ """Define a property as overridable or not (only for custom properties!).
1695
+
1696
+ :return: True when the overridable status of the property was successfully set.
1697
+ :rtype: bool
1698
+ """
1247
1699
  ...
1248
1700
 
1249
1701
  def property_unset(self):
1250
- """ """
1702
+ """Unset a property, will use default value afterward."""
1251
1703
  ...
1252
1704
 
1253
1705
  def remove(self, draw_func):
1254
- """
1706
+ """Remove a draw function that has been added to this menu
1255
1707
 
1256
1708
  :param draw_func:
1257
1709
  """
1258
1710
  ...
1259
1711
 
1260
1712
  def type_recast(self):
1261
- """ """
1713
+ """Return a new instance, this is needed because types
1714
+ such as textures can be changed at runtime.
1715
+
1716
+ :return: a new instance of this object with the type initialized again.
1717
+ """
1262
1718
  ...
1263
1719
 
1264
1720
  def values(self):
1265
- """ """
1721
+ """Returns the values of this objects custom properties (matches Python's
1722
+ dictionary function of the same name).
1723
+
1724
+ :return: custom property values.
1725
+ """
1266
1726
  ...
1267
1727
 
1268
1728
  class PHYSICS_PT_field_settings(
1269
1729
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
1270
1730
  ):
1271
- """ """
1272
-
1273
1731
  COMPAT_ENGINES: typing.Any
1274
- """ """
1275
-
1276
1732
  bl_context: typing.Any
1277
- """ """
1278
-
1279
1733
  bl_label: typing.Any
1280
- """ """
1281
-
1282
1734
  bl_parent_id: typing.Any
1283
- """ """
1284
-
1285
1735
  bl_region_type: typing.Any
1286
- """ """
1287
-
1288
1736
  bl_rna: typing.Any
1289
- """ """
1290
-
1291
1737
  bl_space_type: typing.Any
1292
- """ """
1293
-
1294
1738
  id_data: typing.Any
1295
- """ """
1296
1739
 
1297
1740
  def append(self, draw_func):
1298
- """
1741
+ """Append a draw function to this menu,
1742
+ takes the same arguments as the menus draw function
1299
1743
 
1300
- :param draw_func:
1744
+ :param draw_func:
1301
1745
  """
1302
1746
  ...
1303
1747
 
1304
- def as_pointer(self):
1305
- """ """
1748
+ def as_pointer(self) -> int:
1749
+ """Returns the memory address which holds a pointer to Blender's internal data
1750
+
1751
+ :return: int (memory address).
1752
+ :rtype: int
1753
+ """
1306
1754
  ...
1307
1755
 
1308
- def bl_rna_get_subclass(self):
1309
- """ """
1756
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1757
+ """
1758
+
1759
+ :return: The RNA type or default when not found.
1760
+ :rtype: bpy.types.Struct
1761
+ """
1310
1762
  ...
1311
1763
 
1312
- def bl_rna_get_subclass_py(self):
1313
- """ """
1764
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1765
+ """
1766
+
1767
+ :return: The class or default when not found.
1768
+ :rtype: typing.Any
1769
+ """
1314
1770
  ...
1315
1771
 
1316
1772
  def draw(self, context):
@@ -1320,72 +1776,126 @@ class PHYSICS_PT_field_settings(
1320
1776
  """
1321
1777
  ...
1322
1778
 
1323
- def driver_add(self):
1324
- """ """
1779
+ def driver_add(self) -> bpy.types.FCurve:
1780
+ """Adds driver(s) to the given property
1781
+
1782
+ :return: The driver(s) added.
1783
+ :rtype: bpy.types.FCurve
1784
+ """
1325
1785
  ...
1326
1786
 
1327
- def driver_remove(self):
1328
- """ """
1787
+ def driver_remove(self) -> bool:
1788
+ """Remove driver(s) from the given property
1789
+
1790
+ :return: Success of driver removal.
1791
+ :rtype: bool
1792
+ """
1329
1793
  ...
1330
1794
 
1331
1795
  def get(self):
1332
- """ """
1796
+ """Returns the value of the custom property assigned to key or default
1797
+ when not found (matches Python's dictionary function of the same name).
1798
+
1799
+ """
1333
1800
  ...
1334
1801
 
1335
1802
  def id_properties_clear(self):
1336
- """ """
1803
+ """
1804
+
1805
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1806
+ """
1337
1807
  ...
1338
1808
 
1339
1809
  def id_properties_ensure(self):
1340
- """ """
1810
+ """
1811
+
1812
+ :return: the parent group for an RNA struct's custom IDProperties.
1813
+ """
1341
1814
  ...
1342
1815
 
1343
1816
  def id_properties_ui(self):
1344
- """ """
1345
- ...
1817
+ """
1346
1818
 
1347
- def is_extended(self):
1348
- """ """
1819
+ :return: Return an object used to manage an IDProperty's UI data.
1820
+ """
1349
1821
  ...
1350
1822
 
1351
- def is_property_hidden(self):
1352
- """ """
1823
+ def is_extended(self): ...
1824
+ def is_property_hidden(self) -> bool:
1825
+ """Check if a property is hidden.
1826
+
1827
+ :return: True when the property is hidden.
1828
+ :rtype: bool
1829
+ """
1353
1830
  ...
1354
1831
 
1355
- def is_property_overridable_library(self):
1356
- """ """
1832
+ def is_property_overridable_library(self) -> bool:
1833
+ """Check if a property is overridable.
1834
+
1835
+ :return: True when the property is overridable.
1836
+ :rtype: bool
1837
+ """
1357
1838
  ...
1358
1839
 
1359
- def is_property_readonly(self):
1360
- """ """
1840
+ def is_property_readonly(self) -> bool:
1841
+ """Check if a property is readonly.
1842
+
1843
+ :return: True when the property is readonly (not writable).
1844
+ :rtype: bool
1845
+ """
1361
1846
  ...
1362
1847
 
1363
- def is_property_set(self):
1364
- """ """
1848
+ def is_property_set(self) -> bool:
1849
+ """Check if a property is set, use for testing operator properties.
1850
+
1851
+ :return: True when the property has been set.
1852
+ :rtype: bool
1853
+ """
1365
1854
  ...
1366
1855
 
1367
1856
  def items(self):
1368
- """ """
1857
+ """Returns the items of this objects custom properties (matches Python's
1858
+ dictionary function of the same name).
1859
+
1860
+ :return: custom property key, value pairs.
1861
+ """
1369
1862
  ...
1370
1863
 
1371
- def keyframe_delete(self):
1372
- """ """
1864
+ def keyframe_delete(self) -> bool:
1865
+ """Remove a keyframe from this properties fcurve.
1866
+
1867
+ :return: Success of keyframe deletion.
1868
+ :rtype: bool
1869
+ """
1373
1870
  ...
1374
1871
 
1375
- def keyframe_insert(self):
1376
- """ """
1872
+ def keyframe_insert(self) -> bool:
1873
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1874
+
1875
+ :return: Success of keyframe insertion.
1876
+ :rtype: bool
1877
+ """
1377
1878
  ...
1378
1879
 
1379
1880
  def keys(self):
1380
- """ """
1881
+ """Returns the keys of this objects custom properties (matches Python's
1882
+ dictionary function of the same name).
1883
+
1884
+ :return: custom property keys.
1885
+ """
1381
1886
  ...
1382
1887
 
1383
- def path_from_id(self):
1384
- """ """
1888
+ def path_from_id(self) -> str:
1889
+ """Returns the data path from the ID to this object (string).
1890
+
1891
+ :return: The path from `bpy.types.bpy_struct.id_data`
1892
+ to this struct and property (when given).
1893
+ :rtype: str
1894
+ """
1385
1895
  ...
1386
1896
 
1387
1897
  def path_resolve(self):
1388
- """ """
1898
+ """Returns the property from the path, raise an exception when not found."""
1389
1899
  ...
1390
1900
 
1391
1901
  def poll(self, context):
@@ -1410,85 +1920,97 @@ class PHYSICS_PT_field_settings(
1410
1920
  ...
1411
1921
 
1412
1922
  def pop(self):
1413
- """ """
1923
+ """Remove and return the value of the custom property assigned to key or default
1924
+ when not found (matches Python's dictionary function of the same name).
1925
+
1926
+ """
1414
1927
  ...
1415
1928
 
1416
1929
  def prepend(self, draw_func):
1417
- """
1930
+ """Prepend a draw function to this menu, takes the same arguments as
1931
+ the menus draw function
1418
1932
 
1419
- :param draw_func:
1933
+ :param draw_func:
1420
1934
  """
1421
1935
  ...
1422
1936
 
1423
- def property_overridable_library_set(self):
1424
- """ """
1937
+ def property_overridable_library_set(self) -> bool:
1938
+ """Define a property as overridable or not (only for custom properties!).
1939
+
1940
+ :return: True when the overridable status of the property was successfully set.
1941
+ :rtype: bool
1942
+ """
1425
1943
  ...
1426
1944
 
1427
1945
  def property_unset(self):
1428
- """ """
1946
+ """Unset a property, will use default value afterward."""
1429
1947
  ...
1430
1948
 
1431
1949
  def remove(self, draw_func):
1432
- """
1950
+ """Remove a draw function that has been added to this menu
1433
1951
 
1434
1952
  :param draw_func:
1435
1953
  """
1436
1954
  ...
1437
1955
 
1438
1956
  def type_recast(self):
1439
- """ """
1957
+ """Return a new instance, this is needed because types
1958
+ such as textures can be changed at runtime.
1959
+
1960
+ :return: a new instance of this object with the type initialized again.
1961
+ """
1440
1962
  ...
1441
1963
 
1442
1964
  def values(self):
1443
- """ """
1965
+ """Returns the values of this objects custom properties (matches Python's
1966
+ dictionary function of the same name).
1967
+
1968
+ :return: custom property values.
1969
+ """
1444
1970
  ...
1445
1971
 
1446
1972
  class PHYSICS_PT_field_settings_kink(
1447
1973
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
1448
1974
  ):
1449
- """ """
1450
-
1451
1975
  COMPAT_ENGINES: typing.Any
1452
- """ """
1453
-
1454
1976
  bl_context: typing.Any
1455
- """ """
1456
-
1457
1977
  bl_label: typing.Any
1458
- """ """
1459
-
1460
1978
  bl_parent_id: typing.Any
1461
- """ """
1462
-
1463
1979
  bl_region_type: typing.Any
1464
- """ """
1465
-
1466
1980
  bl_rna: typing.Any
1467
- """ """
1468
-
1469
1981
  bl_space_type: typing.Any
1470
- """ """
1471
-
1472
1982
  id_data: typing.Any
1473
- """ """
1474
1983
 
1475
1984
  def append(self, draw_func):
1476
- """
1985
+ """Append a draw function to this menu,
1986
+ takes the same arguments as the menus draw function
1477
1987
 
1478
- :param draw_func:
1988
+ :param draw_func:
1479
1989
  """
1480
1990
  ...
1481
1991
 
1482
- def as_pointer(self):
1483
- """ """
1992
+ def as_pointer(self) -> int:
1993
+ """Returns the memory address which holds a pointer to Blender's internal data
1994
+
1995
+ :return: int (memory address).
1996
+ :rtype: int
1997
+ """
1484
1998
  ...
1485
1999
 
1486
- def bl_rna_get_subclass(self):
1487
- """ """
2000
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2001
+ """
2002
+
2003
+ :return: The RNA type or default when not found.
2004
+ :rtype: bpy.types.Struct
2005
+ """
1488
2006
  ...
1489
2007
 
1490
- def bl_rna_get_subclass_py(self):
1491
- """ """
2008
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2009
+ """
2010
+
2011
+ :return: The class or default when not found.
2012
+ :rtype: typing.Any
2013
+ """
1492
2014
  ...
1493
2015
 
1494
2016
  def draw(self, context):
@@ -1498,72 +2020,126 @@ class PHYSICS_PT_field_settings_kink(
1498
2020
  """
1499
2021
  ...
1500
2022
 
1501
- def driver_add(self):
1502
- """ """
2023
+ def driver_add(self) -> bpy.types.FCurve:
2024
+ """Adds driver(s) to the given property
2025
+
2026
+ :return: The driver(s) added.
2027
+ :rtype: bpy.types.FCurve
2028
+ """
1503
2029
  ...
1504
2030
 
1505
- def driver_remove(self):
1506
- """ """
2031
+ def driver_remove(self) -> bool:
2032
+ """Remove driver(s) from the given property
2033
+
2034
+ :return: Success of driver removal.
2035
+ :rtype: bool
2036
+ """
1507
2037
  ...
1508
2038
 
1509
2039
  def get(self):
1510
- """ """
2040
+ """Returns the value of the custom property assigned to key or default
2041
+ when not found (matches Python's dictionary function of the same name).
2042
+
2043
+ """
1511
2044
  ...
1512
2045
 
1513
2046
  def id_properties_clear(self):
1514
- """ """
2047
+ """
2048
+
2049
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2050
+ """
1515
2051
  ...
1516
2052
 
1517
2053
  def id_properties_ensure(self):
1518
- """ """
2054
+ """
2055
+
2056
+ :return: the parent group for an RNA struct's custom IDProperties.
2057
+ """
1519
2058
  ...
1520
2059
 
1521
2060
  def id_properties_ui(self):
1522
- """ """
1523
- ...
2061
+ """
1524
2062
 
1525
- def is_extended(self):
1526
- """ """
2063
+ :return: Return an object used to manage an IDProperty's UI data.
2064
+ """
1527
2065
  ...
1528
2066
 
1529
- def is_property_hidden(self):
1530
- """ """
2067
+ def is_extended(self): ...
2068
+ def is_property_hidden(self) -> bool:
2069
+ """Check if a property is hidden.
2070
+
2071
+ :return: True when the property is hidden.
2072
+ :rtype: bool
2073
+ """
1531
2074
  ...
1532
2075
 
1533
- def is_property_overridable_library(self):
1534
- """ """
2076
+ def is_property_overridable_library(self) -> bool:
2077
+ """Check if a property is overridable.
2078
+
2079
+ :return: True when the property is overridable.
2080
+ :rtype: bool
2081
+ """
1535
2082
  ...
1536
2083
 
1537
- def is_property_readonly(self):
1538
- """ """
2084
+ def is_property_readonly(self) -> bool:
2085
+ """Check if a property is readonly.
2086
+
2087
+ :return: True when the property is readonly (not writable).
2088
+ :rtype: bool
2089
+ """
1539
2090
  ...
1540
2091
 
1541
- def is_property_set(self):
1542
- """ """
2092
+ def is_property_set(self) -> bool:
2093
+ """Check if a property is set, use for testing operator properties.
2094
+
2095
+ :return: True when the property has been set.
2096
+ :rtype: bool
2097
+ """
1543
2098
  ...
1544
2099
 
1545
2100
  def items(self):
1546
- """ """
2101
+ """Returns the items of this objects custom properties (matches Python's
2102
+ dictionary function of the same name).
2103
+
2104
+ :return: custom property key, value pairs.
2105
+ """
1547
2106
  ...
1548
2107
 
1549
- def keyframe_delete(self):
1550
- """ """
2108
+ def keyframe_delete(self) -> bool:
2109
+ """Remove a keyframe from this properties fcurve.
2110
+
2111
+ :return: Success of keyframe deletion.
2112
+ :rtype: bool
2113
+ """
1551
2114
  ...
1552
2115
 
1553
- def keyframe_insert(self):
1554
- """ """
2116
+ def keyframe_insert(self) -> bool:
2117
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2118
+
2119
+ :return: Success of keyframe insertion.
2120
+ :rtype: bool
2121
+ """
1555
2122
  ...
1556
2123
 
1557
2124
  def keys(self):
1558
- """ """
2125
+ """Returns the keys of this objects custom properties (matches Python's
2126
+ dictionary function of the same name).
2127
+
2128
+ :return: custom property keys.
2129
+ """
1559
2130
  ...
1560
2131
 
1561
- def path_from_id(self):
1562
- """ """
2132
+ def path_from_id(self) -> str:
2133
+ """Returns the data path from the ID to this object (string).
2134
+
2135
+ :return: The path from `bpy.types.bpy_struct.id_data`
2136
+ to this struct and property (when given).
2137
+ :rtype: str
2138
+ """
1563
2139
  ...
1564
2140
 
1565
2141
  def path_resolve(self):
1566
- """ """
2142
+ """Returns the property from the path, raise an exception when not found."""
1567
2143
  ...
1568
2144
 
1569
2145
  def poll(self, context):
@@ -1588,85 +2164,97 @@ class PHYSICS_PT_field_settings_kink(
1588
2164
  ...
1589
2165
 
1590
2166
  def pop(self):
1591
- """ """
2167
+ """Remove and return the value of the custom property assigned to key or default
2168
+ when not found (matches Python's dictionary function of the same name).
2169
+
2170
+ """
1592
2171
  ...
1593
2172
 
1594
2173
  def prepend(self, draw_func):
1595
- """
2174
+ """Prepend a draw function to this menu, takes the same arguments as
2175
+ the menus draw function
1596
2176
 
1597
- :param draw_func:
2177
+ :param draw_func:
1598
2178
  """
1599
2179
  ...
1600
2180
 
1601
- def property_overridable_library_set(self):
1602
- """ """
2181
+ def property_overridable_library_set(self) -> bool:
2182
+ """Define a property as overridable or not (only for custom properties!).
2183
+
2184
+ :return: True when the overridable status of the property was successfully set.
2185
+ :rtype: bool
2186
+ """
1603
2187
  ...
1604
2188
 
1605
2189
  def property_unset(self):
1606
- """ """
2190
+ """Unset a property, will use default value afterward."""
1607
2191
  ...
1608
2192
 
1609
2193
  def remove(self, draw_func):
1610
- """
2194
+ """Remove a draw function that has been added to this menu
1611
2195
 
1612
2196
  :param draw_func:
1613
2197
  """
1614
2198
  ...
1615
2199
 
1616
2200
  def type_recast(self):
1617
- """ """
2201
+ """Return a new instance, this is needed because types
2202
+ such as textures can be changed at runtime.
2203
+
2204
+ :return: a new instance of this object with the type initialized again.
2205
+ """
1618
2206
  ...
1619
2207
 
1620
2208
  def values(self):
1621
- """ """
2209
+ """Returns the values of this objects custom properties (matches Python's
2210
+ dictionary function of the same name).
2211
+
2212
+ :return: custom property values.
2213
+ """
1622
2214
  ...
1623
2215
 
1624
2216
  class PHYSICS_PT_field_settings_texture_select(
1625
2217
  bpy_types.Panel, PhysicButtonsPanel, bpy_types._GenericUI
1626
2218
  ):
1627
- """ """
1628
-
1629
2219
  COMPAT_ENGINES: typing.Any
1630
- """ """
1631
-
1632
2220
  bl_context: typing.Any
1633
- """ """
1634
-
1635
2221
  bl_label: typing.Any
1636
- """ """
1637
-
1638
2222
  bl_parent_id: typing.Any
1639
- """ """
1640
-
1641
2223
  bl_region_type: typing.Any
1642
- """ """
1643
-
1644
2224
  bl_rna: typing.Any
1645
- """ """
1646
-
1647
2225
  bl_space_type: typing.Any
1648
- """ """
1649
-
1650
2226
  id_data: typing.Any
1651
- """ """
1652
2227
 
1653
2228
  def append(self, draw_func):
1654
- """
2229
+ """Append a draw function to this menu,
2230
+ takes the same arguments as the menus draw function
1655
2231
 
1656
- :param draw_func:
2232
+ :param draw_func:
1657
2233
  """
1658
2234
  ...
1659
2235
 
1660
- def as_pointer(self):
1661
- """ """
2236
+ def as_pointer(self) -> int:
2237
+ """Returns the memory address which holds a pointer to Blender's internal data
2238
+
2239
+ :return: int (memory address).
2240
+ :rtype: int
2241
+ """
1662
2242
  ...
1663
2243
 
1664
- def bl_rna_get_subclass(self):
1665
- """ """
2244
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2245
+ """
2246
+
2247
+ :return: The RNA type or default when not found.
2248
+ :rtype: bpy.types.Struct
2249
+ """
1666
2250
  ...
1667
2251
 
1668
- def bl_rna_get_subclass_py(self):
1669
- """ """
2252
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2253
+ """
2254
+
2255
+ :return: The class or default when not found.
2256
+ :rtype: typing.Any
2257
+ """
1670
2258
  ...
1671
2259
 
1672
2260
  def draw(self, context):
@@ -1676,72 +2264,126 @@ class PHYSICS_PT_field_settings_texture_select(
1676
2264
  """
1677
2265
  ...
1678
2266
 
1679
- def driver_add(self):
1680
- """ """
2267
+ def driver_add(self) -> bpy.types.FCurve:
2268
+ """Adds driver(s) to the given property
2269
+
2270
+ :return: The driver(s) added.
2271
+ :rtype: bpy.types.FCurve
2272
+ """
1681
2273
  ...
1682
2274
 
1683
- def driver_remove(self):
1684
- """ """
2275
+ def driver_remove(self) -> bool:
2276
+ """Remove driver(s) from the given property
2277
+
2278
+ :return: Success of driver removal.
2279
+ :rtype: bool
2280
+ """
1685
2281
  ...
1686
2282
 
1687
2283
  def get(self):
1688
- """ """
2284
+ """Returns the value of the custom property assigned to key or default
2285
+ when not found (matches Python's dictionary function of the same name).
2286
+
2287
+ """
1689
2288
  ...
1690
2289
 
1691
2290
  def id_properties_clear(self):
1692
- """ """
2291
+ """
2292
+
2293
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2294
+ """
1693
2295
  ...
1694
2296
 
1695
2297
  def id_properties_ensure(self):
1696
- """ """
2298
+ """
2299
+
2300
+ :return: the parent group for an RNA struct's custom IDProperties.
2301
+ """
1697
2302
  ...
1698
2303
 
1699
2304
  def id_properties_ui(self):
1700
- """ """
1701
- ...
2305
+ """
1702
2306
 
1703
- def is_extended(self):
1704
- """ """
2307
+ :return: Return an object used to manage an IDProperty's UI data.
2308
+ """
1705
2309
  ...
1706
2310
 
1707
- def is_property_hidden(self):
1708
- """ """
2311
+ def is_extended(self): ...
2312
+ def is_property_hidden(self) -> bool:
2313
+ """Check if a property is hidden.
2314
+
2315
+ :return: True when the property is hidden.
2316
+ :rtype: bool
2317
+ """
1709
2318
  ...
1710
2319
 
1711
- def is_property_overridable_library(self):
1712
- """ """
2320
+ def is_property_overridable_library(self) -> bool:
2321
+ """Check if a property is overridable.
2322
+
2323
+ :return: True when the property is overridable.
2324
+ :rtype: bool
2325
+ """
1713
2326
  ...
1714
2327
 
1715
- def is_property_readonly(self):
1716
- """ """
2328
+ def is_property_readonly(self) -> bool:
2329
+ """Check if a property is readonly.
2330
+
2331
+ :return: True when the property is readonly (not writable).
2332
+ :rtype: bool
2333
+ """
1717
2334
  ...
1718
2335
 
1719
- def is_property_set(self):
1720
- """ """
2336
+ def is_property_set(self) -> bool:
2337
+ """Check if a property is set, use for testing operator properties.
2338
+
2339
+ :return: True when the property has been set.
2340
+ :rtype: bool
2341
+ """
1721
2342
  ...
1722
2343
 
1723
2344
  def items(self):
1724
- """ """
2345
+ """Returns the items of this objects custom properties (matches Python's
2346
+ dictionary function of the same name).
2347
+
2348
+ :return: custom property key, value pairs.
2349
+ """
1725
2350
  ...
1726
2351
 
1727
- def keyframe_delete(self):
1728
- """ """
2352
+ def keyframe_delete(self) -> bool:
2353
+ """Remove a keyframe from this properties fcurve.
2354
+
2355
+ :return: Success of keyframe deletion.
2356
+ :rtype: bool
2357
+ """
1729
2358
  ...
1730
2359
 
1731
- def keyframe_insert(self):
1732
- """ """
2360
+ def keyframe_insert(self) -> bool:
2361
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2362
+
2363
+ :return: Success of keyframe insertion.
2364
+ :rtype: bool
2365
+ """
1733
2366
  ...
1734
2367
 
1735
2368
  def keys(self):
1736
- """ """
2369
+ """Returns the keys of this objects custom properties (matches Python's
2370
+ dictionary function of the same name).
2371
+
2372
+ :return: custom property keys.
2373
+ """
1737
2374
  ...
1738
2375
 
1739
- def path_from_id(self):
1740
- """ """
2376
+ def path_from_id(self) -> str:
2377
+ """Returns the data path from the ID to this object (string).
2378
+
2379
+ :return: The path from `bpy.types.bpy_struct.id_data`
2380
+ to this struct and property (when given).
2381
+ :rtype: str
2382
+ """
1741
2383
  ...
1742
2384
 
1743
2385
  def path_resolve(self):
1744
- """ """
2386
+ """Returns the property from the path, raise an exception when not found."""
1745
2387
  ...
1746
2388
 
1747
2389
  def poll(self, context):
@@ -1766,40 +2408,53 @@ class PHYSICS_PT_field_settings_texture_select(
1766
2408
  ...
1767
2409
 
1768
2410
  def pop(self):
1769
- """ """
2411
+ """Remove and return the value of the custom property assigned to key or default
2412
+ when not found (matches Python's dictionary function of the same name).
2413
+
2414
+ """
1770
2415
  ...
1771
2416
 
1772
2417
  def prepend(self, draw_func):
1773
- """
2418
+ """Prepend a draw function to this menu, takes the same arguments as
2419
+ the menus draw function
1774
2420
 
1775
- :param draw_func:
2421
+ :param draw_func:
1776
2422
  """
1777
2423
  ...
1778
2424
 
1779
- def property_overridable_library_set(self):
1780
- """ """
2425
+ def property_overridable_library_set(self) -> bool:
2426
+ """Define a property as overridable or not (only for custom properties!).
2427
+
2428
+ :return: True when the overridable status of the property was successfully set.
2429
+ :rtype: bool
2430
+ """
1781
2431
  ...
1782
2432
 
1783
2433
  def property_unset(self):
1784
- """ """
2434
+ """Unset a property, will use default value afterward."""
1785
2435
  ...
1786
2436
 
1787
2437
  def remove(self, draw_func):
1788
- """
2438
+ """Remove a draw function that has been added to this menu
1789
2439
 
1790
2440
  :param draw_func:
1791
2441
  """
1792
2442
  ...
1793
2443
 
1794
2444
  def type_recast(self):
1795
- """ """
2445
+ """Return a new instance, this is needed because types
2446
+ such as textures can be changed at runtime.
2447
+
2448
+ :return: a new instance of this object with the type initialized again.
2449
+ """
1796
2450
  ...
1797
2451
 
1798
2452
  def values(self):
1799
- """ """
1800
- ...
2453
+ """Returns the values of this objects custom properties (matches Python's
2454
+ dictionary function of the same name).
1801
2455
 
1802
- def collision_warning(layout):
1803
- """ """
2456
+ :return: custom property values.
2457
+ """
2458
+ ...
1804
2459
 
1805
- ...
2460
+ def collision_warning(layout): ...