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