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")
@@ -22,22 +23,35 @@ class MASK_MT_add(bpy_types.Menu, bpy_types._GenericUI):
22
23
  """ """
23
24
 
24
25
  def append(self, draw_func):
25
- """
26
+ """Append a draw function to this menu,
27
+ takes the same arguments as the menus draw function
26
28
 
27
- :param draw_func:
29
+ :param draw_func:
28
30
  """
29
31
  ...
30
32
 
31
- def as_pointer(self):
32
- """ """
33
+ def as_pointer(self) -> int:
34
+ """Returns the memory address which holds a pointer to Blender's internal data
35
+
36
+ :return: int (memory address).
37
+ :rtype: int
38
+ """
33
39
  ...
34
40
 
35
- def bl_rna_get_subclass(self):
36
- """ """
41
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
42
+ """
43
+
44
+ :return: The RNA type or default when not found.
45
+ :rtype: bpy.types.Struct
46
+ """
37
47
  ...
38
48
 
39
- def bl_rna_get_subclass_py(self):
40
- """ """
49
+ def bl_rna_get_subclass_py(self) -> typing.Any:
50
+ """
51
+
52
+ :return: The class or default when not found.
53
+ :rtype: typing.Any
54
+ """
41
55
  ...
42
56
 
43
57
  def draw(self, _context):
@@ -56,138 +70,224 @@ class MASK_MT_add(bpy_types.Menu, bpy_types._GenericUI):
56
70
  ...
57
71
 
58
72
  def draw_preset(self, _context):
59
- """
73
+ """Define these on the subclass:
74
+ - preset_operator (string)
75
+ - preset_subdir (string)Optionally:
76
+ - preset_add_operator (string)
77
+ - preset_extensions (set of strings)
78
+ - preset_operator_defaults (dict of keyword args)
60
79
 
61
- :param _context:
80
+ :param _context:
62
81
  """
63
82
  ...
64
83
 
65
- def driver_add(self):
66
- """ """
84
+ def driver_add(self) -> bpy.types.FCurve:
85
+ """Adds driver(s) to the given property
86
+
87
+ :return: The driver(s) added.
88
+ :rtype: bpy.types.FCurve
89
+ """
67
90
  ...
68
91
 
69
- def driver_remove(self):
70
- """ """
92
+ def driver_remove(self) -> bool:
93
+ """Remove driver(s) from the given property
94
+
95
+ :return: Success of driver removal.
96
+ :rtype: bool
97
+ """
71
98
  ...
72
99
 
73
100
  def get(self):
74
- """ """
101
+ """Returns the value of the custom property assigned to key or default
102
+ when not found (matches Python's dictionary function of the same name).
103
+
104
+ """
75
105
  ...
76
106
 
77
107
  def id_properties_clear(self):
78
- """ """
108
+ """
109
+
110
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
111
+ """
79
112
  ...
80
113
 
81
114
  def id_properties_ensure(self):
82
- """ """
115
+ """
116
+
117
+ :return: the parent group for an RNA struct's custom IDProperties.
118
+ """
83
119
  ...
84
120
 
85
121
  def id_properties_ui(self):
86
- """ """
122
+ """
123
+
124
+ :return: Return an object used to manage an IDProperty's UI data.
125
+ """
87
126
  ...
88
127
 
89
128
  def is_extended(self):
90
129
  """ """
91
130
  ...
92
131
 
93
- def is_property_hidden(self):
94
- """ """
132
+ def is_property_hidden(self) -> bool:
133
+ """Check if a property is hidden.
134
+
135
+ :return: True when the property is hidden.
136
+ :rtype: bool
137
+ """
95
138
  ...
96
139
 
97
- def is_property_overridable_library(self):
98
- """ """
140
+ def is_property_overridable_library(self) -> bool:
141
+ """Check if a property is overridable.
142
+
143
+ :return: True when the property is overridable.
144
+ :rtype: bool
145
+ """
99
146
  ...
100
147
 
101
- def is_property_readonly(self):
102
- """ """
148
+ def is_property_readonly(self) -> bool:
149
+ """Check if a property is readonly.
150
+
151
+ :return: True when the property is readonly (not writable).
152
+ :rtype: bool
153
+ """
103
154
  ...
104
155
 
105
- def is_property_set(self):
106
- """ """
156
+ def is_property_set(self) -> bool:
157
+ """Check if a property is set, use for testing operator properties.
158
+
159
+ :return: True when the property has been set.
160
+ :rtype: bool
161
+ """
107
162
  ...
108
163
 
109
164
  def items(self):
110
- """ """
165
+ """Returns the items of this objects custom properties (matches Python's
166
+ dictionary function of the same name).
167
+
168
+ :return: custom property key, value pairs.
169
+ """
111
170
  ...
112
171
 
113
- def keyframe_delete(self):
114
- """ """
172
+ def keyframe_delete(self) -> bool:
173
+ """Remove a keyframe from this properties fcurve.
174
+
175
+ :return: Success of keyframe deletion.
176
+ :rtype: bool
177
+ """
115
178
  ...
116
179
 
117
- def keyframe_insert(self):
118
- """ """
180
+ def keyframe_insert(self) -> bool:
181
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
182
+
183
+ :return: Success of keyframe insertion.
184
+ :rtype: bool
185
+ """
119
186
  ...
120
187
 
121
188
  def keys(self):
122
- """ """
189
+ """Returns the keys of this objects custom properties (matches Python's
190
+ dictionary function of the same name).
191
+
192
+ :return: custom property keys.
193
+ """
123
194
  ...
124
195
 
125
- def path_from_id(self):
126
- """ """
196
+ def path_from_id(self) -> str:
197
+ """Returns the data path from the ID to this object (string).
198
+
199
+ :return: The path from `bpy.types.bpy_struct.id_data`
200
+ to this struct and property (when given).
201
+ :rtype: str
202
+ """
127
203
  ...
128
204
 
129
205
  def path_menu(
130
206
  self,
131
- searchpaths,
132
- operator,
133
- props_default,
134
- prop_filepath,
135
- filter_ext,
136
- filter_path,
137
- display_name,
138
- add_operator,
139
- add_operator_props,
207
+ searchpaths: list[str],
208
+ operator: str,
209
+ props_default: dict = None,
210
+ prop_filepath: str = "filepath",
211
+ filter_ext: typing.Callable = None,
212
+ filter_path=None,
213
+ display_name: typing.Callable = None,
214
+ add_operator=None,
215
+ add_operator_props=None,
140
216
  ):
141
- """
217
+ """Populate a menu from a list of paths.
218
+
219
+ :param searchpaths: Paths to scan.
220
+ :type searchpaths: list[str]
221
+ :param operator: The operator id to use with each file.
222
+ :type operator: str
223
+ :param props_default: Properties to assign to each operator.
224
+ :type props_default: dict
225
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
226
+ :type prop_filepath: str
227
+ :param filter_ext: Optional callback that takes the file extensions.
142
228
 
143
- :param searchpaths:
144
- :param operator:
145
- :param props_default:
146
- :param prop_filepath:
147
- :param filter_ext:
148
- :param filter_path:
149
- :param display_name:
150
- :param add_operator:
151
- :param add_operator_props:
229
+ Returning false excludes the file from the list.
230
+ :type filter_ext: typing.Callable
231
+ :param filter_path:
232
+ :param display_name: Optional callback that takes the full path, returns the name to display.
233
+ :type display_name: typing.Callable
234
+ :param add_operator:
235
+ :param add_operator_props:
152
236
  """
153
237
  ...
154
238
 
155
239
  def path_resolve(self):
156
- """ """
240
+ """Returns the property from the path, raise an exception when not found."""
157
241
  ...
158
242
 
159
243
  def pop(self):
160
- """ """
244
+ """Remove and return the value of the custom property assigned to key or default
245
+ when not found (matches Python's dictionary function of the same name).
246
+
247
+ """
161
248
  ...
162
249
 
163
250
  def prepend(self, draw_func):
164
- """
251
+ """Prepend a draw function to this menu, takes the same arguments as
252
+ the menus draw function
165
253
 
166
- :param draw_func:
254
+ :param draw_func:
167
255
  """
168
256
  ...
169
257
 
170
- def property_overridable_library_set(self):
171
- """ """
258
+ def property_overridable_library_set(self) -> bool:
259
+ """Define a property as overridable or not (only for custom properties!).
260
+
261
+ :return: True when the overridable status of the property was successfully set.
262
+ :rtype: bool
263
+ """
172
264
  ...
173
265
 
174
266
  def property_unset(self):
175
- """ """
267
+ """Unset a property, will use default value afterward."""
176
268
  ...
177
269
 
178
270
  def remove(self, draw_func):
179
- """
271
+ """Remove a draw function that has been added to this menu
180
272
 
181
273
  :param draw_func:
182
274
  """
183
275
  ...
184
276
 
185
277
  def type_recast(self):
186
- """ """
278
+ """Return a new instance, this is needed because types
279
+ such as textures can be changed at runtime.
280
+
281
+ :return: a new instance of this object with the type initialized again.
282
+ """
187
283
  ...
188
284
 
189
285
  def values(self):
190
- """ """
286
+ """Returns the values of this objects custom properties (matches Python's
287
+ dictionary function of the same name).
288
+
289
+ :return: custom property values.
290
+ """
191
291
  ...
192
292
 
193
293
  class MASK_MT_animation(bpy_types.Menu, bpy_types._GenericUI):
@@ -203,22 +303,35 @@ class MASK_MT_animation(bpy_types.Menu, bpy_types._GenericUI):
203
303
  """ """
204
304
 
205
305
  def append(self, draw_func):
206
- """
306
+ """Append a draw function to this menu,
307
+ takes the same arguments as the menus draw function
207
308
 
208
- :param draw_func:
309
+ :param draw_func:
209
310
  """
210
311
  ...
211
312
 
212
- def as_pointer(self):
213
- """ """
313
+ def as_pointer(self) -> int:
314
+ """Returns the memory address which holds a pointer to Blender's internal data
315
+
316
+ :return: int (memory address).
317
+ :rtype: int
318
+ """
214
319
  ...
215
320
 
216
- def bl_rna_get_subclass(self):
217
- """ """
321
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
322
+ """
323
+
324
+ :return: The RNA type or default when not found.
325
+ :rtype: bpy.types.Struct
326
+ """
218
327
  ...
219
328
 
220
- def bl_rna_get_subclass_py(self):
221
- """ """
329
+ def bl_rna_get_subclass_py(self) -> typing.Any:
330
+ """
331
+
332
+ :return: The class or default when not found.
333
+ :rtype: typing.Any
334
+ """
222
335
  ...
223
336
 
224
337
  def draw(self, _context):
@@ -237,138 +350,224 @@ class MASK_MT_animation(bpy_types.Menu, bpy_types._GenericUI):
237
350
  ...
238
351
 
239
352
  def draw_preset(self, _context):
240
- """
353
+ """Define these on the subclass:
354
+ - preset_operator (string)
355
+ - preset_subdir (string)Optionally:
356
+ - preset_add_operator (string)
357
+ - preset_extensions (set of strings)
358
+ - preset_operator_defaults (dict of keyword args)
241
359
 
242
- :param _context:
360
+ :param _context:
243
361
  """
244
362
  ...
245
363
 
246
- def driver_add(self):
247
- """ """
364
+ def driver_add(self) -> bpy.types.FCurve:
365
+ """Adds driver(s) to the given property
366
+
367
+ :return: The driver(s) added.
368
+ :rtype: bpy.types.FCurve
369
+ """
248
370
  ...
249
371
 
250
- def driver_remove(self):
251
- """ """
372
+ def driver_remove(self) -> bool:
373
+ """Remove driver(s) from the given property
374
+
375
+ :return: Success of driver removal.
376
+ :rtype: bool
377
+ """
252
378
  ...
253
379
 
254
380
  def get(self):
255
- """ """
381
+ """Returns the value of the custom property assigned to key or default
382
+ when not found (matches Python's dictionary function of the same name).
383
+
384
+ """
256
385
  ...
257
386
 
258
387
  def id_properties_clear(self):
259
- """ """
388
+ """
389
+
390
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
391
+ """
260
392
  ...
261
393
 
262
394
  def id_properties_ensure(self):
263
- """ """
395
+ """
396
+
397
+ :return: the parent group for an RNA struct's custom IDProperties.
398
+ """
264
399
  ...
265
400
 
266
401
  def id_properties_ui(self):
267
- """ """
402
+ """
403
+
404
+ :return: Return an object used to manage an IDProperty's UI data.
405
+ """
268
406
  ...
269
407
 
270
408
  def is_extended(self):
271
409
  """ """
272
410
  ...
273
411
 
274
- def is_property_hidden(self):
275
- """ """
412
+ def is_property_hidden(self) -> bool:
413
+ """Check if a property is hidden.
414
+
415
+ :return: True when the property is hidden.
416
+ :rtype: bool
417
+ """
276
418
  ...
277
419
 
278
- def is_property_overridable_library(self):
279
- """ """
420
+ def is_property_overridable_library(self) -> bool:
421
+ """Check if a property is overridable.
422
+
423
+ :return: True when the property is overridable.
424
+ :rtype: bool
425
+ """
280
426
  ...
281
427
 
282
- def is_property_readonly(self):
283
- """ """
428
+ def is_property_readonly(self) -> bool:
429
+ """Check if a property is readonly.
430
+
431
+ :return: True when the property is readonly (not writable).
432
+ :rtype: bool
433
+ """
284
434
  ...
285
435
 
286
- def is_property_set(self):
287
- """ """
436
+ def is_property_set(self) -> bool:
437
+ """Check if a property is set, use for testing operator properties.
438
+
439
+ :return: True when the property has been set.
440
+ :rtype: bool
441
+ """
288
442
  ...
289
443
 
290
444
  def items(self):
291
- """ """
445
+ """Returns the items of this objects custom properties (matches Python's
446
+ dictionary function of the same name).
447
+
448
+ :return: custom property key, value pairs.
449
+ """
292
450
  ...
293
451
 
294
- def keyframe_delete(self):
295
- """ """
452
+ def keyframe_delete(self) -> bool:
453
+ """Remove a keyframe from this properties fcurve.
454
+
455
+ :return: Success of keyframe deletion.
456
+ :rtype: bool
457
+ """
296
458
  ...
297
459
 
298
- def keyframe_insert(self):
299
- """ """
460
+ def keyframe_insert(self) -> bool:
461
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
462
+
463
+ :return: Success of keyframe insertion.
464
+ :rtype: bool
465
+ """
300
466
  ...
301
467
 
302
468
  def keys(self):
303
- """ """
469
+ """Returns the keys of this objects custom properties (matches Python's
470
+ dictionary function of the same name).
471
+
472
+ :return: custom property keys.
473
+ """
304
474
  ...
305
475
 
306
- def path_from_id(self):
307
- """ """
476
+ def path_from_id(self) -> str:
477
+ """Returns the data path from the ID to this object (string).
478
+
479
+ :return: The path from `bpy.types.bpy_struct.id_data`
480
+ to this struct and property (when given).
481
+ :rtype: str
482
+ """
308
483
  ...
309
484
 
310
485
  def path_menu(
311
486
  self,
312
- searchpaths,
313
- operator,
314
- props_default,
315
- prop_filepath,
316
- filter_ext,
317
- filter_path,
318
- display_name,
319
- add_operator,
320
- add_operator_props,
487
+ searchpaths: list[str],
488
+ operator: str,
489
+ props_default: dict = None,
490
+ prop_filepath: str = "filepath",
491
+ filter_ext: typing.Callable = None,
492
+ filter_path=None,
493
+ display_name: typing.Callable = None,
494
+ add_operator=None,
495
+ add_operator_props=None,
321
496
  ):
322
- """
497
+ """Populate a menu from a list of paths.
323
498
 
324
- :param searchpaths:
325
- :param operator:
326
- :param props_default:
327
- :param prop_filepath:
328
- :param filter_ext:
329
- :param filter_path:
330
- :param display_name:
331
- :param add_operator:
332
- :param add_operator_props:
499
+ :param searchpaths: Paths to scan.
500
+ :type searchpaths: list[str]
501
+ :param operator: The operator id to use with each file.
502
+ :type operator: str
503
+ :param props_default: Properties to assign to each operator.
504
+ :type props_default: dict
505
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
506
+ :type prop_filepath: str
507
+ :param filter_ext: Optional callback that takes the file extensions.
508
+
509
+ Returning false excludes the file from the list.
510
+ :type filter_ext: typing.Callable
511
+ :param filter_path:
512
+ :param display_name: Optional callback that takes the full path, returns the name to display.
513
+ :type display_name: typing.Callable
514
+ :param add_operator:
515
+ :param add_operator_props:
333
516
  """
334
517
  ...
335
518
 
336
519
  def path_resolve(self):
337
- """ """
520
+ """Returns the property from the path, raise an exception when not found."""
338
521
  ...
339
522
 
340
523
  def pop(self):
341
- """ """
524
+ """Remove and return the value of the custom property assigned to key or default
525
+ when not found (matches Python's dictionary function of the same name).
526
+
527
+ """
342
528
  ...
343
529
 
344
530
  def prepend(self, draw_func):
345
- """
531
+ """Prepend a draw function to this menu, takes the same arguments as
532
+ the menus draw function
346
533
 
347
- :param draw_func:
534
+ :param draw_func:
348
535
  """
349
536
  ...
350
537
 
351
- def property_overridable_library_set(self):
352
- """ """
538
+ def property_overridable_library_set(self) -> bool:
539
+ """Define a property as overridable or not (only for custom properties!).
540
+
541
+ :return: True when the overridable status of the property was successfully set.
542
+ :rtype: bool
543
+ """
353
544
  ...
354
545
 
355
546
  def property_unset(self):
356
- """ """
547
+ """Unset a property, will use default value afterward."""
357
548
  ...
358
549
 
359
550
  def remove(self, draw_func):
360
- """
551
+ """Remove a draw function that has been added to this menu
361
552
 
362
553
  :param draw_func:
363
554
  """
364
555
  ...
365
556
 
366
557
  def type_recast(self):
367
- """ """
558
+ """Return a new instance, this is needed because types
559
+ such as textures can be changed at runtime.
560
+
561
+ :return: a new instance of this object with the type initialized again.
562
+ """
368
563
  ...
369
564
 
370
565
  def values(self):
371
- """ """
566
+ """Returns the values of this objects custom properties (matches Python's
567
+ dictionary function of the same name).
568
+
569
+ :return: custom property values.
570
+ """
372
571
  ...
373
572
 
374
573
  class MASK_MT_mask(bpy_types.Menu, bpy_types._GenericUI):
@@ -384,22 +583,35 @@ class MASK_MT_mask(bpy_types.Menu, bpy_types._GenericUI):
384
583
  """ """
385
584
 
386
585
  def append(self, draw_func):
387
- """
586
+ """Append a draw function to this menu,
587
+ takes the same arguments as the menus draw function
388
588
 
389
- :param draw_func:
589
+ :param draw_func:
390
590
  """
391
591
  ...
392
592
 
393
- def as_pointer(self):
394
- """ """
593
+ def as_pointer(self) -> int:
594
+ """Returns the memory address which holds a pointer to Blender's internal data
595
+
596
+ :return: int (memory address).
597
+ :rtype: int
598
+ """
395
599
  ...
396
600
 
397
- def bl_rna_get_subclass(self):
398
- """ """
601
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
602
+ """
603
+
604
+ :return: The RNA type or default when not found.
605
+ :rtype: bpy.types.Struct
606
+ """
399
607
  ...
400
608
 
401
- def bl_rna_get_subclass_py(self):
402
- """ """
609
+ def bl_rna_get_subclass_py(self) -> typing.Any:
610
+ """
611
+
612
+ :return: The class or default when not found.
613
+ :rtype: typing.Any
614
+ """
403
615
  ...
404
616
 
405
617
  def draw(self, _context):
@@ -418,138 +630,224 @@ class MASK_MT_mask(bpy_types.Menu, bpy_types._GenericUI):
418
630
  ...
419
631
 
420
632
  def draw_preset(self, _context):
421
- """
633
+ """Define these on the subclass:
634
+ - preset_operator (string)
635
+ - preset_subdir (string)Optionally:
636
+ - preset_add_operator (string)
637
+ - preset_extensions (set of strings)
638
+ - preset_operator_defaults (dict of keyword args)
422
639
 
423
- :param _context:
640
+ :param _context:
424
641
  """
425
642
  ...
426
643
 
427
- def driver_add(self):
428
- """ """
644
+ def driver_add(self) -> bpy.types.FCurve:
645
+ """Adds driver(s) to the given property
646
+
647
+ :return: The driver(s) added.
648
+ :rtype: bpy.types.FCurve
649
+ """
429
650
  ...
430
651
 
431
- def driver_remove(self):
432
- """ """
652
+ def driver_remove(self) -> bool:
653
+ """Remove driver(s) from the given property
654
+
655
+ :return: Success of driver removal.
656
+ :rtype: bool
657
+ """
433
658
  ...
434
659
 
435
660
  def get(self):
436
- """ """
661
+ """Returns the value of the custom property assigned to key or default
662
+ when not found (matches Python's dictionary function of the same name).
663
+
664
+ """
437
665
  ...
438
666
 
439
667
  def id_properties_clear(self):
440
- """ """
668
+ """
669
+
670
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
671
+ """
441
672
  ...
442
673
 
443
674
  def id_properties_ensure(self):
444
- """ """
675
+ """
676
+
677
+ :return: the parent group for an RNA struct's custom IDProperties.
678
+ """
445
679
  ...
446
680
 
447
681
  def id_properties_ui(self):
448
- """ """
682
+ """
683
+
684
+ :return: Return an object used to manage an IDProperty's UI data.
685
+ """
449
686
  ...
450
687
 
451
688
  def is_extended(self):
452
689
  """ """
453
690
  ...
454
691
 
455
- def is_property_hidden(self):
456
- """ """
692
+ def is_property_hidden(self) -> bool:
693
+ """Check if a property is hidden.
694
+
695
+ :return: True when the property is hidden.
696
+ :rtype: bool
697
+ """
457
698
  ...
458
699
 
459
- def is_property_overridable_library(self):
460
- """ """
700
+ def is_property_overridable_library(self) -> bool:
701
+ """Check if a property is overridable.
702
+
703
+ :return: True when the property is overridable.
704
+ :rtype: bool
705
+ """
461
706
  ...
462
707
 
463
- def is_property_readonly(self):
464
- """ """
708
+ def is_property_readonly(self) -> bool:
709
+ """Check if a property is readonly.
710
+
711
+ :return: True when the property is readonly (not writable).
712
+ :rtype: bool
713
+ """
465
714
  ...
466
715
 
467
- def is_property_set(self):
468
- """ """
716
+ def is_property_set(self) -> bool:
717
+ """Check if a property is set, use for testing operator properties.
718
+
719
+ :return: True when the property has been set.
720
+ :rtype: bool
721
+ """
469
722
  ...
470
723
 
471
724
  def items(self):
472
- """ """
725
+ """Returns the items of this objects custom properties (matches Python's
726
+ dictionary function of the same name).
727
+
728
+ :return: custom property key, value pairs.
729
+ """
473
730
  ...
474
731
 
475
- def keyframe_delete(self):
476
- """ """
732
+ def keyframe_delete(self) -> bool:
733
+ """Remove a keyframe from this properties fcurve.
734
+
735
+ :return: Success of keyframe deletion.
736
+ :rtype: bool
737
+ """
477
738
  ...
478
739
 
479
- def keyframe_insert(self):
480
- """ """
740
+ def keyframe_insert(self) -> bool:
741
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
742
+
743
+ :return: Success of keyframe insertion.
744
+ :rtype: bool
745
+ """
481
746
  ...
482
747
 
483
748
  def keys(self):
484
- """ """
749
+ """Returns the keys of this objects custom properties (matches Python's
750
+ dictionary function of the same name).
751
+
752
+ :return: custom property keys.
753
+ """
485
754
  ...
486
755
 
487
- def path_from_id(self):
488
- """ """
756
+ def path_from_id(self) -> str:
757
+ """Returns the data path from the ID to this object (string).
758
+
759
+ :return: The path from `bpy.types.bpy_struct.id_data`
760
+ to this struct and property (when given).
761
+ :rtype: str
762
+ """
489
763
  ...
490
764
 
491
765
  def path_menu(
492
766
  self,
493
- searchpaths,
494
- operator,
495
- props_default,
496
- prop_filepath,
497
- filter_ext,
498
- filter_path,
499
- display_name,
500
- add_operator,
501
- add_operator_props,
767
+ searchpaths: list[str],
768
+ operator: str,
769
+ props_default: dict = None,
770
+ prop_filepath: str = "filepath",
771
+ filter_ext: typing.Callable = None,
772
+ filter_path=None,
773
+ display_name: typing.Callable = None,
774
+ add_operator=None,
775
+ add_operator_props=None,
502
776
  ):
503
- """
777
+ """Populate a menu from a list of paths.
778
+
779
+ :param searchpaths: Paths to scan.
780
+ :type searchpaths: list[str]
781
+ :param operator: The operator id to use with each file.
782
+ :type operator: str
783
+ :param props_default: Properties to assign to each operator.
784
+ :type props_default: dict
785
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
786
+ :type prop_filepath: str
787
+ :param filter_ext: Optional callback that takes the file extensions.
504
788
 
505
- :param searchpaths:
506
- :param operator:
507
- :param props_default:
508
- :param prop_filepath:
509
- :param filter_ext:
510
- :param filter_path:
511
- :param display_name:
512
- :param add_operator:
513
- :param add_operator_props:
789
+ Returning false excludes the file from the list.
790
+ :type filter_ext: typing.Callable
791
+ :param filter_path:
792
+ :param display_name: Optional callback that takes the full path, returns the name to display.
793
+ :type display_name: typing.Callable
794
+ :param add_operator:
795
+ :param add_operator_props:
514
796
  """
515
797
  ...
516
798
 
517
799
  def path_resolve(self):
518
- """ """
800
+ """Returns the property from the path, raise an exception when not found."""
519
801
  ...
520
802
 
521
803
  def pop(self):
522
- """ """
804
+ """Remove and return the value of the custom property assigned to key or default
805
+ when not found (matches Python's dictionary function of the same name).
806
+
807
+ """
523
808
  ...
524
809
 
525
810
  def prepend(self, draw_func):
526
- """
811
+ """Prepend a draw function to this menu, takes the same arguments as
812
+ the menus draw function
527
813
 
528
- :param draw_func:
814
+ :param draw_func:
529
815
  """
530
816
  ...
531
817
 
532
- def property_overridable_library_set(self):
533
- """ """
818
+ def property_overridable_library_set(self) -> bool:
819
+ """Define a property as overridable or not (only for custom properties!).
820
+
821
+ :return: True when the overridable status of the property was successfully set.
822
+ :rtype: bool
823
+ """
534
824
  ...
535
825
 
536
826
  def property_unset(self):
537
- """ """
827
+ """Unset a property, will use default value afterward."""
538
828
  ...
539
829
 
540
830
  def remove(self, draw_func):
541
- """
831
+ """Remove a draw function that has been added to this menu
542
832
 
543
833
  :param draw_func:
544
834
  """
545
835
  ...
546
836
 
547
837
  def type_recast(self):
548
- """ """
838
+ """Return a new instance, this is needed because types
839
+ such as textures can be changed at runtime.
840
+
841
+ :return: a new instance of this object with the type initialized again.
842
+ """
549
843
  ...
550
844
 
551
845
  def values(self):
552
- """ """
846
+ """Returns the values of this objects custom properties (matches Python's
847
+ dictionary function of the same name).
848
+
849
+ :return: custom property values.
850
+ """
553
851
  ...
554
852
 
555
853
  class MASK_MT_select(bpy_types.Menu, bpy_types._GenericUI):
@@ -565,22 +863,35 @@ class MASK_MT_select(bpy_types.Menu, bpy_types._GenericUI):
565
863
  """ """
566
864
 
567
865
  def append(self, draw_func):
568
- """
866
+ """Append a draw function to this menu,
867
+ takes the same arguments as the menus draw function
569
868
 
570
- :param draw_func:
869
+ :param draw_func:
571
870
  """
572
871
  ...
573
872
 
574
- def as_pointer(self):
575
- """ """
873
+ def as_pointer(self) -> int:
874
+ """Returns the memory address which holds a pointer to Blender's internal data
875
+
876
+ :return: int (memory address).
877
+ :rtype: int
878
+ """
576
879
  ...
577
880
 
578
- def bl_rna_get_subclass(self):
579
- """ """
881
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
882
+ """
883
+
884
+ :return: The RNA type or default when not found.
885
+ :rtype: bpy.types.Struct
886
+ """
580
887
  ...
581
888
 
582
- def bl_rna_get_subclass_py(self):
583
- """ """
889
+ def bl_rna_get_subclass_py(self) -> typing.Any:
890
+ """
891
+
892
+ :return: The class or default when not found.
893
+ :rtype: typing.Any
894
+ """
584
895
  ...
585
896
 
586
897
  def draw(self, _context):
@@ -599,138 +910,224 @@ class MASK_MT_select(bpy_types.Menu, bpy_types._GenericUI):
599
910
  ...
600
911
 
601
912
  def draw_preset(self, _context):
602
- """
913
+ """Define these on the subclass:
914
+ - preset_operator (string)
915
+ - preset_subdir (string)Optionally:
916
+ - preset_add_operator (string)
917
+ - preset_extensions (set of strings)
918
+ - preset_operator_defaults (dict of keyword args)
603
919
 
604
- :param _context:
920
+ :param _context:
605
921
  """
606
922
  ...
607
923
 
608
- def driver_add(self):
609
- """ """
924
+ def driver_add(self) -> bpy.types.FCurve:
925
+ """Adds driver(s) to the given property
926
+
927
+ :return: The driver(s) added.
928
+ :rtype: bpy.types.FCurve
929
+ """
610
930
  ...
611
931
 
612
- def driver_remove(self):
613
- """ """
932
+ def driver_remove(self) -> bool:
933
+ """Remove driver(s) from the given property
934
+
935
+ :return: Success of driver removal.
936
+ :rtype: bool
937
+ """
614
938
  ...
615
939
 
616
940
  def get(self):
617
- """ """
941
+ """Returns the value of the custom property assigned to key or default
942
+ when not found (matches Python's dictionary function of the same name).
943
+
944
+ """
618
945
  ...
619
946
 
620
947
  def id_properties_clear(self):
621
- """ """
948
+ """
949
+
950
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
951
+ """
622
952
  ...
623
953
 
624
954
  def id_properties_ensure(self):
625
- """ """
955
+ """
956
+
957
+ :return: the parent group for an RNA struct's custom IDProperties.
958
+ """
626
959
  ...
627
960
 
628
961
  def id_properties_ui(self):
629
- """ """
962
+ """
963
+
964
+ :return: Return an object used to manage an IDProperty's UI data.
965
+ """
630
966
  ...
631
967
 
632
968
  def is_extended(self):
633
969
  """ """
634
970
  ...
635
971
 
636
- def is_property_hidden(self):
637
- """ """
972
+ def is_property_hidden(self) -> bool:
973
+ """Check if a property is hidden.
974
+
975
+ :return: True when the property is hidden.
976
+ :rtype: bool
977
+ """
638
978
  ...
639
979
 
640
- def is_property_overridable_library(self):
641
- """ """
980
+ def is_property_overridable_library(self) -> bool:
981
+ """Check if a property is overridable.
982
+
983
+ :return: True when the property is overridable.
984
+ :rtype: bool
985
+ """
642
986
  ...
643
987
 
644
- def is_property_readonly(self):
645
- """ """
988
+ def is_property_readonly(self) -> bool:
989
+ """Check if a property is readonly.
990
+
991
+ :return: True when the property is readonly (not writable).
992
+ :rtype: bool
993
+ """
646
994
  ...
647
995
 
648
- def is_property_set(self):
649
- """ """
996
+ def is_property_set(self) -> bool:
997
+ """Check if a property is set, use for testing operator properties.
998
+
999
+ :return: True when the property has been set.
1000
+ :rtype: bool
1001
+ """
650
1002
  ...
651
1003
 
652
1004
  def items(self):
653
- """ """
1005
+ """Returns the items of this objects custom properties (matches Python's
1006
+ dictionary function of the same name).
1007
+
1008
+ :return: custom property key, value pairs.
1009
+ """
654
1010
  ...
655
1011
 
656
- def keyframe_delete(self):
657
- """ """
1012
+ def keyframe_delete(self) -> bool:
1013
+ """Remove a keyframe from this properties fcurve.
1014
+
1015
+ :return: Success of keyframe deletion.
1016
+ :rtype: bool
1017
+ """
658
1018
  ...
659
1019
 
660
- def keyframe_insert(self):
661
- """ """
1020
+ def keyframe_insert(self) -> bool:
1021
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1022
+
1023
+ :return: Success of keyframe insertion.
1024
+ :rtype: bool
1025
+ """
662
1026
  ...
663
1027
 
664
1028
  def keys(self):
665
- """ """
1029
+ """Returns the keys of this objects custom properties (matches Python's
1030
+ dictionary function of the same name).
1031
+
1032
+ :return: custom property keys.
1033
+ """
666
1034
  ...
667
1035
 
668
- def path_from_id(self):
669
- """ """
1036
+ def path_from_id(self) -> str:
1037
+ """Returns the data path from the ID to this object (string).
1038
+
1039
+ :return: The path from `bpy.types.bpy_struct.id_data`
1040
+ to this struct and property (when given).
1041
+ :rtype: str
1042
+ """
670
1043
  ...
671
1044
 
672
1045
  def path_menu(
673
1046
  self,
674
- searchpaths,
675
- operator,
676
- props_default,
677
- prop_filepath,
678
- filter_ext,
679
- filter_path,
680
- display_name,
681
- add_operator,
682
- add_operator_props,
1047
+ searchpaths: list[str],
1048
+ operator: str,
1049
+ props_default: dict = None,
1050
+ prop_filepath: str = "filepath",
1051
+ filter_ext: typing.Callable = None,
1052
+ filter_path=None,
1053
+ display_name: typing.Callable = None,
1054
+ add_operator=None,
1055
+ add_operator_props=None,
683
1056
  ):
684
- """
1057
+ """Populate a menu from a list of paths.
685
1058
 
686
- :param searchpaths:
687
- :param operator:
688
- :param props_default:
689
- :param prop_filepath:
690
- :param filter_ext:
691
- :param filter_path:
692
- :param display_name:
693
- :param add_operator:
694
- :param add_operator_props:
1059
+ :param searchpaths: Paths to scan.
1060
+ :type searchpaths: list[str]
1061
+ :param operator: The operator id to use with each file.
1062
+ :type operator: str
1063
+ :param props_default: Properties to assign to each operator.
1064
+ :type props_default: dict
1065
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1066
+ :type prop_filepath: str
1067
+ :param filter_ext: Optional callback that takes the file extensions.
1068
+
1069
+ Returning false excludes the file from the list.
1070
+ :type filter_ext: typing.Callable
1071
+ :param filter_path:
1072
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1073
+ :type display_name: typing.Callable
1074
+ :param add_operator:
1075
+ :param add_operator_props:
695
1076
  """
696
1077
  ...
697
1078
 
698
1079
  def path_resolve(self):
699
- """ """
1080
+ """Returns the property from the path, raise an exception when not found."""
700
1081
  ...
701
1082
 
702
1083
  def pop(self):
703
- """ """
1084
+ """Remove and return the value of the custom property assigned to key or default
1085
+ when not found (matches Python's dictionary function of the same name).
1086
+
1087
+ """
704
1088
  ...
705
1089
 
706
1090
  def prepend(self, draw_func):
707
- """
1091
+ """Prepend a draw function to this menu, takes the same arguments as
1092
+ the menus draw function
708
1093
 
709
- :param draw_func:
1094
+ :param draw_func:
710
1095
  """
711
1096
  ...
712
1097
 
713
- def property_overridable_library_set(self):
714
- """ """
1098
+ def property_overridable_library_set(self) -> bool:
1099
+ """Define a property as overridable or not (only for custom properties!).
1100
+
1101
+ :return: True when the overridable status of the property was successfully set.
1102
+ :rtype: bool
1103
+ """
715
1104
  ...
716
1105
 
717
1106
  def property_unset(self):
718
- """ """
1107
+ """Unset a property, will use default value afterward."""
719
1108
  ...
720
1109
 
721
1110
  def remove(self, draw_func):
722
- """
1111
+ """Remove a draw function that has been added to this menu
723
1112
 
724
1113
  :param draw_func:
725
1114
  """
726
1115
  ...
727
1116
 
728
1117
  def type_recast(self):
729
- """ """
1118
+ """Return a new instance, this is needed because types
1119
+ such as textures can be changed at runtime.
1120
+
1121
+ :return: a new instance of this object with the type initialized again.
1122
+ """
730
1123
  ...
731
1124
 
732
1125
  def values(self):
733
- """ """
1126
+ """Returns the values of this objects custom properties (matches Python's
1127
+ dictionary function of the same name).
1128
+
1129
+ :return: custom property values.
1130
+ """
734
1131
  ...
735
1132
 
736
1133
  class MASK_MT_transform(bpy_types.Menu, bpy_types._GenericUI):
@@ -746,22 +1143,35 @@ class MASK_MT_transform(bpy_types.Menu, bpy_types._GenericUI):
746
1143
  """ """
747
1144
 
748
1145
  def append(self, draw_func):
749
- """
1146
+ """Append a draw function to this menu,
1147
+ takes the same arguments as the menus draw function
750
1148
 
751
- :param draw_func:
1149
+ :param draw_func:
752
1150
  """
753
1151
  ...
754
1152
 
755
- def as_pointer(self):
756
- """ """
1153
+ def as_pointer(self) -> int:
1154
+ """Returns the memory address which holds a pointer to Blender's internal data
1155
+
1156
+ :return: int (memory address).
1157
+ :rtype: int
1158
+ """
757
1159
  ...
758
1160
 
759
- def bl_rna_get_subclass(self):
760
- """ """
1161
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1162
+ """
1163
+
1164
+ :return: The RNA type or default when not found.
1165
+ :rtype: bpy.types.Struct
1166
+ """
761
1167
  ...
762
1168
 
763
- def bl_rna_get_subclass_py(self):
764
- """ """
1169
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1170
+ """
1171
+
1172
+ :return: The class or default when not found.
1173
+ :rtype: typing.Any
1174
+ """
765
1175
  ...
766
1176
 
767
1177
  def draw(self, _context):
@@ -780,138 +1190,224 @@ class MASK_MT_transform(bpy_types.Menu, bpy_types._GenericUI):
780
1190
  ...
781
1191
 
782
1192
  def draw_preset(self, _context):
783
- """
1193
+ """Define these on the subclass:
1194
+ - preset_operator (string)
1195
+ - preset_subdir (string)Optionally:
1196
+ - preset_add_operator (string)
1197
+ - preset_extensions (set of strings)
1198
+ - preset_operator_defaults (dict of keyword args)
784
1199
 
785
- :param _context:
1200
+ :param _context:
786
1201
  """
787
1202
  ...
788
1203
 
789
- def driver_add(self):
790
- """ """
1204
+ def driver_add(self) -> bpy.types.FCurve:
1205
+ """Adds driver(s) to the given property
1206
+
1207
+ :return: The driver(s) added.
1208
+ :rtype: bpy.types.FCurve
1209
+ """
791
1210
  ...
792
1211
 
793
- def driver_remove(self):
794
- """ """
1212
+ def driver_remove(self) -> bool:
1213
+ """Remove driver(s) from the given property
1214
+
1215
+ :return: Success of driver removal.
1216
+ :rtype: bool
1217
+ """
795
1218
  ...
796
1219
 
797
1220
  def get(self):
798
- """ """
1221
+ """Returns the value of the custom property assigned to key or default
1222
+ when not found (matches Python's dictionary function of the same name).
1223
+
1224
+ """
799
1225
  ...
800
1226
 
801
1227
  def id_properties_clear(self):
802
- """ """
1228
+ """
1229
+
1230
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1231
+ """
803
1232
  ...
804
1233
 
805
1234
  def id_properties_ensure(self):
806
- """ """
1235
+ """
1236
+
1237
+ :return: the parent group for an RNA struct's custom IDProperties.
1238
+ """
807
1239
  ...
808
1240
 
809
1241
  def id_properties_ui(self):
810
- """ """
1242
+ """
1243
+
1244
+ :return: Return an object used to manage an IDProperty's UI data.
1245
+ """
811
1246
  ...
812
1247
 
813
1248
  def is_extended(self):
814
1249
  """ """
815
1250
  ...
816
1251
 
817
- def is_property_hidden(self):
818
- """ """
1252
+ def is_property_hidden(self) -> bool:
1253
+ """Check if a property is hidden.
1254
+
1255
+ :return: True when the property is hidden.
1256
+ :rtype: bool
1257
+ """
819
1258
  ...
820
1259
 
821
- def is_property_overridable_library(self):
822
- """ """
1260
+ def is_property_overridable_library(self) -> bool:
1261
+ """Check if a property is overridable.
1262
+
1263
+ :return: True when the property is overridable.
1264
+ :rtype: bool
1265
+ """
823
1266
  ...
824
1267
 
825
- def is_property_readonly(self):
826
- """ """
1268
+ def is_property_readonly(self) -> bool:
1269
+ """Check if a property is readonly.
1270
+
1271
+ :return: True when the property is readonly (not writable).
1272
+ :rtype: bool
1273
+ """
827
1274
  ...
828
1275
 
829
- def is_property_set(self):
830
- """ """
1276
+ def is_property_set(self) -> bool:
1277
+ """Check if a property is set, use for testing operator properties.
1278
+
1279
+ :return: True when the property has been set.
1280
+ :rtype: bool
1281
+ """
831
1282
  ...
832
1283
 
833
1284
  def items(self):
834
- """ """
1285
+ """Returns the items of this objects custom properties (matches Python's
1286
+ dictionary function of the same name).
1287
+
1288
+ :return: custom property key, value pairs.
1289
+ """
835
1290
  ...
836
1291
 
837
- def keyframe_delete(self):
838
- """ """
1292
+ def keyframe_delete(self) -> bool:
1293
+ """Remove a keyframe from this properties fcurve.
1294
+
1295
+ :return: Success of keyframe deletion.
1296
+ :rtype: bool
1297
+ """
839
1298
  ...
840
1299
 
841
- def keyframe_insert(self):
842
- """ """
1300
+ def keyframe_insert(self) -> bool:
1301
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1302
+
1303
+ :return: Success of keyframe insertion.
1304
+ :rtype: bool
1305
+ """
843
1306
  ...
844
1307
 
845
1308
  def keys(self):
846
- """ """
1309
+ """Returns the keys of this objects custom properties (matches Python's
1310
+ dictionary function of the same name).
1311
+
1312
+ :return: custom property keys.
1313
+ """
847
1314
  ...
848
1315
 
849
- def path_from_id(self):
850
- """ """
1316
+ def path_from_id(self) -> str:
1317
+ """Returns the data path from the ID to this object (string).
1318
+
1319
+ :return: The path from `bpy.types.bpy_struct.id_data`
1320
+ to this struct and property (when given).
1321
+ :rtype: str
1322
+ """
851
1323
  ...
852
1324
 
853
1325
  def path_menu(
854
1326
  self,
855
- searchpaths,
856
- operator,
857
- props_default,
858
- prop_filepath,
859
- filter_ext,
860
- filter_path,
861
- display_name,
862
- add_operator,
863
- add_operator_props,
1327
+ searchpaths: list[str],
1328
+ operator: str,
1329
+ props_default: dict = None,
1330
+ prop_filepath: str = "filepath",
1331
+ filter_ext: typing.Callable = None,
1332
+ filter_path=None,
1333
+ display_name: typing.Callable = None,
1334
+ add_operator=None,
1335
+ add_operator_props=None,
864
1336
  ):
865
- """
1337
+ """Populate a menu from a list of paths.
866
1338
 
867
- :param searchpaths:
868
- :param operator:
869
- :param props_default:
870
- :param prop_filepath:
871
- :param filter_ext:
872
- :param filter_path:
873
- :param display_name:
874
- :param add_operator:
875
- :param add_operator_props:
1339
+ :param searchpaths: Paths to scan.
1340
+ :type searchpaths: list[str]
1341
+ :param operator: The operator id to use with each file.
1342
+ :type operator: str
1343
+ :param props_default: Properties to assign to each operator.
1344
+ :type props_default: dict
1345
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1346
+ :type prop_filepath: str
1347
+ :param filter_ext: Optional callback that takes the file extensions.
1348
+
1349
+ Returning false excludes the file from the list.
1350
+ :type filter_ext: typing.Callable
1351
+ :param filter_path:
1352
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1353
+ :type display_name: typing.Callable
1354
+ :param add_operator:
1355
+ :param add_operator_props:
876
1356
  """
877
1357
  ...
878
1358
 
879
1359
  def path_resolve(self):
880
- """ """
1360
+ """Returns the property from the path, raise an exception when not found."""
881
1361
  ...
882
1362
 
883
1363
  def pop(self):
884
- """ """
1364
+ """Remove and return the value of the custom property assigned to key or default
1365
+ when not found (matches Python's dictionary function of the same name).
1366
+
1367
+ """
885
1368
  ...
886
1369
 
887
1370
  def prepend(self, draw_func):
888
- """
1371
+ """Prepend a draw function to this menu, takes the same arguments as
1372
+ the menus draw function
889
1373
 
890
- :param draw_func:
1374
+ :param draw_func:
891
1375
  """
892
1376
  ...
893
1377
 
894
- def property_overridable_library_set(self):
895
- """ """
1378
+ def property_overridable_library_set(self) -> bool:
1379
+ """Define a property as overridable or not (only for custom properties!).
1380
+
1381
+ :return: True when the overridable status of the property was successfully set.
1382
+ :rtype: bool
1383
+ """
896
1384
  ...
897
1385
 
898
1386
  def property_unset(self):
899
- """ """
1387
+ """Unset a property, will use default value afterward."""
900
1388
  ...
901
1389
 
902
1390
  def remove(self, draw_func):
903
- """
1391
+ """Remove a draw function that has been added to this menu
904
1392
 
905
1393
  :param draw_func:
906
1394
  """
907
1395
  ...
908
1396
 
909
1397
  def type_recast(self):
910
- """ """
1398
+ """Return a new instance, this is needed because types
1399
+ such as textures can be changed at runtime.
1400
+
1401
+ :return: a new instance of this object with the type initialized again.
1402
+ """
911
1403
  ...
912
1404
 
913
1405
  def values(self):
914
- """ """
1406
+ """Returns the values of this objects custom properties (matches Python's
1407
+ dictionary function of the same name).
1408
+
1409
+ :return: custom property values.
1410
+ """
915
1411
  ...
916
1412
 
917
1413
  class MASK_MT_visibility(bpy_types.Menu, bpy_types._GenericUI):
@@ -927,22 +1423,35 @@ class MASK_MT_visibility(bpy_types.Menu, bpy_types._GenericUI):
927
1423
  """ """
928
1424
 
929
1425
  def append(self, draw_func):
930
- """
1426
+ """Append a draw function to this menu,
1427
+ takes the same arguments as the menus draw function
931
1428
 
932
- :param draw_func:
1429
+ :param draw_func:
933
1430
  """
934
1431
  ...
935
1432
 
936
- def as_pointer(self):
937
- """ """
1433
+ def as_pointer(self) -> int:
1434
+ """Returns the memory address which holds a pointer to Blender's internal data
1435
+
1436
+ :return: int (memory address).
1437
+ :rtype: int
1438
+ """
938
1439
  ...
939
1440
 
940
- def bl_rna_get_subclass(self):
941
- """ """
1441
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1442
+ """
1443
+
1444
+ :return: The RNA type or default when not found.
1445
+ :rtype: bpy.types.Struct
1446
+ """
942
1447
  ...
943
1448
 
944
- def bl_rna_get_subclass_py(self):
945
- """ """
1449
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1450
+ """
1451
+
1452
+ :return: The class or default when not found.
1453
+ :rtype: typing.Any
1454
+ """
946
1455
  ...
947
1456
 
948
1457
  def draw(self, _context):
@@ -961,138 +1470,224 @@ class MASK_MT_visibility(bpy_types.Menu, bpy_types._GenericUI):
961
1470
  ...
962
1471
 
963
1472
  def draw_preset(self, _context):
964
- """
1473
+ """Define these on the subclass:
1474
+ - preset_operator (string)
1475
+ - preset_subdir (string)Optionally:
1476
+ - preset_add_operator (string)
1477
+ - preset_extensions (set of strings)
1478
+ - preset_operator_defaults (dict of keyword args)
965
1479
 
966
- :param _context:
1480
+ :param _context:
967
1481
  """
968
1482
  ...
969
1483
 
970
- def driver_add(self):
971
- """ """
1484
+ def driver_add(self) -> bpy.types.FCurve:
1485
+ """Adds driver(s) to the given property
1486
+
1487
+ :return: The driver(s) added.
1488
+ :rtype: bpy.types.FCurve
1489
+ """
972
1490
  ...
973
1491
 
974
- def driver_remove(self):
975
- """ """
1492
+ def driver_remove(self) -> bool:
1493
+ """Remove driver(s) from the given property
1494
+
1495
+ :return: Success of driver removal.
1496
+ :rtype: bool
1497
+ """
976
1498
  ...
977
1499
 
978
1500
  def get(self):
979
- """ """
1501
+ """Returns the value of the custom property assigned to key or default
1502
+ when not found (matches Python's dictionary function of the same name).
1503
+
1504
+ """
980
1505
  ...
981
1506
 
982
1507
  def id_properties_clear(self):
983
- """ """
1508
+ """
1509
+
1510
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1511
+ """
984
1512
  ...
985
1513
 
986
1514
  def id_properties_ensure(self):
987
- """ """
1515
+ """
1516
+
1517
+ :return: the parent group for an RNA struct's custom IDProperties.
1518
+ """
988
1519
  ...
989
1520
 
990
1521
  def id_properties_ui(self):
991
- """ """
1522
+ """
1523
+
1524
+ :return: Return an object used to manage an IDProperty's UI data.
1525
+ """
992
1526
  ...
993
1527
 
994
1528
  def is_extended(self):
995
1529
  """ """
996
1530
  ...
997
1531
 
998
- def is_property_hidden(self):
999
- """ """
1532
+ def is_property_hidden(self) -> bool:
1533
+ """Check if a property is hidden.
1534
+
1535
+ :return: True when the property is hidden.
1536
+ :rtype: bool
1537
+ """
1000
1538
  ...
1001
1539
 
1002
- def is_property_overridable_library(self):
1003
- """ """
1540
+ def is_property_overridable_library(self) -> bool:
1541
+ """Check if a property is overridable.
1542
+
1543
+ :return: True when the property is overridable.
1544
+ :rtype: bool
1545
+ """
1004
1546
  ...
1005
1547
 
1006
- def is_property_readonly(self):
1007
- """ """
1548
+ def is_property_readonly(self) -> bool:
1549
+ """Check if a property is readonly.
1550
+
1551
+ :return: True when the property is readonly (not writable).
1552
+ :rtype: bool
1553
+ """
1008
1554
  ...
1009
1555
 
1010
- def is_property_set(self):
1011
- """ """
1556
+ def is_property_set(self) -> bool:
1557
+ """Check if a property is set, use for testing operator properties.
1558
+
1559
+ :return: True when the property has been set.
1560
+ :rtype: bool
1561
+ """
1012
1562
  ...
1013
1563
 
1014
1564
  def items(self):
1015
- """ """
1565
+ """Returns the items of this objects custom properties (matches Python's
1566
+ dictionary function of the same name).
1567
+
1568
+ :return: custom property key, value pairs.
1569
+ """
1016
1570
  ...
1017
1571
 
1018
- def keyframe_delete(self):
1019
- """ """
1572
+ def keyframe_delete(self) -> bool:
1573
+ """Remove a keyframe from this properties fcurve.
1574
+
1575
+ :return: Success of keyframe deletion.
1576
+ :rtype: bool
1577
+ """
1020
1578
  ...
1021
1579
 
1022
- def keyframe_insert(self):
1023
- """ """
1580
+ def keyframe_insert(self) -> bool:
1581
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1582
+
1583
+ :return: Success of keyframe insertion.
1584
+ :rtype: bool
1585
+ """
1024
1586
  ...
1025
1587
 
1026
1588
  def keys(self):
1027
- """ """
1589
+ """Returns the keys of this objects custom properties (matches Python's
1590
+ dictionary function of the same name).
1591
+
1592
+ :return: custom property keys.
1593
+ """
1028
1594
  ...
1029
1595
 
1030
- def path_from_id(self):
1031
- """ """
1596
+ def path_from_id(self) -> str:
1597
+ """Returns the data path from the ID to this object (string).
1598
+
1599
+ :return: The path from `bpy.types.bpy_struct.id_data`
1600
+ to this struct and property (when given).
1601
+ :rtype: str
1602
+ """
1032
1603
  ...
1033
1604
 
1034
1605
  def path_menu(
1035
1606
  self,
1036
- searchpaths,
1037
- operator,
1038
- props_default,
1039
- prop_filepath,
1040
- filter_ext,
1041
- filter_path,
1042
- display_name,
1043
- add_operator,
1044
- add_operator_props,
1607
+ searchpaths: list[str],
1608
+ operator: str,
1609
+ props_default: dict = None,
1610
+ prop_filepath: str = "filepath",
1611
+ filter_ext: typing.Callable = None,
1612
+ filter_path=None,
1613
+ display_name: typing.Callable = None,
1614
+ add_operator=None,
1615
+ add_operator_props=None,
1045
1616
  ):
1046
- """
1617
+ """Populate a menu from a list of paths.
1047
1618
 
1048
- :param searchpaths:
1049
- :param operator:
1050
- :param props_default:
1051
- :param prop_filepath:
1052
- :param filter_ext:
1053
- :param filter_path:
1054
- :param display_name:
1055
- :param add_operator:
1056
- :param add_operator_props:
1619
+ :param searchpaths: Paths to scan.
1620
+ :type searchpaths: list[str]
1621
+ :param operator: The operator id to use with each file.
1622
+ :type operator: str
1623
+ :param props_default: Properties to assign to each operator.
1624
+ :type props_default: dict
1625
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
1626
+ :type prop_filepath: str
1627
+ :param filter_ext: Optional callback that takes the file extensions.
1628
+
1629
+ Returning false excludes the file from the list.
1630
+ :type filter_ext: typing.Callable
1631
+ :param filter_path:
1632
+ :param display_name: Optional callback that takes the full path, returns the name to display.
1633
+ :type display_name: typing.Callable
1634
+ :param add_operator:
1635
+ :param add_operator_props:
1057
1636
  """
1058
1637
  ...
1059
1638
 
1060
1639
  def path_resolve(self):
1061
- """ """
1640
+ """Returns the property from the path, raise an exception when not found."""
1062
1641
  ...
1063
1642
 
1064
1643
  def pop(self):
1065
- """ """
1644
+ """Remove and return the value of the custom property assigned to key or default
1645
+ when not found (matches Python's dictionary function of the same name).
1646
+
1647
+ """
1066
1648
  ...
1067
1649
 
1068
1650
  def prepend(self, draw_func):
1069
- """
1651
+ """Prepend a draw function to this menu, takes the same arguments as
1652
+ the menus draw function
1070
1653
 
1071
- :param draw_func:
1654
+ :param draw_func:
1072
1655
  """
1073
1656
  ...
1074
1657
 
1075
- def property_overridable_library_set(self):
1076
- """ """
1658
+ def property_overridable_library_set(self) -> bool:
1659
+ """Define a property as overridable or not (only for custom properties!).
1660
+
1661
+ :return: True when the overridable status of the property was successfully set.
1662
+ :rtype: bool
1663
+ """
1077
1664
  ...
1078
1665
 
1079
1666
  def property_unset(self):
1080
- """ """
1667
+ """Unset a property, will use default value afterward."""
1081
1668
  ...
1082
1669
 
1083
1670
  def remove(self, draw_func):
1084
- """
1671
+ """Remove a draw function that has been added to this menu
1085
1672
 
1086
1673
  :param draw_func:
1087
1674
  """
1088
1675
  ...
1089
1676
 
1090
1677
  def type_recast(self):
1091
- """ """
1678
+ """Return a new instance, this is needed because types
1679
+ such as textures can be changed at runtime.
1680
+
1681
+ :return: a new instance of this object with the type initialized again.
1682
+ """
1092
1683
  ...
1093
1684
 
1094
1685
  def values(self):
1095
- """ """
1686
+ """Returns the values of this objects custom properties (matches Python's
1687
+ dictionary function of the same name).
1688
+
1689
+ :return: custom property values.
1690
+ """
1096
1691
  ...
1097
1692
 
1098
1693
  class MASK_PT_display:
@@ -1254,22 +1849,35 @@ class MASK_UL_layers(bpy_types.UIList, bpy_types._GenericUI):
1254
1849
  """ """
1255
1850
 
1256
1851
  def append(self, draw_func):
1257
- """
1852
+ """Append a draw function to this menu,
1853
+ takes the same arguments as the menus draw function
1258
1854
 
1259
- :param draw_func:
1855
+ :param draw_func:
1260
1856
  """
1261
1857
  ...
1262
1858
 
1263
- def as_pointer(self):
1264
- """ """
1859
+ def as_pointer(self) -> int:
1860
+ """Returns the memory address which holds a pointer to Blender's internal data
1861
+
1862
+ :return: int (memory address).
1863
+ :rtype: int
1864
+ """
1265
1865
  ...
1266
1866
 
1267
- def bl_rna_get_subclass(self):
1268
- """ """
1867
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1868
+ """
1869
+
1870
+ :return: The RNA type or default when not found.
1871
+ :rtype: bpy.types.Struct
1872
+ """
1269
1873
  ...
1270
1874
 
1271
- def bl_rna_get_subclass_py(self):
1272
- """ """
1875
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1876
+ """
1877
+
1878
+ :return: The class or default when not found.
1879
+ :rtype: typing.Any
1880
+ """
1273
1881
  ...
1274
1882
 
1275
1883
  def draw_item(
@@ -1296,106 +1904,179 @@ class MASK_UL_layers(bpy_types.UIList, bpy_types._GenericUI):
1296
1904
  """
1297
1905
  ...
1298
1906
 
1299
- def driver_add(self):
1300
- """ """
1907
+ def driver_add(self) -> bpy.types.FCurve:
1908
+ """Adds driver(s) to the given property
1909
+
1910
+ :return: The driver(s) added.
1911
+ :rtype: bpy.types.FCurve
1912
+ """
1301
1913
  ...
1302
1914
 
1303
- def driver_remove(self):
1304
- """ """
1915
+ def driver_remove(self) -> bool:
1916
+ """Remove driver(s) from the given property
1917
+
1918
+ :return: Success of driver removal.
1919
+ :rtype: bool
1920
+ """
1305
1921
  ...
1306
1922
 
1307
1923
  def get(self):
1308
- """ """
1924
+ """Returns the value of the custom property assigned to key or default
1925
+ when not found (matches Python's dictionary function of the same name).
1926
+
1927
+ """
1309
1928
  ...
1310
1929
 
1311
1930
  def id_properties_clear(self):
1312
- """ """
1931
+ """
1932
+
1933
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1934
+ """
1313
1935
  ...
1314
1936
 
1315
1937
  def id_properties_ensure(self):
1316
- """ """
1938
+ """
1939
+
1940
+ :return: the parent group for an RNA struct's custom IDProperties.
1941
+ """
1317
1942
  ...
1318
1943
 
1319
1944
  def id_properties_ui(self):
1320
- """ """
1945
+ """
1946
+
1947
+ :return: Return an object used to manage an IDProperty's UI data.
1948
+ """
1321
1949
  ...
1322
1950
 
1323
1951
  def is_extended(self):
1324
1952
  """ """
1325
1953
  ...
1326
1954
 
1327
- def is_property_hidden(self):
1328
- """ """
1955
+ def is_property_hidden(self) -> bool:
1956
+ """Check if a property is hidden.
1957
+
1958
+ :return: True when the property is hidden.
1959
+ :rtype: bool
1960
+ """
1329
1961
  ...
1330
1962
 
1331
- def is_property_overridable_library(self):
1332
- """ """
1963
+ def is_property_overridable_library(self) -> bool:
1964
+ """Check if a property is overridable.
1965
+
1966
+ :return: True when the property is overridable.
1967
+ :rtype: bool
1968
+ """
1333
1969
  ...
1334
1970
 
1335
- def is_property_readonly(self):
1336
- """ """
1971
+ def is_property_readonly(self) -> bool:
1972
+ """Check if a property is readonly.
1973
+
1974
+ :return: True when the property is readonly (not writable).
1975
+ :rtype: bool
1976
+ """
1337
1977
  ...
1338
1978
 
1339
- def is_property_set(self):
1340
- """ """
1979
+ def is_property_set(self) -> bool:
1980
+ """Check if a property is set, use for testing operator properties.
1981
+
1982
+ :return: True when the property has been set.
1983
+ :rtype: bool
1984
+ """
1341
1985
  ...
1342
1986
 
1343
1987
  def items(self):
1344
- """ """
1988
+ """Returns the items of this objects custom properties (matches Python's
1989
+ dictionary function of the same name).
1990
+
1991
+ :return: custom property key, value pairs.
1992
+ """
1345
1993
  ...
1346
1994
 
1347
- def keyframe_delete(self):
1348
- """ """
1995
+ def keyframe_delete(self) -> bool:
1996
+ """Remove a keyframe from this properties fcurve.
1997
+
1998
+ :return: Success of keyframe deletion.
1999
+ :rtype: bool
2000
+ """
1349
2001
  ...
1350
2002
 
1351
- def keyframe_insert(self):
1352
- """ """
2003
+ def keyframe_insert(self) -> bool:
2004
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2005
+
2006
+ :return: Success of keyframe insertion.
2007
+ :rtype: bool
2008
+ """
1353
2009
  ...
1354
2010
 
1355
2011
  def keys(self):
1356
- """ """
2012
+ """Returns the keys of this objects custom properties (matches Python's
2013
+ dictionary function of the same name).
2014
+
2015
+ :return: custom property keys.
2016
+ """
1357
2017
  ...
1358
2018
 
1359
- def path_from_id(self):
1360
- """ """
2019
+ def path_from_id(self) -> str:
2020
+ """Returns the data path from the ID to this object (string).
2021
+
2022
+ :return: The path from `bpy.types.bpy_struct.id_data`
2023
+ to this struct and property (when given).
2024
+ :rtype: str
2025
+ """
1361
2026
  ...
1362
2027
 
1363
2028
  def path_resolve(self):
1364
- """ """
2029
+ """Returns the property from the path, raise an exception when not found."""
1365
2030
  ...
1366
2031
 
1367
2032
  def pop(self):
1368
- """ """
2033
+ """Remove and return the value of the custom property assigned to key or default
2034
+ when not found (matches Python's dictionary function of the same name).
2035
+
2036
+ """
1369
2037
  ...
1370
2038
 
1371
2039
  def prepend(self, draw_func):
1372
- """
2040
+ """Prepend a draw function to this menu, takes the same arguments as
2041
+ the menus draw function
1373
2042
 
1374
- :param draw_func:
2043
+ :param draw_func:
1375
2044
  """
1376
2045
  ...
1377
2046
 
1378
- def property_overridable_library_set(self):
1379
- """ """
2047
+ def property_overridable_library_set(self) -> bool:
2048
+ """Define a property as overridable or not (only for custom properties!).
2049
+
2050
+ :return: True when the overridable status of the property was successfully set.
2051
+ :rtype: bool
2052
+ """
1380
2053
  ...
1381
2054
 
1382
2055
  def property_unset(self):
1383
- """ """
2056
+ """Unset a property, will use default value afterward."""
1384
2057
  ...
1385
2058
 
1386
2059
  def remove(self, draw_func):
1387
- """
2060
+ """Remove a draw function that has been added to this menu
1388
2061
 
1389
2062
  :param draw_func:
1390
2063
  """
1391
2064
  ...
1392
2065
 
1393
2066
  def type_recast(self):
1394
- """ """
2067
+ """Return a new instance, this is needed because types
2068
+ such as textures can be changed at runtime.
2069
+
2070
+ :return: a new instance of this object with the type initialized again.
2071
+ """
1395
2072
  ...
1396
2073
 
1397
2074
  def values(self):
1398
- """ """
2075
+ """Returns the values of this objects custom properties (matches Python's
2076
+ dictionary function of the same name).
2077
+
2078
+ :return: custom property values.
2079
+ """
1399
2080
  ...
1400
2081
 
1401
2082
  def draw_mask_context_menu(layout, _context):