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

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

Potentially problematic release.


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

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