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

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

Potentially problematic release.


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

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