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

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

Potentially problematic release.


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

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