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

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

Potentially problematic release.


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

Files changed (549) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +17 -84
  2. addon_utils/__init__.pyi +44 -38
  3. animsys_refactor/__init__.pyi +7 -27
  4. aud/__init__.pyi +8 -11
  5. bgl/__init__.pyi +121 -1812
  6. bl_app_override/__init__.pyi +8 -19
  7. bl_app_override/helpers/__init__.pyi +5 -23
  8. bl_app_template_utils/__init__.pyi +5 -17
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
  14. bl_i18n_utils/merge_po/__init__.pyi +1 -4
  15. bl_i18n_utils/settings/__init__.pyi +6 -24
  16. bl_i18n_utils/utils/__init__.pyi +93 -122
  17. bl_i18n_utils/utils_cli/__init__.pyi +6 -29
  18. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
  19. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  20. bl_keymap_utils/io/__init__.pyi +9 -40
  21. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  22. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
  23. bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
  24. bl_keymap_utils/versioning/__init__.pyi +1 -4
  25. bl_operators/__init__.pyi +2 -9
  26. bl_operators/add_mesh_torus/__init__.pyi +128 -59
  27. bl_operators/anim/__init__.pyi +1001 -398
  28. bl_operators/assets/__init__.pyi +376 -152
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
  30. bl_operators/clip/__init__.pyi +1264 -532
  31. bl_operators/console/__init__.pyi +626 -242
  32. bl_operators/constraint/__init__.pyi +502 -201
  33. bl_operators/file/__init__.pyi +376 -150
  34. bl_operators/freestyle/__init__.pyi +501 -200
  35. bl_operators/geometry_nodes/__init__.pyi +514 -266
  36. bl_operators/image/__init__.pyi +621 -251
  37. bl_operators/mesh/__init__.pyi +376 -150
  38. bl_operators/node/__init__.pyi +1253 -516
  39. bl_operators/object/__init__.pyi +1879 -755
  40. bl_operators/object_align/__init__.pyi +129 -64
  41. bl_operators/object_quick_effects/__init__.pyi +504 -213
  42. bl_operators/object_randomize_transform/__init__.pyi +129 -54
  43. bl_operators/presets/__init__.pyi +3072 -1403
  44. bl_operators/rigidbody/__init__.pyi +376 -150
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
  46. bl_operators/sequencer/__init__.pyi +1010 -434
  47. bl_operators/spreadsheet/__init__.pyi +126 -50
  48. bl_operators/userpref/__init__.pyi +3253 -1267
  49. bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
  50. bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
  51. bl_operators/uvcalc_transform/__init__.pyi +297 -159
  52. bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
  53. bl_operators/view3d/__init__.pyi +868 -342
  54. bl_operators/wm/__init__.pyi +5795 -2388
  55. bl_operators/world/__init__.pyi +126 -50
  56. bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
  57. bl_rna_utils/data_path/__init__.pyi +8 -4
  58. bl_text_utils/external_editor/__init__.pyi +1 -4
  59. bl_ui/__init__.pyi +366 -269
  60. bl_ui/anim/__init__.pyi +164 -74
  61. bl_ui/asset_shelf/__init__.pyi +129 -56
  62. bl_ui/generic_ui_list/__init__.pyi +412 -163
  63. bl_ui/node_add_menu/__init__.pyi +171 -94
  64. bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
  65. bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
  66. bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
  67. bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
  68. bl_ui/properties_animviz/__init__.pyi +2 -16
  69. bl_ui/properties_collection/__init__.pyi +807 -379
  70. bl_ui/properties_constraint/__init__.pyi +10292 -4941
  71. bl_ui/properties_data_armature/__init__.pyi +1615 -753
  72. bl_ui/properties_data_bone/__init__.pyi +1284 -608
  73. bl_ui/properties_data_camera/__init__.pyi +1854 -927
  74. bl_ui/properties_data_curve/__init__.pyi +1927 -937
  75. bl_ui/properties_data_curves/__init__.pyi +806 -375
  76. bl_ui/properties_data_empty/__init__.pyi +257 -125
  77. bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
  79. bl_ui/properties_data_lattice/__init__.pyi +388 -188
  80. bl_ui/properties_data_light/__init__.pyi +1540 -756
  81. bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
  82. bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
  83. bl_ui/properties_data_metaball/__init__.pyi +644 -308
  84. bl_ui/properties_data_modifier/__init__.pyi +1353 -671
  85. bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
  86. bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
  87. bl_ui/properties_data_speaker/__init__.pyi +644 -316
  88. bl_ui/properties_data_volume/__init__.pyi +1028 -484
  89. bl_ui/properties_freestyle/__init__.pyi +3112 -1619
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
  91. bl_ui/properties_mask_common/__init__.pyi +1102 -523
  92. bl_ui/properties_material/__init__.pyi +2089 -1009
  93. bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
  94. bl_ui/properties_object/__init__.pyi +1832 -873
  95. bl_ui/properties_output/__init__.pyi +2405 -1173
  96. bl_ui/properties_paint_common/__init__.pyi +416 -386
  97. bl_ui/properties_particle/__init__.pyi +6740 -3346
  98. bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
  99. bl_ui/properties_physics_common/__init__.pyi +135 -98
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
  101. bl_ui/properties_physics_field/__init__.pyi +1282 -627
  102. bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
  106. bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
  107. bl_ui/properties_render/__init__.pyi +6843 -3367
  108. bl_ui/properties_scene/__init__.pyi +1924 -913
  109. bl_ui/properties_texture/__init__.pyi +3371 -1667
  110. bl_ui/properties_view_layer/__init__.pyi +2344 -1107
  111. bl_ui/properties_workspace/__init__.pyi +516 -244
  112. bl_ui/properties_world/__init__.pyi +1284 -630
  113. bl_ui/space_clip/__init__.pyi +10172 -4695
  114. bl_ui/space_console/__init__.pyi +940 -423
  115. bl_ui/space_dopesheet/__init__.pyi +4325 -2013
  116. bl_ui/space_filebrowser/__init__.pyi +4172 -1903
  117. bl_ui/space_graph/__init__.pyi +3107 -1394
  118. bl_ui/space_image/__init__.pyi +9764 -4614
  119. bl_ui/space_info/__init__.pyi +939 -421
  120. bl_ui/space_nla/__init__.pyi +2623 -1183
  121. bl_ui/space_node/__init__.pyi +3995 -1840
  122. bl_ui/space_outliner/__init__.pyi +2203 -991
  123. bl_ui/space_properties/__init__.pyi +386 -165
  124. bl_ui/space_sequencer/__init__.pyi +10809 -4978
  125. bl_ui/space_spreadsheet/__init__.pyi +130 -53
  126. bl_ui/space_statusbar/__init__.pyi +129 -52
  127. bl_ui/space_text/__init__.pyi +2457 -1100
  128. bl_ui/space_time/__init__.pyi +1034 -481
  129. bl_ui/space_toolsystem_common/__init__.pyi +56 -211
  130. bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
  131. bl_ui/space_topbar/__init__.pyi +3982 -1805
  132. bl_ui/space_userpref/__init__.pyi +11383 -5290
  133. bl_ui/space_view3d/__init__.pyi +40873 -18532
  134. bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
  135. bl_ui/temp_anim_layers/__init__.pyi +130 -62
  136. bl_ui/utils/__init__.pyi +28 -27
  137. bl_ui_utils/bug_report_url/__init__.pyi +1 -4
  138. bl_ui_utils/layout/__init__.pyi +1 -1
  139. blend_render_info/__init__.pyi +3 -10
  140. blf/__init__.pyi +4 -4
  141. bmesh/geometry/__init__.pyi +2 -3
  142. bmesh/ops/__init__.pyi +372 -419
  143. bmesh/types/__init__.pyi +39 -56
  144. bmesh/utils/__init__.pyi +10 -13
  145. bpy/app/__init__.pyi +4 -4
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -8
  148. bpy/app/timers/__init__.pyi +10 -10
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +2 -4
  151. bpy/ops/action/__init__.pyi +316 -394
  152. bpy/ops/anim/__init__.pyi +442 -548
  153. bpy/ops/armature/__init__.pyi +374 -470
  154. bpy/ops/asset/__init__.pyi +152 -184
  155. bpy/ops/bl_pkg/__init__.pyi +221 -272
  156. bpy/ops/boid/__init__.pyi +50 -66
  157. bpy/ops/brush/__init__.pyi +72 -90
  158. bpy/ops/buttons/__init__.pyi +132 -144
  159. bpy/ops/cachefile/__init__.pyi +128 -138
  160. bpy/ops/camera/__init__.pyi +26 -30
  161. bpy/ops/clip/__init__.pyi +777 -964
  162. bpy/ops/cloth/__init__.pyi +12 -14
  163. bpy/ops/collection/__init__.pyi +68 -86
  164. bpy/ops/console/__init__.pyi +158 -200
  165. bpy/ops/constraint/__init__.pyi +178 -214
  166. bpy/ops/curve/__init__.pyi +473 -576
  167. bpy/ops/curves/__init__.pyi +247 -302
  168. bpy/ops/cycles/__init__.pyi +28 -34
  169. bpy/ops/dpaint/__init__.pyi +34 -44
  170. bpy/ops/ed/__init__.pyi +126 -150
  171. bpy/ops/export_anim/__init__.pyi +22 -24
  172. bpy/ops/export_scene/__init__.pyi +302 -336
  173. bpy/ops/file/__init__.pyi +352 -432
  174. bpy/ops/fluid/__init__.pyi +90 -118
  175. bpy/ops/font/__init__.pyi +258 -304
  176. bpy/ops/geometry/__init__.pyi +100 -120
  177. bpy/ops/gizmogroup/__init__.pyi +22 -26
  178. bpy/ops/gpencil/__init__.pyi +1469 -1778
  179. bpy/ops/graph/__init__.pyi +644 -776
  180. bpy/ops/grease_pencil/__init__.pyi +597 -748
  181. bpy/ops/image/__init__.pyi +648 -744
  182. bpy/ops/import_anim/__init__.pyi +30 -32
  183. bpy/ops/import_curve/__init__.pyi +10 -12
  184. bpy/ops/import_scene/__init__.pyi +88 -96
  185. bpy/ops/info/__init__.pyi +60 -74
  186. bpy/ops/lattice/__init__.pyi +64 -80
  187. bpy/ops/marker/__init__.pyi +108 -130
  188. bpy/ops/mask/__init__.pyi +322 -402
  189. bpy/ops/material/__init__.pyi +18 -24
  190. bpy/ops/mball/__init__.pyi +70 -86
  191. bpy/ops/mesh/__init__.pyi +1986 -2322
  192. bpy/ops/nla/__init__.pyi +333 -411
  193. bpy/ops/node/__init__.pyi +886 -1100
  194. bpy/ops/object/__init__.pyi +2585 -3078
  195. bpy/ops/outliner/__init__.pyi +498 -636
  196. bpy/ops/paint/__init__.pyi +565 -680
  197. bpy/ops/paintcurve/__init__.pyi +64 -80
  198. bpy/ops/palette/__init__.pyi +50 -64
  199. bpy/ops/particle/__init__.pyi +267 -340
  200. bpy/ops/pose/__init__.pyi +336 -414
  201. bpy/ops/poselib/__init__.pyi +72 -90
  202. bpy/ops/preferences/__init__.pyi +386 -463
  203. bpy/ops/ptcache/__init__.pyi +46 -60
  204. bpy/ops/render/__init__.pyi +130 -154
  205. bpy/ops/rigidbody/__init__.pyi +102 -128
  206. bpy/ops/scene/__init__.pyi +280 -358
  207. bpy/ops/screen/__init__.pyi +382 -460
  208. bpy/ops/script/__init__.pyi +24 -30
  209. bpy/ops/sculpt/__init__.pyi +458 -532
  210. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  211. bpy/ops/sequencer/__init__.pyi +1066 -1244
  212. bpy/ops/sound/__init__.pyi +216 -230
  213. bpy/ops/spreadsheet/__init__.pyi +30 -38
  214. bpy/ops/surface/__init__.pyi +108 -120
  215. bpy/ops/text/__init__.pyi +390 -476
  216. bpy/ops/text_editor/__init__.pyi +12 -14
  217. bpy/ops/texture/__init__.pyi +26 -34
  218. bpy/ops/transform/__init__.pyi +792 -878
  219. bpy/ops/ui/__init__.pyi +228 -294
  220. bpy/ops/uilist/__init__.pyi +32 -38
  221. bpy/ops/uv/__init__.pyi +602 -704
  222. bpy/ops/view2d/__init__.pyi +156 -184
  223. bpy/ops/view3d/__init__.pyi +582 -718
  224. bpy/ops/wm/__init__.pyi +2683 -2928
  225. bpy/ops/workspace/__init__.pyi +46 -60
  226. bpy/ops/world/__init__.pyi +12 -16
  227. bpy/path/__init__.pyi +179 -75
  228. bpy/props/__init__.pyi +261 -263
  229. bpy/types/__init__.pyi +17058 -26311
  230. bpy/utils/__init__.pyi +247 -179
  231. bpy/utils/previews/__init__.pyi +58 -28
  232. bpy/utils/units/__init__.pyi +20 -20
  233. bpy_extras/anim_utils/__init__.pyi +68 -29
  234. bpy_extras/asset_utils/__init__.pyi +0 -10
  235. bpy_extras/bmesh_utils/__init__.pyi +9 -6
  236. bpy_extras/extensions/junction_module/__init__.pyi +6 -8
  237. bpy_extras/id_map_utils/__init__.pyi +3 -3
  238. bpy_extras/image_utils/__init__.pyi +44 -11
  239. bpy_extras/io_utils/__init__.pyi +116 -41
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -11
  241. bpy_extras/mesh_utils/__init__.pyi +71 -19
  242. bpy_extras/node_shader_utils/__init__.pyi +52 -288
  243. bpy_extras/node_utils/__init__.pyi +10 -10
  244. bpy_extras/object_utils/__init__.pyi +71 -14
  245. bpy_extras/view3d_utils/__init__.pyi +80 -10
  246. bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
  247. bpy_restrict_state/__init__.pyi +1 -14
  248. bpy_types/__init__.pyi +4203 -1605
  249. console_python/__init__.pyi +12 -37
  250. console_shell/__init__.pyi +5 -24
  251. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20240518.dist-info/RECORD +353 -0
  253. freestyle/chainingiterators/__init__.pyi +14 -44
  254. freestyle/functions/__init__.pyi +7 -33
  255. freestyle/predicates/__init__.pyi +44 -217
  256. freestyle/shaders/__init__.pyi +2 -12
  257. freestyle/types/__init__.pyi +84 -96
  258. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  259. freestyle/utils/__init__.pyi +6 -18
  260. gpu/matrix/__init__.pyi +6 -8
  261. gpu/state/__init__.pyi +2 -2
  262. gpu/types/__init__.pyi +12 -12
  263. gpu_extras/presets/__init__.pyi +2 -5
  264. graphviz_export/__init__.pyi +4 -9
  265. idprop/types/__init__.pyi +8 -35
  266. imbuf/__init__.pyi +4 -4
  267. imbuf/types/__init__.pyi +0 -2
  268. keyingsets_builtins/__init__.pyi +2692 -997
  269. keyingsets_utils/__init__.pyi +14 -69
  270. mathutils/__init__.pyi +194 -238
  271. mathutils/bvhtree/__init__.pyi +4 -6
  272. mathutils/geometry/__init__.pyi +153 -155
  273. mathutils/kdtree/__init__.pyi +8 -12
  274. mathutils/noise/__init__.pyi +26 -26
  275. nodeitems_builtins/__init__.pyi +5 -30
  276. nodeitems_utils/__init__.pyi +8 -45
  277. rna_info/__init__.pyi +39 -215
  278. rna_keymap_ui/__init__.pyi +6 -29
  279. rna_prop_ui/__init__.pyi +24 -62
  280. rna_xml/__init__.pyi +16 -39
  281. sys_info/__init__.pyi +1 -4
  282. _bpy_internal/freedesktop/py.typed +0 -0
  283. bl_app_override/helpers/py.typed +0 -0
  284. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  285. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  286. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  287. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  288. bl_console_utils/autocomplete/py.typed +0 -0
  289. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  290. bl_i18n_utils/merge_po/py.typed +0 -0
  291. bl_i18n_utils/settings/py.typed +0 -0
  292. bl_i18n_utils/utils/py.typed +0 -0
  293. bl_i18n_utils/utils_cli/py.typed +0 -0
  294. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  295. bl_i18n_utils/utils_rtl/py.typed +0 -0
  296. bl_keymap_utils/io/py.typed +0 -0
  297. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  298. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  299. bl_keymap_utils/platform_helpers/py.typed +0 -0
  300. bl_keymap_utils/versioning/py.typed +0 -0
  301. bl_operators/add_mesh_torus/py.typed +0 -0
  302. bl_operators/anim/py.typed +0 -0
  303. bl_operators/assets/py.typed +0 -0
  304. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  305. bl_operators/bmesh/py.typed +0 -0
  306. bl_operators/clip/py.typed +0 -0
  307. bl_operators/console/py.typed +0 -0
  308. bl_operators/constraint/py.typed +0 -0
  309. bl_operators/file/py.typed +0 -0
  310. bl_operators/freestyle/py.typed +0 -0
  311. bl_operators/geometry_nodes/py.typed +0 -0
  312. bl_operators/image/py.typed +0 -0
  313. bl_operators/mesh/py.typed +0 -0
  314. bl_operators/node/py.typed +0 -0
  315. bl_operators/object/py.typed +0 -0
  316. bl_operators/object_align/py.typed +0 -0
  317. bl_operators/object_quick_effects/py.typed +0 -0
  318. bl_operators/object_randomize_transform/py.typed +0 -0
  319. bl_operators/presets/py.typed +0 -0
  320. bl_operators/rigidbody/py.typed +0 -0
  321. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  322. bl_operators/sequencer/py.typed +0 -0
  323. bl_operators/spreadsheet/py.typed +0 -0
  324. bl_operators/userpref/py.typed +0 -0
  325. bl_operators/uvcalc_follow_active/py.typed +0 -0
  326. bl_operators/uvcalc_lightmap/py.typed +0 -0
  327. bl_operators/uvcalc_transform/py.typed +0 -0
  328. bl_operators/vertexpaint_dirt/py.typed +0 -0
  329. bl_operators/view3d/py.typed +0 -0
  330. bl_operators/wm/py.typed +0 -0
  331. bl_operators/world/py.typed +0 -0
  332. bl_previews_utils/bl_previews_render/py.typed +0 -0
  333. bl_rna_utils/data_path/py.typed +0 -0
  334. bl_text_utils/external_editor/py.typed +0 -0
  335. bl_ui/anim/py.typed +0 -0
  336. bl_ui/asset_shelf/py.typed +0 -0
  337. bl_ui/generic_ui_list/py.typed +0 -0
  338. bl_ui/node_add_menu/py.typed +0 -0
  339. bl_ui/node_add_menu_compositor/py.typed +0 -0
  340. bl_ui/node_add_menu_geometry/py.typed +0 -0
  341. bl_ui/node_add_menu_shader/py.typed +0 -0
  342. bl_ui/node_add_menu_texture/py.typed +0 -0
  343. bl_ui/properties_animviz/py.typed +0 -0
  344. bl_ui/properties_collection/py.typed +0 -0
  345. bl_ui/properties_constraint/py.typed +0 -0
  346. bl_ui/properties_data_armature/py.typed +0 -0
  347. bl_ui/properties_data_bone/py.typed +0 -0
  348. bl_ui/properties_data_camera/py.typed +0 -0
  349. bl_ui/properties_data_curve/py.typed +0 -0
  350. bl_ui/properties_data_curves/py.typed +0 -0
  351. bl_ui/properties_data_empty/py.typed +0 -0
  352. bl_ui/properties_data_gpencil/py.typed +0 -0
  353. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  354. bl_ui/properties_data_lattice/py.typed +0 -0
  355. bl_ui/properties_data_light/py.typed +0 -0
  356. bl_ui/properties_data_lightprobe/py.typed +0 -0
  357. bl_ui/properties_data_mesh/py.typed +0 -0
  358. bl_ui/properties_data_metaball/py.typed +0 -0
  359. bl_ui/properties_data_modifier/py.typed +0 -0
  360. bl_ui/properties_data_pointcloud/py.typed +0 -0
  361. bl_ui/properties_data_shaderfx/py.typed +0 -0
  362. bl_ui/properties_data_speaker/py.typed +0 -0
  363. bl_ui/properties_data_volume/py.typed +0 -0
  364. bl_ui/properties_freestyle/py.typed +0 -0
  365. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  366. bl_ui/properties_mask_common/py.typed +0 -0
  367. bl_ui/properties_material/py.typed +0 -0
  368. bl_ui/properties_material_gpencil/py.typed +0 -0
  369. bl_ui/properties_object/py.typed +0 -0
  370. bl_ui/properties_output/py.typed +0 -0
  371. bl_ui/properties_paint_common/py.typed +0 -0
  372. bl_ui/properties_particle/py.typed +0 -0
  373. bl_ui/properties_physics_cloth/py.typed +0 -0
  374. bl_ui/properties_physics_common/py.typed +0 -0
  375. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  376. bl_ui/properties_physics_field/py.typed +0 -0
  377. bl_ui/properties_physics_fluid/py.typed +0 -0
  378. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  379. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  380. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  381. bl_ui/properties_physics_softbody/py.typed +0 -0
  382. bl_ui/properties_render/py.typed +0 -0
  383. bl_ui/properties_scene/py.typed +0 -0
  384. bl_ui/properties_texture/py.typed +0 -0
  385. bl_ui/properties_view_layer/py.typed +0 -0
  386. bl_ui/properties_workspace/py.typed +0 -0
  387. bl_ui/properties_world/py.typed +0 -0
  388. bl_ui/space_clip/py.typed +0 -0
  389. bl_ui/space_console/py.typed +0 -0
  390. bl_ui/space_dopesheet/py.typed +0 -0
  391. bl_ui/space_filebrowser/py.typed +0 -0
  392. bl_ui/space_graph/py.typed +0 -0
  393. bl_ui/space_image/py.typed +0 -0
  394. bl_ui/space_info/py.typed +0 -0
  395. bl_ui/space_nla/py.typed +0 -0
  396. bl_ui/space_node/py.typed +0 -0
  397. bl_ui/space_outliner/py.typed +0 -0
  398. bl_ui/space_properties/py.typed +0 -0
  399. bl_ui/space_sequencer/py.typed +0 -0
  400. bl_ui/space_spreadsheet/py.typed +0 -0
  401. bl_ui/space_statusbar/py.typed +0 -0
  402. bl_ui/space_text/py.typed +0 -0
  403. bl_ui/space_time/py.typed +0 -0
  404. bl_ui/space_toolsystem_common/py.typed +0 -0
  405. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  406. bl_ui/space_topbar/py.typed +0 -0
  407. bl_ui/space_userpref/py.typed +0 -0
  408. bl_ui/space_view3d/py.typed +0 -0
  409. bl_ui/space_view3d_toolbar/py.typed +0 -0
  410. bl_ui/temp_anim_layers/py.typed +0 -0
  411. bl_ui/utils/py.typed +0 -0
  412. bl_ui_utils/bug_report_url/py.typed +0 -0
  413. bl_ui_utils/layout/py.typed +0 -0
  414. bmesh/geometry/py.typed +0 -0
  415. bmesh/ops/py.typed +0 -0
  416. bmesh/types/py.typed +0 -0
  417. bmesh/utils/py.typed +0 -0
  418. bpy/app/handlers/py.typed +0 -0
  419. bpy/app/icons/py.typed +0 -0
  420. bpy/app/py.typed +0 -0
  421. bpy/app/timers/py.typed +0 -0
  422. bpy/app/translations/py.typed +0 -0
  423. bpy/msgbus/py.typed +0 -0
  424. bpy/ops/action/py.typed +0 -0
  425. bpy/ops/anim/py.typed +0 -0
  426. bpy/ops/armature/py.typed +0 -0
  427. bpy/ops/asset/py.typed +0 -0
  428. bpy/ops/bl_pkg/py.typed +0 -0
  429. bpy/ops/boid/py.typed +0 -0
  430. bpy/ops/brush/py.typed +0 -0
  431. bpy/ops/buttons/py.typed +0 -0
  432. bpy/ops/cachefile/py.typed +0 -0
  433. bpy/ops/camera/py.typed +0 -0
  434. bpy/ops/clip/py.typed +0 -0
  435. bpy/ops/cloth/py.typed +0 -0
  436. bpy/ops/collection/py.typed +0 -0
  437. bpy/ops/console/py.typed +0 -0
  438. bpy/ops/constraint/py.typed +0 -0
  439. bpy/ops/curve/py.typed +0 -0
  440. bpy/ops/curves/py.typed +0 -0
  441. bpy/ops/cycles/py.typed +0 -0
  442. bpy/ops/dpaint/py.typed +0 -0
  443. bpy/ops/ed/py.typed +0 -0
  444. bpy/ops/export_anim/py.typed +0 -0
  445. bpy/ops/export_scene/py.typed +0 -0
  446. bpy/ops/file/py.typed +0 -0
  447. bpy/ops/fluid/py.typed +0 -0
  448. bpy/ops/font/py.typed +0 -0
  449. bpy/ops/geometry/py.typed +0 -0
  450. bpy/ops/gizmogroup/py.typed +0 -0
  451. bpy/ops/gpencil/py.typed +0 -0
  452. bpy/ops/graph/py.typed +0 -0
  453. bpy/ops/grease_pencil/py.typed +0 -0
  454. bpy/ops/image/py.typed +0 -0
  455. bpy/ops/import_anim/py.typed +0 -0
  456. bpy/ops/import_curve/py.typed +0 -0
  457. bpy/ops/import_scene/py.typed +0 -0
  458. bpy/ops/info/py.typed +0 -0
  459. bpy/ops/lattice/py.typed +0 -0
  460. bpy/ops/marker/py.typed +0 -0
  461. bpy/ops/mask/py.typed +0 -0
  462. bpy/ops/material/py.typed +0 -0
  463. bpy/ops/mball/py.typed +0 -0
  464. bpy/ops/mesh/py.typed +0 -0
  465. bpy/ops/nla/py.typed +0 -0
  466. bpy/ops/node/py.typed +0 -0
  467. bpy/ops/object/py.typed +0 -0
  468. bpy/ops/outliner/py.typed +0 -0
  469. bpy/ops/paint/py.typed +0 -0
  470. bpy/ops/paintcurve/py.typed +0 -0
  471. bpy/ops/palette/py.typed +0 -0
  472. bpy/ops/particle/py.typed +0 -0
  473. bpy/ops/pose/py.typed +0 -0
  474. bpy/ops/poselib/py.typed +0 -0
  475. bpy/ops/preferences/py.typed +0 -0
  476. bpy/ops/ptcache/py.typed +0 -0
  477. bpy/ops/py.typed +0 -0
  478. bpy/ops/render/py.typed +0 -0
  479. bpy/ops/rigidbody/py.typed +0 -0
  480. bpy/ops/scene/py.typed +0 -0
  481. bpy/ops/screen/py.typed +0 -0
  482. bpy/ops/script/py.typed +0 -0
  483. bpy/ops/sculpt/py.typed +0 -0
  484. bpy/ops/sculpt_curves/py.typed +0 -0
  485. bpy/ops/sequencer/py.typed +0 -0
  486. bpy/ops/sound/py.typed +0 -0
  487. bpy/ops/spreadsheet/py.typed +0 -0
  488. bpy/ops/surface/py.typed +0 -0
  489. bpy/ops/text/py.typed +0 -0
  490. bpy/ops/text_editor/py.typed +0 -0
  491. bpy/ops/texture/py.typed +0 -0
  492. bpy/ops/transform/py.typed +0 -0
  493. bpy/ops/ui/py.typed +0 -0
  494. bpy/ops/uilist/py.typed +0 -0
  495. bpy/ops/uv/py.typed +0 -0
  496. bpy/ops/view2d/py.typed +0 -0
  497. bpy/ops/view3d/py.typed +0 -0
  498. bpy/ops/wm/py.typed +0 -0
  499. bpy/ops/workspace/py.typed +0 -0
  500. bpy/ops/world/py.typed +0 -0
  501. bpy/path/py.typed +0 -0
  502. bpy/props/py.typed +0 -0
  503. bpy/types/py.typed +0 -0
  504. bpy/utils/previews/py.typed +0 -0
  505. bpy/utils/py.typed +0 -0
  506. bpy/utils/units/py.typed +0 -0
  507. bpy_extras/anim_utils/py.typed +0 -0
  508. bpy_extras/asset_utils/py.typed +0 -0
  509. bpy_extras/bmesh_utils/py.typed +0 -0
  510. bpy_extras/extensions/junction_module/py.typed +0 -0
  511. bpy_extras/extensions/py.typed +0 -0
  512. bpy_extras/id_map_utils/py.typed +0 -0
  513. bpy_extras/image_utils/py.typed +0 -0
  514. bpy_extras/io_utils/py.typed +0 -0
  515. bpy_extras/keyconfig_utils/py.typed +0 -0
  516. bpy_extras/mesh_utils/py.typed +0 -0
  517. bpy_extras/node_shader_utils/py.typed +0 -0
  518. bpy_extras/node_utils/py.typed +0 -0
  519. bpy_extras/object_utils/py.typed +0 -0
  520. bpy_extras/view3d_utils/py.typed +0 -0
  521. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  522. bpy_extras/wm_utils/py.typed +0 -0
  523. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  524. freestyle/chainingiterators/py.typed +0 -0
  525. freestyle/functions/py.typed +0 -0
  526. freestyle/predicates/py.typed +0 -0
  527. freestyle/shaders/py.typed +0 -0
  528. freestyle/types/py.typed +0 -0
  529. freestyle/utils/ContextFunctions/py.typed +0 -0
  530. freestyle/utils/py.typed +0 -0
  531. gpu/capabilities/py.typed +0 -0
  532. gpu/matrix/py.typed +0 -0
  533. gpu/platform/py.typed +0 -0
  534. gpu/select/py.typed +0 -0
  535. gpu/shader/py.typed +0 -0
  536. gpu/state/py.typed +0 -0
  537. gpu/texture/py.typed +0 -0
  538. gpu/types/py.typed +0 -0
  539. gpu_extras/batch/py.typed +0 -0
  540. gpu_extras/presets/py.typed +0 -0
  541. idprop/types/py.typed +0 -0
  542. imbuf/types/py.typed +0 -0
  543. mathutils/bvhtree/py.typed +0 -0
  544. mathutils/geometry/py.typed +0 -0
  545. mathutils/interpolate/py.typed +0 -0
  546. mathutils/kdtree/py.typed +0 -0
  547. mathutils/noise/py.typed +0 -0
  548. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
  549. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
@@ -1,11 +1,10 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
5
6
 
6
7
  class TIME_HT_editor_buttons:
7
- """ """
8
-
9
8
  def draw_header(self, context, layout):
10
9
  """
11
10
 
@@ -15,34 +14,40 @@ class TIME_HT_editor_buttons:
15
14
  ...
16
15
 
17
16
  class TIME_MT_cache(bpy_types.Menu, bpy_types._GenericUI):
18
- """ """
19
-
20
17
  bl_label: typing.Any
21
- """ """
22
-
23
18
  bl_rna: typing.Any
24
- """ """
25
-
26
19
  id_data: typing.Any
27
- """ """
28
20
 
29
21
  def append(self, draw_func):
30
- """
22
+ """Append a draw function to this menu,
23
+ takes the same arguments as the menus draw function
31
24
 
32
- :param draw_func:
25
+ :param draw_func:
33
26
  """
34
27
  ...
35
28
 
36
- def as_pointer(self):
37
- """ """
29
+ def as_pointer(self) -> int:
30
+ """Returns the memory address which holds a pointer to Blender's internal data
31
+
32
+ :return: int (memory address).
33
+ :rtype: int
34
+ """
38
35
  ...
39
36
 
40
- def bl_rna_get_subclass(self):
41
- """ """
37
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
38
+ """
39
+
40
+ :return: The RNA type or default when not found.
41
+ :rtype: bpy.types.Struct
42
+ """
42
43
  ...
43
44
 
44
- def bl_rna_get_subclass_py(self):
45
- """ """
45
+ def bl_rna_get_subclass_py(self) -> typing.Any:
46
+ """
47
+
48
+ :return: The class or default when not found.
49
+ :rtype: typing.Any
50
+ """
46
51
  ...
47
52
 
48
53
  def draw(self, context):
@@ -61,172 +66,259 @@ class TIME_MT_cache(bpy_types.Menu, bpy_types._GenericUI):
61
66
  ...
62
67
 
63
68
  def draw_preset(self, _context):
64
- """
69
+ """Define these on the subclass:
70
+ - preset_operator (string)
71
+ - preset_subdir (string)Optionally:
72
+ - preset_add_operator (string)
73
+ - preset_extensions (set of strings)
74
+ - preset_operator_defaults (dict of keyword args)
65
75
 
66
- :param _context:
76
+ :param _context:
67
77
  """
68
78
  ...
69
79
 
70
- def driver_add(self):
71
- """ """
80
+ def driver_add(self) -> bpy.types.FCurve:
81
+ """Adds driver(s) to the given property
82
+
83
+ :return: The driver(s) added.
84
+ :rtype: bpy.types.FCurve
85
+ """
72
86
  ...
73
87
 
74
- def driver_remove(self):
75
- """ """
88
+ def driver_remove(self) -> bool:
89
+ """Remove driver(s) from the given property
90
+
91
+ :return: Success of driver removal.
92
+ :rtype: bool
93
+ """
76
94
  ...
77
95
 
78
96
  def get(self):
79
- """ """
97
+ """Returns the value of the custom property assigned to key or default
98
+ when not found (matches Python's dictionary function of the same name).
99
+
100
+ """
80
101
  ...
81
102
 
82
103
  def id_properties_clear(self):
83
- """ """
104
+ """
105
+
106
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
107
+ """
84
108
  ...
85
109
 
86
110
  def id_properties_ensure(self):
87
- """ """
111
+ """
112
+
113
+ :return: the parent group for an RNA struct's custom IDProperties.
114
+ """
88
115
  ...
89
116
 
90
117
  def id_properties_ui(self):
91
- """ """
92
- ...
118
+ """
93
119
 
94
- def is_extended(self):
95
- """ """
120
+ :return: Return an object used to manage an IDProperty's UI data.
121
+ """
96
122
  ...
97
123
 
98
- def is_property_hidden(self):
99
- """ """
124
+ def is_extended(self): ...
125
+ def is_property_hidden(self) -> bool:
126
+ """Check if a property is hidden.
127
+
128
+ :return: True when the property is hidden.
129
+ :rtype: bool
130
+ """
100
131
  ...
101
132
 
102
- def is_property_overridable_library(self):
103
- """ """
133
+ def is_property_overridable_library(self) -> bool:
134
+ """Check if a property is overridable.
135
+
136
+ :return: True when the property is overridable.
137
+ :rtype: bool
138
+ """
104
139
  ...
105
140
 
106
- def is_property_readonly(self):
107
- """ """
141
+ def is_property_readonly(self) -> bool:
142
+ """Check if a property is readonly.
143
+
144
+ :return: True when the property is readonly (not writable).
145
+ :rtype: bool
146
+ """
108
147
  ...
109
148
 
110
- def is_property_set(self):
111
- """ """
149
+ def is_property_set(self) -> bool:
150
+ """Check if a property is set, use for testing operator properties.
151
+
152
+ :return: True when the property has been set.
153
+ :rtype: bool
154
+ """
112
155
  ...
113
156
 
114
157
  def items(self):
115
- """ """
158
+ """Returns the items of this objects custom properties (matches Python's
159
+ dictionary function of the same name).
160
+
161
+ :return: custom property key, value pairs.
162
+ """
116
163
  ...
117
164
 
118
- def keyframe_delete(self):
119
- """ """
165
+ def keyframe_delete(self) -> bool:
166
+ """Remove a keyframe from this properties fcurve.
167
+
168
+ :return: Success of keyframe deletion.
169
+ :rtype: bool
170
+ """
120
171
  ...
121
172
 
122
- def keyframe_insert(self):
123
- """ """
173
+ def keyframe_insert(self) -> bool:
174
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
175
+
176
+ :return: Success of keyframe insertion.
177
+ :rtype: bool
178
+ """
124
179
  ...
125
180
 
126
181
  def keys(self):
127
- """ """
182
+ """Returns the keys of this objects custom properties (matches Python's
183
+ dictionary function of the same name).
184
+
185
+ :return: custom property keys.
186
+ """
128
187
  ...
129
188
 
130
- def path_from_id(self):
131
- """ """
189
+ def path_from_id(self) -> str:
190
+ """Returns the data path from the ID to this object (string).
191
+
192
+ :return: The path from `bpy.types.bpy_struct.id_data`
193
+ to this struct and property (when given).
194
+ :rtype: str
195
+ """
132
196
  ...
133
197
 
134
198
  def path_menu(
135
199
  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,
200
+ searchpaths: list[str],
201
+ operator: str,
202
+ props_default: dict = None,
203
+ prop_filepath: str = "filepath",
204
+ filter_ext: typing.Callable = None,
205
+ filter_path=None,
206
+ display_name: typing.Callable = None,
207
+ add_operator=None,
208
+ add_operator_props=None,
145
209
  ):
146
- """
210
+ """Populate a menu from a list of paths.
211
+
212
+ :param searchpaths: Paths to scan.
213
+ :type searchpaths: list[str]
214
+ :param operator: The operator id to use with each file.
215
+ :type operator: str
216
+ :param props_default: Properties to assign to each operator.
217
+ :type props_default: dict
218
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
219
+ :type prop_filepath: str
220
+ :param filter_ext: Optional callback that takes the file extensions.
147
221
 
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:
222
+ Returning false excludes the file from the list.
223
+ :type filter_ext: typing.Callable
224
+ :param filter_path:
225
+ :param display_name: Optional callback that takes the full path, returns the name to display.
226
+ :type display_name: typing.Callable
227
+ :param add_operator:
228
+ :param add_operator_props:
157
229
  """
158
230
  ...
159
231
 
160
232
  def path_resolve(self):
161
- """ """
233
+ """Returns the property from the path, raise an exception when not found."""
162
234
  ...
163
235
 
164
236
  def pop(self):
165
- """ """
237
+ """Remove and return the value of the custom property assigned to key or default
238
+ when not found (matches Python's dictionary function of the same name).
239
+
240
+ """
166
241
  ...
167
242
 
168
243
  def prepend(self, draw_func):
169
- """
244
+ """Prepend a draw function to this menu, takes the same arguments as
245
+ the menus draw function
170
246
 
171
- :param draw_func:
247
+ :param draw_func:
172
248
  """
173
249
  ...
174
250
 
175
- def property_overridable_library_set(self):
176
- """ """
251
+ def property_overridable_library_set(self) -> bool:
252
+ """Define a property as overridable or not (only for custom properties!).
253
+
254
+ :return: True when the overridable status of the property was successfully set.
255
+ :rtype: bool
256
+ """
177
257
  ...
178
258
 
179
259
  def property_unset(self):
180
- """ """
260
+ """Unset a property, will use default value afterward."""
181
261
  ...
182
262
 
183
263
  def remove(self, draw_func):
184
- """
264
+ """Remove a draw function that has been added to this menu
185
265
 
186
266
  :param draw_func:
187
267
  """
188
268
  ...
189
269
 
190
270
  def type_recast(self):
191
- """ """
271
+ """Return a new instance, this is needed because types
272
+ such as textures can be changed at runtime.
273
+
274
+ :return: a new instance of this object with the type initialized again.
275
+ """
192
276
  ...
193
277
 
194
278
  def values(self):
195
- """ """
279
+ """Returns the values of this objects custom properties (matches Python's
280
+ dictionary function of the same name).
281
+
282
+ :return: custom property values.
283
+ """
196
284
  ...
197
285
 
198
286
  class TIME_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
199
- """ """
200
-
201
287
  bl_idname: typing.Any
202
- """ """
203
-
204
288
  bl_label: typing.Any
205
- """ """
206
-
207
289
  bl_rna: typing.Any
208
- """ """
209
-
210
290
  id_data: typing.Any
211
- """ """
212
291
 
213
292
  def append(self, draw_func):
214
- """
293
+ """Append a draw function to this menu,
294
+ takes the same arguments as the menus draw function
215
295
 
216
- :param draw_func:
296
+ :param draw_func:
217
297
  """
218
298
  ...
219
299
 
220
- def as_pointer(self):
221
- """ """
300
+ def as_pointer(self) -> int:
301
+ """Returns the memory address which holds a pointer to Blender's internal data
302
+
303
+ :return: int (memory address).
304
+ :rtype: int
305
+ """
222
306
  ...
223
307
 
224
- def bl_rna_get_subclass(self):
225
- """ """
308
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
309
+ """
310
+
311
+ :return: The RNA type or default when not found.
312
+ :rtype: bpy.types.Struct
313
+ """
226
314
  ...
227
315
 
228
- def bl_rna_get_subclass_py(self):
229
- """ """
316
+ def bl_rna_get_subclass_py(self) -> typing.Any:
317
+ """
318
+
319
+ :return: The class or default when not found.
320
+ :rtype: typing.Any
321
+ """
230
322
  ...
231
323
 
232
324
  def draw(self, context):
@@ -245,169 +337,258 @@ class TIME_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
245
337
  ...
246
338
 
247
339
  def draw_preset(self, _context):
248
- """
340
+ """Define these on the subclass:
341
+ - preset_operator (string)
342
+ - preset_subdir (string)Optionally:
343
+ - preset_add_operator (string)
344
+ - preset_extensions (set of strings)
345
+ - preset_operator_defaults (dict of keyword args)
249
346
 
250
- :param _context:
347
+ :param _context:
251
348
  """
252
349
  ...
253
350
 
254
- def driver_add(self):
255
- """ """
351
+ def driver_add(self) -> bpy.types.FCurve:
352
+ """Adds driver(s) to the given property
353
+
354
+ :return: The driver(s) added.
355
+ :rtype: bpy.types.FCurve
356
+ """
256
357
  ...
257
358
 
258
- def driver_remove(self):
259
- """ """
359
+ def driver_remove(self) -> bool:
360
+ """Remove driver(s) from the given property
361
+
362
+ :return: Success of driver removal.
363
+ :rtype: bool
364
+ """
260
365
  ...
261
366
 
262
367
  def get(self):
263
- """ """
368
+ """Returns the value of the custom property assigned to key or default
369
+ when not found (matches Python's dictionary function of the same name).
370
+
371
+ """
264
372
  ...
265
373
 
266
374
  def id_properties_clear(self):
267
- """ """
375
+ """
376
+
377
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
378
+ """
268
379
  ...
269
380
 
270
381
  def id_properties_ensure(self):
271
- """ """
382
+ """
383
+
384
+ :return: the parent group for an RNA struct's custom IDProperties.
385
+ """
272
386
  ...
273
387
 
274
388
  def id_properties_ui(self):
275
- """ """
276
- ...
389
+ """
277
390
 
278
- def is_extended(self):
279
- """ """
391
+ :return: Return an object used to manage an IDProperty's UI data.
392
+ """
280
393
  ...
281
394
 
282
- def is_property_hidden(self):
283
- """ """
395
+ def is_extended(self): ...
396
+ def is_property_hidden(self) -> bool:
397
+ """Check if a property is hidden.
398
+
399
+ :return: True when the property is hidden.
400
+ :rtype: bool
401
+ """
284
402
  ...
285
403
 
286
- def is_property_overridable_library(self):
287
- """ """
404
+ def is_property_overridable_library(self) -> bool:
405
+ """Check if a property is overridable.
406
+
407
+ :return: True when the property is overridable.
408
+ :rtype: bool
409
+ """
288
410
  ...
289
411
 
290
- def is_property_readonly(self):
291
- """ """
412
+ def is_property_readonly(self) -> bool:
413
+ """Check if a property is readonly.
414
+
415
+ :return: True when the property is readonly (not writable).
416
+ :rtype: bool
417
+ """
292
418
  ...
293
419
 
294
- def is_property_set(self):
295
- """ """
420
+ def is_property_set(self) -> bool:
421
+ """Check if a property is set, use for testing operator properties.
422
+
423
+ :return: True when the property has been set.
424
+ :rtype: bool
425
+ """
296
426
  ...
297
427
 
298
428
  def items(self):
299
- """ """
429
+ """Returns the items of this objects custom properties (matches Python's
430
+ dictionary function of the same name).
431
+
432
+ :return: custom property key, value pairs.
433
+ """
300
434
  ...
301
435
 
302
- def keyframe_delete(self):
303
- """ """
436
+ def keyframe_delete(self) -> bool:
437
+ """Remove a keyframe from this properties fcurve.
438
+
439
+ :return: Success of keyframe deletion.
440
+ :rtype: bool
441
+ """
304
442
  ...
305
443
 
306
- def keyframe_insert(self):
307
- """ """
444
+ def keyframe_insert(self) -> bool:
445
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
446
+
447
+ :return: Success of keyframe insertion.
448
+ :rtype: bool
449
+ """
308
450
  ...
309
451
 
310
452
  def keys(self):
311
- """ """
453
+ """Returns the keys of this objects custom properties (matches Python's
454
+ dictionary function of the same name).
455
+
456
+ :return: custom property keys.
457
+ """
312
458
  ...
313
459
 
314
- def path_from_id(self):
315
- """ """
460
+ def path_from_id(self) -> str:
461
+ """Returns the data path from the ID to this object (string).
462
+
463
+ :return: The path from `bpy.types.bpy_struct.id_data`
464
+ to this struct and property (when given).
465
+ :rtype: str
466
+ """
316
467
  ...
317
468
 
318
469
  def path_menu(
319
470
  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,
471
+ searchpaths: list[str],
472
+ operator: str,
473
+ props_default: dict = None,
474
+ prop_filepath: str = "filepath",
475
+ filter_ext: typing.Callable = None,
476
+ filter_path=None,
477
+ display_name: typing.Callable = None,
478
+ add_operator=None,
479
+ add_operator_props=None,
329
480
  ):
330
- """
481
+ """Populate a menu from a list of paths.
482
+
483
+ :param searchpaths: Paths to scan.
484
+ :type searchpaths: list[str]
485
+ :param operator: The operator id to use with each file.
486
+ :type operator: str
487
+ :param props_default: Properties to assign to each operator.
488
+ :type props_default: dict
489
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
490
+ :type prop_filepath: str
491
+ :param filter_ext: Optional callback that takes the file extensions.
331
492
 
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:
493
+ Returning false excludes the file from the list.
494
+ :type filter_ext: typing.Callable
495
+ :param filter_path:
496
+ :param display_name: Optional callback that takes the full path, returns the name to display.
497
+ :type display_name: typing.Callable
498
+ :param add_operator:
499
+ :param add_operator_props:
341
500
  """
342
501
  ...
343
502
 
344
503
  def path_resolve(self):
345
- """ """
504
+ """Returns the property from the path, raise an exception when not found."""
346
505
  ...
347
506
 
348
507
  def pop(self):
349
- """ """
508
+ """Remove and return the value of the custom property assigned to key or default
509
+ when not found (matches Python's dictionary function of the same name).
510
+
511
+ """
350
512
  ...
351
513
 
352
514
  def prepend(self, draw_func):
353
- """
515
+ """Prepend a draw function to this menu, takes the same arguments as
516
+ the menus draw function
354
517
 
355
- :param draw_func:
518
+ :param draw_func:
356
519
  """
357
520
  ...
358
521
 
359
- def property_overridable_library_set(self):
360
- """ """
522
+ def property_overridable_library_set(self) -> bool:
523
+ """Define a property as overridable or not (only for custom properties!).
524
+
525
+ :return: True when the overridable status of the property was successfully set.
526
+ :rtype: bool
527
+ """
361
528
  ...
362
529
 
363
530
  def property_unset(self):
364
- """ """
531
+ """Unset a property, will use default value afterward."""
365
532
  ...
366
533
 
367
534
  def remove(self, draw_func):
368
- """
535
+ """Remove a draw function that has been added to this menu
369
536
 
370
537
  :param draw_func:
371
538
  """
372
539
  ...
373
540
 
374
541
  def type_recast(self):
375
- """ """
542
+ """Return a new instance, this is needed because types
543
+ such as textures can be changed at runtime.
544
+
545
+ :return: a new instance of this object with the type initialized again.
546
+ """
376
547
  ...
377
548
 
378
549
  def values(self):
379
- """ """
550
+ """Returns the values of this objects custom properties (matches Python's
551
+ dictionary function of the same name).
552
+
553
+ :return: custom property values.
554
+ """
380
555
  ...
381
556
 
382
557
  class TIME_MT_marker(bpy_types.Menu, bpy_types._GenericUI):
383
- """ """
384
-
385
558
  bl_label: typing.Any
386
- """ """
387
-
388
559
  bl_rna: typing.Any
389
- """ """
390
-
391
560
  id_data: typing.Any
392
- """ """
393
561
 
394
562
  def append(self, draw_func):
395
- """
563
+ """Append a draw function to this menu,
564
+ takes the same arguments as the menus draw function
396
565
 
397
- :param draw_func:
566
+ :param draw_func:
398
567
  """
399
568
  ...
400
569
 
401
- def as_pointer(self):
402
- """ """
570
+ def as_pointer(self) -> int:
571
+ """Returns the memory address which holds a pointer to Blender's internal data
572
+
573
+ :return: int (memory address).
574
+ :rtype: int
575
+ """
403
576
  ...
404
577
 
405
- def bl_rna_get_subclass(self):
406
- """ """
578
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
579
+ """
580
+
581
+ :return: The RNA type or default when not found.
582
+ :rtype: bpy.types.Struct
583
+ """
407
584
  ...
408
585
 
409
- def bl_rna_get_subclass_py(self):
410
- """ """
586
+ def bl_rna_get_subclass_py(self) -> typing.Any:
587
+ """
588
+
589
+ :return: The class or default when not found.
590
+ :rtype: typing.Any
591
+ """
411
592
  ...
412
593
 
413
594
  def draw(self, context):
@@ -426,169 +607,258 @@ class TIME_MT_marker(bpy_types.Menu, bpy_types._GenericUI):
426
607
  ...
427
608
 
428
609
  def draw_preset(self, _context):
429
- """
610
+ """Define these on the subclass:
611
+ - preset_operator (string)
612
+ - preset_subdir (string)Optionally:
613
+ - preset_add_operator (string)
614
+ - preset_extensions (set of strings)
615
+ - preset_operator_defaults (dict of keyword args)
430
616
 
431
- :param _context:
617
+ :param _context:
432
618
  """
433
619
  ...
434
620
 
435
- def driver_add(self):
436
- """ """
621
+ def driver_add(self) -> bpy.types.FCurve:
622
+ """Adds driver(s) to the given property
623
+
624
+ :return: The driver(s) added.
625
+ :rtype: bpy.types.FCurve
626
+ """
437
627
  ...
438
628
 
439
- def driver_remove(self):
440
- """ """
629
+ def driver_remove(self) -> bool:
630
+ """Remove driver(s) from the given property
631
+
632
+ :return: Success of driver removal.
633
+ :rtype: bool
634
+ """
441
635
  ...
442
636
 
443
637
  def get(self):
444
- """ """
638
+ """Returns the value of the custom property assigned to key or default
639
+ when not found (matches Python's dictionary function of the same name).
640
+
641
+ """
445
642
  ...
446
643
 
447
644
  def id_properties_clear(self):
448
- """ """
645
+ """
646
+
647
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
648
+ """
449
649
  ...
450
650
 
451
651
  def id_properties_ensure(self):
452
- """ """
652
+ """
653
+
654
+ :return: the parent group for an RNA struct's custom IDProperties.
655
+ """
453
656
  ...
454
657
 
455
658
  def id_properties_ui(self):
456
- """ """
457
- ...
659
+ """
458
660
 
459
- def is_extended(self):
460
- """ """
661
+ :return: Return an object used to manage an IDProperty's UI data.
662
+ """
461
663
  ...
462
664
 
463
- def is_property_hidden(self):
464
- """ """
665
+ def is_extended(self): ...
666
+ def is_property_hidden(self) -> bool:
667
+ """Check if a property is hidden.
668
+
669
+ :return: True when the property is hidden.
670
+ :rtype: bool
671
+ """
465
672
  ...
466
673
 
467
- def is_property_overridable_library(self):
468
- """ """
674
+ def is_property_overridable_library(self) -> bool:
675
+ """Check if a property is overridable.
676
+
677
+ :return: True when the property is overridable.
678
+ :rtype: bool
679
+ """
469
680
  ...
470
681
 
471
- def is_property_readonly(self):
472
- """ """
682
+ def is_property_readonly(self) -> bool:
683
+ """Check if a property is readonly.
684
+
685
+ :return: True when the property is readonly (not writable).
686
+ :rtype: bool
687
+ """
473
688
  ...
474
689
 
475
- def is_property_set(self):
476
- """ """
690
+ def is_property_set(self) -> bool:
691
+ """Check if a property is set, use for testing operator properties.
692
+
693
+ :return: True when the property has been set.
694
+ :rtype: bool
695
+ """
477
696
  ...
478
697
 
479
698
  def items(self):
480
- """ """
699
+ """Returns the items of this objects custom properties (matches Python's
700
+ dictionary function of the same name).
701
+
702
+ :return: custom property key, value pairs.
703
+ """
481
704
  ...
482
705
 
483
- def keyframe_delete(self):
484
- """ """
706
+ def keyframe_delete(self) -> bool:
707
+ """Remove a keyframe from this properties fcurve.
708
+
709
+ :return: Success of keyframe deletion.
710
+ :rtype: bool
711
+ """
485
712
  ...
486
713
 
487
- def keyframe_insert(self):
488
- """ """
714
+ def keyframe_insert(self) -> bool:
715
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
716
+
717
+ :return: Success of keyframe insertion.
718
+ :rtype: bool
719
+ """
489
720
  ...
490
721
 
491
722
  def keys(self):
492
- """ """
723
+ """Returns the keys of this objects custom properties (matches Python's
724
+ dictionary function of the same name).
725
+
726
+ :return: custom property keys.
727
+ """
493
728
  ...
494
729
 
495
- def path_from_id(self):
496
- """ """
730
+ def path_from_id(self) -> str:
731
+ """Returns the data path from the ID to this object (string).
732
+
733
+ :return: The path from `bpy.types.bpy_struct.id_data`
734
+ to this struct and property (when given).
735
+ :rtype: str
736
+ """
497
737
  ...
498
738
 
499
739
  def path_menu(
500
740
  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,
741
+ searchpaths: list[str],
742
+ operator: str,
743
+ props_default: dict = None,
744
+ prop_filepath: str = "filepath",
745
+ filter_ext: typing.Callable = None,
746
+ filter_path=None,
747
+ display_name: typing.Callable = None,
748
+ add_operator=None,
749
+ add_operator_props=None,
510
750
  ):
511
- """
751
+ """Populate a menu from a list of paths.
752
+
753
+ :param searchpaths: Paths to scan.
754
+ :type searchpaths: list[str]
755
+ :param operator: The operator id to use with each file.
756
+ :type operator: str
757
+ :param props_default: Properties to assign to each operator.
758
+ :type props_default: dict
759
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
760
+ :type prop_filepath: str
761
+ :param filter_ext: Optional callback that takes the file extensions.
512
762
 
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:
763
+ Returning false excludes the file from the list.
764
+ :type filter_ext: typing.Callable
765
+ :param filter_path:
766
+ :param display_name: Optional callback that takes the full path, returns the name to display.
767
+ :type display_name: typing.Callable
768
+ :param add_operator:
769
+ :param add_operator_props:
522
770
  """
523
771
  ...
524
772
 
525
773
  def path_resolve(self):
526
- """ """
774
+ """Returns the property from the path, raise an exception when not found."""
527
775
  ...
528
776
 
529
777
  def pop(self):
530
- """ """
778
+ """Remove and return the value of the custom property assigned to key or default
779
+ when not found (matches Python's dictionary function of the same name).
780
+
781
+ """
531
782
  ...
532
783
 
533
784
  def prepend(self, draw_func):
534
- """
785
+ """Prepend a draw function to this menu, takes the same arguments as
786
+ the menus draw function
535
787
 
536
- :param draw_func:
788
+ :param draw_func:
537
789
  """
538
790
  ...
539
791
 
540
- def property_overridable_library_set(self):
541
- """ """
792
+ def property_overridable_library_set(self) -> bool:
793
+ """Define a property as overridable or not (only for custom properties!).
794
+
795
+ :return: True when the overridable status of the property was successfully set.
796
+ :rtype: bool
797
+ """
542
798
  ...
543
799
 
544
800
  def property_unset(self):
545
- """ """
801
+ """Unset a property, will use default value afterward."""
546
802
  ...
547
803
 
548
804
  def remove(self, draw_func):
549
- """
805
+ """Remove a draw function that has been added to this menu
550
806
 
551
807
  :param draw_func:
552
808
  """
553
809
  ...
554
810
 
555
811
  def type_recast(self):
556
- """ """
812
+ """Return a new instance, this is needed because types
813
+ such as textures can be changed at runtime.
814
+
815
+ :return: a new instance of this object with the type initialized again.
816
+ """
557
817
  ...
558
818
 
559
819
  def values(self):
560
- """ """
820
+ """Returns the values of this objects custom properties (matches Python's
821
+ dictionary function of the same name).
822
+
823
+ :return: custom property values.
824
+ """
561
825
  ...
562
826
 
563
827
  class TIME_MT_view(bpy_types.Menu, bpy_types._GenericUI):
564
- """ """
565
-
566
828
  bl_label: typing.Any
567
- """ """
568
-
569
829
  bl_rna: typing.Any
570
- """ """
571
-
572
830
  id_data: typing.Any
573
- """ """
574
831
 
575
832
  def append(self, draw_func):
576
- """
833
+ """Append a draw function to this menu,
834
+ takes the same arguments as the menus draw function
577
835
 
578
- :param draw_func:
836
+ :param draw_func:
579
837
  """
580
838
  ...
581
839
 
582
- def as_pointer(self):
583
- """ """
840
+ def as_pointer(self) -> int:
841
+ """Returns the memory address which holds a pointer to Blender's internal data
842
+
843
+ :return: int (memory address).
844
+ :rtype: int
845
+ """
584
846
  ...
585
847
 
586
- def bl_rna_get_subclass(self):
587
- """ """
848
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
849
+ """
850
+
851
+ :return: The RNA type or default when not found.
852
+ :rtype: bpy.types.Struct
853
+ """
588
854
  ...
589
855
 
590
- def bl_rna_get_subclass_py(self):
591
- """ """
856
+ def bl_rna_get_subclass_py(self) -> typing.Any:
857
+ """
858
+
859
+ :return: The class or default when not found.
860
+ :rtype: typing.Any
861
+ """
592
862
  ...
593
863
 
594
864
  def draw(self, context):
@@ -607,148 +877,226 @@ class TIME_MT_view(bpy_types.Menu, bpy_types._GenericUI):
607
877
  ...
608
878
 
609
879
  def draw_preset(self, _context):
610
- """
880
+ """Define these on the subclass:
881
+ - preset_operator (string)
882
+ - preset_subdir (string)Optionally:
883
+ - preset_add_operator (string)
884
+ - preset_extensions (set of strings)
885
+ - preset_operator_defaults (dict of keyword args)
611
886
 
612
- :param _context:
887
+ :param _context:
613
888
  """
614
889
  ...
615
890
 
616
- def driver_add(self):
617
- """ """
891
+ def driver_add(self) -> bpy.types.FCurve:
892
+ """Adds driver(s) to the given property
893
+
894
+ :return: The driver(s) added.
895
+ :rtype: bpy.types.FCurve
896
+ """
618
897
  ...
619
898
 
620
- def driver_remove(self):
621
- """ """
899
+ def driver_remove(self) -> bool:
900
+ """Remove driver(s) from the given property
901
+
902
+ :return: Success of driver removal.
903
+ :rtype: bool
904
+ """
622
905
  ...
623
906
 
624
907
  def get(self):
625
- """ """
908
+ """Returns the value of the custom property assigned to key or default
909
+ when not found (matches Python's dictionary function of the same name).
910
+
911
+ """
626
912
  ...
627
913
 
628
914
  def id_properties_clear(self):
629
- """ """
915
+ """
916
+
917
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
918
+ """
630
919
  ...
631
920
 
632
921
  def id_properties_ensure(self):
633
- """ """
922
+ """
923
+
924
+ :return: the parent group for an RNA struct's custom IDProperties.
925
+ """
634
926
  ...
635
927
 
636
928
  def id_properties_ui(self):
637
- """ """
638
- ...
929
+ """
639
930
 
640
- def is_extended(self):
641
- """ """
931
+ :return: Return an object used to manage an IDProperty's UI data.
932
+ """
642
933
  ...
643
934
 
644
- def is_property_hidden(self):
645
- """ """
935
+ def is_extended(self): ...
936
+ def is_property_hidden(self) -> bool:
937
+ """Check if a property is hidden.
938
+
939
+ :return: True when the property is hidden.
940
+ :rtype: bool
941
+ """
646
942
  ...
647
943
 
648
- def is_property_overridable_library(self):
649
- """ """
944
+ def is_property_overridable_library(self) -> bool:
945
+ """Check if a property is overridable.
946
+
947
+ :return: True when the property is overridable.
948
+ :rtype: bool
949
+ """
650
950
  ...
651
951
 
652
- def is_property_readonly(self):
653
- """ """
952
+ def is_property_readonly(self) -> bool:
953
+ """Check if a property is readonly.
954
+
955
+ :return: True when the property is readonly (not writable).
956
+ :rtype: bool
957
+ """
654
958
  ...
655
959
 
656
- def is_property_set(self):
657
- """ """
960
+ def is_property_set(self) -> bool:
961
+ """Check if a property is set, use for testing operator properties.
962
+
963
+ :return: True when the property has been set.
964
+ :rtype: bool
965
+ """
658
966
  ...
659
967
 
660
968
  def items(self):
661
- """ """
969
+ """Returns the items of this objects custom properties (matches Python's
970
+ dictionary function of the same name).
971
+
972
+ :return: custom property key, value pairs.
973
+ """
662
974
  ...
663
975
 
664
- def keyframe_delete(self):
665
- """ """
976
+ def keyframe_delete(self) -> bool:
977
+ """Remove a keyframe from this properties fcurve.
978
+
979
+ :return: Success of keyframe deletion.
980
+ :rtype: bool
981
+ """
666
982
  ...
667
983
 
668
- def keyframe_insert(self):
669
- """ """
984
+ def keyframe_insert(self) -> bool:
985
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
986
+
987
+ :return: Success of keyframe insertion.
988
+ :rtype: bool
989
+ """
670
990
  ...
671
991
 
672
992
  def keys(self):
673
- """ """
993
+ """Returns the keys of this objects custom properties (matches Python's
994
+ dictionary function of the same name).
995
+
996
+ :return: custom property keys.
997
+ """
674
998
  ...
675
999
 
676
- def path_from_id(self):
677
- """ """
1000
+ def path_from_id(self) -> str:
1001
+ """Returns the data path from the ID to this object (string).
1002
+
1003
+ :return: The path from `bpy.types.bpy_struct.id_data`
1004
+ to this struct and property (when given).
1005
+ :rtype: str
1006
+ """
678
1007
  ...
679
1008
 
680
1009
  def path_menu(
681
1010
  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,
1011
+ searchpaths: list[str],
1012
+ operator: str,
1013
+ props_default: dict = None,
1014
+ prop_filepath: str = "filepath",
1015
+ filter_ext: typing.Callable = None,
1016
+ filter_path=None,
1017
+ display_name: typing.Callable = None,
1018
+ add_operator=None,
1019
+ add_operator_props=None,
691
1020
  ):
692
- """
1021
+ """Populate a menu from a list of paths.
1022
+
1023
+ :param searchpaths: Paths to scan.
1024
+ :type searchpaths: list[str]
1025
+ :param operator: The operator id to use with each file.
1026
+ :type operator: str
1027
+ :param props_default: Properties to assign to each operator.
1028
+ :type props_default: dict
1029
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1030
+ :type prop_filepath: str
1031
+ :param filter_ext: Optional callback that takes the file extensions.
693
1032
 
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:
1033
+ Returning false excludes the file from the list.
1034
+ :type filter_ext: typing.Callable
1035
+ :param filter_path:
1036
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1037
+ :type display_name: typing.Callable
1038
+ :param add_operator:
1039
+ :param add_operator_props:
703
1040
  """
704
1041
  ...
705
1042
 
706
1043
  def path_resolve(self):
707
- """ """
1044
+ """Returns the property from the path, raise an exception when not found."""
708
1045
  ...
709
1046
 
710
1047
  def pop(self):
711
- """ """
1048
+ """Remove and return the value of the custom property assigned to key or default
1049
+ when not found (matches Python's dictionary function of the same name).
1050
+
1051
+ """
712
1052
  ...
713
1053
 
714
1054
  def prepend(self, draw_func):
715
- """
1055
+ """Prepend a draw function to this menu, takes the same arguments as
1056
+ the menus draw function
716
1057
 
717
- :param draw_func:
1058
+ :param draw_func:
718
1059
  """
719
1060
  ...
720
1061
 
721
- def property_overridable_library_set(self):
722
- """ """
1062
+ def property_overridable_library_set(self) -> bool:
1063
+ """Define a property as overridable or not (only for custom properties!).
1064
+
1065
+ :return: True when the overridable status of the property was successfully set.
1066
+ :rtype: bool
1067
+ """
723
1068
  ...
724
1069
 
725
1070
  def property_unset(self):
726
- """ """
1071
+ """Unset a property, will use default value afterward."""
727
1072
  ...
728
1073
 
729
1074
  def remove(self, draw_func):
730
- """
1075
+ """Remove a draw function that has been added to this menu
731
1076
 
732
1077
  :param draw_func:
733
1078
  """
734
1079
  ...
735
1080
 
736
1081
  def type_recast(self):
737
- """ """
1082
+ """Return a new instance, this is needed because types
1083
+ such as textures can be changed at runtime.
1084
+
1085
+ :return: a new instance of this object with the type initialized again.
1086
+ """
738
1087
  ...
739
1088
 
740
1089
  def values(self):
741
- """ """
1090
+ """Returns the values of this objects custom properties (matches Python's
1091
+ dictionary function of the same name).
1092
+
1093
+ :return: custom property values.
1094
+ """
742
1095
  ...
743
1096
 
744
1097
  class TimelinePanelButtons:
745
- """ """
746
-
747
1098
  bl_region_type: typing.Any
748
- """ """
749
-
750
1099
  bl_space_type: typing.Any
751
- """ """
752
1100
 
753
1101
  def has_timeline(self, context):
754
1102
  """
@@ -760,46 +1108,44 @@ class TimelinePanelButtons:
760
1108
  class TIME_PT_auto_keyframing(
761
1109
  bpy_types.Panel, TimelinePanelButtons, bpy_types._GenericUI
762
1110
  ):
763
- """ """
764
-
765
1111
  bl_label: typing.Any
766
- """ """
767
-
768
1112
  bl_options: typing.Any
769
- """ """
770
-
771
1113
  bl_region_type: typing.Any
772
- """ """
773
-
774
1114
  bl_rna: typing.Any
775
- """ """
776
-
777
1115
  bl_space_type: typing.Any
778
- """ """
779
-
780
1116
  bl_ui_units_x: typing.Any
781
- """ """
782
-
783
1117
  id_data: typing.Any
784
- """ """
785
1118
 
786
1119
  def append(self, draw_func):
787
- """
1120
+ """Append a draw function to this menu,
1121
+ takes the same arguments as the menus draw function
788
1122
 
789
- :param draw_func:
1123
+ :param draw_func:
790
1124
  """
791
1125
  ...
792
1126
 
793
- def as_pointer(self):
794
- """ """
1127
+ def as_pointer(self) -> int:
1128
+ """Returns the memory address which holds a pointer to Blender's internal data
1129
+
1130
+ :return: int (memory address).
1131
+ :rtype: int
1132
+ """
795
1133
  ...
796
1134
 
797
- def bl_rna_get_subclass(self):
798
- """ """
1135
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1136
+ """
1137
+
1138
+ :return: The RNA type or default when not found.
1139
+ :rtype: bpy.types.Struct
1140
+ """
799
1141
  ...
800
1142
 
801
- def bl_rna_get_subclass_py(self):
802
- """ """
1143
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1144
+ """
1145
+
1146
+ :return: The class or default when not found.
1147
+ :rtype: typing.Any
1148
+ """
803
1149
  ...
804
1150
 
805
1151
  def draw(self, context):
@@ -809,16 +1155,27 @@ class TIME_PT_auto_keyframing(
809
1155
  """
810
1156
  ...
811
1157
 
812
- def driver_add(self):
813
- """ """
1158
+ def driver_add(self) -> bpy.types.FCurve:
1159
+ """Adds driver(s) to the given property
1160
+
1161
+ :return: The driver(s) added.
1162
+ :rtype: bpy.types.FCurve
1163
+ """
814
1164
  ...
815
1165
 
816
- def driver_remove(self):
817
- """ """
1166
+ def driver_remove(self) -> bool:
1167
+ """Remove driver(s) from the given property
1168
+
1169
+ :return: Success of driver removal.
1170
+ :rtype: bool
1171
+ """
818
1172
  ...
819
1173
 
820
1174
  def get(self):
821
- """ """
1175
+ """Returns the value of the custom property assigned to key or default
1176
+ when not found (matches Python's dictionary function of the same name).
1177
+
1178
+ """
822
1179
  ...
823
1180
 
824
1181
  def has_timeline(self, context):
@@ -829,59 +1186,102 @@ class TIME_PT_auto_keyframing(
829
1186
  ...
830
1187
 
831
1188
  def id_properties_clear(self):
832
- """ """
1189
+ """
1190
+
1191
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1192
+ """
833
1193
  ...
834
1194
 
835
1195
  def id_properties_ensure(self):
836
- """ """
1196
+ """
1197
+
1198
+ :return: the parent group for an RNA struct's custom IDProperties.
1199
+ """
837
1200
  ...
838
1201
 
839
1202
  def id_properties_ui(self):
840
- """ """
841
- ...
1203
+ """
842
1204
 
843
- def is_extended(self):
844
- """ """
1205
+ :return: Return an object used to manage an IDProperty's UI data.
1206
+ """
845
1207
  ...
846
1208
 
847
- def is_property_hidden(self):
848
- """ """
1209
+ def is_extended(self): ...
1210
+ def is_property_hidden(self) -> bool:
1211
+ """Check if a property is hidden.
1212
+
1213
+ :return: True when the property is hidden.
1214
+ :rtype: bool
1215
+ """
849
1216
  ...
850
1217
 
851
- def is_property_overridable_library(self):
852
- """ """
1218
+ def is_property_overridable_library(self) -> bool:
1219
+ """Check if a property is overridable.
1220
+
1221
+ :return: True when the property is overridable.
1222
+ :rtype: bool
1223
+ """
853
1224
  ...
854
1225
 
855
- def is_property_readonly(self):
856
- """ """
1226
+ def is_property_readonly(self) -> bool:
1227
+ """Check if a property is readonly.
1228
+
1229
+ :return: True when the property is readonly (not writable).
1230
+ :rtype: bool
1231
+ """
857
1232
  ...
858
1233
 
859
- def is_property_set(self):
860
- """ """
1234
+ def is_property_set(self) -> bool:
1235
+ """Check if a property is set, use for testing operator properties.
1236
+
1237
+ :return: True when the property has been set.
1238
+ :rtype: bool
1239
+ """
861
1240
  ...
862
1241
 
863
1242
  def items(self):
864
- """ """
1243
+ """Returns the items of this objects custom properties (matches Python's
1244
+ dictionary function of the same name).
1245
+
1246
+ :return: custom property key, value pairs.
1247
+ """
865
1248
  ...
866
1249
 
867
- def keyframe_delete(self):
868
- """ """
1250
+ def keyframe_delete(self) -> bool:
1251
+ """Remove a keyframe from this properties fcurve.
1252
+
1253
+ :return: Success of keyframe deletion.
1254
+ :rtype: bool
1255
+ """
869
1256
  ...
870
1257
 
871
- def keyframe_insert(self):
872
- """ """
1258
+ def keyframe_insert(self) -> bool:
1259
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1260
+
1261
+ :return: Success of keyframe insertion.
1262
+ :rtype: bool
1263
+ """
873
1264
  ...
874
1265
 
875
1266
  def keys(self):
876
- """ """
1267
+ """Returns the keys of this objects custom properties (matches Python's
1268
+ dictionary function of the same name).
1269
+
1270
+ :return: custom property keys.
1271
+ """
877
1272
  ...
878
1273
 
879
- def path_from_id(self):
880
- """ """
1274
+ def path_from_id(self) -> str:
1275
+ """Returns the data path from the ID to this object (string).
1276
+
1277
+ :return: The path from `bpy.types.bpy_struct.id_data`
1278
+ to this struct and property (when given).
1279
+ :rtype: str
1280
+ """
881
1281
  ...
882
1282
 
883
1283
  def path_resolve(self):
884
- """ """
1284
+ """Returns the property from the path, raise an exception when not found."""
885
1285
  ...
886
1286
 
887
1287
  def poll(self, context):
@@ -892,79 +1292,95 @@ class TIME_PT_auto_keyframing(
892
1292
  ...
893
1293
 
894
1294
  def pop(self):
895
- """ """
1295
+ """Remove and return the value of the custom property assigned to key or default
1296
+ when not found (matches Python's dictionary function of the same name).
1297
+
1298
+ """
896
1299
  ...
897
1300
 
898
1301
  def prepend(self, draw_func):
899
- """
1302
+ """Prepend a draw function to this menu, takes the same arguments as
1303
+ the menus draw function
900
1304
 
901
- :param draw_func:
1305
+ :param draw_func:
902
1306
  """
903
1307
  ...
904
1308
 
905
- def property_overridable_library_set(self):
906
- """ """
1309
+ def property_overridable_library_set(self) -> bool:
1310
+ """Define a property as overridable or not (only for custom properties!).
1311
+
1312
+ :return: True when the overridable status of the property was successfully set.
1313
+ :rtype: bool
1314
+ """
907
1315
  ...
908
1316
 
909
1317
  def property_unset(self):
910
- """ """
1318
+ """Unset a property, will use default value afterward."""
911
1319
  ...
912
1320
 
913
1321
  def remove(self, draw_func):
914
- """
1322
+ """Remove a draw function that has been added to this menu
915
1323
 
916
1324
  :param draw_func:
917
1325
  """
918
1326
  ...
919
1327
 
920
1328
  def type_recast(self):
921
- """ """
1329
+ """Return a new instance, this is needed because types
1330
+ such as textures can be changed at runtime.
1331
+
1332
+ :return: a new instance of this object with the type initialized again.
1333
+ """
922
1334
  ...
923
1335
 
924
1336
  def values(self):
925
- """ """
1337
+ """Returns the values of this objects custom properties (matches Python's
1338
+ dictionary function of the same name).
1339
+
1340
+ :return: custom property values.
1341
+ """
926
1342
  ...
927
1343
 
928
1344
  class TIME_PT_keyframing_settings(
929
1345
  bpy_types.Panel, TimelinePanelButtons, bpy_types._GenericUI
930
1346
  ):
931
- """ """
932
-
933
1347
  bl_label: typing.Any
934
- """ """
935
-
936
1348
  bl_options: typing.Any
937
- """ """
938
-
939
1349
  bl_region_type: typing.Any
940
- """ """
941
-
942
1350
  bl_rna: typing.Any
943
- """ """
944
-
945
1351
  bl_space_type: typing.Any
946
- """ """
947
-
948
1352
  id_data: typing.Any
949
- """ """
950
1353
 
951
1354
  def append(self, draw_func):
952
- """
1355
+ """Append a draw function to this menu,
1356
+ takes the same arguments as the menus draw function
953
1357
 
954
- :param draw_func:
1358
+ :param draw_func:
955
1359
  """
956
1360
  ...
957
1361
 
958
- def as_pointer(self):
959
- """ """
1362
+ def as_pointer(self) -> int:
1363
+ """Returns the memory address which holds a pointer to Blender's internal data
1364
+
1365
+ :return: int (memory address).
1366
+ :rtype: int
1367
+ """
960
1368
  ...
961
1369
 
962
- def bl_rna_get_subclass(self):
963
- """ """
1370
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1371
+ """
1372
+
1373
+ :return: The RNA type or default when not found.
1374
+ :rtype: bpy.types.Struct
1375
+ """
964
1376
  ...
965
1377
 
966
- def bl_rna_get_subclass_py(self):
967
- """ """
1378
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1379
+ """
1380
+
1381
+ :return: The class or default when not found.
1382
+ :rtype: typing.Any
1383
+ """
968
1384
  ...
969
1385
 
970
1386
  def draw(self, context):
@@ -974,16 +1390,27 @@ class TIME_PT_keyframing_settings(
974
1390
  """
975
1391
  ...
976
1392
 
977
- def driver_add(self):
978
- """ """
1393
+ def driver_add(self) -> bpy.types.FCurve:
1394
+ """Adds driver(s) to the given property
1395
+
1396
+ :return: The driver(s) added.
1397
+ :rtype: bpy.types.FCurve
1398
+ """
979
1399
  ...
980
1400
 
981
- def driver_remove(self):
982
- """ """
1401
+ def driver_remove(self) -> bool:
1402
+ """Remove driver(s) from the given property
1403
+
1404
+ :return: Success of driver removal.
1405
+ :rtype: bool
1406
+ """
983
1407
  ...
984
1408
 
985
1409
  def get(self):
986
- """ """
1410
+ """Returns the value of the custom property assigned to key or default
1411
+ when not found (matches Python's dictionary function of the same name).
1412
+
1413
+ """
987
1414
  ...
988
1415
 
989
1416
  def has_timeline(self, context):
@@ -994,59 +1421,102 @@ class TIME_PT_keyframing_settings(
994
1421
  ...
995
1422
 
996
1423
  def id_properties_clear(self):
997
- """ """
1424
+ """
1425
+
1426
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1427
+ """
998
1428
  ...
999
1429
 
1000
1430
  def id_properties_ensure(self):
1001
- """ """
1431
+ """
1432
+
1433
+ :return: the parent group for an RNA struct's custom IDProperties.
1434
+ """
1002
1435
  ...
1003
1436
 
1004
1437
  def id_properties_ui(self):
1005
- """ """
1006
- ...
1438
+ """
1007
1439
 
1008
- def is_extended(self):
1009
- """ """
1440
+ :return: Return an object used to manage an IDProperty's UI data.
1441
+ """
1010
1442
  ...
1011
1443
 
1012
- def is_property_hidden(self):
1013
- """ """
1444
+ def is_extended(self): ...
1445
+ def is_property_hidden(self) -> bool:
1446
+ """Check if a property is hidden.
1447
+
1448
+ :return: True when the property is hidden.
1449
+ :rtype: bool
1450
+ """
1014
1451
  ...
1015
1452
 
1016
- def is_property_overridable_library(self):
1017
- """ """
1453
+ def is_property_overridable_library(self) -> bool:
1454
+ """Check if a property is overridable.
1455
+
1456
+ :return: True when the property is overridable.
1457
+ :rtype: bool
1458
+ """
1018
1459
  ...
1019
1460
 
1020
- def is_property_readonly(self):
1021
- """ """
1461
+ def is_property_readonly(self) -> bool:
1462
+ """Check if a property is readonly.
1463
+
1464
+ :return: True when the property is readonly (not writable).
1465
+ :rtype: bool
1466
+ """
1022
1467
  ...
1023
1468
 
1024
- def is_property_set(self):
1025
- """ """
1469
+ def is_property_set(self) -> bool:
1470
+ """Check if a property is set, use for testing operator properties.
1471
+
1472
+ :return: True when the property has been set.
1473
+ :rtype: bool
1474
+ """
1026
1475
  ...
1027
1476
 
1028
1477
  def items(self):
1029
- """ """
1478
+ """Returns the items of this objects custom properties (matches Python's
1479
+ dictionary function of the same name).
1480
+
1481
+ :return: custom property key, value pairs.
1482
+ """
1030
1483
  ...
1031
1484
 
1032
- def keyframe_delete(self):
1033
- """ """
1485
+ def keyframe_delete(self) -> bool:
1486
+ """Remove a keyframe from this properties fcurve.
1487
+
1488
+ :return: Success of keyframe deletion.
1489
+ :rtype: bool
1490
+ """
1034
1491
  ...
1035
1492
 
1036
- def keyframe_insert(self):
1037
- """ """
1493
+ def keyframe_insert(self) -> bool:
1494
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1495
+
1496
+ :return: Success of keyframe insertion.
1497
+ :rtype: bool
1498
+ """
1038
1499
  ...
1039
1500
 
1040
1501
  def keys(self):
1041
- """ """
1502
+ """Returns the keys of this objects custom properties (matches Python's
1503
+ dictionary function of the same name).
1504
+
1505
+ :return: custom property keys.
1506
+ """
1042
1507
  ...
1043
1508
 
1044
- def path_from_id(self):
1045
- """ """
1509
+ def path_from_id(self) -> str:
1510
+ """Returns the data path from the ID to this object (string).
1511
+
1512
+ :return: The path from `bpy.types.bpy_struct.id_data`
1513
+ to this struct and property (when given).
1514
+ :rtype: str
1515
+ """
1046
1516
  ...
1047
1517
 
1048
1518
  def path_resolve(self):
1049
- """ """
1519
+ """Returns the property from the path, raise an exception when not found."""
1050
1520
  ...
1051
1521
 
1052
1522
  def poll(self, context):
@@ -1057,77 +1527,93 @@ class TIME_PT_keyframing_settings(
1057
1527
  ...
1058
1528
 
1059
1529
  def pop(self):
1060
- """ """
1530
+ """Remove and return the value of the custom property assigned to key or default
1531
+ when not found (matches Python's dictionary function of the same name).
1532
+
1533
+ """
1061
1534
  ...
1062
1535
 
1063
1536
  def prepend(self, draw_func):
1064
- """
1537
+ """Prepend a draw function to this menu, takes the same arguments as
1538
+ the menus draw function
1065
1539
 
1066
- :param draw_func:
1540
+ :param draw_func:
1067
1541
  """
1068
1542
  ...
1069
1543
 
1070
- def property_overridable_library_set(self):
1071
- """ """
1544
+ def property_overridable_library_set(self) -> bool:
1545
+ """Define a property as overridable or not (only for custom properties!).
1546
+
1547
+ :return: True when the overridable status of the property was successfully set.
1548
+ :rtype: bool
1549
+ """
1072
1550
  ...
1073
1551
 
1074
1552
  def property_unset(self):
1075
- """ """
1553
+ """Unset a property, will use default value afterward."""
1076
1554
  ...
1077
1555
 
1078
1556
  def remove(self, draw_func):
1079
- """
1557
+ """Remove a draw function that has been added to this menu
1080
1558
 
1081
1559
  :param draw_func:
1082
1560
  """
1083
1561
  ...
1084
1562
 
1085
1563
  def type_recast(self):
1086
- """ """
1564
+ """Return a new instance, this is needed because types
1565
+ such as textures can be changed at runtime.
1566
+
1567
+ :return: a new instance of this object with the type initialized again.
1568
+ """
1087
1569
  ...
1088
1570
 
1089
1571
  def values(self):
1090
- """ """
1572
+ """Returns the values of this objects custom properties (matches Python's
1573
+ dictionary function of the same name).
1574
+
1575
+ :return: custom property values.
1576
+ """
1091
1577
  ...
1092
1578
 
1093
1579
  class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._GenericUI):
1094
- """ """
1095
-
1096
1580
  bl_label: typing.Any
1097
- """ """
1098
-
1099
1581
  bl_region_type: typing.Any
1100
- """ """
1101
-
1102
1582
  bl_rna: typing.Any
1103
- """ """
1104
-
1105
1583
  bl_space_type: typing.Any
1106
- """ """
1107
-
1108
1584
  bl_ui_units_x: typing.Any
1109
- """ """
1110
-
1111
1585
  id_data: typing.Any
1112
- """ """
1113
1586
 
1114
1587
  def append(self, draw_func):
1115
- """
1588
+ """Append a draw function to this menu,
1589
+ takes the same arguments as the menus draw function
1116
1590
 
1117
- :param draw_func:
1591
+ :param draw_func:
1118
1592
  """
1119
1593
  ...
1120
1594
 
1121
- def as_pointer(self):
1122
- """ """
1595
+ def as_pointer(self) -> int:
1596
+ """Returns the memory address which holds a pointer to Blender's internal data
1597
+
1598
+ :return: int (memory address).
1599
+ :rtype: int
1600
+ """
1123
1601
  ...
1124
1602
 
1125
- def bl_rna_get_subclass(self):
1126
- """ """
1603
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1604
+ """
1605
+
1606
+ :return: The RNA type or default when not found.
1607
+ :rtype: bpy.types.Struct
1608
+ """
1127
1609
  ...
1128
1610
 
1129
- def bl_rna_get_subclass_py(self):
1130
- """ """
1611
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1612
+ """
1613
+
1614
+ :return: The class or default when not found.
1615
+ :rtype: typing.Any
1616
+ """
1131
1617
  ...
1132
1618
 
1133
1619
  def draw(self, context):
@@ -1137,16 +1623,27 @@ class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._Generic
1137
1623
  """
1138
1624
  ...
1139
1625
 
1140
- def driver_add(self):
1141
- """ """
1626
+ def driver_add(self) -> bpy.types.FCurve:
1627
+ """Adds driver(s) to the given property
1628
+
1629
+ :return: The driver(s) added.
1630
+ :rtype: bpy.types.FCurve
1631
+ """
1142
1632
  ...
1143
1633
 
1144
- def driver_remove(self):
1145
- """ """
1634
+ def driver_remove(self) -> bool:
1635
+ """Remove driver(s) from the given property
1636
+
1637
+ :return: Success of driver removal.
1638
+ :rtype: bool
1639
+ """
1146
1640
  ...
1147
1641
 
1148
1642
  def get(self):
1149
- """ """
1643
+ """Returns the value of the custom property assigned to key or default
1644
+ when not found (matches Python's dictionary function of the same name).
1645
+
1646
+ """
1150
1647
  ...
1151
1648
 
1152
1649
  def has_timeline(self, context):
@@ -1157,96 +1654,152 @@ class TIME_PT_playback(bpy_types.Panel, TimelinePanelButtons, bpy_types._Generic
1157
1654
  ...
1158
1655
 
1159
1656
  def id_properties_clear(self):
1160
- """ """
1657
+ """
1658
+
1659
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1660
+ """
1161
1661
  ...
1162
1662
 
1163
1663
  def id_properties_ensure(self):
1164
- """ """
1664
+ """
1665
+
1666
+ :return: the parent group for an RNA struct's custom IDProperties.
1667
+ """
1165
1668
  ...
1166
1669
 
1167
1670
  def id_properties_ui(self):
1168
- """ """
1169
- ...
1671
+ """
1170
1672
 
1171
- def is_extended(self):
1172
- """ """
1673
+ :return: Return an object used to manage an IDProperty's UI data.
1674
+ """
1173
1675
  ...
1174
1676
 
1175
- def is_property_hidden(self):
1176
- """ """
1677
+ def is_extended(self): ...
1678
+ def is_property_hidden(self) -> bool:
1679
+ """Check if a property is hidden.
1680
+
1681
+ :return: True when the property is hidden.
1682
+ :rtype: bool
1683
+ """
1177
1684
  ...
1178
1685
 
1179
- def is_property_overridable_library(self):
1180
- """ """
1686
+ def is_property_overridable_library(self) -> bool:
1687
+ """Check if a property is overridable.
1688
+
1689
+ :return: True when the property is overridable.
1690
+ :rtype: bool
1691
+ """
1181
1692
  ...
1182
1693
 
1183
- def is_property_readonly(self):
1184
- """ """
1694
+ def is_property_readonly(self) -> bool:
1695
+ """Check if a property is readonly.
1696
+
1697
+ :return: True when the property is readonly (not writable).
1698
+ :rtype: bool
1699
+ """
1185
1700
  ...
1186
1701
 
1187
- def is_property_set(self):
1188
- """ """
1702
+ def is_property_set(self) -> bool:
1703
+ """Check if a property is set, use for testing operator properties.
1704
+
1705
+ :return: True when the property has been set.
1706
+ :rtype: bool
1707
+ """
1189
1708
  ...
1190
1709
 
1191
1710
  def items(self):
1192
- """ """
1711
+ """Returns the items of this objects custom properties (matches Python's
1712
+ dictionary function of the same name).
1713
+
1714
+ :return: custom property key, value pairs.
1715
+ """
1193
1716
  ...
1194
1717
 
1195
- def keyframe_delete(self):
1196
- """ """
1718
+ def keyframe_delete(self) -> bool:
1719
+ """Remove a keyframe from this properties fcurve.
1720
+
1721
+ :return: Success of keyframe deletion.
1722
+ :rtype: bool
1723
+ """
1197
1724
  ...
1198
1725
 
1199
- def keyframe_insert(self):
1200
- """ """
1726
+ def keyframe_insert(self) -> bool:
1727
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1728
+
1729
+ :return: Success of keyframe insertion.
1730
+ :rtype: bool
1731
+ """
1201
1732
  ...
1202
1733
 
1203
1734
  def keys(self):
1204
- """ """
1735
+ """Returns the keys of this objects custom properties (matches Python's
1736
+ dictionary function of the same name).
1737
+
1738
+ :return: custom property keys.
1739
+ """
1205
1740
  ...
1206
1741
 
1207
- def path_from_id(self):
1208
- """ """
1742
+ def path_from_id(self) -> str:
1743
+ """Returns the data path from the ID to this object (string).
1744
+
1745
+ :return: The path from `bpy.types.bpy_struct.id_data`
1746
+ to this struct and property (when given).
1747
+ :rtype: str
1748
+ """
1209
1749
  ...
1210
1750
 
1211
1751
  def path_resolve(self):
1212
- """ """
1752
+ """Returns the property from the path, raise an exception when not found."""
1213
1753
  ...
1214
1754
 
1215
1755
  def pop(self):
1216
- """ """
1756
+ """Remove and return the value of the custom property assigned to key or default
1757
+ when not found (matches Python's dictionary function of the same name).
1758
+
1759
+ """
1217
1760
  ...
1218
1761
 
1219
1762
  def prepend(self, draw_func):
1220
- """
1763
+ """Prepend a draw function to this menu, takes the same arguments as
1764
+ the menus draw function
1221
1765
 
1222
- :param draw_func:
1766
+ :param draw_func:
1223
1767
  """
1224
1768
  ...
1225
1769
 
1226
- def property_overridable_library_set(self):
1227
- """ """
1770
+ def property_overridable_library_set(self) -> bool:
1771
+ """Define a property as overridable or not (only for custom properties!).
1772
+
1773
+ :return: True when the overridable status of the property was successfully set.
1774
+ :rtype: bool
1775
+ """
1228
1776
  ...
1229
1777
 
1230
1778
  def property_unset(self):
1231
- """ """
1779
+ """Unset a property, will use default value afterward."""
1232
1780
  ...
1233
1781
 
1234
1782
  def remove(self, draw_func):
1235
- """
1783
+ """Remove a draw function that has been added to this menu
1236
1784
 
1237
1785
  :param draw_func:
1238
1786
  """
1239
1787
  ...
1240
1788
 
1241
1789
  def type_recast(self):
1242
- """ """
1790
+ """Return a new instance, this is needed because types
1791
+ such as textures can be changed at runtime.
1792
+
1793
+ :return: a new instance of this object with the type initialized again.
1794
+ """
1243
1795
  ...
1244
1796
 
1245
1797
  def values(self):
1246
- """ """
1247
- ...
1798
+ """Returns the values of this objects custom properties (matches Python's
1799
+ dictionary function of the same name).
1248
1800
 
1249
- def marker_menu_generic(layout, context):
1250
- """ """
1801
+ :return: custom property values.
1802
+ """
1803
+ ...
1251
1804
 
1252
- ...
1805
+ def marker_menu_generic(layout, context): ...