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