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

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

Potentially problematic release.


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

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