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

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

Potentially problematic release.


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

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