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 TEXT_HT_footer(bpy_types.Header, bpy_types._GenericUI):
7
- """ """
8
-
9
8
  bl_region_type: typing.Any
10
- """ """
11
-
12
9
  bl_rna: typing.Any
13
- """ """
14
-
15
10
  bl_space_type: 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):
@@ -44,137 +49,213 @@ class TEXT_HT_footer(bpy_types.Header, bpy_types._GenericUI):
44
49
  """
45
50
  ...
46
51
 
47
- def driver_add(self):
48
- """ """
52
+ def driver_add(self) -> bpy.types.FCurve:
53
+ """Adds driver(s) to the given property
54
+
55
+ :return: The driver(s) added.
56
+ :rtype: bpy.types.FCurve
57
+ """
49
58
  ...
50
59
 
51
- def driver_remove(self):
52
- """ """
60
+ def driver_remove(self) -> bool:
61
+ """Remove driver(s) from the given property
62
+
63
+ :return: Success of driver removal.
64
+ :rtype: bool
65
+ """
53
66
  ...
54
67
 
55
68
  def get(self):
56
- """ """
69
+ """Returns the value of the custom property assigned to key or default
70
+ when not found (matches Python's dictionary function of the same name).
71
+
72
+ """
57
73
  ...
58
74
 
59
75
  def id_properties_clear(self):
60
- """ """
76
+ """
77
+
78
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
79
+ """
61
80
  ...
62
81
 
63
82
  def id_properties_ensure(self):
64
- """ """
83
+ """
84
+
85
+ :return: the parent group for an RNA struct's custom IDProperties.
86
+ """
65
87
  ...
66
88
 
67
89
  def id_properties_ui(self):
68
- """ """
69
- ...
90
+ """
70
91
 
71
- def is_extended(self):
72
- """ """
92
+ :return: Return an object used to manage an IDProperty's UI data.
93
+ """
73
94
  ...
74
95
 
75
- def is_property_hidden(self):
76
- """ """
96
+ def is_extended(self): ...
97
+ def is_property_hidden(self) -> bool:
98
+ """Check if a property is hidden.
99
+
100
+ :return: True when the property is hidden.
101
+ :rtype: bool
102
+ """
77
103
  ...
78
104
 
79
- def is_property_overridable_library(self):
80
- """ """
105
+ def is_property_overridable_library(self) -> bool:
106
+ """Check if a property is overridable.
107
+
108
+ :return: True when the property is overridable.
109
+ :rtype: bool
110
+ """
81
111
  ...
82
112
 
83
- def is_property_readonly(self):
84
- """ """
113
+ def is_property_readonly(self) -> bool:
114
+ """Check if a property is readonly.
115
+
116
+ :return: True when the property is readonly (not writable).
117
+ :rtype: bool
118
+ """
85
119
  ...
86
120
 
87
- def is_property_set(self):
88
- """ """
121
+ def is_property_set(self) -> bool:
122
+ """Check if a property is set, use for testing operator properties.
123
+
124
+ :return: True when the property has been set.
125
+ :rtype: bool
126
+ """
89
127
  ...
90
128
 
91
129
  def items(self):
92
- """ """
130
+ """Returns the items of this objects custom properties (matches Python's
131
+ dictionary function of the same name).
132
+
133
+ :return: custom property key, value pairs.
134
+ """
93
135
  ...
94
136
 
95
- def keyframe_delete(self):
96
- """ """
137
+ def keyframe_delete(self) -> bool:
138
+ """Remove a keyframe from this properties fcurve.
139
+
140
+ :return: Success of keyframe deletion.
141
+ :rtype: bool
142
+ """
97
143
  ...
98
144
 
99
- def keyframe_insert(self):
100
- """ """
145
+ def keyframe_insert(self) -> bool:
146
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
147
+
148
+ :return: Success of keyframe insertion.
149
+ :rtype: bool
150
+ """
101
151
  ...
102
152
 
103
153
  def keys(self):
104
- """ """
154
+ """Returns the keys of this objects custom properties (matches Python's
155
+ dictionary function of the same name).
156
+
157
+ :return: custom property keys.
158
+ """
105
159
  ...
106
160
 
107
- def path_from_id(self):
108
- """ """
161
+ def path_from_id(self) -> str:
162
+ """Returns the data path from the ID to this object (string).
163
+
164
+ :return: The path from `bpy.types.bpy_struct.id_data`
165
+ to this struct and property (when given).
166
+ :rtype: str
167
+ """
109
168
  ...
110
169
 
111
170
  def path_resolve(self):
112
- """ """
171
+ """Returns the property from the path, raise an exception when not found."""
113
172
  ...
114
173
 
115
174
  def pop(self):
116
- """ """
175
+ """Remove and return the value of the custom property assigned to key or default
176
+ when not found (matches Python's dictionary function of the same name).
177
+
178
+ """
117
179
  ...
118
180
 
119
181
  def prepend(self, draw_func):
120
- """
182
+ """Prepend a draw function to this menu, takes the same arguments as
183
+ the menus draw function
121
184
 
122
- :param draw_func:
185
+ :param draw_func:
123
186
  """
124
187
  ...
125
188
 
126
- def property_overridable_library_set(self):
127
- """ """
189
+ def property_overridable_library_set(self) -> bool:
190
+ """Define a property as overridable or not (only for custom properties!).
191
+
192
+ :return: True when the overridable status of the property was successfully set.
193
+ :rtype: bool
194
+ """
128
195
  ...
129
196
 
130
197
  def property_unset(self):
131
- """ """
198
+ """Unset a property, will use default value afterward."""
132
199
  ...
133
200
 
134
201
  def remove(self, draw_func):
135
- """
202
+ """Remove a draw function that has been added to this menu
136
203
 
137
204
  :param draw_func:
138
205
  """
139
206
  ...
140
207
 
141
208
  def type_recast(self):
142
- """ """
209
+ """Return a new instance, this is needed because types
210
+ such as textures can be changed at runtime.
211
+
212
+ :return: a new instance of this object with the type initialized again.
213
+ """
143
214
  ...
144
215
 
145
216
  def values(self):
146
- """ """
217
+ """Returns the values of this objects custom properties (matches Python's
218
+ dictionary function of the same name).
219
+
220
+ :return: custom property values.
221
+ """
147
222
  ...
148
223
 
149
224
  class TEXT_HT_header(bpy_types.Header, bpy_types._GenericUI):
150
- """ """
151
-
152
225
  bl_rna: typing.Any
153
- """ """
154
-
155
226
  bl_space_type: typing.Any
156
- """ """
157
-
158
227
  id_data: typing.Any
159
- """ """
160
228
 
161
229
  def append(self, draw_func):
162
- """
230
+ """Append a draw function to this menu,
231
+ takes the same arguments as the menus draw function
163
232
 
164
- :param draw_func:
233
+ :param draw_func:
165
234
  """
166
235
  ...
167
236
 
168
- def as_pointer(self):
169
- """ """
237
+ def as_pointer(self) -> int:
238
+ """Returns the memory address which holds a pointer to Blender's internal data
239
+
240
+ :return: int (memory address).
241
+ :rtype: int
242
+ """
170
243
  ...
171
244
 
172
- def bl_rna_get_subclass(self):
173
- """ """
245
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
246
+ """
247
+
248
+ :return: The RNA type or default when not found.
249
+ :rtype: bpy.types.Struct
250
+ """
174
251
  ...
175
252
 
176
- def bl_rna_get_subclass_py(self):
177
- """ """
253
+ def bl_rna_get_subclass_py(self) -> typing.Any:
254
+ """
255
+
256
+ :return: The class or default when not found.
257
+ :rtype: typing.Any
258
+ """
178
259
  ...
179
260
 
180
261
  def draw(self, context):
@@ -184,137 +265,213 @@ class TEXT_HT_header(bpy_types.Header, bpy_types._GenericUI):
184
265
  """
185
266
  ...
186
267
 
187
- def driver_add(self):
188
- """ """
268
+ def driver_add(self) -> bpy.types.FCurve:
269
+ """Adds driver(s) to the given property
270
+
271
+ :return: The driver(s) added.
272
+ :rtype: bpy.types.FCurve
273
+ """
189
274
  ...
190
275
 
191
- def driver_remove(self):
192
- """ """
276
+ def driver_remove(self) -> bool:
277
+ """Remove driver(s) from the given property
278
+
279
+ :return: Success of driver removal.
280
+ :rtype: bool
281
+ """
193
282
  ...
194
283
 
195
284
  def get(self):
196
- """ """
285
+ """Returns the value of the custom property assigned to key or default
286
+ when not found (matches Python's dictionary function of the same name).
287
+
288
+ """
197
289
  ...
198
290
 
199
291
  def id_properties_clear(self):
200
- """ """
292
+ """
293
+
294
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
295
+ """
201
296
  ...
202
297
 
203
298
  def id_properties_ensure(self):
204
- """ """
299
+ """
300
+
301
+ :return: the parent group for an RNA struct's custom IDProperties.
302
+ """
205
303
  ...
206
304
 
207
305
  def id_properties_ui(self):
208
- """ """
209
- ...
306
+ """
210
307
 
211
- def is_extended(self):
212
- """ """
308
+ :return: Return an object used to manage an IDProperty's UI data.
309
+ """
213
310
  ...
214
311
 
215
- def is_property_hidden(self):
216
- """ """
312
+ def is_extended(self): ...
313
+ def is_property_hidden(self) -> bool:
314
+ """Check if a property is hidden.
315
+
316
+ :return: True when the property is hidden.
317
+ :rtype: bool
318
+ """
217
319
  ...
218
320
 
219
- def is_property_overridable_library(self):
220
- """ """
321
+ def is_property_overridable_library(self) -> bool:
322
+ """Check if a property is overridable.
323
+
324
+ :return: True when the property is overridable.
325
+ :rtype: bool
326
+ """
221
327
  ...
222
328
 
223
- def is_property_readonly(self):
224
- """ """
329
+ def is_property_readonly(self) -> bool:
330
+ """Check if a property is readonly.
331
+
332
+ :return: True when the property is readonly (not writable).
333
+ :rtype: bool
334
+ """
225
335
  ...
226
336
 
227
- def is_property_set(self):
228
- """ """
337
+ def is_property_set(self) -> bool:
338
+ """Check if a property is set, use for testing operator properties.
339
+
340
+ :return: True when the property has been set.
341
+ :rtype: bool
342
+ """
229
343
  ...
230
344
 
231
345
  def items(self):
232
- """ """
346
+ """Returns the items of this objects custom properties (matches Python's
347
+ dictionary function of the same name).
348
+
349
+ :return: custom property key, value pairs.
350
+ """
233
351
  ...
234
352
 
235
- def keyframe_delete(self):
236
- """ """
353
+ def keyframe_delete(self) -> bool:
354
+ """Remove a keyframe from this properties fcurve.
355
+
356
+ :return: Success of keyframe deletion.
357
+ :rtype: bool
358
+ """
237
359
  ...
238
360
 
239
- def keyframe_insert(self):
240
- """ """
361
+ def keyframe_insert(self) -> bool:
362
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
363
+
364
+ :return: Success of keyframe insertion.
365
+ :rtype: bool
366
+ """
241
367
  ...
242
368
 
243
369
  def keys(self):
244
- """ """
370
+ """Returns the keys of this objects custom properties (matches Python's
371
+ dictionary function of the same name).
372
+
373
+ :return: custom property keys.
374
+ """
245
375
  ...
246
376
 
247
- def path_from_id(self):
248
- """ """
377
+ def path_from_id(self) -> str:
378
+ """Returns the data path from the ID to this object (string).
379
+
380
+ :return: The path from `bpy.types.bpy_struct.id_data`
381
+ to this struct and property (when given).
382
+ :rtype: str
383
+ """
249
384
  ...
250
385
 
251
386
  def path_resolve(self):
252
- """ """
387
+ """Returns the property from the path, raise an exception when not found."""
253
388
  ...
254
389
 
255
390
  def pop(self):
256
- """ """
391
+ """Remove and return the value of the custom property assigned to key or default
392
+ when not found (matches Python's dictionary function of the same name).
393
+
394
+ """
257
395
  ...
258
396
 
259
397
  def prepend(self, draw_func):
260
- """
398
+ """Prepend a draw function to this menu, takes the same arguments as
399
+ the menus draw function
261
400
 
262
- :param draw_func:
401
+ :param draw_func:
263
402
  """
264
403
  ...
265
404
 
266
- def property_overridable_library_set(self):
267
- """ """
405
+ def property_overridable_library_set(self) -> bool:
406
+ """Define a property as overridable or not (only for custom properties!).
407
+
408
+ :return: True when the overridable status of the property was successfully set.
409
+ :rtype: bool
410
+ """
268
411
  ...
269
412
 
270
413
  def property_unset(self):
271
- """ """
414
+ """Unset a property, will use default value afterward."""
272
415
  ...
273
416
 
274
417
  def remove(self, draw_func):
275
- """
418
+ """Remove a draw function that has been added to this menu
276
419
 
277
420
  :param draw_func:
278
421
  """
279
422
  ...
280
423
 
281
424
  def type_recast(self):
282
- """ """
425
+ """Return a new instance, this is needed because types
426
+ such as textures can be changed at runtime.
427
+
428
+ :return: a new instance of this object with the type initialized again.
429
+ """
283
430
  ...
284
431
 
285
432
  def values(self):
286
- """ """
433
+ """Returns the values of this objects custom properties (matches Python's
434
+ dictionary function of the same name).
435
+
436
+ :return: custom property values.
437
+ """
287
438
  ...
288
439
 
289
440
  class TEXT_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
290
- """ """
291
-
292
441
  bl_label: typing.Any
293
- """ """
294
-
295
442
  bl_rna: typing.Any
296
- """ """
297
-
298
443
  id_data: typing.Any
299
- """ """
300
444
 
301
445
  def append(self, draw_func):
302
- """
446
+ """Append a draw function to this menu,
447
+ takes the same arguments as the menus draw function
303
448
 
304
- :param draw_func:
449
+ :param draw_func:
305
450
  """
306
451
  ...
307
452
 
308
- def as_pointer(self):
309
- """ """
453
+ def as_pointer(self) -> int:
454
+ """Returns the memory address which holds a pointer to Blender's internal data
455
+
456
+ :return: int (memory address).
457
+ :rtype: int
458
+ """
310
459
  ...
311
460
 
312
- def bl_rna_get_subclass(self):
313
- """ """
461
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
462
+ """
463
+
464
+ :return: The RNA type or default when not found.
465
+ :rtype: bpy.types.Struct
466
+ """
314
467
  ...
315
468
 
316
- def bl_rna_get_subclass_py(self):
317
- """ """
469
+ def bl_rna_get_subclass_py(self) -> typing.Any:
470
+ """
471
+
472
+ :return: The class or default when not found.
473
+ :rtype: typing.Any
474
+ """
318
475
  ...
319
476
 
320
477
  def draw(self, _context):
@@ -333,169 +490,258 @@ class TEXT_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
333
490
  ...
334
491
 
335
492
  def draw_preset(self, _context):
336
- """
493
+ """Define these on the subclass:
494
+ - preset_operator (string)
495
+ - preset_subdir (string)Optionally:
496
+ - preset_add_operator (string)
497
+ - preset_extensions (set of strings)
498
+ - preset_operator_defaults (dict of keyword args)
337
499
 
338
- :param _context:
500
+ :param _context:
339
501
  """
340
502
  ...
341
503
 
342
- def driver_add(self):
343
- """ """
504
+ def driver_add(self) -> bpy.types.FCurve:
505
+ """Adds driver(s) to the given property
506
+
507
+ :return: The driver(s) added.
508
+ :rtype: bpy.types.FCurve
509
+ """
344
510
  ...
345
511
 
346
- def driver_remove(self):
347
- """ """
512
+ def driver_remove(self) -> bool:
513
+ """Remove driver(s) from the given property
514
+
515
+ :return: Success of driver removal.
516
+ :rtype: bool
517
+ """
348
518
  ...
349
519
 
350
520
  def get(self):
351
- """ """
521
+ """Returns the value of the custom property assigned to key or default
522
+ when not found (matches Python's dictionary function of the same name).
523
+
524
+ """
352
525
  ...
353
526
 
354
527
  def id_properties_clear(self):
355
- """ """
528
+ """
529
+
530
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
531
+ """
356
532
  ...
357
533
 
358
534
  def id_properties_ensure(self):
359
- """ """
535
+ """
536
+
537
+ :return: the parent group for an RNA struct's custom IDProperties.
538
+ """
360
539
  ...
361
540
 
362
541
  def id_properties_ui(self):
363
- """ """
364
- ...
542
+ """
365
543
 
366
- def is_extended(self):
367
- """ """
544
+ :return: Return an object used to manage an IDProperty's UI data.
545
+ """
368
546
  ...
369
547
 
370
- def is_property_hidden(self):
371
- """ """
548
+ def is_extended(self): ...
549
+ def is_property_hidden(self) -> bool:
550
+ """Check if a property is hidden.
551
+
552
+ :return: True when the property is hidden.
553
+ :rtype: bool
554
+ """
372
555
  ...
373
556
 
374
- def is_property_overridable_library(self):
375
- """ """
557
+ def is_property_overridable_library(self) -> bool:
558
+ """Check if a property is overridable.
559
+
560
+ :return: True when the property is overridable.
561
+ :rtype: bool
562
+ """
376
563
  ...
377
564
 
378
- def is_property_readonly(self):
379
- """ """
565
+ def is_property_readonly(self) -> bool:
566
+ """Check if a property is readonly.
567
+
568
+ :return: True when the property is readonly (not writable).
569
+ :rtype: bool
570
+ """
380
571
  ...
381
572
 
382
- def is_property_set(self):
383
- """ """
573
+ def is_property_set(self) -> bool:
574
+ """Check if a property is set, use for testing operator properties.
575
+
576
+ :return: True when the property has been set.
577
+ :rtype: bool
578
+ """
384
579
  ...
385
580
 
386
581
  def items(self):
387
- """ """
582
+ """Returns the items of this objects custom properties (matches Python's
583
+ dictionary function of the same name).
584
+
585
+ :return: custom property key, value pairs.
586
+ """
388
587
  ...
389
588
 
390
- def keyframe_delete(self):
391
- """ """
589
+ def keyframe_delete(self) -> bool:
590
+ """Remove a keyframe from this properties fcurve.
591
+
592
+ :return: Success of keyframe deletion.
593
+ :rtype: bool
594
+ """
392
595
  ...
393
596
 
394
- def keyframe_insert(self):
395
- """ """
597
+ def keyframe_insert(self) -> bool:
598
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
599
+
600
+ :return: Success of keyframe insertion.
601
+ :rtype: bool
602
+ """
396
603
  ...
397
604
 
398
605
  def keys(self):
399
- """ """
606
+ """Returns the keys of this objects custom properties (matches Python's
607
+ dictionary function of the same name).
608
+
609
+ :return: custom property keys.
610
+ """
400
611
  ...
401
612
 
402
- def path_from_id(self):
403
- """ """
613
+ def path_from_id(self) -> str:
614
+ """Returns the data path from the ID to this object (string).
615
+
616
+ :return: The path from `bpy.types.bpy_struct.id_data`
617
+ to this struct and property (when given).
618
+ :rtype: str
619
+ """
404
620
  ...
405
621
 
406
622
  def path_menu(
407
623
  self,
408
- searchpaths,
409
- operator,
410
- props_default,
411
- prop_filepath,
412
- filter_ext,
413
- filter_path,
414
- display_name,
415
- add_operator,
416
- add_operator_props,
624
+ searchpaths: list[str],
625
+ operator: str,
626
+ props_default: dict = None,
627
+ prop_filepath: str = "filepath",
628
+ filter_ext: typing.Callable = None,
629
+ filter_path=None,
630
+ display_name: typing.Callable = None,
631
+ add_operator=None,
632
+ add_operator_props=None,
417
633
  ):
418
- """
634
+ """Populate a menu from a list of paths.
419
635
 
420
- :param searchpaths:
421
- :param operator:
422
- :param props_default:
423
- :param prop_filepath:
424
- :param filter_ext:
425
- :param filter_path:
426
- :param display_name:
427
- :param add_operator:
428
- :param add_operator_props:
636
+ :param searchpaths: Paths to scan.
637
+ :type searchpaths: list[str]
638
+ :param operator: The operator id to use with each file.
639
+ :type operator: str
640
+ :param props_default: Properties to assign to each operator.
641
+ :type props_default: dict
642
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
643
+ :type prop_filepath: str
644
+ :param filter_ext: Optional callback that takes the file extensions.
645
+
646
+ Returning false excludes the file from the list.
647
+ :type filter_ext: typing.Callable
648
+ :param filter_path:
649
+ :param display_name: Optional callback that takes the full path, returns the name to display.
650
+ :type display_name: typing.Callable
651
+ :param add_operator:
652
+ :param add_operator_props:
429
653
  """
430
654
  ...
431
655
 
432
656
  def path_resolve(self):
433
- """ """
657
+ """Returns the property from the path, raise an exception when not found."""
434
658
  ...
435
659
 
436
660
  def pop(self):
437
- """ """
661
+ """Remove and return the value of the custom property assigned to key or default
662
+ when not found (matches Python's dictionary function of the same name).
663
+
664
+ """
438
665
  ...
439
666
 
440
667
  def prepend(self, draw_func):
441
- """
668
+ """Prepend a draw function to this menu, takes the same arguments as
669
+ the menus draw function
442
670
 
443
- :param draw_func:
671
+ :param draw_func:
444
672
  """
445
673
  ...
446
674
 
447
- def property_overridable_library_set(self):
448
- """ """
675
+ def property_overridable_library_set(self) -> bool:
676
+ """Define a property as overridable or not (only for custom properties!).
677
+
678
+ :return: True when the overridable status of the property was successfully set.
679
+ :rtype: bool
680
+ """
449
681
  ...
450
682
 
451
683
  def property_unset(self):
452
- """ """
684
+ """Unset a property, will use default value afterward."""
453
685
  ...
454
686
 
455
687
  def remove(self, draw_func):
456
- """
688
+ """Remove a draw function that has been added to this menu
457
689
 
458
690
  :param draw_func:
459
691
  """
460
692
  ...
461
693
 
462
694
  def type_recast(self):
463
- """ """
695
+ """Return a new instance, this is needed because types
696
+ such as textures can be changed at runtime.
697
+
698
+ :return: a new instance of this object with the type initialized again.
699
+ """
464
700
  ...
465
701
 
466
702
  def values(self):
467
- """ """
703
+ """Returns the values of this objects custom properties (matches Python's
704
+ dictionary function of the same name).
705
+
706
+ :return: custom property values.
707
+ """
468
708
  ...
469
709
 
470
710
  class TEXT_MT_edit(bpy_types.Menu, bpy_types._GenericUI):
471
- """ """
472
-
473
711
  bl_label: typing.Any
474
- """ """
475
-
476
712
  bl_rna: typing.Any
477
- """ """
478
-
479
713
  id_data: typing.Any
480
- """ """
481
714
 
482
715
  def append(self, draw_func):
483
- """
716
+ """Append a draw function to this menu,
717
+ takes the same arguments as the menus draw function
484
718
 
485
- :param draw_func:
719
+ :param draw_func:
486
720
  """
487
721
  ...
488
722
 
489
- def as_pointer(self):
490
- """ """
723
+ def as_pointer(self) -> int:
724
+ """Returns the memory address which holds a pointer to Blender's internal data
725
+
726
+ :return: int (memory address).
727
+ :rtype: int
728
+ """
491
729
  ...
492
730
 
493
- def bl_rna_get_subclass(self):
494
- """ """
731
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
732
+ """
733
+
734
+ :return: The RNA type or default when not found.
735
+ :rtype: bpy.types.Struct
736
+ """
495
737
  ...
496
738
 
497
- def bl_rna_get_subclass_py(self):
498
- """ """
739
+ def bl_rna_get_subclass_py(self) -> typing.Any:
740
+ """
741
+
742
+ :return: The class or default when not found.
743
+ :rtype: typing.Any
744
+ """
499
745
  ...
500
746
 
501
747
  def draw(self, _context):
@@ -514,104 +760,171 @@ class TEXT_MT_edit(bpy_types.Menu, bpy_types._GenericUI):
514
760
  ...
515
761
 
516
762
  def draw_preset(self, _context):
517
- """
763
+ """Define these on the subclass:
764
+ - preset_operator (string)
765
+ - preset_subdir (string)Optionally:
766
+ - preset_add_operator (string)
767
+ - preset_extensions (set of strings)
768
+ - preset_operator_defaults (dict of keyword args)
518
769
 
519
- :param _context:
770
+ :param _context:
520
771
  """
521
772
  ...
522
773
 
523
- def driver_add(self):
524
- """ """
774
+ def driver_add(self) -> bpy.types.FCurve:
775
+ """Adds driver(s) to the given property
776
+
777
+ :return: The driver(s) added.
778
+ :rtype: bpy.types.FCurve
779
+ """
525
780
  ...
526
781
 
527
- def driver_remove(self):
528
- """ """
782
+ def driver_remove(self) -> bool:
783
+ """Remove driver(s) from the given property
784
+
785
+ :return: Success of driver removal.
786
+ :rtype: bool
787
+ """
529
788
  ...
530
789
 
531
790
  def get(self):
532
- """ """
791
+ """Returns the value of the custom property assigned to key or default
792
+ when not found (matches Python's dictionary function of the same name).
793
+
794
+ """
533
795
  ...
534
796
 
535
797
  def id_properties_clear(self):
536
- """ """
798
+ """
799
+
800
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
801
+ """
537
802
  ...
538
803
 
539
804
  def id_properties_ensure(self):
540
- """ """
805
+ """
806
+
807
+ :return: the parent group for an RNA struct's custom IDProperties.
808
+ """
541
809
  ...
542
810
 
543
811
  def id_properties_ui(self):
544
- """ """
545
- ...
812
+ """
546
813
 
547
- def is_extended(self):
548
- """ """
814
+ :return: Return an object used to manage an IDProperty's UI data.
815
+ """
549
816
  ...
550
817
 
551
- def is_property_hidden(self):
552
- """ """
818
+ def is_extended(self): ...
819
+ def is_property_hidden(self) -> bool:
820
+ """Check if a property is hidden.
821
+
822
+ :return: True when the property is hidden.
823
+ :rtype: bool
824
+ """
553
825
  ...
554
826
 
555
- def is_property_overridable_library(self):
556
- """ """
827
+ def is_property_overridable_library(self) -> bool:
828
+ """Check if a property is overridable.
829
+
830
+ :return: True when the property is overridable.
831
+ :rtype: bool
832
+ """
557
833
  ...
558
834
 
559
- def is_property_readonly(self):
560
- """ """
835
+ def is_property_readonly(self) -> bool:
836
+ """Check if a property is readonly.
837
+
838
+ :return: True when the property is readonly (not writable).
839
+ :rtype: bool
840
+ """
561
841
  ...
562
842
 
563
- def is_property_set(self):
564
- """ """
843
+ def is_property_set(self) -> bool:
844
+ """Check if a property is set, use for testing operator properties.
845
+
846
+ :return: True when the property has been set.
847
+ :rtype: bool
848
+ """
565
849
  ...
566
850
 
567
851
  def items(self):
568
- """ """
852
+ """Returns the items of this objects custom properties (matches Python's
853
+ dictionary function of the same name).
854
+
855
+ :return: custom property key, value pairs.
856
+ """
569
857
  ...
570
858
 
571
- def keyframe_delete(self):
572
- """ """
859
+ def keyframe_delete(self) -> bool:
860
+ """Remove a keyframe from this properties fcurve.
861
+
862
+ :return: Success of keyframe deletion.
863
+ :rtype: bool
864
+ """
573
865
  ...
574
866
 
575
- def keyframe_insert(self):
576
- """ """
867
+ def keyframe_insert(self) -> bool:
868
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
869
+
870
+ :return: Success of keyframe insertion.
871
+ :rtype: bool
872
+ """
577
873
  ...
578
874
 
579
875
  def keys(self):
580
- """ """
876
+ """Returns the keys of this objects custom properties (matches Python's
877
+ dictionary function of the same name).
878
+
879
+ :return: custom property keys.
880
+ """
581
881
  ...
582
882
 
583
- def path_from_id(self):
584
- """ """
883
+ def path_from_id(self) -> str:
884
+ """Returns the data path from the ID to this object (string).
885
+
886
+ :return: The path from `bpy.types.bpy_struct.id_data`
887
+ to this struct and property (when given).
888
+ :rtype: str
889
+ """
585
890
  ...
586
891
 
587
892
  def path_menu(
588
893
  self,
589
- searchpaths,
590
- operator,
591
- props_default,
592
- prop_filepath,
593
- filter_ext,
594
- filter_path,
595
- display_name,
596
- add_operator,
597
- add_operator_props,
894
+ searchpaths: list[str],
895
+ operator: str,
896
+ props_default: dict = None,
897
+ prop_filepath: str = "filepath",
898
+ filter_ext: typing.Callable = None,
899
+ filter_path=None,
900
+ display_name: typing.Callable = None,
901
+ add_operator=None,
902
+ add_operator_props=None,
598
903
  ):
599
- """
904
+ """Populate a menu from a list of paths.
905
+
906
+ :param searchpaths: Paths to scan.
907
+ :type searchpaths: list[str]
908
+ :param operator: The operator id to use with each file.
909
+ :type operator: str
910
+ :param props_default: Properties to assign to each operator.
911
+ :type props_default: dict
912
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
913
+ :type prop_filepath: str
914
+ :param filter_ext: Optional callback that takes the file extensions.
600
915
 
601
- :param searchpaths:
602
- :param operator:
603
- :param props_default:
604
- :param prop_filepath:
605
- :param filter_ext:
606
- :param filter_path:
607
- :param display_name:
608
- :param add_operator:
609
- :param add_operator_props:
916
+ Returning false excludes the file from the list.
917
+ :type filter_ext: typing.Callable
918
+ :param filter_path:
919
+ :param display_name: Optional callback that takes the full path, returns the name to display.
920
+ :type display_name: typing.Callable
921
+ :param add_operator:
922
+ :param add_operator_props:
610
923
  """
611
924
  ...
612
925
 
613
926
  def path_resolve(self):
614
- """ """
927
+ """Returns the property from the path, raise an exception when not found."""
615
928
  ...
616
929
 
617
930
  def poll(self, context):
@@ -622,68 +935,90 @@ class TEXT_MT_edit(bpy_types.Menu, bpy_types._GenericUI):
622
935
  ...
623
936
 
624
937
  def pop(self):
625
- """ """
938
+ """Remove and return the value of the custom property assigned to key or default
939
+ when not found (matches Python's dictionary function of the same name).
940
+
941
+ """
626
942
  ...
627
943
 
628
944
  def prepend(self, draw_func):
629
- """
945
+ """Prepend a draw function to this menu, takes the same arguments as
946
+ the menus draw function
630
947
 
631
- :param draw_func:
948
+ :param draw_func:
632
949
  """
633
950
  ...
634
951
 
635
- def property_overridable_library_set(self):
636
- """ """
952
+ def property_overridable_library_set(self) -> bool:
953
+ """Define a property as overridable or not (only for custom properties!).
954
+
955
+ :return: True when the overridable status of the property was successfully set.
956
+ :rtype: bool
957
+ """
637
958
  ...
638
959
 
639
960
  def property_unset(self):
640
- """ """
961
+ """Unset a property, will use default value afterward."""
641
962
  ...
642
963
 
643
964
  def remove(self, draw_func):
644
- """
965
+ """Remove a draw function that has been added to this menu
645
966
 
646
967
  :param draw_func:
647
968
  """
648
969
  ...
649
970
 
650
971
  def type_recast(self):
651
- """ """
972
+ """Return a new instance, this is needed because types
973
+ such as textures can be changed at runtime.
974
+
975
+ :return: a new instance of this object with the type initialized again.
976
+ """
652
977
  ...
653
978
 
654
979
  def values(self):
655
- """ """
980
+ """Returns the values of this objects custom properties (matches Python's
981
+ dictionary function of the same name).
982
+
983
+ :return: custom property values.
984
+ """
656
985
  ...
657
986
 
658
987
  class TEXT_MT_edit_to3d(bpy_types.Menu, bpy_types._GenericUI):
659
- """ """
660
-
661
988
  bl_label: typing.Any
662
- """ """
663
-
664
989
  bl_rna: typing.Any
665
- """ """
666
-
667
990
  id_data: typing.Any
668
- """ """
669
991
 
670
992
  def append(self, draw_func):
671
- """
993
+ """Append a draw function to this menu,
994
+ takes the same arguments as the menus draw function
672
995
 
673
- :param draw_func:
996
+ :param draw_func:
674
997
  """
675
998
  ...
676
999
 
677
- def as_pointer(self):
678
- """ """
1000
+ def as_pointer(self) -> int:
1001
+ """Returns the memory address which holds a pointer to Blender's internal data
1002
+
1003
+ :return: int (memory address).
1004
+ :rtype: int
1005
+ """
679
1006
  ...
680
1007
 
681
- def bl_rna_get_subclass(self):
682
- """ """
1008
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1009
+ """
1010
+
1011
+ :return: The RNA type or default when not found.
1012
+ :rtype: bpy.types.Struct
1013
+ """
683
1014
  ...
684
1015
 
685
- def bl_rna_get_subclass_py(self):
686
- """ """
1016
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1017
+ """
1018
+
1019
+ :return: The class or default when not found.
1020
+ :rtype: typing.Any
1021
+ """
687
1022
  ...
688
1023
 
689
1024
  def draw(self, _context):
@@ -702,172 +1037,259 @@ class TEXT_MT_edit_to3d(bpy_types.Menu, bpy_types._GenericUI):
702
1037
  ...
703
1038
 
704
1039
  def draw_preset(self, _context):
705
- """
1040
+ """Define these on the subclass:
1041
+ - preset_operator (string)
1042
+ - preset_subdir (string)Optionally:
1043
+ - preset_add_operator (string)
1044
+ - preset_extensions (set of strings)
1045
+ - preset_operator_defaults (dict of keyword args)
706
1046
 
707
- :param _context:
1047
+ :param _context:
708
1048
  """
709
1049
  ...
710
1050
 
711
- def driver_add(self):
712
- """ """
1051
+ def driver_add(self) -> bpy.types.FCurve:
1052
+ """Adds driver(s) to the given property
1053
+
1054
+ :return: The driver(s) added.
1055
+ :rtype: bpy.types.FCurve
1056
+ """
713
1057
  ...
714
1058
 
715
- def driver_remove(self):
716
- """ """
1059
+ def driver_remove(self) -> bool:
1060
+ """Remove driver(s) from the given property
1061
+
1062
+ :return: Success of driver removal.
1063
+ :rtype: bool
1064
+ """
717
1065
  ...
718
1066
 
719
1067
  def get(self):
720
- """ """
1068
+ """Returns the value of the custom property assigned to key or default
1069
+ when not found (matches Python's dictionary function of the same name).
1070
+
1071
+ """
721
1072
  ...
722
1073
 
723
1074
  def id_properties_clear(self):
724
- """ """
1075
+ """
1076
+
1077
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1078
+ """
725
1079
  ...
726
1080
 
727
1081
  def id_properties_ensure(self):
728
- """ """
1082
+ """
1083
+
1084
+ :return: the parent group for an RNA struct's custom IDProperties.
1085
+ """
729
1086
  ...
730
1087
 
731
1088
  def id_properties_ui(self):
732
- """ """
733
- ...
1089
+ """
734
1090
 
735
- def is_extended(self):
736
- """ """
1091
+ :return: Return an object used to manage an IDProperty's UI data.
1092
+ """
737
1093
  ...
738
1094
 
739
- def is_property_hidden(self):
740
- """ """
1095
+ def is_extended(self): ...
1096
+ def is_property_hidden(self) -> bool:
1097
+ """Check if a property is hidden.
1098
+
1099
+ :return: True when the property is hidden.
1100
+ :rtype: bool
1101
+ """
741
1102
  ...
742
1103
 
743
- def is_property_overridable_library(self):
744
- """ """
1104
+ def is_property_overridable_library(self) -> bool:
1105
+ """Check if a property is overridable.
1106
+
1107
+ :return: True when the property is overridable.
1108
+ :rtype: bool
1109
+ """
745
1110
  ...
746
1111
 
747
- def is_property_readonly(self):
748
- """ """
1112
+ def is_property_readonly(self) -> bool:
1113
+ """Check if a property is readonly.
1114
+
1115
+ :return: True when the property is readonly (not writable).
1116
+ :rtype: bool
1117
+ """
749
1118
  ...
750
1119
 
751
- def is_property_set(self):
752
- """ """
1120
+ def is_property_set(self) -> bool:
1121
+ """Check if a property is set, use for testing operator properties.
1122
+
1123
+ :return: True when the property has been set.
1124
+ :rtype: bool
1125
+ """
753
1126
  ...
754
1127
 
755
1128
  def items(self):
756
- """ """
1129
+ """Returns the items of this objects custom properties (matches Python's
1130
+ dictionary function of the same name).
1131
+
1132
+ :return: custom property key, value pairs.
1133
+ """
757
1134
  ...
758
1135
 
759
- def keyframe_delete(self):
760
- """ """
1136
+ def keyframe_delete(self) -> bool:
1137
+ """Remove a keyframe from this properties fcurve.
1138
+
1139
+ :return: Success of keyframe deletion.
1140
+ :rtype: bool
1141
+ """
761
1142
  ...
762
1143
 
763
- def keyframe_insert(self):
764
- """ """
1144
+ def keyframe_insert(self) -> bool:
1145
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1146
+
1147
+ :return: Success of keyframe insertion.
1148
+ :rtype: bool
1149
+ """
765
1150
  ...
766
1151
 
767
1152
  def keys(self):
768
- """ """
1153
+ """Returns the keys of this objects custom properties (matches Python's
1154
+ dictionary function of the same name).
1155
+
1156
+ :return: custom property keys.
1157
+ """
769
1158
  ...
770
1159
 
771
- def path_from_id(self):
772
- """ """
1160
+ def path_from_id(self) -> str:
1161
+ """Returns the data path from the ID to this object (string).
1162
+
1163
+ :return: The path from `bpy.types.bpy_struct.id_data`
1164
+ to this struct and property (when given).
1165
+ :rtype: str
1166
+ """
773
1167
  ...
774
1168
 
775
1169
  def path_menu(
776
1170
  self,
777
- searchpaths,
778
- operator,
779
- props_default,
780
- prop_filepath,
781
- filter_ext,
782
- filter_path,
783
- display_name,
784
- add_operator,
785
- add_operator_props,
1171
+ searchpaths: list[str],
1172
+ operator: str,
1173
+ props_default: dict = None,
1174
+ prop_filepath: str = "filepath",
1175
+ filter_ext: typing.Callable = None,
1176
+ filter_path=None,
1177
+ display_name: typing.Callable = None,
1178
+ add_operator=None,
1179
+ add_operator_props=None,
786
1180
  ):
787
- """
1181
+ """Populate a menu from a list of paths.
788
1182
 
789
- :param searchpaths:
790
- :param operator:
791
- :param props_default:
792
- :param prop_filepath:
793
- :param filter_ext:
794
- :param filter_path:
795
- :param display_name:
796
- :param add_operator:
797
- :param add_operator_props:
1183
+ :param searchpaths: Paths to scan.
1184
+ :type searchpaths: list[str]
1185
+ :param operator: The operator id to use with each file.
1186
+ :type operator: str
1187
+ :param props_default: Properties to assign to each operator.
1188
+ :type props_default: dict
1189
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1190
+ :type prop_filepath: str
1191
+ :param filter_ext: Optional callback that takes the file extensions.
1192
+
1193
+ Returning false excludes the file from the list.
1194
+ :type filter_ext: typing.Callable
1195
+ :param filter_path:
1196
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1197
+ :type display_name: typing.Callable
1198
+ :param add_operator:
1199
+ :param add_operator_props:
798
1200
  """
799
1201
  ...
800
1202
 
801
1203
  def path_resolve(self):
802
- """ """
1204
+ """Returns the property from the path, raise an exception when not found."""
803
1205
  ...
804
1206
 
805
1207
  def pop(self):
806
- """ """
1208
+ """Remove and return the value of the custom property assigned to key or default
1209
+ when not found (matches Python's dictionary function of the same name).
1210
+
1211
+ """
807
1212
  ...
808
1213
 
809
1214
  def prepend(self, draw_func):
810
- """
1215
+ """Prepend a draw function to this menu, takes the same arguments as
1216
+ the menus draw function
811
1217
 
812
- :param draw_func:
1218
+ :param draw_func:
813
1219
  """
814
1220
  ...
815
1221
 
816
- def property_overridable_library_set(self):
817
- """ """
1222
+ def property_overridable_library_set(self) -> bool:
1223
+ """Define a property as overridable or not (only for custom properties!).
1224
+
1225
+ :return: True when the overridable status of the property was successfully set.
1226
+ :rtype: bool
1227
+ """
818
1228
  ...
819
1229
 
820
1230
  def property_unset(self):
821
- """ """
1231
+ """Unset a property, will use default value afterward."""
822
1232
  ...
823
1233
 
824
1234
  def remove(self, draw_func):
825
- """
1235
+ """Remove a draw function that has been added to this menu
826
1236
 
827
1237
  :param draw_func:
828
1238
  """
829
1239
  ...
830
1240
 
831
1241
  def type_recast(self):
832
- """ """
1242
+ """Return a new instance, this is needed because types
1243
+ such as textures can be changed at runtime.
1244
+
1245
+ :return: a new instance of this object with the type initialized again.
1246
+ """
833
1247
  ...
834
1248
 
835
1249
  def values(self):
836
- """ """
1250
+ """Returns the values of this objects custom properties (matches Python's
1251
+ dictionary function of the same name).
1252
+
1253
+ :return: custom property values.
1254
+ """
837
1255
  ...
838
1256
 
839
1257
  class TEXT_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
840
- """ """
841
-
842
1258
  bl_idname: typing.Any
843
- """ """
844
-
845
1259
  bl_label: typing.Any
846
- """ """
847
-
848
1260
  bl_rna: typing.Any
849
- """ """
850
-
851
1261
  id_data: typing.Any
852
- """ """
853
1262
 
854
1263
  def append(self, draw_func):
855
- """
1264
+ """Append a draw function to this menu,
1265
+ takes the same arguments as the menus draw function
856
1266
 
857
- :param draw_func:
1267
+ :param draw_func:
858
1268
  """
859
1269
  ...
860
1270
 
861
- def as_pointer(self):
862
- """ """
1271
+ def as_pointer(self) -> int:
1272
+ """Returns the memory address which holds a pointer to Blender's internal data
1273
+
1274
+ :return: int (memory address).
1275
+ :rtype: int
1276
+ """
863
1277
  ...
864
1278
 
865
- def bl_rna_get_subclass(self):
866
- """ """
1279
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1280
+ """
1281
+
1282
+ :return: The RNA type or default when not found.
1283
+ :rtype: bpy.types.Struct
1284
+ """
867
1285
  ...
868
1286
 
869
- def bl_rna_get_subclass_py(self):
870
- """ """
1287
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1288
+ """
1289
+
1290
+ :return: The class or default when not found.
1291
+ :rtype: typing.Any
1292
+ """
871
1293
  ...
872
1294
 
873
1295
  def draw(self, context):
@@ -886,169 +1308,258 @@ class TEXT_MT_editor_menus(bpy_types.Menu, bpy_types._GenericUI):
886
1308
  ...
887
1309
 
888
1310
  def draw_preset(self, _context):
889
- """
1311
+ """Define these on the subclass:
1312
+ - preset_operator (string)
1313
+ - preset_subdir (string)Optionally:
1314
+ - preset_add_operator (string)
1315
+ - preset_extensions (set of strings)
1316
+ - preset_operator_defaults (dict of keyword args)
890
1317
 
891
- :param _context:
1318
+ :param _context:
892
1319
  """
893
1320
  ...
894
1321
 
895
- def driver_add(self):
896
- """ """
1322
+ def driver_add(self) -> bpy.types.FCurve:
1323
+ """Adds driver(s) to the given property
1324
+
1325
+ :return: The driver(s) added.
1326
+ :rtype: bpy.types.FCurve
1327
+ """
897
1328
  ...
898
1329
 
899
- def driver_remove(self):
900
- """ """
1330
+ def driver_remove(self) -> bool:
1331
+ """Remove driver(s) from the given property
1332
+
1333
+ :return: Success of driver removal.
1334
+ :rtype: bool
1335
+ """
901
1336
  ...
902
1337
 
903
1338
  def get(self):
904
- """ """
1339
+ """Returns the value of the custom property assigned to key or default
1340
+ when not found (matches Python's dictionary function of the same name).
1341
+
1342
+ """
905
1343
  ...
906
1344
 
907
1345
  def id_properties_clear(self):
908
- """ """
1346
+ """
1347
+
1348
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1349
+ """
909
1350
  ...
910
1351
 
911
1352
  def id_properties_ensure(self):
912
- """ """
1353
+ """
1354
+
1355
+ :return: the parent group for an RNA struct's custom IDProperties.
1356
+ """
913
1357
  ...
914
1358
 
915
1359
  def id_properties_ui(self):
916
- """ """
917
- ...
1360
+ """
918
1361
 
919
- def is_extended(self):
920
- """ """
1362
+ :return: Return an object used to manage an IDProperty's UI data.
1363
+ """
921
1364
  ...
922
1365
 
923
- def is_property_hidden(self):
924
- """ """
1366
+ def is_extended(self): ...
1367
+ def is_property_hidden(self) -> bool:
1368
+ """Check if a property is hidden.
1369
+
1370
+ :return: True when the property is hidden.
1371
+ :rtype: bool
1372
+ """
925
1373
  ...
926
1374
 
927
- def is_property_overridable_library(self):
928
- """ """
1375
+ def is_property_overridable_library(self) -> bool:
1376
+ """Check if a property is overridable.
1377
+
1378
+ :return: True when the property is overridable.
1379
+ :rtype: bool
1380
+ """
929
1381
  ...
930
1382
 
931
- def is_property_readonly(self):
932
- """ """
1383
+ def is_property_readonly(self) -> bool:
1384
+ """Check if a property is readonly.
1385
+
1386
+ :return: True when the property is readonly (not writable).
1387
+ :rtype: bool
1388
+ """
933
1389
  ...
934
1390
 
935
- def is_property_set(self):
936
- """ """
1391
+ def is_property_set(self) -> bool:
1392
+ """Check if a property is set, use for testing operator properties.
1393
+
1394
+ :return: True when the property has been set.
1395
+ :rtype: bool
1396
+ """
937
1397
  ...
938
1398
 
939
1399
  def items(self):
940
- """ """
1400
+ """Returns the items of this objects custom properties (matches Python's
1401
+ dictionary function of the same name).
1402
+
1403
+ :return: custom property key, value pairs.
1404
+ """
941
1405
  ...
942
1406
 
943
- def keyframe_delete(self):
944
- """ """
1407
+ def keyframe_delete(self) -> bool:
1408
+ """Remove a keyframe from this properties fcurve.
1409
+
1410
+ :return: Success of keyframe deletion.
1411
+ :rtype: bool
1412
+ """
945
1413
  ...
946
1414
 
947
- def keyframe_insert(self):
948
- """ """
1415
+ def keyframe_insert(self) -> bool:
1416
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1417
+
1418
+ :return: Success of keyframe insertion.
1419
+ :rtype: bool
1420
+ """
949
1421
  ...
950
1422
 
951
1423
  def keys(self):
952
- """ """
1424
+ """Returns the keys of this objects custom properties (matches Python's
1425
+ dictionary function of the same name).
1426
+
1427
+ :return: custom property keys.
1428
+ """
953
1429
  ...
954
1430
 
955
- def path_from_id(self):
956
- """ """
1431
+ def path_from_id(self) -> str:
1432
+ """Returns the data path from the ID to this object (string).
1433
+
1434
+ :return: The path from `bpy.types.bpy_struct.id_data`
1435
+ to this struct and property (when given).
1436
+ :rtype: str
1437
+ """
957
1438
  ...
958
1439
 
959
1440
  def path_menu(
960
1441
  self,
961
- searchpaths,
962
- operator,
963
- props_default,
964
- prop_filepath,
965
- filter_ext,
966
- filter_path,
967
- display_name,
968
- add_operator,
969
- add_operator_props,
1442
+ searchpaths: list[str],
1443
+ operator: str,
1444
+ props_default: dict = None,
1445
+ prop_filepath: str = "filepath",
1446
+ filter_ext: typing.Callable = None,
1447
+ filter_path=None,
1448
+ display_name: typing.Callable = None,
1449
+ add_operator=None,
1450
+ add_operator_props=None,
970
1451
  ):
971
- """
1452
+ """Populate a menu from a list of paths.
972
1453
 
973
- :param searchpaths:
974
- :param operator:
975
- :param props_default:
976
- :param prop_filepath:
977
- :param filter_ext:
978
- :param filter_path:
979
- :param display_name:
980
- :param add_operator:
981
- :param add_operator_props:
1454
+ :param searchpaths: Paths to scan.
1455
+ :type searchpaths: list[str]
1456
+ :param operator: The operator id to use with each file.
1457
+ :type operator: str
1458
+ :param props_default: Properties to assign to each operator.
1459
+ :type props_default: dict
1460
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1461
+ :type prop_filepath: str
1462
+ :param filter_ext: Optional callback that takes the file extensions.
1463
+
1464
+ Returning false excludes the file from the list.
1465
+ :type filter_ext: typing.Callable
1466
+ :param filter_path:
1467
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1468
+ :type display_name: typing.Callable
1469
+ :param add_operator:
1470
+ :param add_operator_props:
982
1471
  """
983
1472
  ...
984
1473
 
985
1474
  def path_resolve(self):
986
- """ """
1475
+ """Returns the property from the path, raise an exception when not found."""
987
1476
  ...
988
1477
 
989
1478
  def pop(self):
990
- """ """
1479
+ """Remove and return the value of the custom property assigned to key or default
1480
+ when not found (matches Python's dictionary function of the same name).
1481
+
1482
+ """
991
1483
  ...
992
1484
 
993
1485
  def prepend(self, draw_func):
994
- """
1486
+ """Prepend a draw function to this menu, takes the same arguments as
1487
+ the menus draw function
995
1488
 
996
- :param draw_func:
1489
+ :param draw_func:
997
1490
  """
998
1491
  ...
999
1492
 
1000
- def property_overridable_library_set(self):
1001
- """ """
1493
+ def property_overridable_library_set(self) -> bool:
1494
+ """Define a property as overridable or not (only for custom properties!).
1495
+
1496
+ :return: True when the overridable status of the property was successfully set.
1497
+ :rtype: bool
1498
+ """
1002
1499
  ...
1003
1500
 
1004
1501
  def property_unset(self):
1005
- """ """
1502
+ """Unset a property, will use default value afterward."""
1006
1503
  ...
1007
1504
 
1008
1505
  def remove(self, draw_func):
1009
- """
1506
+ """Remove a draw function that has been added to this menu
1010
1507
 
1011
1508
  :param draw_func:
1012
1509
  """
1013
1510
  ...
1014
1511
 
1015
1512
  def type_recast(self):
1016
- """ """
1513
+ """Return a new instance, this is needed because types
1514
+ such as textures can be changed at runtime.
1515
+
1516
+ :return: a new instance of this object with the type initialized again.
1517
+ """
1017
1518
  ...
1018
1519
 
1019
1520
  def values(self):
1020
- """ """
1521
+ """Returns the values of this objects custom properties (matches Python's
1522
+ dictionary function of the same name).
1523
+
1524
+ :return: custom property values.
1525
+ """
1021
1526
  ...
1022
1527
 
1023
1528
  class TEXT_MT_format(bpy_types.Menu, bpy_types._GenericUI):
1024
- """ """
1025
-
1026
1529
  bl_label: typing.Any
1027
- """ """
1028
-
1029
1530
  bl_rna: typing.Any
1030
- """ """
1031
-
1032
1531
  id_data: typing.Any
1033
- """ """
1034
1532
 
1035
1533
  def append(self, draw_func):
1036
- """
1534
+ """Append a draw function to this menu,
1535
+ takes the same arguments as the menus draw function
1037
1536
 
1038
- :param draw_func:
1537
+ :param draw_func:
1039
1538
  """
1040
1539
  ...
1041
1540
 
1042
- def as_pointer(self):
1043
- """ """
1541
+ def as_pointer(self) -> int:
1542
+ """Returns the memory address which holds a pointer to Blender's internal data
1543
+
1544
+ :return: int (memory address).
1545
+ :rtype: int
1546
+ """
1044
1547
  ...
1045
1548
 
1046
- def bl_rna_get_subclass(self):
1047
- """ """
1549
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1550
+ """
1551
+
1552
+ :return: The RNA type or default when not found.
1553
+ :rtype: bpy.types.Struct
1554
+ """
1048
1555
  ...
1049
1556
 
1050
- def bl_rna_get_subclass_py(self):
1051
- """ """
1557
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1558
+ """
1559
+
1560
+ :return: The class or default when not found.
1561
+ :rtype: typing.Any
1562
+ """
1052
1563
  ...
1053
1564
 
1054
1565
  def draw(self, _context):
@@ -1067,169 +1578,258 @@ class TEXT_MT_format(bpy_types.Menu, bpy_types._GenericUI):
1067
1578
  ...
1068
1579
 
1069
1580
  def draw_preset(self, _context):
1070
- """
1581
+ """Define these on the subclass:
1582
+ - preset_operator (string)
1583
+ - preset_subdir (string)Optionally:
1584
+ - preset_add_operator (string)
1585
+ - preset_extensions (set of strings)
1586
+ - preset_operator_defaults (dict of keyword args)
1071
1587
 
1072
- :param _context:
1588
+ :param _context:
1073
1589
  """
1074
1590
  ...
1075
1591
 
1076
- def driver_add(self):
1077
- """ """
1592
+ def driver_add(self) -> bpy.types.FCurve:
1593
+ """Adds driver(s) to the given property
1594
+
1595
+ :return: The driver(s) added.
1596
+ :rtype: bpy.types.FCurve
1597
+ """
1078
1598
  ...
1079
1599
 
1080
- def driver_remove(self):
1081
- """ """
1600
+ def driver_remove(self) -> bool:
1601
+ """Remove driver(s) from the given property
1602
+
1603
+ :return: Success of driver removal.
1604
+ :rtype: bool
1605
+ """
1082
1606
  ...
1083
1607
 
1084
1608
  def get(self):
1085
- """ """
1609
+ """Returns the value of the custom property assigned to key or default
1610
+ when not found (matches Python's dictionary function of the same name).
1611
+
1612
+ """
1086
1613
  ...
1087
1614
 
1088
1615
  def id_properties_clear(self):
1089
- """ """
1616
+ """
1617
+
1618
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1619
+ """
1090
1620
  ...
1091
1621
 
1092
1622
  def id_properties_ensure(self):
1093
- """ """
1623
+ """
1624
+
1625
+ :return: the parent group for an RNA struct's custom IDProperties.
1626
+ """
1094
1627
  ...
1095
1628
 
1096
1629
  def id_properties_ui(self):
1097
- """ """
1098
- ...
1630
+ """
1099
1631
 
1100
- def is_extended(self):
1101
- """ """
1632
+ :return: Return an object used to manage an IDProperty's UI data.
1633
+ """
1102
1634
  ...
1103
1635
 
1104
- def is_property_hidden(self):
1105
- """ """
1636
+ def is_extended(self): ...
1637
+ def is_property_hidden(self) -> bool:
1638
+ """Check if a property is hidden.
1639
+
1640
+ :return: True when the property is hidden.
1641
+ :rtype: bool
1642
+ """
1106
1643
  ...
1107
1644
 
1108
- def is_property_overridable_library(self):
1109
- """ """
1645
+ def is_property_overridable_library(self) -> bool:
1646
+ """Check if a property is overridable.
1647
+
1648
+ :return: True when the property is overridable.
1649
+ :rtype: bool
1650
+ """
1110
1651
  ...
1111
1652
 
1112
- def is_property_readonly(self):
1113
- """ """
1653
+ def is_property_readonly(self) -> bool:
1654
+ """Check if a property is readonly.
1655
+
1656
+ :return: True when the property is readonly (not writable).
1657
+ :rtype: bool
1658
+ """
1114
1659
  ...
1115
1660
 
1116
- def is_property_set(self):
1117
- """ """
1661
+ def is_property_set(self) -> bool:
1662
+ """Check if a property is set, use for testing operator properties.
1663
+
1664
+ :return: True when the property has been set.
1665
+ :rtype: bool
1666
+ """
1118
1667
  ...
1119
1668
 
1120
1669
  def items(self):
1121
- """ """
1670
+ """Returns the items of this objects custom properties (matches Python's
1671
+ dictionary function of the same name).
1672
+
1673
+ :return: custom property key, value pairs.
1674
+ """
1122
1675
  ...
1123
1676
 
1124
- def keyframe_delete(self):
1125
- """ """
1677
+ def keyframe_delete(self) -> bool:
1678
+ """Remove a keyframe from this properties fcurve.
1679
+
1680
+ :return: Success of keyframe deletion.
1681
+ :rtype: bool
1682
+ """
1126
1683
  ...
1127
1684
 
1128
- def keyframe_insert(self):
1129
- """ """
1685
+ def keyframe_insert(self) -> bool:
1686
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1687
+
1688
+ :return: Success of keyframe insertion.
1689
+ :rtype: bool
1690
+ """
1130
1691
  ...
1131
1692
 
1132
1693
  def keys(self):
1133
- """ """
1694
+ """Returns the keys of this objects custom properties (matches Python's
1695
+ dictionary function of the same name).
1696
+
1697
+ :return: custom property keys.
1698
+ """
1134
1699
  ...
1135
1700
 
1136
- def path_from_id(self):
1137
- """ """
1701
+ def path_from_id(self) -> str:
1702
+ """Returns the data path from the ID to this object (string).
1703
+
1704
+ :return: The path from `bpy.types.bpy_struct.id_data`
1705
+ to this struct and property (when given).
1706
+ :rtype: str
1707
+ """
1138
1708
  ...
1139
1709
 
1140
1710
  def path_menu(
1141
1711
  self,
1142
- searchpaths,
1143
- operator,
1144
- props_default,
1145
- prop_filepath,
1146
- filter_ext,
1147
- filter_path,
1148
- display_name,
1149
- add_operator,
1150
- add_operator_props,
1712
+ searchpaths: list[str],
1713
+ operator: str,
1714
+ props_default: dict = None,
1715
+ prop_filepath: str = "filepath",
1716
+ filter_ext: typing.Callable = None,
1717
+ filter_path=None,
1718
+ display_name: typing.Callable = None,
1719
+ add_operator=None,
1720
+ add_operator_props=None,
1151
1721
  ):
1152
- """
1722
+ """Populate a menu from a list of paths.
1723
+
1724
+ :param searchpaths: Paths to scan.
1725
+ :type searchpaths: list[str]
1726
+ :param operator: The operator id to use with each file.
1727
+ :type operator: str
1728
+ :param props_default: Properties to assign to each operator.
1729
+ :type props_default: dict
1730
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1731
+ :type prop_filepath: str
1732
+ :param filter_ext: Optional callback that takes the file extensions.
1153
1733
 
1154
- :param searchpaths:
1155
- :param operator:
1156
- :param props_default:
1157
- :param prop_filepath:
1158
- :param filter_ext:
1159
- :param filter_path:
1160
- :param display_name:
1161
- :param add_operator:
1162
- :param add_operator_props:
1734
+ Returning false excludes the file from the list.
1735
+ :type filter_ext: typing.Callable
1736
+ :param filter_path:
1737
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1738
+ :type display_name: typing.Callable
1739
+ :param add_operator:
1740
+ :param add_operator_props:
1163
1741
  """
1164
1742
  ...
1165
1743
 
1166
1744
  def path_resolve(self):
1167
- """ """
1745
+ """Returns the property from the path, raise an exception when not found."""
1168
1746
  ...
1169
1747
 
1170
1748
  def pop(self):
1171
- """ """
1749
+ """Remove and return the value of the custom property assigned to key or default
1750
+ when not found (matches Python's dictionary function of the same name).
1751
+
1752
+ """
1172
1753
  ...
1173
1754
 
1174
1755
  def prepend(self, draw_func):
1175
- """
1756
+ """Prepend a draw function to this menu, takes the same arguments as
1757
+ the menus draw function
1176
1758
 
1177
- :param draw_func:
1759
+ :param draw_func:
1178
1760
  """
1179
1761
  ...
1180
1762
 
1181
- def property_overridable_library_set(self):
1182
- """ """
1763
+ def property_overridable_library_set(self) -> bool:
1764
+ """Define a property as overridable or not (only for custom properties!).
1765
+
1766
+ :return: True when the overridable status of the property was successfully set.
1767
+ :rtype: bool
1768
+ """
1183
1769
  ...
1184
1770
 
1185
1771
  def property_unset(self):
1186
- """ """
1772
+ """Unset a property, will use default value afterward."""
1187
1773
  ...
1188
1774
 
1189
1775
  def remove(self, draw_func):
1190
- """
1776
+ """Remove a draw function that has been added to this menu
1191
1777
 
1192
1778
  :param draw_func:
1193
1779
  """
1194
1780
  ...
1195
1781
 
1196
1782
  def type_recast(self):
1197
- """ """
1783
+ """Return a new instance, this is needed because types
1784
+ such as textures can be changed at runtime.
1785
+
1786
+ :return: a new instance of this object with the type initialized again.
1787
+ """
1198
1788
  ...
1199
1789
 
1200
1790
  def values(self):
1201
- """ """
1791
+ """Returns the values of this objects custom properties (matches Python's
1792
+ dictionary function of the same name).
1793
+
1794
+ :return: custom property values.
1795
+ """
1202
1796
  ...
1203
1797
 
1204
1798
  class TEXT_MT_select(bpy_types.Menu, bpy_types._GenericUI):
1205
- """ """
1206
-
1207
1799
  bl_label: typing.Any
1208
- """ """
1209
-
1210
1800
  bl_rna: typing.Any
1211
- """ """
1212
-
1213
1801
  id_data: typing.Any
1214
- """ """
1215
1802
 
1216
1803
  def append(self, draw_func):
1217
- """
1804
+ """Append a draw function to this menu,
1805
+ takes the same arguments as the menus draw function
1218
1806
 
1219
- :param draw_func:
1807
+ :param draw_func:
1220
1808
  """
1221
1809
  ...
1222
1810
 
1223
- def as_pointer(self):
1224
- """ """
1811
+ def as_pointer(self) -> int:
1812
+ """Returns the memory address which holds a pointer to Blender's internal data
1813
+
1814
+ :return: int (memory address).
1815
+ :rtype: int
1816
+ """
1225
1817
  ...
1226
1818
 
1227
- def bl_rna_get_subclass(self):
1228
- """ """
1819
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1820
+ """
1821
+
1822
+ :return: The RNA type or default when not found.
1823
+ :rtype: bpy.types.Struct
1824
+ """
1229
1825
  ...
1230
1826
 
1231
- def bl_rna_get_subclass_py(self):
1232
- """ """
1827
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1828
+ """
1829
+
1830
+ :return: The class or default when not found.
1831
+ :rtype: typing.Any
1832
+ """
1233
1833
  ...
1234
1834
 
1235
1835
  def draw(self, _context):
@@ -1248,169 +1848,258 @@ class TEXT_MT_select(bpy_types.Menu, bpy_types._GenericUI):
1248
1848
  ...
1249
1849
 
1250
1850
  def draw_preset(self, _context):
1251
- """
1851
+ """Define these on the subclass:
1852
+ - preset_operator (string)
1853
+ - preset_subdir (string)Optionally:
1854
+ - preset_add_operator (string)
1855
+ - preset_extensions (set of strings)
1856
+ - preset_operator_defaults (dict of keyword args)
1252
1857
 
1253
- :param _context:
1858
+ :param _context:
1254
1859
  """
1255
1860
  ...
1256
1861
 
1257
- def driver_add(self):
1258
- """ """
1862
+ def driver_add(self) -> bpy.types.FCurve:
1863
+ """Adds driver(s) to the given property
1864
+
1865
+ :return: The driver(s) added.
1866
+ :rtype: bpy.types.FCurve
1867
+ """
1259
1868
  ...
1260
1869
 
1261
- def driver_remove(self):
1262
- """ """
1870
+ def driver_remove(self) -> bool:
1871
+ """Remove driver(s) from the given property
1872
+
1873
+ :return: Success of driver removal.
1874
+ :rtype: bool
1875
+ """
1263
1876
  ...
1264
1877
 
1265
1878
  def get(self):
1266
- """ """
1879
+ """Returns the value of the custom property assigned to key or default
1880
+ when not found (matches Python's dictionary function of the same name).
1881
+
1882
+ """
1267
1883
  ...
1268
1884
 
1269
1885
  def id_properties_clear(self):
1270
- """ """
1886
+ """
1887
+
1888
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1889
+ """
1271
1890
  ...
1272
1891
 
1273
1892
  def id_properties_ensure(self):
1274
- """ """
1893
+ """
1894
+
1895
+ :return: the parent group for an RNA struct's custom IDProperties.
1896
+ """
1275
1897
  ...
1276
1898
 
1277
1899
  def id_properties_ui(self):
1278
- """ """
1279
- ...
1900
+ """
1280
1901
 
1281
- def is_extended(self):
1282
- """ """
1902
+ :return: Return an object used to manage an IDProperty's UI data.
1903
+ """
1283
1904
  ...
1284
1905
 
1285
- def is_property_hidden(self):
1286
- """ """
1906
+ def is_extended(self): ...
1907
+ def is_property_hidden(self) -> bool:
1908
+ """Check if a property is hidden.
1909
+
1910
+ :return: True when the property is hidden.
1911
+ :rtype: bool
1912
+ """
1287
1913
  ...
1288
1914
 
1289
- def is_property_overridable_library(self):
1290
- """ """
1915
+ def is_property_overridable_library(self) -> bool:
1916
+ """Check if a property is overridable.
1917
+
1918
+ :return: True when the property is overridable.
1919
+ :rtype: bool
1920
+ """
1291
1921
  ...
1292
1922
 
1293
- def is_property_readonly(self):
1294
- """ """
1923
+ def is_property_readonly(self) -> bool:
1924
+ """Check if a property is readonly.
1925
+
1926
+ :return: True when the property is readonly (not writable).
1927
+ :rtype: bool
1928
+ """
1295
1929
  ...
1296
1930
 
1297
- def is_property_set(self):
1298
- """ """
1931
+ def is_property_set(self) -> bool:
1932
+ """Check if a property is set, use for testing operator properties.
1933
+
1934
+ :return: True when the property has been set.
1935
+ :rtype: bool
1936
+ """
1299
1937
  ...
1300
1938
 
1301
1939
  def items(self):
1302
- """ """
1940
+ """Returns the items of this objects custom properties (matches Python's
1941
+ dictionary function of the same name).
1942
+
1943
+ :return: custom property key, value pairs.
1944
+ """
1303
1945
  ...
1304
1946
 
1305
- def keyframe_delete(self):
1306
- """ """
1947
+ def keyframe_delete(self) -> bool:
1948
+ """Remove a keyframe from this properties fcurve.
1949
+
1950
+ :return: Success of keyframe deletion.
1951
+ :rtype: bool
1952
+ """
1307
1953
  ...
1308
1954
 
1309
- def keyframe_insert(self):
1310
- """ """
1955
+ def keyframe_insert(self) -> bool:
1956
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1957
+
1958
+ :return: Success of keyframe insertion.
1959
+ :rtype: bool
1960
+ """
1311
1961
  ...
1312
1962
 
1313
1963
  def keys(self):
1314
- """ """
1964
+ """Returns the keys of this objects custom properties (matches Python's
1965
+ dictionary function of the same name).
1966
+
1967
+ :return: custom property keys.
1968
+ """
1315
1969
  ...
1316
1970
 
1317
- def path_from_id(self):
1318
- """ """
1971
+ def path_from_id(self) -> str:
1972
+ """Returns the data path from the ID to this object (string).
1973
+
1974
+ :return: The path from `bpy.types.bpy_struct.id_data`
1975
+ to this struct and property (when given).
1976
+ :rtype: str
1977
+ """
1319
1978
  ...
1320
1979
 
1321
1980
  def path_menu(
1322
1981
  self,
1323
- searchpaths,
1324
- operator,
1325
- props_default,
1326
- prop_filepath,
1327
- filter_ext,
1328
- filter_path,
1329
- display_name,
1330
- add_operator,
1331
- add_operator_props,
1982
+ searchpaths: list[str],
1983
+ operator: str,
1984
+ props_default: dict = None,
1985
+ prop_filepath: str = "filepath",
1986
+ filter_ext: typing.Callable = None,
1987
+ filter_path=None,
1988
+ display_name: typing.Callable = None,
1989
+ add_operator=None,
1990
+ add_operator_props=None,
1332
1991
  ):
1333
- """
1992
+ """Populate a menu from a list of paths.
1334
1993
 
1335
- :param searchpaths:
1336
- :param operator:
1337
- :param props_default:
1338
- :param prop_filepath:
1339
- :param filter_ext:
1340
- :param filter_path:
1341
- :param display_name:
1342
- :param add_operator:
1343
- :param add_operator_props:
1994
+ :param searchpaths: Paths to scan.
1995
+ :type searchpaths: list[str]
1996
+ :param operator: The operator id to use with each file.
1997
+ :type operator: str
1998
+ :param props_default: Properties to assign to each operator.
1999
+ :type props_default: dict
2000
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
2001
+ :type prop_filepath: str
2002
+ :param filter_ext: Optional callback that takes the file extensions.
2003
+
2004
+ Returning false excludes the file from the list.
2005
+ :type filter_ext: typing.Callable
2006
+ :param filter_path:
2007
+ :param display_name: Optional callback that takes the full path, returns the name to display.
2008
+ :type display_name: typing.Callable
2009
+ :param add_operator:
2010
+ :param add_operator_props:
1344
2011
  """
1345
2012
  ...
1346
2013
 
1347
2014
  def path_resolve(self):
1348
- """ """
2015
+ """Returns the property from the path, raise an exception when not found."""
1349
2016
  ...
1350
2017
 
1351
2018
  def pop(self):
1352
- """ """
2019
+ """Remove and return the value of the custom property assigned to key or default
2020
+ when not found (matches Python's dictionary function of the same name).
2021
+
2022
+ """
1353
2023
  ...
1354
2024
 
1355
2025
  def prepend(self, draw_func):
1356
- """
2026
+ """Prepend a draw function to this menu, takes the same arguments as
2027
+ the menus draw function
1357
2028
 
1358
- :param draw_func:
2029
+ :param draw_func:
1359
2030
  """
1360
2031
  ...
1361
2032
 
1362
- def property_overridable_library_set(self):
1363
- """ """
2033
+ def property_overridable_library_set(self) -> bool:
2034
+ """Define a property as overridable or not (only for custom properties!).
2035
+
2036
+ :return: True when the overridable status of the property was successfully set.
2037
+ :rtype: bool
2038
+ """
1364
2039
  ...
1365
2040
 
1366
2041
  def property_unset(self):
1367
- """ """
2042
+ """Unset a property, will use default value afterward."""
1368
2043
  ...
1369
2044
 
1370
2045
  def remove(self, draw_func):
1371
- """
2046
+ """Remove a draw function that has been added to this menu
1372
2047
 
1373
2048
  :param draw_func:
1374
2049
  """
1375
2050
  ...
1376
2051
 
1377
2052
  def type_recast(self):
1378
- """ """
2053
+ """Return a new instance, this is needed because types
2054
+ such as textures can be changed at runtime.
2055
+
2056
+ :return: a new instance of this object with the type initialized again.
2057
+ """
1379
2058
  ...
1380
2059
 
1381
2060
  def values(self):
1382
- """ """
2061
+ """Returns the values of this objects custom properties (matches Python's
2062
+ dictionary function of the same name).
2063
+
2064
+ :return: custom property values.
2065
+ """
1383
2066
  ...
1384
2067
 
1385
2068
  class TEXT_MT_templates(bpy_types.Menu, bpy_types._GenericUI):
1386
- """ """
1387
-
1388
2069
  bl_label: typing.Any
1389
- """ """
1390
-
1391
2070
  bl_rna: typing.Any
1392
- """ """
1393
-
1394
2071
  id_data: typing.Any
1395
- """ """
1396
2072
 
1397
2073
  def append(self, draw_func):
1398
- """
2074
+ """Append a draw function to this menu,
2075
+ takes the same arguments as the menus draw function
1399
2076
 
1400
- :param draw_func:
2077
+ :param draw_func:
1401
2078
  """
1402
2079
  ...
1403
2080
 
1404
- def as_pointer(self):
1405
- """ """
2081
+ def as_pointer(self) -> int:
2082
+ """Returns the memory address which holds a pointer to Blender's internal data
2083
+
2084
+ :return: int (memory address).
2085
+ :rtype: int
2086
+ """
1406
2087
  ...
1407
2088
 
1408
- def bl_rna_get_subclass(self):
1409
- """ """
2089
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2090
+ """
2091
+
2092
+ :return: The RNA type or default when not found.
2093
+ :rtype: bpy.types.Struct
2094
+ """
1410
2095
  ...
1411
2096
 
1412
- def bl_rna_get_subclass_py(self):
1413
- """ """
2097
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2098
+ """
2099
+
2100
+ :return: The class or default when not found.
2101
+ :rtype: typing.Any
2102
+ """
1414
2103
  ...
1415
2104
 
1416
2105
  def draw(self, _context):
@@ -1429,169 +2118,258 @@ class TEXT_MT_templates(bpy_types.Menu, bpy_types._GenericUI):
1429
2118
  ...
1430
2119
 
1431
2120
  def draw_preset(self, _context):
1432
- """
2121
+ """Define these on the subclass:
2122
+ - preset_operator (string)
2123
+ - preset_subdir (string)Optionally:
2124
+ - preset_add_operator (string)
2125
+ - preset_extensions (set of strings)
2126
+ - preset_operator_defaults (dict of keyword args)
1433
2127
 
1434
- :param _context:
2128
+ :param _context:
1435
2129
  """
1436
2130
  ...
1437
2131
 
1438
- def driver_add(self):
1439
- """ """
2132
+ def driver_add(self) -> bpy.types.FCurve:
2133
+ """Adds driver(s) to the given property
2134
+
2135
+ :return: The driver(s) added.
2136
+ :rtype: bpy.types.FCurve
2137
+ """
1440
2138
  ...
1441
2139
 
1442
- def driver_remove(self):
1443
- """ """
2140
+ def driver_remove(self) -> bool:
2141
+ """Remove driver(s) from the given property
2142
+
2143
+ :return: Success of driver removal.
2144
+ :rtype: bool
2145
+ """
1444
2146
  ...
1445
2147
 
1446
2148
  def get(self):
1447
- """ """
2149
+ """Returns the value of the custom property assigned to key or default
2150
+ when not found (matches Python's dictionary function of the same name).
2151
+
2152
+ """
1448
2153
  ...
1449
2154
 
1450
2155
  def id_properties_clear(self):
1451
- """ """
2156
+ """
2157
+
2158
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2159
+ """
1452
2160
  ...
1453
2161
 
1454
2162
  def id_properties_ensure(self):
1455
- """ """
2163
+ """
2164
+
2165
+ :return: the parent group for an RNA struct's custom IDProperties.
2166
+ """
1456
2167
  ...
1457
2168
 
1458
2169
  def id_properties_ui(self):
1459
- """ """
1460
- ...
2170
+ """
1461
2171
 
1462
- def is_extended(self):
1463
- """ """
2172
+ :return: Return an object used to manage an IDProperty's UI data.
2173
+ """
1464
2174
  ...
1465
2175
 
1466
- def is_property_hidden(self):
1467
- """ """
2176
+ def is_extended(self): ...
2177
+ def is_property_hidden(self) -> bool:
2178
+ """Check if a property is hidden.
2179
+
2180
+ :return: True when the property is hidden.
2181
+ :rtype: bool
2182
+ """
1468
2183
  ...
1469
2184
 
1470
- def is_property_overridable_library(self):
1471
- """ """
2185
+ def is_property_overridable_library(self) -> bool:
2186
+ """Check if a property is overridable.
2187
+
2188
+ :return: True when the property is overridable.
2189
+ :rtype: bool
2190
+ """
1472
2191
  ...
1473
2192
 
1474
- def is_property_readonly(self):
1475
- """ """
2193
+ def is_property_readonly(self) -> bool:
2194
+ """Check if a property is readonly.
2195
+
2196
+ :return: True when the property is readonly (not writable).
2197
+ :rtype: bool
2198
+ """
1476
2199
  ...
1477
2200
 
1478
- def is_property_set(self):
1479
- """ """
2201
+ def is_property_set(self) -> bool:
2202
+ """Check if a property is set, use for testing operator properties.
2203
+
2204
+ :return: True when the property has been set.
2205
+ :rtype: bool
2206
+ """
1480
2207
  ...
1481
2208
 
1482
2209
  def items(self):
1483
- """ """
2210
+ """Returns the items of this objects custom properties (matches Python's
2211
+ dictionary function of the same name).
2212
+
2213
+ :return: custom property key, value pairs.
2214
+ """
1484
2215
  ...
1485
2216
 
1486
- def keyframe_delete(self):
1487
- """ """
2217
+ def keyframe_delete(self) -> bool:
2218
+ """Remove a keyframe from this properties fcurve.
2219
+
2220
+ :return: Success of keyframe deletion.
2221
+ :rtype: bool
2222
+ """
1488
2223
  ...
1489
2224
 
1490
- def keyframe_insert(self):
1491
- """ """
2225
+ def keyframe_insert(self) -> bool:
2226
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2227
+
2228
+ :return: Success of keyframe insertion.
2229
+ :rtype: bool
2230
+ """
1492
2231
  ...
1493
2232
 
1494
2233
  def keys(self):
1495
- """ """
2234
+ """Returns the keys of this objects custom properties (matches Python's
2235
+ dictionary function of the same name).
2236
+
2237
+ :return: custom property keys.
2238
+ """
1496
2239
  ...
1497
2240
 
1498
- def path_from_id(self):
1499
- """ """
2241
+ def path_from_id(self) -> str:
2242
+ """Returns the data path from the ID to this object (string).
2243
+
2244
+ :return: The path from `bpy.types.bpy_struct.id_data`
2245
+ to this struct and property (when given).
2246
+ :rtype: str
2247
+ """
1500
2248
  ...
1501
2249
 
1502
2250
  def path_menu(
1503
2251
  self,
1504
- searchpaths,
1505
- operator,
1506
- props_default,
1507
- prop_filepath,
1508
- filter_ext,
1509
- filter_path,
1510
- display_name,
1511
- add_operator,
1512
- add_operator_props,
2252
+ searchpaths: list[str],
2253
+ operator: str,
2254
+ props_default: dict = None,
2255
+ prop_filepath: str = "filepath",
2256
+ filter_ext: typing.Callable = None,
2257
+ filter_path=None,
2258
+ display_name: typing.Callable = None,
2259
+ add_operator=None,
2260
+ add_operator_props=None,
1513
2261
  ):
1514
- """
2262
+ """Populate a menu from a list of paths.
1515
2263
 
1516
- :param searchpaths:
1517
- :param operator:
1518
- :param props_default:
1519
- :param prop_filepath:
1520
- :param filter_ext:
1521
- :param filter_path:
1522
- :param display_name:
1523
- :param add_operator:
1524
- :param add_operator_props:
2264
+ :param searchpaths: Paths to scan.
2265
+ :type searchpaths: list[str]
2266
+ :param operator: The operator id to use with each file.
2267
+ :type operator: str
2268
+ :param props_default: Properties to assign to each operator.
2269
+ :type props_default: dict
2270
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
2271
+ :type prop_filepath: str
2272
+ :param filter_ext: Optional callback that takes the file extensions.
2273
+
2274
+ Returning false excludes the file from the list.
2275
+ :type filter_ext: typing.Callable
2276
+ :param filter_path:
2277
+ :param display_name: Optional callback that takes the full path, returns the name to display.
2278
+ :type display_name: typing.Callable
2279
+ :param add_operator:
2280
+ :param add_operator_props:
1525
2281
  """
1526
2282
  ...
1527
2283
 
1528
2284
  def path_resolve(self):
1529
- """ """
2285
+ """Returns the property from the path, raise an exception when not found."""
1530
2286
  ...
1531
2287
 
1532
2288
  def pop(self):
1533
- """ """
2289
+ """Remove and return the value of the custom property assigned to key or default
2290
+ when not found (matches Python's dictionary function of the same name).
2291
+
2292
+ """
1534
2293
  ...
1535
2294
 
1536
2295
  def prepend(self, draw_func):
1537
- """
2296
+ """Prepend a draw function to this menu, takes the same arguments as
2297
+ the menus draw function
1538
2298
 
1539
- :param draw_func:
2299
+ :param draw_func:
1540
2300
  """
1541
2301
  ...
1542
2302
 
1543
- def property_overridable_library_set(self):
1544
- """ """
2303
+ def property_overridable_library_set(self) -> bool:
2304
+ """Define a property as overridable or not (only for custom properties!).
2305
+
2306
+ :return: True when the overridable status of the property was successfully set.
2307
+ :rtype: bool
2308
+ """
1545
2309
  ...
1546
2310
 
1547
2311
  def property_unset(self):
1548
- """ """
2312
+ """Unset a property, will use default value afterward."""
1549
2313
  ...
1550
2314
 
1551
2315
  def remove(self, draw_func):
1552
- """
2316
+ """Remove a draw function that has been added to this menu
1553
2317
 
1554
2318
  :param draw_func:
1555
2319
  """
1556
2320
  ...
1557
2321
 
1558
2322
  def type_recast(self):
1559
- """ """
2323
+ """Return a new instance, this is needed because types
2324
+ such as textures can be changed at runtime.
2325
+
2326
+ :return: a new instance of this object with the type initialized again.
2327
+ """
1560
2328
  ...
1561
2329
 
1562
2330
  def values(self):
1563
- """ """
2331
+ """Returns the values of this objects custom properties (matches Python's
2332
+ dictionary function of the same name).
2333
+
2334
+ :return: custom property values.
2335
+ """
1564
2336
  ...
1565
2337
 
1566
2338
  class TEXT_MT_templates_osl(bpy_types.Menu, bpy_types._GenericUI):
1567
- """ """
1568
-
1569
2339
  bl_label: typing.Any
1570
- """ """
1571
-
1572
2340
  bl_rna: typing.Any
1573
- """ """
1574
-
1575
2341
  id_data: typing.Any
1576
- """ """
1577
2342
 
1578
2343
  def append(self, draw_func):
1579
- """
2344
+ """Append a draw function to this menu,
2345
+ takes the same arguments as the menus draw function
1580
2346
 
1581
- :param draw_func:
2347
+ :param draw_func:
1582
2348
  """
1583
2349
  ...
1584
2350
 
1585
- def as_pointer(self):
1586
- """ """
2351
+ def as_pointer(self) -> int:
2352
+ """Returns the memory address which holds a pointer to Blender's internal data
2353
+
2354
+ :return: int (memory address).
2355
+ :rtype: int
2356
+ """
1587
2357
  ...
1588
2358
 
1589
- def bl_rna_get_subclass(self):
1590
- """ """
2359
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2360
+ """
2361
+
2362
+ :return: The RNA type or default when not found.
2363
+ :rtype: bpy.types.Struct
2364
+ """
1591
2365
  ...
1592
2366
 
1593
- def bl_rna_get_subclass_py(self):
1594
- """ """
2367
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2368
+ """
2369
+
2370
+ :return: The class or default when not found.
2371
+ :rtype: typing.Any
2372
+ """
1595
2373
  ...
1596
2374
 
1597
2375
  def draw(self, _context):
@@ -1610,169 +2388,258 @@ class TEXT_MT_templates_osl(bpy_types.Menu, bpy_types._GenericUI):
1610
2388
  ...
1611
2389
 
1612
2390
  def draw_preset(self, _context):
1613
- """
2391
+ """Define these on the subclass:
2392
+ - preset_operator (string)
2393
+ - preset_subdir (string)Optionally:
2394
+ - preset_add_operator (string)
2395
+ - preset_extensions (set of strings)
2396
+ - preset_operator_defaults (dict of keyword args)
1614
2397
 
1615
- :param _context:
2398
+ :param _context:
1616
2399
  """
1617
2400
  ...
1618
2401
 
1619
- def driver_add(self):
1620
- """ """
2402
+ def driver_add(self) -> bpy.types.FCurve:
2403
+ """Adds driver(s) to the given property
2404
+
2405
+ :return: The driver(s) added.
2406
+ :rtype: bpy.types.FCurve
2407
+ """
1621
2408
  ...
1622
2409
 
1623
- def driver_remove(self):
1624
- """ """
2410
+ def driver_remove(self) -> bool:
2411
+ """Remove driver(s) from the given property
2412
+
2413
+ :return: Success of driver removal.
2414
+ :rtype: bool
2415
+ """
1625
2416
  ...
1626
2417
 
1627
2418
  def get(self):
1628
- """ """
2419
+ """Returns the value of the custom property assigned to key or default
2420
+ when not found (matches Python's dictionary function of the same name).
2421
+
2422
+ """
1629
2423
  ...
1630
2424
 
1631
2425
  def id_properties_clear(self):
1632
- """ """
2426
+ """
2427
+
2428
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2429
+ """
1633
2430
  ...
1634
2431
 
1635
2432
  def id_properties_ensure(self):
1636
- """ """
2433
+ """
2434
+
2435
+ :return: the parent group for an RNA struct's custom IDProperties.
2436
+ """
1637
2437
  ...
1638
2438
 
1639
2439
  def id_properties_ui(self):
1640
- """ """
1641
- ...
2440
+ """
1642
2441
 
1643
- def is_extended(self):
1644
- """ """
2442
+ :return: Return an object used to manage an IDProperty's UI data.
2443
+ """
1645
2444
  ...
1646
2445
 
1647
- def is_property_hidden(self):
1648
- """ """
2446
+ def is_extended(self): ...
2447
+ def is_property_hidden(self) -> bool:
2448
+ """Check if a property is hidden.
2449
+
2450
+ :return: True when the property is hidden.
2451
+ :rtype: bool
2452
+ """
1649
2453
  ...
1650
2454
 
1651
- def is_property_overridable_library(self):
1652
- """ """
2455
+ def is_property_overridable_library(self) -> bool:
2456
+ """Check if a property is overridable.
2457
+
2458
+ :return: True when the property is overridable.
2459
+ :rtype: bool
2460
+ """
1653
2461
  ...
1654
2462
 
1655
- def is_property_readonly(self):
1656
- """ """
2463
+ def is_property_readonly(self) -> bool:
2464
+ """Check if a property is readonly.
2465
+
2466
+ :return: True when the property is readonly (not writable).
2467
+ :rtype: bool
2468
+ """
1657
2469
  ...
1658
2470
 
1659
- def is_property_set(self):
1660
- """ """
2471
+ def is_property_set(self) -> bool:
2472
+ """Check if a property is set, use for testing operator properties.
2473
+
2474
+ :return: True when the property has been set.
2475
+ :rtype: bool
2476
+ """
1661
2477
  ...
1662
2478
 
1663
2479
  def items(self):
1664
- """ """
2480
+ """Returns the items of this objects custom properties (matches Python's
2481
+ dictionary function of the same name).
2482
+
2483
+ :return: custom property key, value pairs.
2484
+ """
1665
2485
  ...
1666
2486
 
1667
- def keyframe_delete(self):
1668
- """ """
2487
+ def keyframe_delete(self) -> bool:
2488
+ """Remove a keyframe from this properties fcurve.
2489
+
2490
+ :return: Success of keyframe deletion.
2491
+ :rtype: bool
2492
+ """
1669
2493
  ...
1670
2494
 
1671
- def keyframe_insert(self):
1672
- """ """
2495
+ def keyframe_insert(self) -> bool:
2496
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2497
+
2498
+ :return: Success of keyframe insertion.
2499
+ :rtype: bool
2500
+ """
1673
2501
  ...
1674
2502
 
1675
2503
  def keys(self):
1676
- """ """
2504
+ """Returns the keys of this objects custom properties (matches Python's
2505
+ dictionary function of the same name).
2506
+
2507
+ :return: custom property keys.
2508
+ """
1677
2509
  ...
1678
2510
 
1679
- def path_from_id(self):
1680
- """ """
2511
+ def path_from_id(self) -> str:
2512
+ """Returns the data path from the ID to this object (string).
2513
+
2514
+ :return: The path from `bpy.types.bpy_struct.id_data`
2515
+ to this struct and property (when given).
2516
+ :rtype: str
2517
+ """
1681
2518
  ...
1682
2519
 
1683
2520
  def path_menu(
1684
2521
  self,
1685
- searchpaths,
1686
- operator,
1687
- props_default,
1688
- prop_filepath,
1689
- filter_ext,
1690
- filter_path,
1691
- display_name,
1692
- add_operator,
1693
- add_operator_props,
2522
+ searchpaths: list[str],
2523
+ operator: str,
2524
+ props_default: dict = None,
2525
+ prop_filepath: str = "filepath",
2526
+ filter_ext: typing.Callable = None,
2527
+ filter_path=None,
2528
+ display_name: typing.Callable = None,
2529
+ add_operator=None,
2530
+ add_operator_props=None,
1694
2531
  ):
1695
- """
2532
+ """Populate a menu from a list of paths.
2533
+
2534
+ :param searchpaths: Paths to scan.
2535
+ :type searchpaths: list[str]
2536
+ :param operator: The operator id to use with each file.
2537
+ :type operator: str
2538
+ :param props_default: Properties to assign to each operator.
2539
+ :type props_default: dict
2540
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
2541
+ :type prop_filepath: str
2542
+ :param filter_ext: Optional callback that takes the file extensions.
1696
2543
 
1697
- :param searchpaths:
1698
- :param operator:
1699
- :param props_default:
1700
- :param prop_filepath:
1701
- :param filter_ext:
1702
- :param filter_path:
1703
- :param display_name:
1704
- :param add_operator:
1705
- :param add_operator_props:
2544
+ Returning false excludes the file from the list.
2545
+ :type filter_ext: typing.Callable
2546
+ :param filter_path:
2547
+ :param display_name: Optional callback that takes the full path, returns the name to display.
2548
+ :type display_name: typing.Callable
2549
+ :param add_operator:
2550
+ :param add_operator_props:
1706
2551
  """
1707
2552
  ...
1708
2553
 
1709
2554
  def path_resolve(self):
1710
- """ """
2555
+ """Returns the property from the path, raise an exception when not found."""
1711
2556
  ...
1712
2557
 
1713
2558
  def pop(self):
1714
- """ """
2559
+ """Remove and return the value of the custom property assigned to key or default
2560
+ when not found (matches Python's dictionary function of the same name).
2561
+
2562
+ """
1715
2563
  ...
1716
2564
 
1717
2565
  def prepend(self, draw_func):
1718
- """
2566
+ """Prepend a draw function to this menu, takes the same arguments as
2567
+ the menus draw function
1719
2568
 
1720
- :param draw_func:
2569
+ :param draw_func:
1721
2570
  """
1722
2571
  ...
1723
2572
 
1724
- def property_overridable_library_set(self):
1725
- """ """
2573
+ def property_overridable_library_set(self) -> bool:
2574
+ """Define a property as overridable or not (only for custom properties!).
2575
+
2576
+ :return: True when the overridable status of the property was successfully set.
2577
+ :rtype: bool
2578
+ """
1726
2579
  ...
1727
2580
 
1728
2581
  def property_unset(self):
1729
- """ """
2582
+ """Unset a property, will use default value afterward."""
1730
2583
  ...
1731
2584
 
1732
2585
  def remove(self, draw_func):
1733
- """
2586
+ """Remove a draw function that has been added to this menu
1734
2587
 
1735
2588
  :param draw_func:
1736
2589
  """
1737
2590
  ...
1738
2591
 
1739
2592
  def type_recast(self):
1740
- """ """
2593
+ """Return a new instance, this is needed because types
2594
+ such as textures can be changed at runtime.
2595
+
2596
+ :return: a new instance of this object with the type initialized again.
2597
+ """
1741
2598
  ...
1742
2599
 
1743
2600
  def values(self):
1744
- """ """
2601
+ """Returns the values of this objects custom properties (matches Python's
2602
+ dictionary function of the same name).
2603
+
2604
+ :return: custom property values.
2605
+ """
1745
2606
  ...
1746
2607
 
1747
2608
  class TEXT_MT_templates_py(bpy_types.Menu, bpy_types._GenericUI):
1748
- """ """
1749
-
1750
2609
  bl_label: typing.Any
1751
- """ """
1752
-
1753
2610
  bl_rna: typing.Any
1754
- """ """
1755
-
1756
2611
  id_data: typing.Any
1757
- """ """
1758
2612
 
1759
2613
  def append(self, draw_func):
1760
- """
2614
+ """Append a draw function to this menu,
2615
+ takes the same arguments as the menus draw function
1761
2616
 
1762
- :param draw_func:
2617
+ :param draw_func:
1763
2618
  """
1764
2619
  ...
1765
2620
 
1766
- def as_pointer(self):
1767
- """ """
2621
+ def as_pointer(self) -> int:
2622
+ """Returns the memory address which holds a pointer to Blender's internal data
2623
+
2624
+ :return: int (memory address).
2625
+ :rtype: int
2626
+ """
1768
2627
  ...
1769
2628
 
1770
- def bl_rna_get_subclass(self):
1771
- """ """
2629
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2630
+ """
2631
+
2632
+ :return: The RNA type or default when not found.
2633
+ :rtype: bpy.types.Struct
2634
+ """
1772
2635
  ...
1773
2636
 
1774
- def bl_rna_get_subclass_py(self):
1775
- """ """
2637
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2638
+ """
2639
+
2640
+ :return: The class or default when not found.
2641
+ :rtype: typing.Any
2642
+ """
1776
2643
  ...
1777
2644
 
1778
2645
  def draw(self, _context):
@@ -1791,169 +2658,258 @@ class TEXT_MT_templates_py(bpy_types.Menu, bpy_types._GenericUI):
1791
2658
  ...
1792
2659
 
1793
2660
  def draw_preset(self, _context):
1794
- """
2661
+ """Define these on the subclass:
2662
+ - preset_operator (string)
2663
+ - preset_subdir (string)Optionally:
2664
+ - preset_add_operator (string)
2665
+ - preset_extensions (set of strings)
2666
+ - preset_operator_defaults (dict of keyword args)
1795
2667
 
1796
- :param _context:
2668
+ :param _context:
1797
2669
  """
1798
2670
  ...
1799
2671
 
1800
- def driver_add(self):
1801
- """ """
2672
+ def driver_add(self) -> bpy.types.FCurve:
2673
+ """Adds driver(s) to the given property
2674
+
2675
+ :return: The driver(s) added.
2676
+ :rtype: bpy.types.FCurve
2677
+ """
1802
2678
  ...
1803
2679
 
1804
- def driver_remove(self):
1805
- """ """
2680
+ def driver_remove(self) -> bool:
2681
+ """Remove driver(s) from the given property
2682
+
2683
+ :return: Success of driver removal.
2684
+ :rtype: bool
2685
+ """
1806
2686
  ...
1807
2687
 
1808
2688
  def get(self):
1809
- """ """
2689
+ """Returns the value of the custom property assigned to key or default
2690
+ when not found (matches Python's dictionary function of the same name).
2691
+
2692
+ """
1810
2693
  ...
1811
2694
 
1812
2695
  def id_properties_clear(self):
1813
- """ """
2696
+ """
2697
+
2698
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2699
+ """
1814
2700
  ...
1815
2701
 
1816
2702
  def id_properties_ensure(self):
1817
- """ """
2703
+ """
2704
+
2705
+ :return: the parent group for an RNA struct's custom IDProperties.
2706
+ """
1818
2707
  ...
1819
2708
 
1820
2709
  def id_properties_ui(self):
1821
- """ """
1822
- ...
2710
+ """
1823
2711
 
1824
- def is_extended(self):
1825
- """ """
2712
+ :return: Return an object used to manage an IDProperty's UI data.
2713
+ """
1826
2714
  ...
1827
2715
 
1828
- def is_property_hidden(self):
1829
- """ """
2716
+ def is_extended(self): ...
2717
+ def is_property_hidden(self) -> bool:
2718
+ """Check if a property is hidden.
2719
+
2720
+ :return: True when the property is hidden.
2721
+ :rtype: bool
2722
+ """
1830
2723
  ...
1831
2724
 
1832
- def is_property_overridable_library(self):
1833
- """ """
2725
+ def is_property_overridable_library(self) -> bool:
2726
+ """Check if a property is overridable.
2727
+
2728
+ :return: True when the property is overridable.
2729
+ :rtype: bool
2730
+ """
1834
2731
  ...
1835
2732
 
1836
- def is_property_readonly(self):
1837
- """ """
2733
+ def is_property_readonly(self) -> bool:
2734
+ """Check if a property is readonly.
2735
+
2736
+ :return: True when the property is readonly (not writable).
2737
+ :rtype: bool
2738
+ """
1838
2739
  ...
1839
2740
 
1840
- def is_property_set(self):
1841
- """ """
2741
+ def is_property_set(self) -> bool:
2742
+ """Check if a property is set, use for testing operator properties.
2743
+
2744
+ :return: True when the property has been set.
2745
+ :rtype: bool
2746
+ """
1842
2747
  ...
1843
2748
 
1844
2749
  def items(self):
1845
- """ """
2750
+ """Returns the items of this objects custom properties (matches Python's
2751
+ dictionary function of the same name).
2752
+
2753
+ :return: custom property key, value pairs.
2754
+ """
1846
2755
  ...
1847
2756
 
1848
- def keyframe_delete(self):
1849
- """ """
2757
+ def keyframe_delete(self) -> bool:
2758
+ """Remove a keyframe from this properties fcurve.
2759
+
2760
+ :return: Success of keyframe deletion.
2761
+ :rtype: bool
2762
+ """
1850
2763
  ...
1851
2764
 
1852
- def keyframe_insert(self):
1853
- """ """
2765
+ def keyframe_insert(self) -> bool:
2766
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2767
+
2768
+ :return: Success of keyframe insertion.
2769
+ :rtype: bool
2770
+ """
1854
2771
  ...
1855
2772
 
1856
2773
  def keys(self):
1857
- """ """
2774
+ """Returns the keys of this objects custom properties (matches Python's
2775
+ dictionary function of the same name).
2776
+
2777
+ :return: custom property keys.
2778
+ """
1858
2779
  ...
1859
2780
 
1860
- def path_from_id(self):
1861
- """ """
2781
+ def path_from_id(self) -> str:
2782
+ """Returns the data path from the ID to this object (string).
2783
+
2784
+ :return: The path from `bpy.types.bpy_struct.id_data`
2785
+ to this struct and property (when given).
2786
+ :rtype: str
2787
+ """
1862
2788
  ...
1863
2789
 
1864
2790
  def path_menu(
1865
2791
  self,
1866
- searchpaths,
1867
- operator,
1868
- props_default,
1869
- prop_filepath,
1870
- filter_ext,
1871
- filter_path,
1872
- display_name,
1873
- add_operator,
1874
- add_operator_props,
2792
+ searchpaths: list[str],
2793
+ operator: str,
2794
+ props_default: dict = None,
2795
+ prop_filepath: str = "filepath",
2796
+ filter_ext: typing.Callable = None,
2797
+ filter_path=None,
2798
+ display_name: typing.Callable = None,
2799
+ add_operator=None,
2800
+ add_operator_props=None,
1875
2801
  ):
1876
- """
2802
+ """Populate a menu from a list of paths.
2803
+
2804
+ :param searchpaths: Paths to scan.
2805
+ :type searchpaths: list[str]
2806
+ :param operator: The operator id to use with each file.
2807
+ :type operator: str
2808
+ :param props_default: Properties to assign to each operator.
2809
+ :type props_default: dict
2810
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
2811
+ :type prop_filepath: str
2812
+ :param filter_ext: Optional callback that takes the file extensions.
1877
2813
 
1878
- :param searchpaths:
1879
- :param operator:
1880
- :param props_default:
1881
- :param prop_filepath:
1882
- :param filter_ext:
1883
- :param filter_path:
1884
- :param display_name:
1885
- :param add_operator:
1886
- :param add_operator_props:
2814
+ Returning false excludes the file from the list.
2815
+ :type filter_ext: typing.Callable
2816
+ :param filter_path:
2817
+ :param display_name: Optional callback that takes the full path, returns the name to display.
2818
+ :type display_name: typing.Callable
2819
+ :param add_operator:
2820
+ :param add_operator_props:
1887
2821
  """
1888
2822
  ...
1889
2823
 
1890
2824
  def path_resolve(self):
1891
- """ """
2825
+ """Returns the property from the path, raise an exception when not found."""
1892
2826
  ...
1893
2827
 
1894
2828
  def pop(self):
1895
- """ """
2829
+ """Remove and return the value of the custom property assigned to key or default
2830
+ when not found (matches Python's dictionary function of the same name).
2831
+
2832
+ """
1896
2833
  ...
1897
2834
 
1898
2835
  def prepend(self, draw_func):
1899
- """
2836
+ """Prepend a draw function to this menu, takes the same arguments as
2837
+ the menus draw function
1900
2838
 
1901
- :param draw_func:
2839
+ :param draw_func:
1902
2840
  """
1903
2841
  ...
1904
2842
 
1905
- def property_overridable_library_set(self):
1906
- """ """
2843
+ def property_overridable_library_set(self) -> bool:
2844
+ """Define a property as overridable or not (only for custom properties!).
2845
+
2846
+ :return: True when the overridable status of the property was successfully set.
2847
+ :rtype: bool
2848
+ """
1907
2849
  ...
1908
2850
 
1909
2851
  def property_unset(self):
1910
- """ """
2852
+ """Unset a property, will use default value afterward."""
1911
2853
  ...
1912
2854
 
1913
2855
  def remove(self, draw_func):
1914
- """
2856
+ """Remove a draw function that has been added to this menu
1915
2857
 
1916
2858
  :param draw_func:
1917
2859
  """
1918
2860
  ...
1919
2861
 
1920
2862
  def type_recast(self):
1921
- """ """
2863
+ """Return a new instance, this is needed because types
2864
+ such as textures can be changed at runtime.
2865
+
2866
+ :return: a new instance of this object with the type initialized again.
2867
+ """
1922
2868
  ...
1923
2869
 
1924
2870
  def values(self):
1925
- """ """
2871
+ """Returns the values of this objects custom properties (matches Python's
2872
+ dictionary function of the same name).
2873
+
2874
+ :return: custom property values.
2875
+ """
1926
2876
  ...
1927
2877
 
1928
2878
  class TEXT_MT_text(bpy_types.Menu, bpy_types._GenericUI):
1929
- """ """
1930
-
1931
2879
  bl_label: typing.Any
1932
- """ """
1933
-
1934
2880
  bl_rna: typing.Any
1935
- """ """
1936
-
1937
2881
  id_data: typing.Any
1938
- """ """
1939
2882
 
1940
2883
  def append(self, draw_func):
1941
- """
2884
+ """Append a draw function to this menu,
2885
+ takes the same arguments as the menus draw function
1942
2886
 
1943
- :param draw_func:
2887
+ :param draw_func:
1944
2888
  """
1945
2889
  ...
1946
2890
 
1947
- def as_pointer(self):
1948
- """ """
2891
+ def as_pointer(self) -> int:
2892
+ """Returns the memory address which holds a pointer to Blender's internal data
2893
+
2894
+ :return: int (memory address).
2895
+ :rtype: int
2896
+ """
1949
2897
  ...
1950
2898
 
1951
- def bl_rna_get_subclass(self):
1952
- """ """
2899
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2900
+ """
2901
+
2902
+ :return: The RNA type or default when not found.
2903
+ :rtype: bpy.types.Struct
2904
+ """
1953
2905
  ...
1954
2906
 
1955
- def bl_rna_get_subclass_py(self):
1956
- """ """
2907
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2908
+ """
2909
+
2910
+ :return: The class or default when not found.
2911
+ :rtype: typing.Any
2912
+ """
1957
2913
  ...
1958
2914
 
1959
2915
  def draw(self, context):
@@ -1972,169 +2928,258 @@ class TEXT_MT_text(bpy_types.Menu, bpy_types._GenericUI):
1972
2928
  ...
1973
2929
 
1974
2930
  def draw_preset(self, _context):
1975
- """
2931
+ """Define these on the subclass:
2932
+ - preset_operator (string)
2933
+ - preset_subdir (string)Optionally:
2934
+ - preset_add_operator (string)
2935
+ - preset_extensions (set of strings)
2936
+ - preset_operator_defaults (dict of keyword args)
1976
2937
 
1977
- :param _context:
2938
+ :param _context:
1978
2939
  """
1979
2940
  ...
1980
2941
 
1981
- def driver_add(self):
1982
- """ """
2942
+ def driver_add(self) -> bpy.types.FCurve:
2943
+ """Adds driver(s) to the given property
2944
+
2945
+ :return: The driver(s) added.
2946
+ :rtype: bpy.types.FCurve
2947
+ """
1983
2948
  ...
1984
2949
 
1985
- def driver_remove(self):
1986
- """ """
2950
+ def driver_remove(self) -> bool:
2951
+ """Remove driver(s) from the given property
2952
+
2953
+ :return: Success of driver removal.
2954
+ :rtype: bool
2955
+ """
1987
2956
  ...
1988
2957
 
1989
2958
  def get(self):
1990
- """ """
2959
+ """Returns the value of the custom property assigned to key or default
2960
+ when not found (matches Python's dictionary function of the same name).
2961
+
2962
+ """
1991
2963
  ...
1992
2964
 
1993
2965
  def id_properties_clear(self):
1994
- """ """
2966
+ """
2967
+
2968
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2969
+ """
1995
2970
  ...
1996
2971
 
1997
2972
  def id_properties_ensure(self):
1998
- """ """
2973
+ """
2974
+
2975
+ :return: the parent group for an RNA struct's custom IDProperties.
2976
+ """
1999
2977
  ...
2000
2978
 
2001
2979
  def id_properties_ui(self):
2002
- """ """
2003
- ...
2980
+ """
2004
2981
 
2005
- def is_extended(self):
2006
- """ """
2982
+ :return: Return an object used to manage an IDProperty's UI data.
2983
+ """
2007
2984
  ...
2008
2985
 
2009
- def is_property_hidden(self):
2010
- """ """
2986
+ def is_extended(self): ...
2987
+ def is_property_hidden(self) -> bool:
2988
+ """Check if a property is hidden.
2989
+
2990
+ :return: True when the property is hidden.
2991
+ :rtype: bool
2992
+ """
2011
2993
  ...
2012
2994
 
2013
- def is_property_overridable_library(self):
2014
- """ """
2995
+ def is_property_overridable_library(self) -> bool:
2996
+ """Check if a property is overridable.
2997
+
2998
+ :return: True when the property is overridable.
2999
+ :rtype: bool
3000
+ """
2015
3001
  ...
2016
3002
 
2017
- def is_property_readonly(self):
2018
- """ """
3003
+ def is_property_readonly(self) -> bool:
3004
+ """Check if a property is readonly.
3005
+
3006
+ :return: True when the property is readonly (not writable).
3007
+ :rtype: bool
3008
+ """
2019
3009
  ...
2020
3010
 
2021
- def is_property_set(self):
2022
- """ """
3011
+ def is_property_set(self) -> bool:
3012
+ """Check if a property is set, use for testing operator properties.
3013
+
3014
+ :return: True when the property has been set.
3015
+ :rtype: bool
3016
+ """
2023
3017
  ...
2024
3018
 
2025
3019
  def items(self):
2026
- """ """
3020
+ """Returns the items of this objects custom properties (matches Python's
3021
+ dictionary function of the same name).
3022
+
3023
+ :return: custom property key, value pairs.
3024
+ """
2027
3025
  ...
2028
3026
 
2029
- def keyframe_delete(self):
2030
- """ """
3027
+ def keyframe_delete(self) -> bool:
3028
+ """Remove a keyframe from this properties fcurve.
3029
+
3030
+ :return: Success of keyframe deletion.
3031
+ :rtype: bool
3032
+ """
2031
3033
  ...
2032
3034
 
2033
- def keyframe_insert(self):
2034
- """ """
3035
+ def keyframe_insert(self) -> bool:
3036
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3037
+
3038
+ :return: Success of keyframe insertion.
3039
+ :rtype: bool
3040
+ """
2035
3041
  ...
2036
3042
 
2037
3043
  def keys(self):
2038
- """ """
3044
+ """Returns the keys of this objects custom properties (matches Python's
3045
+ dictionary function of the same name).
3046
+
3047
+ :return: custom property keys.
3048
+ """
2039
3049
  ...
2040
3050
 
2041
- def path_from_id(self):
2042
- """ """
3051
+ def path_from_id(self) -> str:
3052
+ """Returns the data path from the ID to this object (string).
3053
+
3054
+ :return: The path from `bpy.types.bpy_struct.id_data`
3055
+ to this struct and property (when given).
3056
+ :rtype: str
3057
+ """
2043
3058
  ...
2044
3059
 
2045
3060
  def path_menu(
2046
3061
  self,
2047
- searchpaths,
2048
- operator,
2049
- props_default,
2050
- prop_filepath,
2051
- filter_ext,
2052
- filter_path,
2053
- display_name,
2054
- add_operator,
2055
- add_operator_props,
3062
+ searchpaths: list[str],
3063
+ operator: str,
3064
+ props_default: dict = None,
3065
+ prop_filepath: str = "filepath",
3066
+ filter_ext: typing.Callable = None,
3067
+ filter_path=None,
3068
+ display_name: typing.Callable = None,
3069
+ add_operator=None,
3070
+ add_operator_props=None,
2056
3071
  ):
2057
- """
3072
+ """Populate a menu from a list of paths.
2058
3073
 
2059
- :param searchpaths:
2060
- :param operator:
2061
- :param props_default:
2062
- :param prop_filepath:
2063
- :param filter_ext:
2064
- :param filter_path:
2065
- :param display_name:
2066
- :param add_operator:
2067
- :param add_operator_props:
3074
+ :param searchpaths: Paths to scan.
3075
+ :type searchpaths: list[str]
3076
+ :param operator: The operator id to use with each file.
3077
+ :type operator: str
3078
+ :param props_default: Properties to assign to each operator.
3079
+ :type props_default: dict
3080
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3081
+ :type prop_filepath: str
3082
+ :param filter_ext: Optional callback that takes the file extensions.
3083
+
3084
+ Returning false excludes the file from the list.
3085
+ :type filter_ext: typing.Callable
3086
+ :param filter_path:
3087
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3088
+ :type display_name: typing.Callable
3089
+ :param add_operator:
3090
+ :param add_operator_props:
2068
3091
  """
2069
3092
  ...
2070
3093
 
2071
3094
  def path_resolve(self):
2072
- """ """
3095
+ """Returns the property from the path, raise an exception when not found."""
2073
3096
  ...
2074
3097
 
2075
3098
  def pop(self):
2076
- """ """
3099
+ """Remove and return the value of the custom property assigned to key or default
3100
+ when not found (matches Python's dictionary function of the same name).
3101
+
3102
+ """
2077
3103
  ...
2078
3104
 
2079
3105
  def prepend(self, draw_func):
2080
- """
3106
+ """Prepend a draw function to this menu, takes the same arguments as
3107
+ the menus draw function
2081
3108
 
2082
- :param draw_func:
3109
+ :param draw_func:
2083
3110
  """
2084
3111
  ...
2085
3112
 
2086
- def property_overridable_library_set(self):
2087
- """ """
3113
+ def property_overridable_library_set(self) -> bool:
3114
+ """Define a property as overridable or not (only for custom properties!).
3115
+
3116
+ :return: True when the overridable status of the property was successfully set.
3117
+ :rtype: bool
3118
+ """
2088
3119
  ...
2089
3120
 
2090
3121
  def property_unset(self):
2091
- """ """
3122
+ """Unset a property, will use default value afterward."""
2092
3123
  ...
2093
3124
 
2094
3125
  def remove(self, draw_func):
2095
- """
3126
+ """Remove a draw function that has been added to this menu
2096
3127
 
2097
3128
  :param draw_func:
2098
3129
  """
2099
3130
  ...
2100
3131
 
2101
3132
  def type_recast(self):
2102
- """ """
3133
+ """Return a new instance, this is needed because types
3134
+ such as textures can be changed at runtime.
3135
+
3136
+ :return: a new instance of this object with the type initialized again.
3137
+ """
2103
3138
  ...
2104
3139
 
2105
3140
  def values(self):
2106
- """ """
3141
+ """Returns the values of this objects custom properties (matches Python's
3142
+ dictionary function of the same name).
3143
+
3144
+ :return: custom property values.
3145
+ """
2107
3146
  ...
2108
3147
 
2109
3148
  class TEXT_MT_view(bpy_types.Menu, bpy_types._GenericUI):
2110
- """ """
2111
-
2112
3149
  bl_label: typing.Any
2113
- """ """
2114
-
2115
3150
  bl_rna: typing.Any
2116
- """ """
2117
-
2118
3151
  id_data: typing.Any
2119
- """ """
2120
3152
 
2121
3153
  def append(self, draw_func):
2122
- """
3154
+ """Append a draw function to this menu,
3155
+ takes the same arguments as the menus draw function
2123
3156
 
2124
- :param draw_func:
3157
+ :param draw_func:
2125
3158
  """
2126
3159
  ...
2127
3160
 
2128
- def as_pointer(self):
2129
- """ """
3161
+ def as_pointer(self) -> int:
3162
+ """Returns the memory address which holds a pointer to Blender's internal data
3163
+
3164
+ :return: int (memory address).
3165
+ :rtype: int
3166
+ """
2130
3167
  ...
2131
3168
 
2132
- def bl_rna_get_subclass(self):
2133
- """ """
3169
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3170
+ """
3171
+
3172
+ :return: The RNA type or default when not found.
3173
+ :rtype: bpy.types.Struct
3174
+ """
2134
3175
  ...
2135
3176
 
2136
- def bl_rna_get_subclass_py(self):
2137
- """ """
3177
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3178
+ """
3179
+
3180
+ :return: The class or default when not found.
3181
+ :rtype: typing.Any
3182
+ """
2138
3183
  ...
2139
3184
 
2140
3185
  def draw(self, context):
@@ -2153,169 +3198,258 @@ class TEXT_MT_view(bpy_types.Menu, bpy_types._GenericUI):
2153
3198
  ...
2154
3199
 
2155
3200
  def draw_preset(self, _context):
2156
- """
3201
+ """Define these on the subclass:
3202
+ - preset_operator (string)
3203
+ - preset_subdir (string)Optionally:
3204
+ - preset_add_operator (string)
3205
+ - preset_extensions (set of strings)
3206
+ - preset_operator_defaults (dict of keyword args)
2157
3207
 
2158
- :param _context:
3208
+ :param _context:
2159
3209
  """
2160
3210
  ...
2161
3211
 
2162
- def driver_add(self):
2163
- """ """
3212
+ def driver_add(self) -> bpy.types.FCurve:
3213
+ """Adds driver(s) to the given property
3214
+
3215
+ :return: The driver(s) added.
3216
+ :rtype: bpy.types.FCurve
3217
+ """
2164
3218
  ...
2165
3219
 
2166
- def driver_remove(self):
2167
- """ """
3220
+ def driver_remove(self) -> bool:
3221
+ """Remove driver(s) from the given property
3222
+
3223
+ :return: Success of driver removal.
3224
+ :rtype: bool
3225
+ """
2168
3226
  ...
2169
3227
 
2170
3228
  def get(self):
2171
- """ """
3229
+ """Returns the value of the custom property assigned to key or default
3230
+ when not found (matches Python's dictionary function of the same name).
3231
+
3232
+ """
2172
3233
  ...
2173
3234
 
2174
3235
  def id_properties_clear(self):
2175
- """ """
3236
+ """
3237
+
3238
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3239
+ """
2176
3240
  ...
2177
3241
 
2178
3242
  def id_properties_ensure(self):
2179
- """ """
3243
+ """
3244
+
3245
+ :return: the parent group for an RNA struct's custom IDProperties.
3246
+ """
2180
3247
  ...
2181
3248
 
2182
3249
  def id_properties_ui(self):
2183
- """ """
2184
- ...
3250
+ """
2185
3251
 
2186
- def is_extended(self):
2187
- """ """
3252
+ :return: Return an object used to manage an IDProperty's UI data.
3253
+ """
2188
3254
  ...
2189
3255
 
2190
- def is_property_hidden(self):
2191
- """ """
3256
+ def is_extended(self): ...
3257
+ def is_property_hidden(self) -> bool:
3258
+ """Check if a property is hidden.
3259
+
3260
+ :return: True when the property is hidden.
3261
+ :rtype: bool
3262
+ """
2192
3263
  ...
2193
3264
 
2194
- def is_property_overridable_library(self):
2195
- """ """
3265
+ def is_property_overridable_library(self) -> bool:
3266
+ """Check if a property is overridable.
3267
+
3268
+ :return: True when the property is overridable.
3269
+ :rtype: bool
3270
+ """
2196
3271
  ...
2197
3272
 
2198
- def is_property_readonly(self):
2199
- """ """
3273
+ def is_property_readonly(self) -> bool:
3274
+ """Check if a property is readonly.
3275
+
3276
+ :return: True when the property is readonly (not writable).
3277
+ :rtype: bool
3278
+ """
2200
3279
  ...
2201
3280
 
2202
- def is_property_set(self):
2203
- """ """
3281
+ def is_property_set(self) -> bool:
3282
+ """Check if a property is set, use for testing operator properties.
3283
+
3284
+ :return: True when the property has been set.
3285
+ :rtype: bool
3286
+ """
2204
3287
  ...
2205
3288
 
2206
3289
  def items(self):
2207
- """ """
3290
+ """Returns the items of this objects custom properties (matches Python's
3291
+ dictionary function of the same name).
3292
+
3293
+ :return: custom property key, value pairs.
3294
+ """
2208
3295
  ...
2209
3296
 
2210
- def keyframe_delete(self):
2211
- """ """
3297
+ def keyframe_delete(self) -> bool:
3298
+ """Remove a keyframe from this properties fcurve.
3299
+
3300
+ :return: Success of keyframe deletion.
3301
+ :rtype: bool
3302
+ """
2212
3303
  ...
2213
3304
 
2214
- def keyframe_insert(self):
2215
- """ """
3305
+ def keyframe_insert(self) -> bool:
3306
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3307
+
3308
+ :return: Success of keyframe insertion.
3309
+ :rtype: bool
3310
+ """
2216
3311
  ...
2217
3312
 
2218
3313
  def keys(self):
2219
- """ """
3314
+ """Returns the keys of this objects custom properties (matches Python's
3315
+ dictionary function of the same name).
3316
+
3317
+ :return: custom property keys.
3318
+ """
2220
3319
  ...
2221
3320
 
2222
- def path_from_id(self):
2223
- """ """
3321
+ def path_from_id(self) -> str:
3322
+ """Returns the data path from the ID to this object (string).
3323
+
3324
+ :return: The path from `bpy.types.bpy_struct.id_data`
3325
+ to this struct and property (when given).
3326
+ :rtype: str
3327
+ """
2224
3328
  ...
2225
3329
 
2226
3330
  def path_menu(
2227
3331
  self,
2228
- searchpaths,
2229
- operator,
2230
- props_default,
2231
- prop_filepath,
2232
- filter_ext,
2233
- filter_path,
2234
- display_name,
2235
- add_operator,
2236
- add_operator_props,
3332
+ searchpaths: list[str],
3333
+ operator: str,
3334
+ props_default: dict = None,
3335
+ prop_filepath: str = "filepath",
3336
+ filter_ext: typing.Callable = None,
3337
+ filter_path=None,
3338
+ display_name: typing.Callable = None,
3339
+ add_operator=None,
3340
+ add_operator_props=None,
2237
3341
  ):
2238
- """
3342
+ """Populate a menu from a list of paths.
3343
+
3344
+ :param searchpaths: Paths to scan.
3345
+ :type searchpaths: list[str]
3346
+ :param operator: The operator id to use with each file.
3347
+ :type operator: str
3348
+ :param props_default: Properties to assign to each operator.
3349
+ :type props_default: dict
3350
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3351
+ :type prop_filepath: str
3352
+ :param filter_ext: Optional callback that takes the file extensions.
2239
3353
 
2240
- :param searchpaths:
2241
- :param operator:
2242
- :param props_default:
2243
- :param prop_filepath:
2244
- :param filter_ext:
2245
- :param filter_path:
2246
- :param display_name:
2247
- :param add_operator:
2248
- :param add_operator_props:
3354
+ Returning false excludes the file from the list.
3355
+ :type filter_ext: typing.Callable
3356
+ :param filter_path:
3357
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3358
+ :type display_name: typing.Callable
3359
+ :param add_operator:
3360
+ :param add_operator_props:
2249
3361
  """
2250
3362
  ...
2251
3363
 
2252
3364
  def path_resolve(self):
2253
- """ """
3365
+ """Returns the property from the path, raise an exception when not found."""
2254
3366
  ...
2255
3367
 
2256
3368
  def pop(self):
2257
- """ """
3369
+ """Remove and return the value of the custom property assigned to key or default
3370
+ when not found (matches Python's dictionary function of the same name).
3371
+
3372
+ """
2258
3373
  ...
2259
3374
 
2260
3375
  def prepend(self, draw_func):
2261
- """
3376
+ """Prepend a draw function to this menu, takes the same arguments as
3377
+ the menus draw function
2262
3378
 
2263
- :param draw_func:
3379
+ :param draw_func:
2264
3380
  """
2265
3381
  ...
2266
3382
 
2267
- def property_overridable_library_set(self):
2268
- """ """
3383
+ def property_overridable_library_set(self) -> bool:
3384
+ """Define a property as overridable or not (only for custom properties!).
3385
+
3386
+ :return: True when the overridable status of the property was successfully set.
3387
+ :rtype: bool
3388
+ """
2269
3389
  ...
2270
3390
 
2271
3391
  def property_unset(self):
2272
- """ """
3392
+ """Unset a property, will use default value afterward."""
2273
3393
  ...
2274
3394
 
2275
3395
  def remove(self, draw_func):
2276
- """
3396
+ """Remove a draw function that has been added to this menu
2277
3397
 
2278
3398
  :param draw_func:
2279
3399
  """
2280
3400
  ...
2281
3401
 
2282
3402
  def type_recast(self):
2283
- """ """
3403
+ """Return a new instance, this is needed because types
3404
+ such as textures can be changed at runtime.
3405
+
3406
+ :return: a new instance of this object with the type initialized again.
3407
+ """
2284
3408
  ...
2285
3409
 
2286
3410
  def values(self):
2287
- """ """
3411
+ """Returns the values of this objects custom properties (matches Python's
3412
+ dictionary function of the same name).
3413
+
3414
+ :return: custom property values.
3415
+ """
2288
3416
  ...
2289
3417
 
2290
3418
  class TEXT_MT_view_navigation(bpy_types.Menu, bpy_types._GenericUI):
2291
- """ """
2292
-
2293
3419
  bl_label: typing.Any
2294
- """ """
2295
-
2296
3420
  bl_rna: typing.Any
2297
- """ """
2298
-
2299
3421
  id_data: typing.Any
2300
- """ """
2301
3422
 
2302
3423
  def append(self, draw_func):
2303
- """
3424
+ """Append a draw function to this menu,
3425
+ takes the same arguments as the menus draw function
2304
3426
 
2305
- :param draw_func:
3427
+ :param draw_func:
2306
3428
  """
2307
3429
  ...
2308
3430
 
2309
- def as_pointer(self):
2310
- """ """
3431
+ def as_pointer(self) -> int:
3432
+ """Returns the memory address which holds a pointer to Blender's internal data
3433
+
3434
+ :return: int (memory address).
3435
+ :rtype: int
3436
+ """
2311
3437
  ...
2312
3438
 
2313
- def bl_rna_get_subclass(self):
2314
- """ """
3439
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3440
+ """
3441
+
3442
+ :return: The RNA type or default when not found.
3443
+ :rtype: bpy.types.Struct
3444
+ """
2315
3445
  ...
2316
3446
 
2317
- def bl_rna_get_subclass_py(self):
2318
- """ """
3447
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3448
+ """
3449
+
3450
+ :return: The class or default when not found.
3451
+ :rtype: typing.Any
3452
+ """
2319
3453
  ...
2320
3454
 
2321
3455
  def draw(self, _context):
@@ -2334,178 +3468,261 @@ class TEXT_MT_view_navigation(bpy_types.Menu, bpy_types._GenericUI):
2334
3468
  ...
2335
3469
 
2336
3470
  def draw_preset(self, _context):
2337
- """
3471
+ """Define these on the subclass:
3472
+ - preset_operator (string)
3473
+ - preset_subdir (string)Optionally:
3474
+ - preset_add_operator (string)
3475
+ - preset_extensions (set of strings)
3476
+ - preset_operator_defaults (dict of keyword args)
2338
3477
 
2339
- :param _context:
3478
+ :param _context:
2340
3479
  """
2341
3480
  ...
2342
3481
 
2343
- def driver_add(self):
2344
- """ """
3482
+ def driver_add(self) -> bpy.types.FCurve:
3483
+ """Adds driver(s) to the given property
3484
+
3485
+ :return: The driver(s) added.
3486
+ :rtype: bpy.types.FCurve
3487
+ """
2345
3488
  ...
2346
3489
 
2347
- def driver_remove(self):
2348
- """ """
3490
+ def driver_remove(self) -> bool:
3491
+ """Remove driver(s) from the given property
3492
+
3493
+ :return: Success of driver removal.
3494
+ :rtype: bool
3495
+ """
2349
3496
  ...
2350
3497
 
2351
3498
  def get(self):
2352
- """ """
3499
+ """Returns the value of the custom property assigned to key or default
3500
+ when not found (matches Python's dictionary function of the same name).
3501
+
3502
+ """
2353
3503
  ...
2354
3504
 
2355
3505
  def id_properties_clear(self):
2356
- """ """
3506
+ """
3507
+
3508
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3509
+ """
2357
3510
  ...
2358
3511
 
2359
3512
  def id_properties_ensure(self):
2360
- """ """
3513
+ """
3514
+
3515
+ :return: the parent group for an RNA struct's custom IDProperties.
3516
+ """
2361
3517
  ...
2362
3518
 
2363
3519
  def id_properties_ui(self):
2364
- """ """
2365
- ...
3520
+ """
2366
3521
 
2367
- def is_extended(self):
2368
- """ """
3522
+ :return: Return an object used to manage an IDProperty's UI data.
3523
+ """
2369
3524
  ...
2370
3525
 
2371
- def is_property_hidden(self):
2372
- """ """
3526
+ def is_extended(self): ...
3527
+ def is_property_hidden(self) -> bool:
3528
+ """Check if a property is hidden.
3529
+
3530
+ :return: True when the property is hidden.
3531
+ :rtype: bool
3532
+ """
2373
3533
  ...
2374
3534
 
2375
- def is_property_overridable_library(self):
2376
- """ """
3535
+ def is_property_overridable_library(self) -> bool:
3536
+ """Check if a property is overridable.
3537
+
3538
+ :return: True when the property is overridable.
3539
+ :rtype: bool
3540
+ """
2377
3541
  ...
2378
3542
 
2379
- def is_property_readonly(self):
2380
- """ """
3543
+ def is_property_readonly(self) -> bool:
3544
+ """Check if a property is readonly.
3545
+
3546
+ :return: True when the property is readonly (not writable).
3547
+ :rtype: bool
3548
+ """
2381
3549
  ...
2382
3550
 
2383
- def is_property_set(self):
2384
- """ """
3551
+ def is_property_set(self) -> bool:
3552
+ """Check if a property is set, use for testing operator properties.
3553
+
3554
+ :return: True when the property has been set.
3555
+ :rtype: bool
3556
+ """
2385
3557
  ...
2386
3558
 
2387
3559
  def items(self):
2388
- """ """
3560
+ """Returns the items of this objects custom properties (matches Python's
3561
+ dictionary function of the same name).
3562
+
3563
+ :return: custom property key, value pairs.
3564
+ """
2389
3565
  ...
2390
3566
 
2391
- def keyframe_delete(self):
2392
- """ """
3567
+ def keyframe_delete(self) -> bool:
3568
+ """Remove a keyframe from this properties fcurve.
3569
+
3570
+ :return: Success of keyframe deletion.
3571
+ :rtype: bool
3572
+ """
2393
3573
  ...
2394
3574
 
2395
- def keyframe_insert(self):
2396
- """ """
3575
+ def keyframe_insert(self) -> bool:
3576
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3577
+
3578
+ :return: Success of keyframe insertion.
3579
+ :rtype: bool
3580
+ """
2397
3581
  ...
2398
3582
 
2399
3583
  def keys(self):
2400
- """ """
3584
+ """Returns the keys of this objects custom properties (matches Python's
3585
+ dictionary function of the same name).
3586
+
3587
+ :return: custom property keys.
3588
+ """
2401
3589
  ...
2402
3590
 
2403
- def path_from_id(self):
2404
- """ """
3591
+ def path_from_id(self) -> str:
3592
+ """Returns the data path from the ID to this object (string).
3593
+
3594
+ :return: The path from `bpy.types.bpy_struct.id_data`
3595
+ to this struct and property (when given).
3596
+ :rtype: str
3597
+ """
2405
3598
  ...
2406
3599
 
2407
3600
  def path_menu(
2408
3601
  self,
2409
- searchpaths,
2410
- operator,
2411
- props_default,
2412
- prop_filepath,
2413
- filter_ext,
2414
- filter_path,
2415
- display_name,
2416
- add_operator,
2417
- add_operator_props,
3602
+ searchpaths: list[str],
3603
+ operator: str,
3604
+ props_default: dict = None,
3605
+ prop_filepath: str = "filepath",
3606
+ filter_ext: typing.Callable = None,
3607
+ filter_path=None,
3608
+ display_name: typing.Callable = None,
3609
+ add_operator=None,
3610
+ add_operator_props=None,
2418
3611
  ):
2419
- """
3612
+ """Populate a menu from a list of paths.
3613
+
3614
+ :param searchpaths: Paths to scan.
3615
+ :type searchpaths: list[str]
3616
+ :param operator: The operator id to use with each file.
3617
+ :type operator: str
3618
+ :param props_default: Properties to assign to each operator.
3619
+ :type props_default: dict
3620
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
3621
+ :type prop_filepath: str
3622
+ :param filter_ext: Optional callback that takes the file extensions.
2420
3623
 
2421
- :param searchpaths:
2422
- :param operator:
2423
- :param props_default:
2424
- :param prop_filepath:
2425
- :param filter_ext:
2426
- :param filter_path:
2427
- :param display_name:
2428
- :param add_operator:
2429
- :param add_operator_props:
3624
+ Returning false excludes the file from the list.
3625
+ :type filter_ext: typing.Callable
3626
+ :param filter_path:
3627
+ :param display_name: Optional callback that takes the full path, returns the name to display.
3628
+ :type display_name: typing.Callable
3629
+ :param add_operator:
3630
+ :param add_operator_props:
2430
3631
  """
2431
3632
  ...
2432
3633
 
2433
3634
  def path_resolve(self):
2434
- """ """
3635
+ """Returns the property from the path, raise an exception when not found."""
2435
3636
  ...
2436
3637
 
2437
3638
  def pop(self):
2438
- """ """
3639
+ """Remove and return the value of the custom property assigned to key or default
3640
+ when not found (matches Python's dictionary function of the same name).
3641
+
3642
+ """
2439
3643
  ...
2440
3644
 
2441
3645
  def prepend(self, draw_func):
2442
- """
3646
+ """Prepend a draw function to this menu, takes the same arguments as
3647
+ the menus draw function
2443
3648
 
2444
- :param draw_func:
3649
+ :param draw_func:
2445
3650
  """
2446
3651
  ...
2447
3652
 
2448
- def property_overridable_library_set(self):
2449
- """ """
3653
+ def property_overridable_library_set(self) -> bool:
3654
+ """Define a property as overridable or not (only for custom properties!).
3655
+
3656
+ :return: True when the overridable status of the property was successfully set.
3657
+ :rtype: bool
3658
+ """
2450
3659
  ...
2451
3660
 
2452
3661
  def property_unset(self):
2453
- """ """
3662
+ """Unset a property, will use default value afterward."""
2454
3663
  ...
2455
3664
 
2456
3665
  def remove(self, draw_func):
2457
- """
3666
+ """Remove a draw function that has been added to this menu
2458
3667
 
2459
3668
  :param draw_func:
2460
3669
  """
2461
3670
  ...
2462
3671
 
2463
3672
  def type_recast(self):
2464
- """ """
3673
+ """Return a new instance, this is needed because types
3674
+ such as textures can be changed at runtime.
3675
+
3676
+ :return: a new instance of this object with the type initialized again.
3677
+ """
2465
3678
  ...
2466
3679
 
2467
3680
  def values(self):
2468
- """ """
3681
+ """Returns the values of this objects custom properties (matches Python's
3682
+ dictionary function of the same name).
3683
+
3684
+ :return: custom property values.
3685
+ """
2469
3686
  ...
2470
3687
 
2471
3688
  class TEXT_PT_find(bpy_types.Panel, bpy_types._GenericUI):
2472
- """ """
2473
-
2474
3689
  bl_category: typing.Any
2475
- """ """
2476
-
2477
3690
  bl_label: typing.Any
2478
- """ """
2479
-
2480
3691
  bl_region_type: typing.Any
2481
- """ """
2482
-
2483
3692
  bl_rna: typing.Any
2484
- """ """
2485
-
2486
3693
  bl_space_type: typing.Any
2487
- """ """
2488
-
2489
3694
  id_data: typing.Any
2490
- """ """
2491
3695
 
2492
3696
  def append(self, draw_func):
2493
- """
3697
+ """Append a draw function to this menu,
3698
+ takes the same arguments as the menus draw function
2494
3699
 
2495
- :param draw_func:
3700
+ :param draw_func:
2496
3701
  """
2497
3702
  ...
2498
3703
 
2499
- def as_pointer(self):
2500
- """ """
3704
+ def as_pointer(self) -> int:
3705
+ """Returns the memory address which holds a pointer to Blender's internal data
3706
+
3707
+ :return: int (memory address).
3708
+ :rtype: int
3709
+ """
2501
3710
  ...
2502
3711
 
2503
- def bl_rna_get_subclass(self):
2504
- """ """
3712
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3713
+ """
3714
+
3715
+ :return: The RNA type or default when not found.
3716
+ :rtype: bpy.types.Struct
3717
+ """
2505
3718
  ...
2506
3719
 
2507
- def bl_rna_get_subclass_py(self):
2508
- """ """
3720
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3721
+ """
3722
+
3723
+ :return: The class or default when not found.
3724
+ :rtype: typing.Any
3725
+ """
2509
3726
  ...
2510
3727
 
2511
3728
  def draw(self, context):
@@ -2515,146 +3732,216 @@ class TEXT_PT_find(bpy_types.Panel, bpy_types._GenericUI):
2515
3732
  """
2516
3733
  ...
2517
3734
 
2518
- def driver_add(self):
2519
- """ """
3735
+ def driver_add(self) -> bpy.types.FCurve:
3736
+ """Adds driver(s) to the given property
3737
+
3738
+ :return: The driver(s) added.
3739
+ :rtype: bpy.types.FCurve
3740
+ """
2520
3741
  ...
2521
3742
 
2522
- def driver_remove(self):
2523
- """ """
3743
+ def driver_remove(self) -> bool:
3744
+ """Remove driver(s) from the given property
3745
+
3746
+ :return: Success of driver removal.
3747
+ :rtype: bool
3748
+ """
2524
3749
  ...
2525
3750
 
2526
3751
  def get(self):
2527
- """ """
3752
+ """Returns the value of the custom property assigned to key or default
3753
+ when not found (matches Python's dictionary function of the same name).
3754
+
3755
+ """
2528
3756
  ...
2529
3757
 
2530
3758
  def id_properties_clear(self):
2531
- """ """
3759
+ """
3760
+
3761
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3762
+ """
2532
3763
  ...
2533
3764
 
2534
3765
  def id_properties_ensure(self):
2535
- """ """
3766
+ """
3767
+
3768
+ :return: the parent group for an RNA struct's custom IDProperties.
3769
+ """
2536
3770
  ...
2537
3771
 
2538
3772
  def id_properties_ui(self):
2539
- """ """
2540
- ...
3773
+ """
2541
3774
 
2542
- def is_extended(self):
2543
- """ """
3775
+ :return: Return an object used to manage an IDProperty's UI data.
3776
+ """
2544
3777
  ...
2545
3778
 
2546
- def is_property_hidden(self):
2547
- """ """
3779
+ def is_extended(self): ...
3780
+ def is_property_hidden(self) -> bool:
3781
+ """Check if a property is hidden.
3782
+
3783
+ :return: True when the property is hidden.
3784
+ :rtype: bool
3785
+ """
2548
3786
  ...
2549
3787
 
2550
- def is_property_overridable_library(self):
2551
- """ """
3788
+ def is_property_overridable_library(self) -> bool:
3789
+ """Check if a property is overridable.
3790
+
3791
+ :return: True when the property is overridable.
3792
+ :rtype: bool
3793
+ """
2552
3794
  ...
2553
3795
 
2554
- def is_property_readonly(self):
2555
- """ """
3796
+ def is_property_readonly(self) -> bool:
3797
+ """Check if a property is readonly.
3798
+
3799
+ :return: True when the property is readonly (not writable).
3800
+ :rtype: bool
3801
+ """
2556
3802
  ...
2557
3803
 
2558
- def is_property_set(self):
2559
- """ """
3804
+ def is_property_set(self) -> bool:
3805
+ """Check if a property is set, use for testing operator properties.
3806
+
3807
+ :return: True when the property has been set.
3808
+ :rtype: bool
3809
+ """
2560
3810
  ...
2561
3811
 
2562
3812
  def items(self):
2563
- """ """
3813
+ """Returns the items of this objects custom properties (matches Python's
3814
+ dictionary function of the same name).
3815
+
3816
+ :return: custom property key, value pairs.
3817
+ """
2564
3818
  ...
2565
3819
 
2566
- def keyframe_delete(self):
2567
- """ """
3820
+ def keyframe_delete(self) -> bool:
3821
+ """Remove a keyframe from this properties fcurve.
3822
+
3823
+ :return: Success of keyframe deletion.
3824
+ :rtype: bool
3825
+ """
2568
3826
  ...
2569
3827
 
2570
- def keyframe_insert(self):
2571
- """ """
3828
+ def keyframe_insert(self) -> bool:
3829
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3830
+
3831
+ :return: Success of keyframe insertion.
3832
+ :rtype: bool
3833
+ """
2572
3834
  ...
2573
3835
 
2574
3836
  def keys(self):
2575
- """ """
3837
+ """Returns the keys of this objects custom properties (matches Python's
3838
+ dictionary function of the same name).
3839
+
3840
+ :return: custom property keys.
3841
+ """
2576
3842
  ...
2577
3843
 
2578
- def path_from_id(self):
2579
- """ """
3844
+ def path_from_id(self) -> str:
3845
+ """Returns the data path from the ID to this object (string).
3846
+
3847
+ :return: The path from `bpy.types.bpy_struct.id_data`
3848
+ to this struct and property (when given).
3849
+ :rtype: str
3850
+ """
2580
3851
  ...
2581
3852
 
2582
3853
  def path_resolve(self):
2583
- """ """
3854
+ """Returns the property from the path, raise an exception when not found."""
2584
3855
  ...
2585
3856
 
2586
3857
  def pop(self):
2587
- """ """
3858
+ """Remove and return the value of the custom property assigned to key or default
3859
+ when not found (matches Python's dictionary function of the same name).
3860
+
3861
+ """
2588
3862
  ...
2589
3863
 
2590
3864
  def prepend(self, draw_func):
2591
- """
3865
+ """Prepend a draw function to this menu, takes the same arguments as
3866
+ the menus draw function
2592
3867
 
2593
- :param draw_func:
3868
+ :param draw_func:
2594
3869
  """
2595
3870
  ...
2596
3871
 
2597
- def property_overridable_library_set(self):
2598
- """ """
3872
+ def property_overridable_library_set(self) -> bool:
3873
+ """Define a property as overridable or not (only for custom properties!).
3874
+
3875
+ :return: True when the overridable status of the property was successfully set.
3876
+ :rtype: bool
3877
+ """
2599
3878
  ...
2600
3879
 
2601
3880
  def property_unset(self):
2602
- """ """
3881
+ """Unset a property, will use default value afterward."""
2603
3882
  ...
2604
3883
 
2605
3884
  def remove(self, draw_func):
2606
- """
3885
+ """Remove a draw function that has been added to this menu
2607
3886
 
2608
3887
  :param draw_func:
2609
3888
  """
2610
3889
  ...
2611
3890
 
2612
3891
  def type_recast(self):
2613
- """ """
3892
+ """Return a new instance, this is needed because types
3893
+ such as textures can be changed at runtime.
3894
+
3895
+ :return: a new instance of this object with the type initialized again.
3896
+ """
2614
3897
  ...
2615
3898
 
2616
3899
  def values(self):
2617
- """ """
3900
+ """Returns the values of this objects custom properties (matches Python's
3901
+ dictionary function of the same name).
3902
+
3903
+ :return: custom property values.
3904
+ """
2618
3905
  ...
2619
3906
 
2620
3907
  class TEXT_PT_properties(bpy_types.Panel, bpy_types._GenericUI):
2621
- """ """
2622
-
2623
3908
  bl_category: typing.Any
2624
- """ """
2625
-
2626
3909
  bl_label: typing.Any
2627
- """ """
2628
-
2629
3910
  bl_region_type: typing.Any
2630
- """ """
2631
-
2632
3911
  bl_rna: typing.Any
2633
- """ """
2634
-
2635
3912
  bl_space_type: typing.Any
2636
- """ """
2637
-
2638
3913
  id_data: typing.Any
2639
- """ """
2640
3914
 
2641
3915
  def append(self, draw_func):
2642
- """
3916
+ """Append a draw function to this menu,
3917
+ takes the same arguments as the menus draw function
2643
3918
 
2644
- :param draw_func:
3919
+ :param draw_func:
2645
3920
  """
2646
3921
  ...
2647
3922
 
2648
- def as_pointer(self):
2649
- """ """
3923
+ def as_pointer(self) -> int:
3924
+ """Returns the memory address which holds a pointer to Blender's internal data
3925
+
3926
+ :return: int (memory address).
3927
+ :rtype: int
3928
+ """
2650
3929
  ...
2651
3930
 
2652
- def bl_rna_get_subclass(self):
2653
- """ """
3931
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3932
+ """
3933
+
3934
+ :return: The RNA type or default when not found.
3935
+ :rtype: bpy.types.Struct
3936
+ """
2654
3937
  ...
2655
3938
 
2656
- def bl_rna_get_subclass_py(self):
2657
- """ """
3939
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3940
+ """
3941
+
3942
+ :return: The class or default when not found.
3943
+ :rtype: typing.Any
3944
+ """
2658
3945
  ...
2659
3946
 
2660
3947
  def draw(self, context):
@@ -2664,104 +3951,174 @@ class TEXT_PT_properties(bpy_types.Panel, bpy_types._GenericUI):
2664
3951
  """
2665
3952
  ...
2666
3953
 
2667
- def driver_add(self):
2668
- """ """
3954
+ def driver_add(self) -> bpy.types.FCurve:
3955
+ """Adds driver(s) to the given property
3956
+
3957
+ :return: The driver(s) added.
3958
+ :rtype: bpy.types.FCurve
3959
+ """
2669
3960
  ...
2670
3961
 
2671
- def driver_remove(self):
2672
- """ """
3962
+ def driver_remove(self) -> bool:
3963
+ """Remove driver(s) from the given property
3964
+
3965
+ :return: Success of driver removal.
3966
+ :rtype: bool
3967
+ """
2673
3968
  ...
2674
3969
 
2675
3970
  def get(self):
2676
- """ """
3971
+ """Returns the value of the custom property assigned to key or default
3972
+ when not found (matches Python's dictionary function of the same name).
3973
+
3974
+ """
2677
3975
  ...
2678
3976
 
2679
3977
  def id_properties_clear(self):
2680
- """ """
3978
+ """
3979
+
3980
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3981
+ """
2681
3982
  ...
2682
3983
 
2683
3984
  def id_properties_ensure(self):
2684
- """ """
3985
+ """
3986
+
3987
+ :return: the parent group for an RNA struct's custom IDProperties.
3988
+ """
2685
3989
  ...
2686
3990
 
2687
3991
  def id_properties_ui(self):
2688
- """ """
2689
- ...
3992
+ """
2690
3993
 
2691
- def is_extended(self):
2692
- """ """
3994
+ :return: Return an object used to manage an IDProperty's UI data.
3995
+ """
2693
3996
  ...
2694
3997
 
2695
- def is_property_hidden(self):
2696
- """ """
3998
+ def is_extended(self): ...
3999
+ def is_property_hidden(self) -> bool:
4000
+ """Check if a property is hidden.
4001
+
4002
+ :return: True when the property is hidden.
4003
+ :rtype: bool
4004
+ """
2697
4005
  ...
2698
4006
 
2699
- def is_property_overridable_library(self):
2700
- """ """
4007
+ def is_property_overridable_library(self) -> bool:
4008
+ """Check if a property is overridable.
4009
+
4010
+ :return: True when the property is overridable.
4011
+ :rtype: bool
4012
+ """
2701
4013
  ...
2702
4014
 
2703
- def is_property_readonly(self):
2704
- """ """
4015
+ def is_property_readonly(self) -> bool:
4016
+ """Check if a property is readonly.
4017
+
4018
+ :return: True when the property is readonly (not writable).
4019
+ :rtype: bool
4020
+ """
2705
4021
  ...
2706
4022
 
2707
- def is_property_set(self):
2708
- """ """
4023
+ def is_property_set(self) -> bool:
4024
+ """Check if a property is set, use for testing operator properties.
4025
+
4026
+ :return: True when the property has been set.
4027
+ :rtype: bool
4028
+ """
2709
4029
  ...
2710
4030
 
2711
4031
  def items(self):
2712
- """ """
4032
+ """Returns the items of this objects custom properties (matches Python's
4033
+ dictionary function of the same name).
4034
+
4035
+ :return: custom property key, value pairs.
4036
+ """
2713
4037
  ...
2714
4038
 
2715
- def keyframe_delete(self):
2716
- """ """
4039
+ def keyframe_delete(self) -> bool:
4040
+ """Remove a keyframe from this properties fcurve.
4041
+
4042
+ :return: Success of keyframe deletion.
4043
+ :rtype: bool
4044
+ """
2717
4045
  ...
2718
4046
 
2719
- def keyframe_insert(self):
2720
- """ """
4047
+ def keyframe_insert(self) -> bool:
4048
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4049
+
4050
+ :return: Success of keyframe insertion.
4051
+ :rtype: bool
4052
+ """
2721
4053
  ...
2722
4054
 
2723
4055
  def keys(self):
2724
- """ """
4056
+ """Returns the keys of this objects custom properties (matches Python's
4057
+ dictionary function of the same name).
4058
+
4059
+ :return: custom property keys.
4060
+ """
2725
4061
  ...
2726
4062
 
2727
- def path_from_id(self):
2728
- """ """
4063
+ def path_from_id(self) -> str:
4064
+ """Returns the data path from the ID to this object (string).
4065
+
4066
+ :return: The path from `bpy.types.bpy_struct.id_data`
4067
+ to this struct and property (when given).
4068
+ :rtype: str
4069
+ """
2729
4070
  ...
2730
4071
 
2731
4072
  def path_resolve(self):
2732
- """ """
4073
+ """Returns the property from the path, raise an exception when not found."""
2733
4074
  ...
2734
4075
 
2735
4076
  def pop(self):
2736
- """ """
4077
+ """Remove and return the value of the custom property assigned to key or default
4078
+ when not found (matches Python's dictionary function of the same name).
4079
+
4080
+ """
2737
4081
  ...
2738
4082
 
2739
4083
  def prepend(self, draw_func):
2740
- """
4084
+ """Prepend a draw function to this menu, takes the same arguments as
4085
+ the menus draw function
2741
4086
 
2742
- :param draw_func:
4087
+ :param draw_func:
2743
4088
  """
2744
4089
  ...
2745
4090
 
2746
- def property_overridable_library_set(self):
2747
- """ """
4091
+ def property_overridable_library_set(self) -> bool:
4092
+ """Define a property as overridable or not (only for custom properties!).
4093
+
4094
+ :return: True when the overridable status of the property was successfully set.
4095
+ :rtype: bool
4096
+ """
2748
4097
  ...
2749
4098
 
2750
4099
  def property_unset(self):
2751
- """ """
4100
+ """Unset a property, will use default value afterward."""
2752
4101
  ...
2753
4102
 
2754
4103
  def remove(self, draw_func):
2755
- """
4104
+ """Remove a draw function that has been added to this menu
2756
4105
 
2757
4106
  :param draw_func:
2758
4107
  """
2759
4108
  ...
2760
4109
 
2761
4110
  def type_recast(self):
2762
- """ """
4111
+ """Return a new instance, this is needed because types
4112
+ such as textures can be changed at runtime.
4113
+
4114
+ :return: a new instance of this object with the type initialized again.
4115
+ """
2763
4116
  ...
2764
4117
 
2765
4118
  def values(self):
2766
- """ """
4119
+ """Returns the values of this objects custom properties (matches Python's
4120
+ dictionary function of the same name).
4121
+
4122
+ :return: custom property values.
4123
+ """
2767
4124
  ...