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")
@@ -27,22 +28,35 @@ class TIME_MT_cache(bpy_types.Menu, bpy_types._GenericUI):
27
28
  """ """
28
29
 
29
30
  def append(self, draw_func):
30
- """
31
+ """Append a draw function to this menu,
32
+ takes the same arguments as the menus draw function
31
33
 
32
- :param draw_func:
34
+ :param draw_func:
33
35
  """
34
36
  ...
35
37
 
36
- def as_pointer(self):
37
- """ """
38
+ def as_pointer(self) -> int:
39
+ """Returns the memory address which holds a pointer to Blender's internal data
40
+
41
+ :return: int (memory address).
42
+ :rtype: int
43
+ """
38
44
  ...
39
45
 
40
- def bl_rna_get_subclass(self):
41
- """ """
46
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
47
+ """
48
+
49
+ :return: The RNA type or default when not found.
50
+ :rtype: bpy.types.Struct
51
+ """
42
52
  ...
43
53
 
44
- def bl_rna_get_subclass_py(self):
45
- """ """
54
+ def bl_rna_get_subclass_py(self) -> typing.Any:
55
+ """
56
+
57
+ :return: The class or default when not found.
58
+ :rtype: typing.Any
59
+ """
46
60
  ...
47
61
 
48
62
  def draw(self, context):
@@ -61,138 +75,224 @@ class TIME_MT_cache(bpy_types.Menu, bpy_types._GenericUI):
61
75
  ...
62
76
 
63
77
  def draw_preset(self, _context):
64
- """
78
+ """Define these on the subclass:
79
+ - preset_operator (string)
80
+ - preset_subdir (string)Optionally:
81
+ - preset_add_operator (string)
82
+ - preset_extensions (set of strings)
83
+ - preset_operator_defaults (dict of keyword args)
65
84
 
66
- :param _context:
85
+ :param _context:
67
86
  """
68
87
  ...
69
88
 
70
- def driver_add(self):
71
- """ """
89
+ def driver_add(self) -> bpy.types.FCurve:
90
+ """Adds driver(s) to the given property
91
+
92
+ :return: The driver(s) added.
93
+ :rtype: bpy.types.FCurve
94
+ """
72
95
  ...
73
96
 
74
- def driver_remove(self):
75
- """ """
97
+ def driver_remove(self) -> bool:
98
+ """Remove driver(s) from the given property
99
+
100
+ :return: Success of driver removal.
101
+ :rtype: bool
102
+ """
76
103
  ...
77
104
 
78
105
  def get(self):
79
- """ """
106
+ """Returns the value of the custom property assigned to key or default
107
+ when not found (matches Python's dictionary function of the same name).
108
+
109
+ """
80
110
  ...
81
111
 
82
112
  def id_properties_clear(self):
83
- """ """
113
+ """
114
+
115
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
116
+ """
84
117
  ...
85
118
 
86
119
  def id_properties_ensure(self):
87
- """ """
120
+ """
121
+
122
+ :return: the parent group for an RNA struct's custom IDProperties.
123
+ """
88
124
  ...
89
125
 
90
126
  def id_properties_ui(self):
91
- """ """
127
+ """
128
+
129
+ :return: Return an object used to manage an IDProperty's UI data.
130
+ """
92
131
  ...
93
132
 
94
133
  def is_extended(self):
95
134
  """ """
96
135
  ...
97
136
 
98
- def is_property_hidden(self):
99
- """ """
137
+ def is_property_hidden(self) -> bool:
138
+ """Check if a property is hidden.
139
+
140
+ :return: True when the property is hidden.
141
+ :rtype: bool
142
+ """
100
143
  ...
101
144
 
102
- def is_property_overridable_library(self):
103
- """ """
145
+ def is_property_overridable_library(self) -> bool:
146
+ """Check if a property is overridable.
147
+
148
+ :return: True when the property is overridable.
149
+ :rtype: bool
150
+ """
104
151
  ...
105
152
 
106
- def is_property_readonly(self):
107
- """ """
153
+ def is_property_readonly(self) -> bool:
154
+ """Check if a property is readonly.
155
+
156
+ :return: True when the property is readonly (not writable).
157
+ :rtype: bool
158
+ """
108
159
  ...
109
160
 
110
- def is_property_set(self):
111
- """ """
161
+ def is_property_set(self) -> bool:
162
+ """Check if a property is set, use for testing operator properties.
163
+
164
+ :return: True when the property has been set.
165
+ :rtype: bool
166
+ """
112
167
  ...
113
168
 
114
169
  def items(self):
115
- """ """
170
+ """Returns the items of this objects custom properties (matches Python's
171
+ dictionary function of the same name).
172
+
173
+ :return: custom property key, value pairs.
174
+ """
116
175
  ...
117
176
 
118
- def keyframe_delete(self):
119
- """ """
177
+ def keyframe_delete(self) -> bool:
178
+ """Remove a keyframe from this properties fcurve.
179
+
180
+ :return: Success of keyframe deletion.
181
+ :rtype: bool
182
+ """
120
183
  ...
121
184
 
122
- def keyframe_insert(self):
123
- """ """
185
+ def keyframe_insert(self) -> bool:
186
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
187
+
188
+ :return: Success of keyframe insertion.
189
+ :rtype: bool
190
+ """
124
191
  ...
125
192
 
126
193
  def keys(self):
127
- """ """
194
+ """Returns the keys of this objects custom properties (matches Python's
195
+ dictionary function of the same name).
196
+
197
+ :return: custom property keys.
198
+ """
128
199
  ...
129
200
 
130
- def path_from_id(self):
131
- """ """
201
+ def path_from_id(self) -> str:
202
+ """Returns the data path from the ID to this object (string).
203
+
204
+ :return: The path from `bpy.types.bpy_struct.id_data`
205
+ to this struct and property (when given).
206
+ :rtype: str
207
+ """
132
208
  ...
133
209
 
134
210
  def path_menu(
135
211
  self,
136
- searchpaths,
137
- operator,
138
- props_default,
139
- prop_filepath,
140
- filter_ext,
141
- filter_path,
142
- display_name,
143
- add_operator,
144
- add_operator_props,
212
+ searchpaths: list[str],
213
+ operator: str,
214
+ props_default: dict = None,
215
+ prop_filepath: str = "filepath",
216
+ filter_ext: typing.Callable = None,
217
+ filter_path=None,
218
+ display_name: typing.Callable = None,
219
+ add_operator=None,
220
+ add_operator_props=None,
145
221
  ):
146
- """
222
+ """Populate a menu from a list of paths.
223
+
224
+ :param searchpaths: Paths to scan.
225
+ :type searchpaths: list[str]
226
+ :param operator: The operator id to use with each file.
227
+ :type operator: str
228
+ :param props_default: Properties to assign to each operator.
229
+ :type props_default: dict
230
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
231
+ :type prop_filepath: str
232
+ :param filter_ext: Optional callback that takes the file extensions.
147
233
 
148
- :param searchpaths:
149
- :param operator:
150
- :param props_default:
151
- :param prop_filepath:
152
- :param filter_ext:
153
- :param filter_path:
154
- :param display_name:
155
- :param add_operator:
156
- :param add_operator_props:
234
+ Returning false excludes the file from the list.
235
+ :type filter_ext: typing.Callable
236
+ :param filter_path:
237
+ :param display_name: Optional callback that takes the full path, returns the name to display.
238
+ :type display_name: typing.Callable
239
+ :param add_operator:
240
+ :param add_operator_props:
157
241
  """
158
242
  ...
159
243
 
160
244
  def path_resolve(self):
161
- """ """
245
+ """Returns the property from the path, raise an exception when not found."""
162
246
  ...
163
247
 
164
248
  def pop(self):
165
- """ """
249
+ """Remove and return the value of the custom property assigned to key or default
250
+ when not found (matches Python's dictionary function of the same name).
251
+
252
+ """
166
253
  ...
167
254
 
168
255
  def prepend(self, draw_func):
169
- """
256
+ """Prepend a draw function to this menu, takes the same arguments as
257
+ the menus draw function
170
258
 
171
- :param draw_func:
259
+ :param draw_func:
172
260
  """
173
261
  ...
174
262
 
175
- def property_overridable_library_set(self):
176
- """ """
263
+ def property_overridable_library_set(self) -> bool:
264
+ """Define a property as overridable or not (only for custom properties!).
265
+
266
+ :return: True when the overridable status of the property was successfully set.
267
+ :rtype: bool
268
+ """
177
269
  ...
178
270
 
179
271
  def property_unset(self):
180
- """ """
272
+ """Unset a property, will use default value afterward."""
181
273
  ...
182
274
 
183
275
  def remove(self, draw_func):
184
- """
276
+ """Remove a draw function that has been added to this menu
185
277
 
186
278
  :param draw_func:
187
279
  """
188
280
  ...
189
281
 
190
282
  def type_recast(self):
191
- """ """
283
+ """Return a new instance, this is needed because types
284
+ such as textures can be changed at runtime.
285
+
286
+ :return: a new instance of this object with the type initialized again.
287
+ """
192
288
  ...
193
289
 
194
290
  def values(self):
195
- """ """
291
+ """Returns the values of this objects custom properties (matches Python's
292
+ dictionary function of the same name).
293
+
294
+ :return: custom property values.
295
+ """
196
296
  ...
197
297
 
198
298
  class TIME_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
@@ -211,22 +311,35 @@ class TIME_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
211
311
  """ """
212
312
 
213
313
  def append(self, draw_func):
214
- """
314
+ """Append a draw function to this menu,
315
+ takes the same arguments as the menus draw function
215
316
 
216
- :param draw_func:
317
+ :param draw_func:
217
318
  """
218
319
  ...
219
320
 
220
- def as_pointer(self):
221
- """ """
321
+ def as_pointer(self) -> int:
322
+ """Returns the memory address which holds a pointer to Blender's internal data
323
+
324
+ :return: int (memory address).
325
+ :rtype: int
326
+ """
222
327
  ...
223
328
 
224
- def bl_rna_get_subclass(self):
225
- """ """
329
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
330
+ """
331
+
332
+ :return: The RNA type or default when not found.
333
+ :rtype: bpy.types.Struct
334
+ """
226
335
  ...
227
336
 
228
- def bl_rna_get_subclass_py(self):
229
- """ """
337
+ def bl_rna_get_subclass_py(self) -> typing.Any:
338
+ """
339
+
340
+ :return: The class or default when not found.
341
+ :rtype: typing.Any
342
+ """
230
343
  ...
231
344
 
232
345
  def draw(self, context):
@@ -245,138 +358,224 @@ class TIME_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
245
358
  ...
246
359
 
247
360
  def draw_preset(self, _context):
248
- """
361
+ """Define these on the subclass:
362
+ - preset_operator (string)
363
+ - preset_subdir (string)Optionally:
364
+ - preset_add_operator (string)
365
+ - preset_extensions (set of strings)
366
+ - preset_operator_defaults (dict of keyword args)
249
367
 
250
- :param _context:
368
+ :param _context:
251
369
  """
252
370
  ...
253
371
 
254
- def driver_add(self):
255
- """ """
372
+ def driver_add(self) -> bpy.types.FCurve:
373
+ """Adds driver(s) to the given property
374
+
375
+ :return: The driver(s) added.
376
+ :rtype: bpy.types.FCurve
377
+ """
256
378
  ...
257
379
 
258
- def driver_remove(self):
259
- """ """
380
+ def driver_remove(self) -> bool:
381
+ """Remove driver(s) from the given property
382
+
383
+ :return: Success of driver removal.
384
+ :rtype: bool
385
+ """
260
386
  ...
261
387
 
262
388
  def get(self):
263
- """ """
389
+ """Returns the value of the custom property assigned to key or default
390
+ when not found (matches Python's dictionary function of the same name).
391
+
392
+ """
264
393
  ...
265
394
 
266
395
  def id_properties_clear(self):
267
- """ """
396
+ """
397
+
398
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
399
+ """
268
400
  ...
269
401
 
270
402
  def id_properties_ensure(self):
271
- """ """
403
+ """
404
+
405
+ :return: the parent group for an RNA struct's custom IDProperties.
406
+ """
272
407
  ...
273
408
 
274
409
  def id_properties_ui(self):
275
- """ """
410
+ """
411
+
412
+ :return: Return an object used to manage an IDProperty's UI data.
413
+ """
276
414
  ...
277
415
 
278
416
  def is_extended(self):
279
417
  """ """
280
418
  ...
281
419
 
282
- def is_property_hidden(self):
283
- """ """
420
+ def is_property_hidden(self) -> bool:
421
+ """Check if a property is hidden.
422
+
423
+ :return: True when the property is hidden.
424
+ :rtype: bool
425
+ """
284
426
  ...
285
427
 
286
- def is_property_overridable_library(self):
287
- """ """
428
+ def is_property_overridable_library(self) -> bool:
429
+ """Check if a property is overridable.
430
+
431
+ :return: True when the property is overridable.
432
+ :rtype: bool
433
+ """
288
434
  ...
289
435
 
290
- def is_property_readonly(self):
291
- """ """
436
+ def is_property_readonly(self) -> bool:
437
+ """Check if a property is readonly.
438
+
439
+ :return: True when the property is readonly (not writable).
440
+ :rtype: bool
441
+ """
292
442
  ...
293
443
 
294
- def is_property_set(self):
295
- """ """
444
+ def is_property_set(self) -> bool:
445
+ """Check if a property is set, use for testing operator properties.
446
+
447
+ :return: True when the property has been set.
448
+ :rtype: bool
449
+ """
296
450
  ...
297
451
 
298
452
  def items(self):
299
- """ """
453
+ """Returns the items of this objects custom properties (matches Python's
454
+ dictionary function of the same name).
455
+
456
+ :return: custom property key, value pairs.
457
+ """
300
458
  ...
301
459
 
302
- def keyframe_delete(self):
303
- """ """
460
+ def keyframe_delete(self) -> bool:
461
+ """Remove a keyframe from this properties fcurve.
462
+
463
+ :return: Success of keyframe deletion.
464
+ :rtype: bool
465
+ """
304
466
  ...
305
467
 
306
- def keyframe_insert(self):
307
- """ """
468
+ def keyframe_insert(self) -> bool:
469
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
470
+
471
+ :return: Success of keyframe insertion.
472
+ :rtype: bool
473
+ """
308
474
  ...
309
475
 
310
476
  def keys(self):
311
- """ """
477
+ """Returns the keys of this objects custom properties (matches Python's
478
+ dictionary function of the same name).
479
+
480
+ :return: custom property keys.
481
+ """
312
482
  ...
313
483
 
314
- def path_from_id(self):
315
- """ """
484
+ def path_from_id(self) -> str:
485
+ """Returns the data path from the ID to this object (string).
486
+
487
+ :return: The path from `bpy.types.bpy_struct.id_data`
488
+ to this struct and property (when given).
489
+ :rtype: str
490
+ """
316
491
  ...
317
492
 
318
493
  def path_menu(
319
494
  self,
320
- searchpaths,
321
- operator,
322
- props_default,
323
- prop_filepath,
324
- filter_ext,
325
- filter_path,
326
- display_name,
327
- add_operator,
328
- add_operator_props,
495
+ searchpaths: list[str],
496
+ operator: str,
497
+ props_default: dict = None,
498
+ prop_filepath: str = "filepath",
499
+ filter_ext: typing.Callable = None,
500
+ filter_path=None,
501
+ display_name: typing.Callable = None,
502
+ add_operator=None,
503
+ add_operator_props=None,
329
504
  ):
330
- """
505
+ """Populate a menu from a list of paths.
506
+
507
+ :param searchpaths: Paths to scan.
508
+ :type searchpaths: list[str]
509
+ :param operator: The operator id to use with each file.
510
+ :type operator: str
511
+ :param props_default: Properties to assign to each operator.
512
+ :type props_default: dict
513
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
514
+ :type prop_filepath: str
515
+ :param filter_ext: Optional callback that takes the file extensions.
331
516
 
332
- :param searchpaths:
333
- :param operator:
334
- :param props_default:
335
- :param prop_filepath:
336
- :param filter_ext:
337
- :param filter_path:
338
- :param display_name:
339
- :param add_operator:
340
- :param add_operator_props:
517
+ Returning false excludes the file from the list.
518
+ :type filter_ext: typing.Callable
519
+ :param filter_path:
520
+ :param display_name: Optional callback that takes the full path, returns the name to display.
521
+ :type display_name: typing.Callable
522
+ :param add_operator:
523
+ :param add_operator_props:
341
524
  """
342
525
  ...
343
526
 
344
527
  def path_resolve(self):
345
- """ """
528
+ """Returns the property from the path, raise an exception when not found."""
346
529
  ...
347
530
 
348
531
  def pop(self):
349
- """ """
532
+ """Remove and return the value of the custom property assigned to key or default
533
+ when not found (matches Python's dictionary function of the same name).
534
+
535
+ """
350
536
  ...
351
537
 
352
538
  def prepend(self, draw_func):
353
- """
539
+ """Prepend a draw function to this menu, takes the same arguments as
540
+ the menus draw function
354
541
 
355
- :param draw_func:
542
+ :param draw_func:
356
543
  """
357
544
  ...
358
545
 
359
- def property_overridable_library_set(self):
360
- """ """
546
+ def property_overridable_library_set(self) -> bool:
547
+ """Define a property as overridable or not (only for custom properties!).
548
+
549
+ :return: True when the overridable status of the property was successfully set.
550
+ :rtype: bool
551
+ """
361
552
  ...
362
553
 
363
554
  def property_unset(self):
364
- """ """
555
+ """Unset a property, will use default value afterward."""
365
556
  ...
366
557
 
367
558
  def remove(self, draw_func):
368
- """
559
+ """Remove a draw function that has been added to this menu
369
560
 
370
561
  :param draw_func:
371
562
  """
372
563
  ...
373
564
 
374
565
  def type_recast(self):
375
- """ """
566
+ """Return a new instance, this is needed because types
567
+ such as textures can be changed at runtime.
568
+
569
+ :return: a new instance of this object with the type initialized again.
570
+ """
376
571
  ...
377
572
 
378
573
  def values(self):
379
- """ """
574
+ """Returns the values of this objects custom properties (matches Python's
575
+ dictionary function of the same name).
576
+
577
+ :return: custom property values.
578
+ """
380
579
  ...
381
580
 
382
581
  class TIME_MT_marker(bpy_types.Menu, bpy_types._GenericUI):
@@ -392,22 +591,35 @@ class TIME_MT_marker(bpy_types.Menu, bpy_types._GenericUI):
392
591
  """ """
393
592
 
394
593
  def append(self, draw_func):
395
- """
594
+ """Append a draw function to this menu,
595
+ takes the same arguments as the menus draw function
396
596
 
397
- :param draw_func:
597
+ :param draw_func:
398
598
  """
399
599
  ...
400
600
 
401
- def as_pointer(self):
402
- """ """
601
+ def as_pointer(self) -> int:
602
+ """Returns the memory address which holds a pointer to Blender's internal data
603
+
604
+ :return: int (memory address).
605
+ :rtype: int
606
+ """
403
607
  ...
404
608
 
405
- def bl_rna_get_subclass(self):
406
- """ """
609
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
610
+ """
611
+
612
+ :return: The RNA type or default when not found.
613
+ :rtype: bpy.types.Struct
614
+ """
407
615
  ...
408
616
 
409
- def bl_rna_get_subclass_py(self):
410
- """ """
617
+ def bl_rna_get_subclass_py(self) -> typing.Any:
618
+ """
619
+
620
+ :return: The class or default when not found.
621
+ :rtype: typing.Any
622
+ """
411
623
  ...
412
624
 
413
625
  def draw(self, context):
@@ -426,138 +638,224 @@ class TIME_MT_marker(bpy_types.Menu, bpy_types._GenericUI):
426
638
  ...
427
639
 
428
640
  def draw_preset(self, _context):
429
- """
641
+ """Define these on the subclass:
642
+ - preset_operator (string)
643
+ - preset_subdir (string)Optionally:
644
+ - preset_add_operator (string)
645
+ - preset_extensions (set of strings)
646
+ - preset_operator_defaults (dict of keyword args)
430
647
 
431
- :param _context:
648
+ :param _context:
432
649
  """
433
650
  ...
434
651
 
435
- def driver_add(self):
436
- """ """
652
+ def driver_add(self) -> bpy.types.FCurve:
653
+ """Adds driver(s) to the given property
654
+
655
+ :return: The driver(s) added.
656
+ :rtype: bpy.types.FCurve
657
+ """
437
658
  ...
438
659
 
439
- def driver_remove(self):
440
- """ """
660
+ def driver_remove(self) -> bool:
661
+ """Remove driver(s) from the given property
662
+
663
+ :return: Success of driver removal.
664
+ :rtype: bool
665
+ """
441
666
  ...
442
667
 
443
668
  def get(self):
444
- """ """
669
+ """Returns the value of the custom property assigned to key or default
670
+ when not found (matches Python's dictionary function of the same name).
671
+
672
+ """
445
673
  ...
446
674
 
447
675
  def id_properties_clear(self):
448
- """ """
676
+ """
677
+
678
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
679
+ """
449
680
  ...
450
681
 
451
682
  def id_properties_ensure(self):
452
- """ """
683
+ """
684
+
685
+ :return: the parent group for an RNA struct's custom IDProperties.
686
+ """
453
687
  ...
454
688
 
455
689
  def id_properties_ui(self):
456
- """ """
690
+ """
691
+
692
+ :return: Return an object used to manage an IDProperty's UI data.
693
+ """
457
694
  ...
458
695
 
459
696
  def is_extended(self):
460
697
  """ """
461
698
  ...
462
699
 
463
- def is_property_hidden(self):
464
- """ """
700
+ def is_property_hidden(self) -> bool:
701
+ """Check if a property is hidden.
702
+
703
+ :return: True when the property is hidden.
704
+ :rtype: bool
705
+ """
465
706
  ...
466
707
 
467
- def is_property_overridable_library(self):
468
- """ """
708
+ def is_property_overridable_library(self) -> bool:
709
+ """Check if a property is overridable.
710
+
711
+ :return: True when the property is overridable.
712
+ :rtype: bool
713
+ """
469
714
  ...
470
715
 
471
- def is_property_readonly(self):
472
- """ """
716
+ def is_property_readonly(self) -> bool:
717
+ """Check if a property is readonly.
718
+
719
+ :return: True when the property is readonly (not writable).
720
+ :rtype: bool
721
+ """
473
722
  ...
474
723
 
475
- def is_property_set(self):
476
- """ """
724
+ def is_property_set(self) -> bool:
725
+ """Check if a property is set, use for testing operator properties.
726
+
727
+ :return: True when the property has been set.
728
+ :rtype: bool
729
+ """
477
730
  ...
478
731
 
479
732
  def items(self):
480
- """ """
733
+ """Returns the items of this objects custom properties (matches Python's
734
+ dictionary function of the same name).
735
+
736
+ :return: custom property key, value pairs.
737
+ """
481
738
  ...
482
739
 
483
- def keyframe_delete(self):
484
- """ """
740
+ def keyframe_delete(self) -> bool:
741
+ """Remove a keyframe from this properties fcurve.
742
+
743
+ :return: Success of keyframe deletion.
744
+ :rtype: bool
745
+ """
485
746
  ...
486
747
 
487
- def keyframe_insert(self):
488
- """ """
748
+ def keyframe_insert(self) -> bool:
749
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
750
+
751
+ :return: Success of keyframe insertion.
752
+ :rtype: bool
753
+ """
489
754
  ...
490
755
 
491
756
  def keys(self):
492
- """ """
757
+ """Returns the keys of this objects custom properties (matches Python's
758
+ dictionary function of the same name).
759
+
760
+ :return: custom property keys.
761
+ """
493
762
  ...
494
763
 
495
- def path_from_id(self):
496
- """ """
764
+ def path_from_id(self) -> str:
765
+ """Returns the data path from the ID to this object (string).
766
+
767
+ :return: The path from `bpy.types.bpy_struct.id_data`
768
+ to this struct and property (when given).
769
+ :rtype: str
770
+ """
497
771
  ...
498
772
 
499
773
  def path_menu(
500
774
  self,
501
- searchpaths,
502
- operator,
503
- props_default,
504
- prop_filepath,
505
- filter_ext,
506
- filter_path,
507
- display_name,
508
- add_operator,
509
- add_operator_props,
775
+ searchpaths: list[str],
776
+ operator: str,
777
+ props_default: dict = None,
778
+ prop_filepath: str = "filepath",
779
+ filter_ext: typing.Callable = None,
780
+ filter_path=None,
781
+ display_name: typing.Callable = None,
782
+ add_operator=None,
783
+ add_operator_props=None,
510
784
  ):
511
- """
785
+ """Populate a menu from a list of paths.
512
786
 
513
- :param searchpaths:
514
- :param operator:
515
- :param props_default:
516
- :param prop_filepath:
517
- :param filter_ext:
518
- :param filter_path:
519
- :param display_name:
520
- :param add_operator:
521
- :param add_operator_props:
787
+ :param searchpaths: Paths to scan.
788
+ :type searchpaths: list[str]
789
+ :param operator: The operator id to use with each file.
790
+ :type operator: str
791
+ :param props_default: Properties to assign to each operator.
792
+ :type props_default: dict
793
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
794
+ :type prop_filepath: str
795
+ :param filter_ext: Optional callback that takes the file extensions.
796
+
797
+ Returning false excludes the file from the list.
798
+ :type filter_ext: typing.Callable
799
+ :param filter_path:
800
+ :param display_name: Optional callback that takes the full path, returns the name to display.
801
+ :type display_name: typing.Callable
802
+ :param add_operator:
803
+ :param add_operator_props:
522
804
  """
523
805
  ...
524
806
 
525
807
  def path_resolve(self):
526
- """ """
808
+ """Returns the property from the path, raise an exception when not found."""
527
809
  ...
528
810
 
529
811
  def pop(self):
530
- """ """
812
+ """Remove and return the value of the custom property assigned to key or default
813
+ when not found (matches Python's dictionary function of the same name).
814
+
815
+ """
531
816
  ...
532
817
 
533
818
  def prepend(self, draw_func):
534
- """
819
+ """Prepend a draw function to this menu, takes the same arguments as
820
+ the menus draw function
535
821
 
536
- :param draw_func:
822
+ :param draw_func:
537
823
  """
538
824
  ...
539
825
 
540
- def property_overridable_library_set(self):
541
- """ """
826
+ def property_overridable_library_set(self) -> bool:
827
+ """Define a property as overridable or not (only for custom properties!).
828
+
829
+ :return: True when the overridable status of the property was successfully set.
830
+ :rtype: bool
831
+ """
542
832
  ...
543
833
 
544
834
  def property_unset(self):
545
- """ """
835
+ """Unset a property, will use default value afterward."""
546
836
  ...
547
837
 
548
838
  def remove(self, draw_func):
549
- """
839
+ """Remove a draw function that has been added to this menu
550
840
 
551
841
  :param draw_func:
552
842
  """
553
843
  ...
554
844
 
555
845
  def type_recast(self):
556
- """ """
846
+ """Return a new instance, this is needed because types
847
+ such as textures can be changed at runtime.
848
+
849
+ :return: a new instance of this object with the type initialized again.
850
+ """
557
851
  ...
558
852
 
559
853
  def values(self):
560
- """ """
854
+ """Returns the values of this objects custom properties (matches Python's
855
+ dictionary function of the same name).
856
+
857
+ :return: custom property values.
858
+ """
561
859
  ...
562
860
 
563
861
  class TIME_MT_view(bpy_types.Menu, bpy_types._GenericUI):
@@ -573,22 +871,35 @@ class TIME_MT_view(bpy_types.Menu, bpy_types._GenericUI):
573
871
  """ """
574
872
 
575
873
  def append(self, draw_func):
576
- """
874
+ """Append a draw function to this menu,
875
+ takes the same arguments as the menus draw function
577
876
 
578
- :param draw_func:
877
+ :param draw_func:
579
878
  """
580
879
  ...
581
880
 
582
- def as_pointer(self):
583
- """ """
881
+ def as_pointer(self) -> int:
882
+ """Returns the memory address which holds a pointer to Blender's internal data
883
+
884
+ :return: int (memory address).
885
+ :rtype: int
886
+ """
584
887
  ...
585
888
 
586
- def bl_rna_get_subclass(self):
587
- """ """
889
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
890
+ """
891
+
892
+ :return: The RNA type or default when not found.
893
+ :rtype: bpy.types.Struct
894
+ """
588
895
  ...
589
896
 
590
- def bl_rna_get_subclass_py(self):
591
- """ """
897
+ def bl_rna_get_subclass_py(self) -> typing.Any:
898
+ """
899
+
900
+ :return: The class or default when not found.
901
+ :rtype: typing.Any
902
+ """
592
903
  ...
593
904
 
594
905
  def draw(self, context):
@@ -607,138 +918,224 @@ class TIME_MT_view(bpy_types.Menu, bpy_types._GenericUI):
607
918
  ...
608
919
 
609
920
  def draw_preset(self, _context):
610
- """
921
+ """Define these on the subclass:
922
+ - preset_operator (string)
923
+ - preset_subdir (string)Optionally:
924
+ - preset_add_operator (string)
925
+ - preset_extensions (set of strings)
926
+ - preset_operator_defaults (dict of keyword args)
611
927
 
612
- :param _context:
928
+ :param _context:
613
929
  """
614
930
  ...
615
931
 
616
- def driver_add(self):
617
- """ """
932
+ def driver_add(self) -> bpy.types.FCurve:
933
+ """Adds driver(s) to the given property
934
+
935
+ :return: The driver(s) added.
936
+ :rtype: bpy.types.FCurve
937
+ """
618
938
  ...
619
939
 
620
- def driver_remove(self):
621
- """ """
940
+ def driver_remove(self) -> bool:
941
+ """Remove driver(s) from the given property
942
+
943
+ :return: Success of driver removal.
944
+ :rtype: bool
945
+ """
622
946
  ...
623
947
 
624
948
  def get(self):
625
- """ """
949
+ """Returns the value of the custom property assigned to key or default
950
+ when not found (matches Python's dictionary function of the same name).
951
+
952
+ """
626
953
  ...
627
954
 
628
955
  def id_properties_clear(self):
629
- """ """
956
+ """
957
+
958
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
959
+ """
630
960
  ...
631
961
 
632
962
  def id_properties_ensure(self):
633
- """ """
963
+ """
964
+
965
+ :return: the parent group for an RNA struct's custom IDProperties.
966
+ """
634
967
  ...
635
968
 
636
969
  def id_properties_ui(self):
637
- """ """
970
+ """
971
+
972
+ :return: Return an object used to manage an IDProperty's UI data.
973
+ """
638
974
  ...
639
975
 
640
976
  def is_extended(self):
641
977
  """ """
642
978
  ...
643
979
 
644
- def is_property_hidden(self):
645
- """ """
980
+ def is_property_hidden(self) -> bool:
981
+ """Check if a property is hidden.
982
+
983
+ :return: True when the property is hidden.
984
+ :rtype: bool
985
+ """
646
986
  ...
647
987
 
648
- def is_property_overridable_library(self):
649
- """ """
988
+ def is_property_overridable_library(self) -> bool:
989
+ """Check if a property is overridable.
990
+
991
+ :return: True when the property is overridable.
992
+ :rtype: bool
993
+ """
650
994
  ...
651
995
 
652
- def is_property_readonly(self):
653
- """ """
996
+ def is_property_readonly(self) -> bool:
997
+ """Check if a property is readonly.
998
+
999
+ :return: True when the property is readonly (not writable).
1000
+ :rtype: bool
1001
+ """
654
1002
  ...
655
1003
 
656
- def is_property_set(self):
657
- """ """
1004
+ def is_property_set(self) -> bool:
1005
+ """Check if a property is set, use for testing operator properties.
1006
+
1007
+ :return: True when the property has been set.
1008
+ :rtype: bool
1009
+ """
658
1010
  ...
659
1011
 
660
1012
  def items(self):
661
- """ """
1013
+ """Returns the items of this objects custom properties (matches Python's
1014
+ dictionary function of the same name).
1015
+
1016
+ :return: custom property key, value pairs.
1017
+ """
662
1018
  ...
663
1019
 
664
- def keyframe_delete(self):
665
- """ """
1020
+ def keyframe_delete(self) -> bool:
1021
+ """Remove a keyframe from this properties fcurve.
1022
+
1023
+ :return: Success of keyframe deletion.
1024
+ :rtype: bool
1025
+ """
666
1026
  ...
667
1027
 
668
- def keyframe_insert(self):
669
- """ """
1028
+ def keyframe_insert(self) -> bool:
1029
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1030
+
1031
+ :return: Success of keyframe insertion.
1032
+ :rtype: bool
1033
+ """
670
1034
  ...
671
1035
 
672
1036
  def keys(self):
673
- """ """
1037
+ """Returns the keys of this objects custom properties (matches Python's
1038
+ dictionary function of the same name).
1039
+
1040
+ :return: custom property keys.
1041
+ """
674
1042
  ...
675
1043
 
676
- def path_from_id(self):
677
- """ """
1044
+ def path_from_id(self) -> str:
1045
+ """Returns the data path from the ID to this object (string).
1046
+
1047
+ :return: The path from `bpy.types.bpy_struct.id_data`
1048
+ to this struct and property (when given).
1049
+ :rtype: str
1050
+ """
678
1051
  ...
679
1052
 
680
1053
  def path_menu(
681
1054
  self,
682
- searchpaths,
683
- operator,
684
- props_default,
685
- prop_filepath,
686
- filter_ext,
687
- filter_path,
688
- display_name,
689
- add_operator,
690
- add_operator_props,
1055
+ searchpaths: list[str],
1056
+ operator: str,
1057
+ props_default: dict = None,
1058
+ prop_filepath: str = "filepath",
1059
+ filter_ext: typing.Callable = None,
1060
+ filter_path=None,
1061
+ display_name: typing.Callable = None,
1062
+ add_operator=None,
1063
+ add_operator_props=None,
691
1064
  ):
692
- """
1065
+ """Populate a menu from a list of paths.
693
1066
 
694
- :param searchpaths:
695
- :param operator:
696
- :param props_default:
697
- :param prop_filepath:
698
- :param filter_ext:
699
- :param filter_path:
700
- :param display_name:
701
- :param add_operator:
702
- :param add_operator_props:
1067
+ :param searchpaths: Paths to scan.
1068
+ :type searchpaths: list[str]
1069
+ :param operator: The operator id to use with each file.
1070
+ :type operator: str
1071
+ :param props_default: Properties to assign to each operator.
1072
+ :type props_default: dict
1073
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1074
+ :type prop_filepath: str
1075
+ :param filter_ext: Optional callback that takes the file extensions.
1076
+
1077
+ Returning false excludes the file from the list.
1078
+ :type filter_ext: typing.Callable
1079
+ :param filter_path:
1080
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1081
+ :type display_name: typing.Callable
1082
+ :param add_operator:
1083
+ :param add_operator_props:
703
1084
  """
704
1085
  ...
705
1086
 
706
1087
  def path_resolve(self):
707
- """ """
1088
+ """Returns the property from the path, raise an exception when not found."""
708
1089
  ...
709
1090
 
710
1091
  def pop(self):
711
- """ """
1092
+ """Remove and return the value of the custom property assigned to key or default
1093
+ when not found (matches Python's dictionary function of the same name).
1094
+
1095
+ """
712
1096
  ...
713
1097
 
714
1098
  def prepend(self, draw_func):
715
- """
1099
+ """Prepend a draw function to this menu, takes the same arguments as
1100
+ the menus draw function
716
1101
 
717
- :param draw_func:
1102
+ :param draw_func:
718
1103
  """
719
1104
  ...
720
1105
 
721
- def property_overridable_library_set(self):
722
- """ """
1106
+ def property_overridable_library_set(self) -> bool:
1107
+ """Define a property as overridable or not (only for custom properties!).
1108
+
1109
+ :return: True when the overridable status of the property was successfully set.
1110
+ :rtype: bool
1111
+ """
723
1112
  ...
724
1113
 
725
1114
  def property_unset(self):
726
- """ """
1115
+ """Unset a property, will use default value afterward."""
727
1116
  ...
728
1117
 
729
1118
  def remove(self, draw_func):
730
- """
1119
+ """Remove a draw function that has been added to this menu
731
1120
 
732
1121
  :param draw_func:
733
1122
  """
734
1123
  ...
735
1124
 
736
1125
  def type_recast(self):
737
- """ """
1126
+ """Return a new instance, this is needed because types
1127
+ such as textures can be changed at runtime.
1128
+
1129
+ :return: a new instance of this object with the type initialized again.
1130
+ """
738
1131
  ...
739
1132
 
740
1133
  def values(self):
741
- """ """
1134
+ """Returns the values of this objects custom properties (matches Python's
1135
+ dictionary function of the same name).
1136
+
1137
+ :return: custom property values.
1138
+ """
742
1139
  ...
743
1140
 
744
1141
  class TimelinePanelButtons:
@@ -784,22 +1181,35 @@ class TIME_PT_auto_keyframing(
784
1181
  """ """
785
1182
 
786
1183
  def append(self, draw_func):
787
- """
1184
+ """Append a draw function to this menu,
1185
+ takes the same arguments as the menus draw function
788
1186
 
789
- :param draw_func:
1187
+ :param draw_func:
790
1188
  """
791
1189
  ...
792
1190
 
793
- def as_pointer(self):
794
- """ """
1191
+ def as_pointer(self) -> int:
1192
+ """Returns the memory address which holds a pointer to Blender's internal data
1193
+
1194
+ :return: int (memory address).
1195
+ :rtype: int
1196
+ """
795
1197
  ...
796
1198
 
797
- def bl_rna_get_subclass(self):
798
- """ """
1199
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1200
+ """
1201
+
1202
+ :return: The RNA type or default when not found.
1203
+ :rtype: bpy.types.Struct
1204
+ """
799
1205
  ...
800
1206
 
801
- def bl_rna_get_subclass_py(self):
802
- """ """
1207
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1208
+ """
1209
+
1210
+ :return: The class or default when not found.
1211
+ :rtype: typing.Any
1212
+ """
803
1213
  ...
804
1214
 
805
1215
  def draw(self, context):
@@ -809,16 +1219,27 @@ class TIME_PT_auto_keyframing(
809
1219
  """
810
1220
  ...
811
1221
 
812
- def driver_add(self):
813
- """ """
1222
+ def driver_add(self) -> bpy.types.FCurve:
1223
+ """Adds driver(s) to the given property
1224
+
1225
+ :return: The driver(s) added.
1226
+ :rtype: bpy.types.FCurve
1227
+ """
814
1228
  ...
815
1229
 
816
- def driver_remove(self):
817
- """ """
1230
+ def driver_remove(self) -> bool:
1231
+ """Remove driver(s) from the given property
1232
+
1233
+ :return: Success of driver removal.
1234
+ :rtype: bool
1235
+ """
818
1236
  ...
819
1237
 
820
1238
  def get(self):
821
- """ """
1239
+ """Returns the value of the custom property assigned to key or default
1240
+ when not found (matches Python's dictionary function of the same name).
1241
+
1242
+ """
822
1243
  ...
823
1244
 
824
1245
  def has_timeline(self, context):
@@ -829,59 +1250,105 @@ class TIME_PT_auto_keyframing(
829
1250
  ...
830
1251
 
831
1252
  def id_properties_clear(self):
832
- """ """
1253
+ """
1254
+
1255
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1256
+ """
833
1257
  ...
834
1258
 
835
1259
  def id_properties_ensure(self):
836
- """ """
1260
+ """
1261
+
1262
+ :return: the parent group for an RNA struct's custom IDProperties.
1263
+ """
837
1264
  ...
838
1265
 
839
1266
  def id_properties_ui(self):
840
- """ """
1267
+ """
1268
+
1269
+ :return: Return an object used to manage an IDProperty's UI data.
1270
+ """
841
1271
  ...
842
1272
 
843
1273
  def is_extended(self):
844
1274
  """ """
845
1275
  ...
846
1276
 
847
- def is_property_hidden(self):
848
- """ """
1277
+ def is_property_hidden(self) -> bool:
1278
+ """Check if a property is hidden.
1279
+
1280
+ :return: True when the property is hidden.
1281
+ :rtype: bool
1282
+ """
849
1283
  ...
850
1284
 
851
- def is_property_overridable_library(self):
852
- """ """
1285
+ def is_property_overridable_library(self) -> bool:
1286
+ """Check if a property is overridable.
1287
+
1288
+ :return: True when the property is overridable.
1289
+ :rtype: bool
1290
+ """
853
1291
  ...
854
1292
 
855
- def is_property_readonly(self):
856
- """ """
1293
+ def is_property_readonly(self) -> bool:
1294
+ """Check if a property is readonly.
1295
+
1296
+ :return: True when the property is readonly (not writable).
1297
+ :rtype: bool
1298
+ """
857
1299
  ...
858
1300
 
859
- def is_property_set(self):
860
- """ """
1301
+ def is_property_set(self) -> bool:
1302
+ """Check if a property is set, use for testing operator properties.
1303
+
1304
+ :return: True when the property has been set.
1305
+ :rtype: bool
1306
+ """
861
1307
  ...
862
1308
 
863
1309
  def items(self):
864
- """ """
1310
+ """Returns the items of this objects custom properties (matches Python's
1311
+ dictionary function of the same name).
1312
+
1313
+ :return: custom property key, value pairs.
1314
+ """
865
1315
  ...
866
1316
 
867
- def keyframe_delete(self):
868
- """ """
1317
+ def keyframe_delete(self) -> bool:
1318
+ """Remove a keyframe from this properties fcurve.
1319
+
1320
+ :return: Success of keyframe deletion.
1321
+ :rtype: bool
1322
+ """
869
1323
  ...
870
1324
 
871
- def keyframe_insert(self):
872
- """ """
1325
+ def keyframe_insert(self) -> bool:
1326
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1327
+
1328
+ :return: Success of keyframe insertion.
1329
+ :rtype: bool
1330
+ """
873
1331
  ...
874
1332
 
875
1333
  def keys(self):
876
- """ """
1334
+ """Returns the keys of this objects custom properties (matches Python's
1335
+ dictionary function of the same name).
1336
+
1337
+ :return: custom property keys.
1338
+ """
877
1339
  ...
878
1340
 
879
- def path_from_id(self):
880
- """ """
1341
+ def path_from_id(self) -> str:
1342
+ """Returns the data path from the ID to this object (string).
1343
+
1344
+ :return: The path from `bpy.types.bpy_struct.id_data`
1345
+ to this struct and property (when given).
1346
+ :rtype: str
1347
+ """
881
1348
  ...
882
1349
 
883
1350
  def path_resolve(self):
884
- """ """
1351
+ """Returns the property from the path, raise an exception when not found."""
885
1352
  ...
886
1353
 
887
1354
  def poll(self, context):
@@ -892,37 +1359,53 @@ class TIME_PT_auto_keyframing(
892
1359
  ...
893
1360
 
894
1361
  def pop(self):
895
- """ """
1362
+ """Remove and return the value of the custom property assigned to key or default
1363
+ when not found (matches Python's dictionary function of the same name).
1364
+
1365
+ """
896
1366
  ...
897
1367
 
898
1368
  def prepend(self, draw_func):
899
- """
1369
+ """Prepend a draw function to this menu, takes the same arguments as
1370
+ the menus draw function
900
1371
 
901
- :param draw_func:
1372
+ :param draw_func:
902
1373
  """
903
1374
  ...
904
1375
 
905
- def property_overridable_library_set(self):
906
- """ """
1376
+ def property_overridable_library_set(self) -> bool:
1377
+ """Define a property as overridable or not (only for custom properties!).
1378
+
1379
+ :return: True when the overridable status of the property was successfully set.
1380
+ :rtype: bool
1381
+ """
907
1382
  ...
908
1383
 
909
1384
  def property_unset(self):
910
- """ """
1385
+ """Unset a property, will use default value afterward."""
911
1386
  ...
912
1387
 
913
1388
  def remove(self, draw_func):
914
- """
1389
+ """Remove a draw function that has been added to this menu
915
1390
 
916
1391
  :param draw_func:
917
1392
  """
918
1393
  ...
919
1394
 
920
1395
  def type_recast(self):
921
- """ """
1396
+ """Return a new instance, this is needed because types
1397
+ such as textures can be changed at runtime.
1398
+
1399
+ :return: a new instance of this object with the type initialized again.
1400
+ """
922
1401
  ...
923
1402
 
924
1403
  def values(self):
925
- """ """
1404
+ """Returns the values of this objects custom properties (matches Python's
1405
+ dictionary function of the same name).
1406
+
1407
+ :return: custom property values.
1408
+ """
926
1409
  ...
927
1410
 
928
1411
  class TIME_PT_keyframing_settings(
@@ -949,22 +1432,35 @@ class TIME_PT_keyframing_settings(
949
1432
  """ """
950
1433
 
951
1434
  def append(self, draw_func):
952
- """
1435
+ """Append a draw function to this menu,
1436
+ takes the same arguments as the menus draw function
953
1437
 
954
- :param draw_func:
1438
+ :param draw_func:
955
1439
  """
956
1440
  ...
957
1441
 
958
- def as_pointer(self):
959
- """ """
1442
+ def as_pointer(self) -> int:
1443
+ """Returns the memory address which holds a pointer to Blender's internal data
1444
+
1445
+ :return: int (memory address).
1446
+ :rtype: int
1447
+ """
960
1448
  ...
961
1449
 
962
- def bl_rna_get_subclass(self):
963
- """ """
1450
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1451
+ """
1452
+
1453
+ :return: The RNA type or default when not found.
1454
+ :rtype: bpy.types.Struct
1455
+ """
964
1456
  ...
965
1457
 
966
- def bl_rna_get_subclass_py(self):
967
- """ """
1458
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1459
+ """
1460
+
1461
+ :return: The class or default when not found.
1462
+ :rtype: typing.Any
1463
+ """
968
1464
  ...
969
1465
 
970
1466
  def draw(self, context):
@@ -974,16 +1470,27 @@ class TIME_PT_keyframing_settings(
974
1470
  """
975
1471
  ...
976
1472
 
977
- def driver_add(self):
978
- """ """
1473
+ def driver_add(self) -> bpy.types.FCurve:
1474
+ """Adds driver(s) to the given property
1475
+
1476
+ :return: The driver(s) added.
1477
+ :rtype: bpy.types.FCurve
1478
+ """
979
1479
  ...
980
1480
 
981
- def driver_remove(self):
982
- """ """
1481
+ def driver_remove(self) -> bool:
1482
+ """Remove driver(s) from the given property
1483
+
1484
+ :return: Success of driver removal.
1485
+ :rtype: bool
1486
+ """
983
1487
  ...
984
1488
 
985
1489
  def get(self):
986
- """ """
1490
+ """Returns the value of the custom property assigned to key or default
1491
+ when not found (matches Python's dictionary function of the same name).
1492
+
1493
+ """
987
1494
  ...
988
1495
 
989
1496
  def has_timeline(self, context):
@@ -994,59 +1501,105 @@ class TIME_PT_keyframing_settings(
994
1501
  ...
995
1502
 
996
1503
  def id_properties_clear(self):
997
- """ """
1504
+ """
1505
+
1506
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1507
+ """
998
1508
  ...
999
1509
 
1000
1510
  def id_properties_ensure(self):
1001
- """ """
1511
+ """
1512
+
1513
+ :return: the parent group for an RNA struct's custom IDProperties.
1514
+ """
1002
1515
  ...
1003
1516
 
1004
1517
  def id_properties_ui(self):
1005
- """ """
1518
+ """
1519
+
1520
+ :return: Return an object used to manage an IDProperty's UI data.
1521
+ """
1006
1522
  ...
1007
1523
 
1008
1524
  def is_extended(self):
1009
1525
  """ """
1010
1526
  ...
1011
1527
 
1012
- def is_property_hidden(self):
1013
- """ """
1528
+ def is_property_hidden(self) -> bool:
1529
+ """Check if a property is hidden.
1530
+
1531
+ :return: True when the property is hidden.
1532
+ :rtype: bool
1533
+ """
1014
1534
  ...
1015
1535
 
1016
- def is_property_overridable_library(self):
1017
- """ """
1536
+ def is_property_overridable_library(self) -> bool:
1537
+ """Check if a property is overridable.
1538
+
1539
+ :return: True when the property is overridable.
1540
+ :rtype: bool
1541
+ """
1018
1542
  ...
1019
1543
 
1020
- def is_property_readonly(self):
1021
- """ """
1544
+ def is_property_readonly(self) -> bool:
1545
+ """Check if a property is readonly.
1546
+
1547
+ :return: True when the property is readonly (not writable).
1548
+ :rtype: bool
1549
+ """
1022
1550
  ...
1023
1551
 
1024
- def is_property_set(self):
1025
- """ """
1552
+ def is_property_set(self) -> bool:
1553
+ """Check if a property is set, use for testing operator properties.
1554
+
1555
+ :return: True when the property has been set.
1556
+ :rtype: bool
1557
+ """
1026
1558
  ...
1027
1559
 
1028
1560
  def items(self):
1029
- """ """
1561
+ """Returns the items of this objects custom properties (matches Python's
1562
+ dictionary function of the same name).
1563
+
1564
+ :return: custom property key, value pairs.
1565
+ """
1030
1566
  ...
1031
1567
 
1032
- def keyframe_delete(self):
1033
- """ """
1568
+ def keyframe_delete(self) -> bool:
1569
+ """Remove a keyframe from this properties fcurve.
1570
+
1571
+ :return: Success of keyframe deletion.
1572
+ :rtype: bool
1573
+ """
1034
1574
  ...
1035
1575
 
1036
- def keyframe_insert(self):
1037
- """ """
1576
+ def keyframe_insert(self) -> bool:
1577
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1578
+
1579
+ :return: Success of keyframe insertion.
1580
+ :rtype: bool
1581
+ """
1038
1582
  ...
1039
1583
 
1040
1584
  def keys(self):
1041
- """ """
1585
+ """Returns the keys of this objects custom properties (matches Python's
1586
+ dictionary function of the same name).
1587
+
1588
+ :return: custom property keys.
1589
+ """
1042
1590
  ...
1043
1591
 
1044
- def path_from_id(self):
1045
- """ """
1592
+ def path_from_id(self) -> str:
1593
+ """Returns the data path from the ID to this object (string).
1594
+
1595
+ :return: The path from `bpy.types.bpy_struct.id_data`
1596
+ to this struct and property (when given).
1597
+ :rtype: str
1598
+ """
1046
1599
  ...
1047
1600
 
1048
1601
  def path_resolve(self):
1049
- """ """
1602
+ """Returns the property from the path, raise an exception when not found."""
1050
1603
  ...
1051
1604
 
1052
1605
  def poll(self, context):
@@ -1057,37 +1610,53 @@ class TIME_PT_keyframing_settings(
1057
1610
  ...
1058
1611
 
1059
1612
  def pop(self):
1060
- """ """
1613
+ """Remove and return the value of the custom property assigned to key or default
1614
+ when not found (matches Python's dictionary function of the same name).
1615
+
1616
+ """
1061
1617
  ...
1062
1618
 
1063
1619
  def prepend(self, draw_func):
1064
- """
1620
+ """Prepend a draw function to this menu, takes the same arguments as
1621
+ the menus draw function
1065
1622
 
1066
- :param draw_func:
1623
+ :param draw_func:
1067
1624
  """
1068
1625
  ...
1069
1626
 
1070
- def property_overridable_library_set(self):
1071
- """ """
1627
+ def property_overridable_library_set(self) -> bool:
1628
+ """Define a property as overridable or not (only for custom properties!).
1629
+
1630
+ :return: True when the overridable status of the property was successfully set.
1631
+ :rtype: bool
1632
+ """
1072
1633
  ...
1073
1634
 
1074
1635
  def property_unset(self):
1075
- """ """
1636
+ """Unset a property, will use default value afterward."""
1076
1637
  ...
1077
1638
 
1078
1639
  def remove(self, draw_func):
1079
- """
1640
+ """Remove a draw function that has been added to this menu
1080
1641
 
1081
1642
  :param draw_func:
1082
1643
  """
1083
1644
  ...
1084
1645
 
1085
1646
  def type_recast(self):
1086
- """ """
1647
+ """Return a new instance, this is needed because types
1648
+ such as textures can be changed at runtime.
1649
+
1650
+ :return: a new instance of this object with the type initialized again.
1651
+ """
1087
1652
  ...
1088
1653
 
1089
1654
  def values(self):
1090
- """ """
1655
+ """Returns the values of this objects custom properties (matches Python's
1656
+ dictionary function of the same name).
1657
+
1658
+ :return: custom property values.
1659
+ """
1091
1660
  ...
1092
1661
 
1093
1662
  class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._GenericUI):
@@ -1112,22 +1681,35 @@ class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._Generic
1112
1681
  """ """
1113
1682
 
1114
1683
  def append(self, draw_func):
1115
- """
1684
+ """Append a draw function to this menu,
1685
+ takes the same arguments as the menus draw function
1116
1686
 
1117
- :param draw_func:
1687
+ :param draw_func:
1118
1688
  """
1119
1689
  ...
1120
1690
 
1121
- def as_pointer(self):
1122
- """ """
1691
+ def as_pointer(self) -> int:
1692
+ """Returns the memory address which holds a pointer to Blender's internal data
1693
+
1694
+ :return: int (memory address).
1695
+ :rtype: int
1696
+ """
1123
1697
  ...
1124
1698
 
1125
- def bl_rna_get_subclass(self):
1126
- """ """
1699
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1700
+ """
1701
+
1702
+ :return: The RNA type or default when not found.
1703
+ :rtype: bpy.types.Struct
1704
+ """
1127
1705
  ...
1128
1706
 
1129
- def bl_rna_get_subclass_py(self):
1130
- """ """
1707
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1708
+ """
1709
+
1710
+ :return: The class or default when not found.
1711
+ :rtype: typing.Any
1712
+ """
1131
1713
  ...
1132
1714
 
1133
1715
  def draw(self, context):
@@ -1137,16 +1719,27 @@ class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._Generic
1137
1719
  """
1138
1720
  ...
1139
1721
 
1140
- def driver_add(self):
1141
- """ """
1722
+ def driver_add(self) -> bpy.types.FCurve:
1723
+ """Adds driver(s) to the given property
1724
+
1725
+ :return: The driver(s) added.
1726
+ :rtype: bpy.types.FCurve
1727
+ """
1142
1728
  ...
1143
1729
 
1144
- def driver_remove(self):
1145
- """ """
1730
+ def driver_remove(self) -> bool:
1731
+ """Remove driver(s) from the given property
1732
+
1733
+ :return: Success of driver removal.
1734
+ :rtype: bool
1735
+ """
1146
1736
  ...
1147
1737
 
1148
1738
  def get(self):
1149
- """ """
1739
+ """Returns the value of the custom property assigned to key or default
1740
+ when not found (matches Python's dictionary function of the same name).
1741
+
1742
+ """
1150
1743
  ...
1151
1744
 
1152
1745
  def has_timeline(self, context):
@@ -1157,93 +1750,155 @@ class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._Generic
1157
1750
  ...
1158
1751
 
1159
1752
  def id_properties_clear(self):
1160
- """ """
1753
+ """
1754
+
1755
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1756
+ """
1161
1757
  ...
1162
1758
 
1163
1759
  def id_properties_ensure(self):
1164
- """ """
1760
+ """
1761
+
1762
+ :return: the parent group for an RNA struct's custom IDProperties.
1763
+ """
1165
1764
  ...
1166
1765
 
1167
1766
  def id_properties_ui(self):
1168
- """ """
1767
+ """
1768
+
1769
+ :return: Return an object used to manage an IDProperty's UI data.
1770
+ """
1169
1771
  ...
1170
1772
 
1171
1773
  def is_extended(self):
1172
1774
  """ """
1173
1775
  ...
1174
1776
 
1175
- def is_property_hidden(self):
1176
- """ """
1777
+ def is_property_hidden(self) -> bool:
1778
+ """Check if a property is hidden.
1779
+
1780
+ :return: True when the property is hidden.
1781
+ :rtype: bool
1782
+ """
1177
1783
  ...
1178
1784
 
1179
- def is_property_overridable_library(self):
1180
- """ """
1785
+ def is_property_overridable_library(self) -> bool:
1786
+ """Check if a property is overridable.
1787
+
1788
+ :return: True when the property is overridable.
1789
+ :rtype: bool
1790
+ """
1181
1791
  ...
1182
1792
 
1183
- def is_property_readonly(self):
1184
- """ """
1793
+ def is_property_readonly(self) -> bool:
1794
+ """Check if a property is readonly.
1795
+
1796
+ :return: True when the property is readonly (not writable).
1797
+ :rtype: bool
1798
+ """
1185
1799
  ...
1186
1800
 
1187
- def is_property_set(self):
1188
- """ """
1801
+ def is_property_set(self) -> bool:
1802
+ """Check if a property is set, use for testing operator properties.
1803
+
1804
+ :return: True when the property has been set.
1805
+ :rtype: bool
1806
+ """
1189
1807
  ...
1190
1808
 
1191
1809
  def items(self):
1192
- """ """
1810
+ """Returns the items of this objects custom properties (matches Python's
1811
+ dictionary function of the same name).
1812
+
1813
+ :return: custom property key, value pairs.
1814
+ """
1193
1815
  ...
1194
1816
 
1195
- def keyframe_delete(self):
1196
- """ """
1817
+ def keyframe_delete(self) -> bool:
1818
+ """Remove a keyframe from this properties fcurve.
1819
+
1820
+ :return: Success of keyframe deletion.
1821
+ :rtype: bool
1822
+ """
1197
1823
  ...
1198
1824
 
1199
- def keyframe_insert(self):
1200
- """ """
1825
+ def keyframe_insert(self) -> bool:
1826
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1827
+
1828
+ :return: Success of keyframe insertion.
1829
+ :rtype: bool
1830
+ """
1201
1831
  ...
1202
1832
 
1203
1833
  def keys(self):
1204
- """ """
1834
+ """Returns the keys of this objects custom properties (matches Python's
1835
+ dictionary function of the same name).
1836
+
1837
+ :return: custom property keys.
1838
+ """
1205
1839
  ...
1206
1840
 
1207
- def path_from_id(self):
1208
- """ """
1841
+ def path_from_id(self) -> str:
1842
+ """Returns the data path from the ID to this object (string).
1843
+
1844
+ :return: The path from `bpy.types.bpy_struct.id_data`
1845
+ to this struct and property (when given).
1846
+ :rtype: str
1847
+ """
1209
1848
  ...
1210
1849
 
1211
1850
  def path_resolve(self):
1212
- """ """
1851
+ """Returns the property from the path, raise an exception when not found."""
1213
1852
  ...
1214
1853
 
1215
1854
  def pop(self):
1216
- """ """
1855
+ """Remove and return the value of the custom property assigned to key or default
1856
+ when not found (matches Python's dictionary function of the same name).
1857
+
1858
+ """
1217
1859
  ...
1218
1860
 
1219
1861
  def prepend(self, draw_func):
1220
- """
1862
+ """Prepend a draw function to this menu, takes the same arguments as
1863
+ the menus draw function
1221
1864
 
1222
- :param draw_func:
1865
+ :param draw_func:
1223
1866
  """
1224
1867
  ...
1225
1868
 
1226
- def property_overridable_library_set(self):
1227
- """ """
1869
+ def property_overridable_library_set(self) -> bool:
1870
+ """Define a property as overridable or not (only for custom properties!).
1871
+
1872
+ :return: True when the overridable status of the property was successfully set.
1873
+ :rtype: bool
1874
+ """
1228
1875
  ...
1229
1876
 
1230
1877
  def property_unset(self):
1231
- """ """
1878
+ """Unset a property, will use default value afterward."""
1232
1879
  ...
1233
1880
 
1234
1881
  def remove(self, draw_func):
1235
- """
1882
+ """Remove a draw function that has been added to this menu
1236
1883
 
1237
1884
  :param draw_func:
1238
1885
  """
1239
1886
  ...
1240
1887
 
1241
1888
  def type_recast(self):
1242
- """ """
1889
+ """Return a new instance, this is needed because types
1890
+ such as textures can be changed at runtime.
1891
+
1892
+ :return: a new instance of this object with the type initialized again.
1893
+ """
1243
1894
  ...
1244
1895
 
1245
1896
  def values(self):
1246
- """ """
1897
+ """Returns the values of this objects custom properties (matches Python's
1898
+ dictionary function of the same name).
1899
+
1900
+ :return: custom property values.
1901
+ """
1247
1902
  ...
1248
1903
 
1249
1904
  def marker_menu_generic(layout, context):