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

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

Potentially problematic release.


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

Files changed (533) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +2 -2
  2. addon_utils/__init__.pyi +43 -12
  3. animsys_refactor/__init__.pyi +4 -4
  4. aud/__init__.pyi +7 -7
  5. bgl/__init__.pyi +121 -183
  6. bl_app_override/__init__.pyi +5 -5
  7. bl_app_override/helpers/__init__.pyi +3 -1
  8. bl_app_template_utils/__init__.pyi +5 -5
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +5 -5
  14. bl_i18n_utils/settings/__init__.pyi +4 -2
  15. bl_i18n_utils/utils/__init__.pyi +86 -58
  16. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  17. bl_keymap_utils/io/__init__.pyi +4 -4
  18. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  19. bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
  20. bl_operators/add_mesh_torus/__init__.pyi +126 -41
  21. bl_operators/anim/__init__.pyi +1001 -328
  22. bl_operators/assets/__init__.pyi +376 -123
  23. bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
  24. bl_operators/clip/__init__.pyi +1250 -409
  25. bl_operators/console/__init__.pyi +626 -205
  26. bl_operators/constraint/__init__.pyi +502 -165
  27. bl_operators/file/__init__.pyi +376 -123
  28. bl_operators/freestyle/__init__.pyi +501 -164
  29. bl_operators/geometry_nodes/__init__.pyi +501 -164
  30. bl_operators/image/__init__.pyi +621 -200
  31. bl_operators/mesh/__init__.pyi +376 -123
  32. bl_operators/node/__init__.pyi +1243 -402
  33. bl_operators/object/__init__.pyi +1876 -615
  34. bl_operators/object_align/__init__.pyi +126 -41
  35. bl_operators/object_quick_effects/__init__.pyi +502 -165
  36. bl_operators/object_randomize_transform/__init__.pyi +126 -41
  37. bl_operators/presets/__init__.pyi +3069 -1027
  38. bl_operators/rigidbody/__init__.pyi +376 -123
  39. bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
  40. bl_operators/sequencer/__init__.pyi +1009 -331
  41. bl_operators/spreadsheet/__init__.pyi +126 -41
  42. bl_operators/userpref/__init__.pyi +3263 -1078
  43. bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
  44. bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
  45. bl_operators/uvcalc_transform/__init__.pyi +289 -90
  46. bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
  47. bl_operators/view3d/__init__.pyi +868 -279
  48. bl_operators/wm/__init__.pyi +5777 -1934
  49. bl_operators/world/__init__.pyi +126 -41
  50. bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
  51. bl_rna_utils/data_path/__init__.pyi +8 -3
  52. bl_ui/__init__.pyi +338 -131
  53. bl_ui/anim/__init__.pyi +164 -64
  54. bl_ui/asset_shelf/__init__.pyi +129 -42
  55. bl_ui/generic_ui_list/__init__.pyi +412 -135
  56. bl_ui/node_add_menu/__init__.pyi +168 -68
  57. bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
  58. bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
  59. bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
  60. bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
  61. bl_ui/properties_animviz/__init__.pyi +2 -2
  62. bl_ui/properties_collection/__init__.pyi +806 -274
  63. bl_ui/properties_constraint/__init__.pyi +10253 -3458
  64. bl_ui/properties_data_armature/__init__.pyi +1615 -552
  65. bl_ui/properties_data_bone/__init__.pyi +1288 -425
  66. bl_ui/properties_data_camera/__init__.pyi +1854 -631
  67. bl_ui/properties_data_curve/__init__.pyi +1929 -636
  68. bl_ui/properties_data_curves/__init__.pyi +806 -274
  69. bl_ui/properties_data_empty/__init__.pyi +257 -84
  70. bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
  71. bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
  72. bl_ui/properties_data_lattice/__init__.pyi +388 -127
  73. bl_ui/properties_data_light/__init__.pyi +1541 -506
  74. bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
  75. bl_ui/properties_data_mesh/__init__.pyi +2704 -929
  76. bl_ui/properties_data_metaball/__init__.pyi +644 -211
  77. bl_ui/properties_data_modifier/__init__.pyi +1353 -502
  78. bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
  79. bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
  80. bl_ui/properties_data_speaker/__init__.pyi +644 -211
  81. bl_ui/properties_data_volume/__init__.pyi +1030 -339
  82. bl_ui/properties_freestyle/__init__.pyi +3113 -1035
  83. bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
  84. bl_ui/properties_mask_common/__init__.pyi +1101 -420
  85. bl_ui/properties_material/__init__.pyi +2091 -699
  86. bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
  87. bl_ui/properties_object/__init__.pyi +1838 -618
  88. bl_ui/properties_output/__init__.pyi +2414 -831
  89. bl_ui/properties_paint_common/__init__.pyi +412 -289
  90. bl_ui/properties_particle/__init__.pyi +6737 -2241
  91. bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
  92. bl_ui/properties_physics_common/__init__.pyi +129 -42
  93. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
  94. bl_ui/properties_physics_field/__init__.pyi +1283 -422
  95. bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
  96. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
  97. bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
  98. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
  99. bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
  100. bl_ui/properties_render/__init__.pyi +6830 -2263
  101. bl_ui/properties_scene/__init__.pyi +1929 -636
  102. bl_ui/properties_texture/__init__.pyi +3370 -1118
  103. bl_ui/properties_view_layer/__init__.pyi +2346 -782
  104. bl_ui/properties_workspace/__init__.pyi +516 -169
  105. bl_ui/properties_world/__init__.pyi +1284 -421
  106. bl_ui/space_clip/__init__.pyi +10134 -3639
  107. bl_ui/space_console/__init__.pyi +939 -357
  108. bl_ui/space_dopesheet/__init__.pyi +4327 -1562
  109. bl_ui/space_filebrowser/__init__.pyi +4164 -1499
  110. bl_ui/space_graph/__init__.pyi +3108 -1179
  111. bl_ui/space_image/__init__.pyi +9766 -3596
  112. bl_ui/space_info/__init__.pyi +939 -357
  113. bl_ui/space_nla/__init__.pyi +2620 -988
  114. bl_ui/space_node/__init__.pyi +3994 -1434
  115. bl_ui/space_outliner/__init__.pyi +2203 -842
  116. bl_ui/space_properties/__init__.pyi +386 -127
  117. bl_ui/space_sequencer/__init__.pyi +10773 -3878
  118. bl_ui/space_spreadsheet/__init__.pyi +130 -43
  119. bl_ui/space_statusbar/__init__.pyi +129 -42
  120. bl_ui/space_text/__init__.pyi +2458 -925
  121. bl_ui/space_time/__init__.pyi +1033 -378
  122. bl_ui/space_toolsystem_common/__init__.pyi +20 -16
  123. bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
  124. bl_ui/space_topbar/__init__.pyi +3980 -1496
  125. bl_ui/space_userpref/__init__.pyi +11373 -3797
  126. bl_ui/space_view3d/__init__.pyi +40865 -15356
  127. bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
  128. bl_ui/temp_anim_layers/__init__.pyi +129 -42
  129. bl_ui/utils/__init__.pyi +28 -20
  130. bl_ui_utils/bug_report_url/__init__.pyi +1 -1
  131. bl_ui_utils/layout/__init__.pyi +1 -1
  132. blend_render_info/__init__.pyi +1 -1
  133. blf/__init__.pyi +4 -4
  134. bmesh/geometry/__init__.pyi +2 -3
  135. bmesh/ops/__init__.pyi +372 -419
  136. bmesh/types/__init__.pyi +38 -38
  137. bmesh/utils/__init__.pyi +10 -13
  138. bpy/app/__init__.pyi +4 -4
  139. bpy/app/handlers/__init__.pyi +36 -36
  140. bpy/app/icons/__init__.pyi +8 -8
  141. bpy/app/timers/__init__.pyi +10 -10
  142. bpy/app/translations/__init__.pyi +20 -22
  143. bpy/msgbus/__init__.pyi +2 -4
  144. bpy/ops/action/__init__.pyi +316 -394
  145. bpy/ops/anim/__init__.pyi +442 -548
  146. bpy/ops/armature/__init__.pyi +374 -470
  147. bpy/ops/asset/__init__.pyi +152 -184
  148. bpy/ops/bl_pkg/__init__.pyi +221 -272
  149. bpy/ops/boid/__init__.pyi +50 -66
  150. bpy/ops/brush/__init__.pyi +72 -90
  151. bpy/ops/buttons/__init__.pyi +132 -144
  152. bpy/ops/cachefile/__init__.pyi +128 -138
  153. bpy/ops/camera/__init__.pyi +26 -30
  154. bpy/ops/clip/__init__.pyi +777 -964
  155. bpy/ops/cloth/__init__.pyi +12 -14
  156. bpy/ops/collection/__init__.pyi +68 -86
  157. bpy/ops/console/__init__.pyi +158 -200
  158. bpy/ops/constraint/__init__.pyi +178 -214
  159. bpy/ops/curve/__init__.pyi +473 -576
  160. bpy/ops/curves/__init__.pyi +247 -302
  161. bpy/ops/cycles/__init__.pyi +28 -34
  162. bpy/ops/dpaint/__init__.pyi +34 -44
  163. bpy/ops/ed/__init__.pyi +126 -150
  164. bpy/ops/export_anim/__init__.pyi +22 -24
  165. bpy/ops/export_scene/__init__.pyi +302 -336
  166. bpy/ops/file/__init__.pyi +352 -432
  167. bpy/ops/fluid/__init__.pyi +90 -118
  168. bpy/ops/font/__init__.pyi +258 -304
  169. bpy/ops/geometry/__init__.pyi +100 -120
  170. bpy/ops/gizmogroup/__init__.pyi +22 -26
  171. bpy/ops/gpencil/__init__.pyi +1469 -1778
  172. bpy/ops/graph/__init__.pyi +644 -776
  173. bpy/ops/grease_pencil/__init__.pyi +597 -748
  174. bpy/ops/image/__init__.pyi +648 -744
  175. bpy/ops/import_anim/__init__.pyi +30 -32
  176. bpy/ops/import_curve/__init__.pyi +10 -12
  177. bpy/ops/import_scene/__init__.pyi +88 -96
  178. bpy/ops/info/__init__.pyi +60 -74
  179. bpy/ops/lattice/__init__.pyi +64 -80
  180. bpy/ops/marker/__init__.pyi +108 -130
  181. bpy/ops/mask/__init__.pyi +322 -402
  182. bpy/ops/material/__init__.pyi +18 -24
  183. bpy/ops/mball/__init__.pyi +70 -86
  184. bpy/ops/mesh/__init__.pyi +1986 -2322
  185. bpy/ops/nla/__init__.pyi +333 -411
  186. bpy/ops/node/__init__.pyi +886 -1100
  187. bpy/ops/object/__init__.pyi +2585 -3078
  188. bpy/ops/outliner/__init__.pyi +498 -636
  189. bpy/ops/paint/__init__.pyi +565 -680
  190. bpy/ops/paintcurve/__init__.pyi +64 -80
  191. bpy/ops/palette/__init__.pyi +50 -64
  192. bpy/ops/particle/__init__.pyi +267 -340
  193. bpy/ops/pose/__init__.pyi +336 -414
  194. bpy/ops/poselib/__init__.pyi +72 -90
  195. bpy/ops/preferences/__init__.pyi +386 -463
  196. bpy/ops/ptcache/__init__.pyi +46 -60
  197. bpy/ops/render/__init__.pyi +130 -154
  198. bpy/ops/rigidbody/__init__.pyi +102 -128
  199. bpy/ops/scene/__init__.pyi +280 -358
  200. bpy/ops/screen/__init__.pyi +382 -460
  201. bpy/ops/script/__init__.pyi +24 -30
  202. bpy/ops/sculpt/__init__.pyi +458 -532
  203. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  204. bpy/ops/sequencer/__init__.pyi +1066 -1244
  205. bpy/ops/sound/__init__.pyi +216 -230
  206. bpy/ops/spreadsheet/__init__.pyi +30 -38
  207. bpy/ops/surface/__init__.pyi +108 -120
  208. bpy/ops/text/__init__.pyi +390 -476
  209. bpy/ops/text_editor/__init__.pyi +12 -14
  210. bpy/ops/texture/__init__.pyi +26 -34
  211. bpy/ops/transform/__init__.pyi +792 -878
  212. bpy/ops/ui/__init__.pyi +228 -294
  213. bpy/ops/uilist/__init__.pyi +32 -38
  214. bpy/ops/uv/__init__.pyi +602 -704
  215. bpy/ops/view2d/__init__.pyi +156 -184
  216. bpy/ops/view3d/__init__.pyi +582 -718
  217. bpy/ops/wm/__init__.pyi +2680 -2928
  218. bpy/ops/workspace/__init__.pyi +46 -60
  219. bpy/ops/world/__init__.pyi +12 -16
  220. bpy/path/__init__.pyi +179 -75
  221. bpy/props/__init__.pyi +261 -263
  222. bpy/types/__init__.pyi +17056 -21951
  223. bpy/utils/__init__.pyi +242 -118
  224. bpy/utils/previews/__init__.pyi +58 -28
  225. bpy/utils/units/__init__.pyi +20 -20
  226. bpy_extras/anim_utils/__init__.pyi +68 -28
  227. bpy_extras/bmesh_utils/__init__.pyi +8 -2
  228. bpy_extras/extensions/junction_module/__init__.pyi +5 -2
  229. bpy_extras/id_map_utils/__init__.pyi +3 -3
  230. bpy_extras/image_utils/__init__.pyi +44 -11
  231. bpy_extras/io_utils/__init__.pyi +113 -18
  232. bpy_extras/keyconfig_utils/__init__.pyi +2 -2
  233. bpy_extras/mesh_utils/__init__.pyi +71 -19
  234. bpy_extras/node_shader_utils/__init__.pyi +9 -4
  235. bpy_extras/node_utils/__init__.pyi +9 -2
  236. bpy_extras/object_utils/__init__.pyi +71 -12
  237. bpy_extras/view3d_utils/__init__.pyi +80 -10
  238. bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
  239. bpy_types/__init__.pyi +4197 -1333
  240. console_python/__init__.pyi +6 -1
  241. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
  242. fake_bpy_module-20240517.dist-info/RECORD +353 -0
  243. freestyle/chainingiterators/__init__.pyi +4 -4
  244. freestyle/shaders/__init__.pyi +2 -2
  245. freestyle/types/__init__.pyi +84 -96
  246. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  247. freestyle/utils/__init__.pyi +3 -3
  248. gpu/matrix/__init__.pyi +6 -8
  249. gpu/state/__init__.pyi +2 -2
  250. gpu/types/__init__.pyi +12 -12
  251. gpu_extras/presets/__init__.pyi +2 -5
  252. graphviz_export/__init__.pyi +4 -2
  253. idprop/types/__init__.pyi +2 -2
  254. imbuf/__init__.pyi +4 -4
  255. keyingsets_builtins/__init__.pyi +2688 -839
  256. mathutils/__init__.pyi +194 -238
  257. mathutils/bvhtree/__init__.pyi +4 -4
  258. mathutils/geometry/__init__.pyi +153 -155
  259. mathutils/kdtree/__init__.pyi +8 -12
  260. mathutils/noise/__init__.pyi +26 -26
  261. nodeitems_utils/__init__.pyi +1 -1
  262. rna_info/__init__.pyi +17 -15
  263. rna_keymap_ui/__init__.pyi +1 -1
  264. rna_prop_ui/__init__.pyi +16 -14
  265. rna_xml/__init__.pyi +12 -12
  266. _bpy_internal/freedesktop/py.typed +0 -0
  267. bl_app_override/helpers/py.typed +0 -0
  268. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  269. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  270. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  271. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  272. bl_console_utils/autocomplete/py.typed +0 -0
  273. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  274. bl_i18n_utils/merge_po/py.typed +0 -0
  275. bl_i18n_utils/settings/py.typed +0 -0
  276. bl_i18n_utils/utils/py.typed +0 -0
  277. bl_i18n_utils/utils_cli/py.typed +0 -0
  278. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  279. bl_i18n_utils/utils_rtl/py.typed +0 -0
  280. bl_keymap_utils/io/py.typed +0 -0
  281. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  282. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  283. bl_keymap_utils/platform_helpers/py.typed +0 -0
  284. bl_keymap_utils/versioning/py.typed +0 -0
  285. bl_operators/add_mesh_torus/py.typed +0 -0
  286. bl_operators/anim/py.typed +0 -0
  287. bl_operators/assets/py.typed +0 -0
  288. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  289. bl_operators/bmesh/py.typed +0 -0
  290. bl_operators/clip/py.typed +0 -0
  291. bl_operators/console/py.typed +0 -0
  292. bl_operators/constraint/py.typed +0 -0
  293. bl_operators/file/py.typed +0 -0
  294. bl_operators/freestyle/py.typed +0 -0
  295. bl_operators/geometry_nodes/py.typed +0 -0
  296. bl_operators/image/py.typed +0 -0
  297. bl_operators/mesh/py.typed +0 -0
  298. bl_operators/node/py.typed +0 -0
  299. bl_operators/object/py.typed +0 -0
  300. bl_operators/object_align/py.typed +0 -0
  301. bl_operators/object_quick_effects/py.typed +0 -0
  302. bl_operators/object_randomize_transform/py.typed +0 -0
  303. bl_operators/presets/py.typed +0 -0
  304. bl_operators/rigidbody/py.typed +0 -0
  305. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  306. bl_operators/sequencer/py.typed +0 -0
  307. bl_operators/spreadsheet/py.typed +0 -0
  308. bl_operators/userpref/py.typed +0 -0
  309. bl_operators/uvcalc_follow_active/py.typed +0 -0
  310. bl_operators/uvcalc_lightmap/py.typed +0 -0
  311. bl_operators/uvcalc_transform/py.typed +0 -0
  312. bl_operators/vertexpaint_dirt/py.typed +0 -0
  313. bl_operators/view3d/py.typed +0 -0
  314. bl_operators/wm/py.typed +0 -0
  315. bl_operators/world/py.typed +0 -0
  316. bl_previews_utils/bl_previews_render/py.typed +0 -0
  317. bl_rna_utils/data_path/py.typed +0 -0
  318. bl_text_utils/external_editor/py.typed +0 -0
  319. bl_ui/anim/py.typed +0 -0
  320. bl_ui/asset_shelf/py.typed +0 -0
  321. bl_ui/generic_ui_list/py.typed +0 -0
  322. bl_ui/node_add_menu/py.typed +0 -0
  323. bl_ui/node_add_menu_compositor/py.typed +0 -0
  324. bl_ui/node_add_menu_geometry/py.typed +0 -0
  325. bl_ui/node_add_menu_shader/py.typed +0 -0
  326. bl_ui/node_add_menu_texture/py.typed +0 -0
  327. bl_ui/properties_animviz/py.typed +0 -0
  328. bl_ui/properties_collection/py.typed +0 -0
  329. bl_ui/properties_constraint/py.typed +0 -0
  330. bl_ui/properties_data_armature/py.typed +0 -0
  331. bl_ui/properties_data_bone/py.typed +0 -0
  332. bl_ui/properties_data_camera/py.typed +0 -0
  333. bl_ui/properties_data_curve/py.typed +0 -0
  334. bl_ui/properties_data_curves/py.typed +0 -0
  335. bl_ui/properties_data_empty/py.typed +0 -0
  336. bl_ui/properties_data_gpencil/py.typed +0 -0
  337. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  338. bl_ui/properties_data_lattice/py.typed +0 -0
  339. bl_ui/properties_data_light/py.typed +0 -0
  340. bl_ui/properties_data_lightprobe/py.typed +0 -0
  341. bl_ui/properties_data_mesh/py.typed +0 -0
  342. bl_ui/properties_data_metaball/py.typed +0 -0
  343. bl_ui/properties_data_modifier/py.typed +0 -0
  344. bl_ui/properties_data_pointcloud/py.typed +0 -0
  345. bl_ui/properties_data_shaderfx/py.typed +0 -0
  346. bl_ui/properties_data_speaker/py.typed +0 -0
  347. bl_ui/properties_data_volume/py.typed +0 -0
  348. bl_ui/properties_freestyle/py.typed +0 -0
  349. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  350. bl_ui/properties_mask_common/py.typed +0 -0
  351. bl_ui/properties_material/py.typed +0 -0
  352. bl_ui/properties_material_gpencil/py.typed +0 -0
  353. bl_ui/properties_object/py.typed +0 -0
  354. bl_ui/properties_output/py.typed +0 -0
  355. bl_ui/properties_paint_common/py.typed +0 -0
  356. bl_ui/properties_particle/py.typed +0 -0
  357. bl_ui/properties_physics_cloth/py.typed +0 -0
  358. bl_ui/properties_physics_common/py.typed +0 -0
  359. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  360. bl_ui/properties_physics_field/py.typed +0 -0
  361. bl_ui/properties_physics_fluid/py.typed +0 -0
  362. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  363. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  364. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  365. bl_ui/properties_physics_softbody/py.typed +0 -0
  366. bl_ui/properties_render/py.typed +0 -0
  367. bl_ui/properties_scene/py.typed +0 -0
  368. bl_ui/properties_texture/py.typed +0 -0
  369. bl_ui/properties_view_layer/py.typed +0 -0
  370. bl_ui/properties_workspace/py.typed +0 -0
  371. bl_ui/properties_world/py.typed +0 -0
  372. bl_ui/space_clip/py.typed +0 -0
  373. bl_ui/space_console/py.typed +0 -0
  374. bl_ui/space_dopesheet/py.typed +0 -0
  375. bl_ui/space_filebrowser/py.typed +0 -0
  376. bl_ui/space_graph/py.typed +0 -0
  377. bl_ui/space_image/py.typed +0 -0
  378. bl_ui/space_info/py.typed +0 -0
  379. bl_ui/space_nla/py.typed +0 -0
  380. bl_ui/space_node/py.typed +0 -0
  381. bl_ui/space_outliner/py.typed +0 -0
  382. bl_ui/space_properties/py.typed +0 -0
  383. bl_ui/space_sequencer/py.typed +0 -0
  384. bl_ui/space_spreadsheet/py.typed +0 -0
  385. bl_ui/space_statusbar/py.typed +0 -0
  386. bl_ui/space_text/py.typed +0 -0
  387. bl_ui/space_time/py.typed +0 -0
  388. bl_ui/space_toolsystem_common/py.typed +0 -0
  389. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  390. bl_ui/space_topbar/py.typed +0 -0
  391. bl_ui/space_userpref/py.typed +0 -0
  392. bl_ui/space_view3d/py.typed +0 -0
  393. bl_ui/space_view3d_toolbar/py.typed +0 -0
  394. bl_ui/temp_anim_layers/py.typed +0 -0
  395. bl_ui/utils/py.typed +0 -0
  396. bl_ui_utils/bug_report_url/py.typed +0 -0
  397. bl_ui_utils/layout/py.typed +0 -0
  398. bmesh/geometry/py.typed +0 -0
  399. bmesh/ops/py.typed +0 -0
  400. bmesh/types/py.typed +0 -0
  401. bmesh/utils/py.typed +0 -0
  402. bpy/app/handlers/py.typed +0 -0
  403. bpy/app/icons/py.typed +0 -0
  404. bpy/app/py.typed +0 -0
  405. bpy/app/timers/py.typed +0 -0
  406. bpy/app/translations/py.typed +0 -0
  407. bpy/msgbus/py.typed +0 -0
  408. bpy/ops/action/py.typed +0 -0
  409. bpy/ops/anim/py.typed +0 -0
  410. bpy/ops/armature/py.typed +0 -0
  411. bpy/ops/asset/py.typed +0 -0
  412. bpy/ops/bl_pkg/py.typed +0 -0
  413. bpy/ops/boid/py.typed +0 -0
  414. bpy/ops/brush/py.typed +0 -0
  415. bpy/ops/buttons/py.typed +0 -0
  416. bpy/ops/cachefile/py.typed +0 -0
  417. bpy/ops/camera/py.typed +0 -0
  418. bpy/ops/clip/py.typed +0 -0
  419. bpy/ops/cloth/py.typed +0 -0
  420. bpy/ops/collection/py.typed +0 -0
  421. bpy/ops/console/py.typed +0 -0
  422. bpy/ops/constraint/py.typed +0 -0
  423. bpy/ops/curve/py.typed +0 -0
  424. bpy/ops/curves/py.typed +0 -0
  425. bpy/ops/cycles/py.typed +0 -0
  426. bpy/ops/dpaint/py.typed +0 -0
  427. bpy/ops/ed/py.typed +0 -0
  428. bpy/ops/export_anim/py.typed +0 -0
  429. bpy/ops/export_scene/py.typed +0 -0
  430. bpy/ops/file/py.typed +0 -0
  431. bpy/ops/fluid/py.typed +0 -0
  432. bpy/ops/font/py.typed +0 -0
  433. bpy/ops/geometry/py.typed +0 -0
  434. bpy/ops/gizmogroup/py.typed +0 -0
  435. bpy/ops/gpencil/py.typed +0 -0
  436. bpy/ops/graph/py.typed +0 -0
  437. bpy/ops/grease_pencil/py.typed +0 -0
  438. bpy/ops/image/py.typed +0 -0
  439. bpy/ops/import_anim/py.typed +0 -0
  440. bpy/ops/import_curve/py.typed +0 -0
  441. bpy/ops/import_scene/py.typed +0 -0
  442. bpy/ops/info/py.typed +0 -0
  443. bpy/ops/lattice/py.typed +0 -0
  444. bpy/ops/marker/py.typed +0 -0
  445. bpy/ops/mask/py.typed +0 -0
  446. bpy/ops/material/py.typed +0 -0
  447. bpy/ops/mball/py.typed +0 -0
  448. bpy/ops/mesh/py.typed +0 -0
  449. bpy/ops/nla/py.typed +0 -0
  450. bpy/ops/node/py.typed +0 -0
  451. bpy/ops/object/py.typed +0 -0
  452. bpy/ops/outliner/py.typed +0 -0
  453. bpy/ops/paint/py.typed +0 -0
  454. bpy/ops/paintcurve/py.typed +0 -0
  455. bpy/ops/palette/py.typed +0 -0
  456. bpy/ops/particle/py.typed +0 -0
  457. bpy/ops/pose/py.typed +0 -0
  458. bpy/ops/poselib/py.typed +0 -0
  459. bpy/ops/preferences/py.typed +0 -0
  460. bpy/ops/ptcache/py.typed +0 -0
  461. bpy/ops/py.typed +0 -0
  462. bpy/ops/render/py.typed +0 -0
  463. bpy/ops/rigidbody/py.typed +0 -0
  464. bpy/ops/scene/py.typed +0 -0
  465. bpy/ops/screen/py.typed +0 -0
  466. bpy/ops/script/py.typed +0 -0
  467. bpy/ops/sculpt/py.typed +0 -0
  468. bpy/ops/sculpt_curves/py.typed +0 -0
  469. bpy/ops/sequencer/py.typed +0 -0
  470. bpy/ops/sound/py.typed +0 -0
  471. bpy/ops/spreadsheet/py.typed +0 -0
  472. bpy/ops/surface/py.typed +0 -0
  473. bpy/ops/text/py.typed +0 -0
  474. bpy/ops/text_editor/py.typed +0 -0
  475. bpy/ops/texture/py.typed +0 -0
  476. bpy/ops/transform/py.typed +0 -0
  477. bpy/ops/ui/py.typed +0 -0
  478. bpy/ops/uilist/py.typed +0 -0
  479. bpy/ops/uv/py.typed +0 -0
  480. bpy/ops/view2d/py.typed +0 -0
  481. bpy/ops/view3d/py.typed +0 -0
  482. bpy/ops/wm/py.typed +0 -0
  483. bpy/ops/workspace/py.typed +0 -0
  484. bpy/ops/world/py.typed +0 -0
  485. bpy/path/py.typed +0 -0
  486. bpy/props/py.typed +0 -0
  487. bpy/types/py.typed +0 -0
  488. bpy/utils/previews/py.typed +0 -0
  489. bpy/utils/py.typed +0 -0
  490. bpy/utils/units/py.typed +0 -0
  491. bpy_extras/anim_utils/py.typed +0 -0
  492. bpy_extras/asset_utils/py.typed +0 -0
  493. bpy_extras/bmesh_utils/py.typed +0 -0
  494. bpy_extras/extensions/junction_module/py.typed +0 -0
  495. bpy_extras/extensions/py.typed +0 -0
  496. bpy_extras/id_map_utils/py.typed +0 -0
  497. bpy_extras/image_utils/py.typed +0 -0
  498. bpy_extras/io_utils/py.typed +0 -0
  499. bpy_extras/keyconfig_utils/py.typed +0 -0
  500. bpy_extras/mesh_utils/py.typed +0 -0
  501. bpy_extras/node_shader_utils/py.typed +0 -0
  502. bpy_extras/node_utils/py.typed +0 -0
  503. bpy_extras/object_utils/py.typed +0 -0
  504. bpy_extras/view3d_utils/py.typed +0 -0
  505. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  506. bpy_extras/wm_utils/py.typed +0 -0
  507. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  508. freestyle/chainingiterators/py.typed +0 -0
  509. freestyle/functions/py.typed +0 -0
  510. freestyle/predicates/py.typed +0 -0
  511. freestyle/shaders/py.typed +0 -0
  512. freestyle/types/py.typed +0 -0
  513. freestyle/utils/ContextFunctions/py.typed +0 -0
  514. freestyle/utils/py.typed +0 -0
  515. gpu/capabilities/py.typed +0 -0
  516. gpu/matrix/py.typed +0 -0
  517. gpu/platform/py.typed +0 -0
  518. gpu/select/py.typed +0 -0
  519. gpu/shader/py.typed +0 -0
  520. gpu/state/py.typed +0 -0
  521. gpu/texture/py.typed +0 -0
  522. gpu/types/py.typed +0 -0
  523. gpu_extras/batch/py.typed +0 -0
  524. gpu_extras/presets/py.typed +0 -0
  525. idprop/types/py.typed +0 -0
  526. imbuf/types/py.typed +0 -0
  527. mathutils/bvhtree/py.typed +0 -0
  528. mathutils/geometry/py.typed +0 -0
  529. mathutils/interpolate/py.typed +0 -0
  530. mathutils/kdtree/py.typed +0 -0
  531. mathutils/noise/py.typed +0 -0
  532. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/WHEEL +0 -0
  533. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
@@ -1,4 +1,5 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
  import rna_prop_ui
4
5
 
@@ -36,22 +37,35 @@ class MATERIAL_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
36
37
  """ """
37
38
 
38
39
  def append(self, draw_func):
39
- """
40
+ """Append a draw function to this menu,
41
+ takes the same arguments as the menus draw function
40
42
 
41
- :param draw_func:
43
+ :param draw_func:
42
44
  """
43
45
  ...
44
46
 
45
- def as_pointer(self):
46
- """ """
47
+ def as_pointer(self) -> int:
48
+ """Returns the memory address which holds a pointer to Blender's internal data
49
+
50
+ :return: int (memory address).
51
+ :rtype: int
52
+ """
47
53
  ...
48
54
 
49
- def bl_rna_get_subclass(self):
50
- """ """
55
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
56
+ """
57
+
58
+ :return: The RNA type or default when not found.
59
+ :rtype: bpy.types.Struct
60
+ """
51
61
  ...
52
62
 
53
- def bl_rna_get_subclass_py(self):
54
- """ """
63
+ def bl_rna_get_subclass_py(self) -> typing.Any:
64
+ """
65
+
66
+ :return: The class or default when not found.
67
+ :rtype: typing.Any
68
+ """
55
69
  ...
56
70
 
57
71
  def draw(self, _context):
@@ -70,138 +84,224 @@ class MATERIAL_MT_context_menu(bpy_types.Menu, bpy_types._GenericUI):
70
84
  ...
71
85
 
72
86
  def draw_preset(self, _context):
73
- """
87
+ """Define these on the subclass:
88
+ - preset_operator (string)
89
+ - preset_subdir (string)Optionally:
90
+ - preset_add_operator (string)
91
+ - preset_extensions (set of strings)
92
+ - preset_operator_defaults (dict of keyword args)
74
93
 
75
- :param _context:
94
+ :param _context:
76
95
  """
77
96
  ...
78
97
 
79
- def driver_add(self):
80
- """ """
98
+ def driver_add(self) -> bpy.types.FCurve:
99
+ """Adds driver(s) to the given property
100
+
101
+ :return: The driver(s) added.
102
+ :rtype: bpy.types.FCurve
103
+ """
81
104
  ...
82
105
 
83
- def driver_remove(self):
84
- """ """
106
+ def driver_remove(self) -> bool:
107
+ """Remove driver(s) from the given property
108
+
109
+ :return: Success of driver removal.
110
+ :rtype: bool
111
+ """
85
112
  ...
86
113
 
87
114
  def get(self):
88
- """ """
115
+ """Returns the value of the custom property assigned to key or default
116
+ when not found (matches Python's dictionary function of the same name).
117
+
118
+ """
89
119
  ...
90
120
 
91
121
  def id_properties_clear(self):
92
- """ """
122
+ """
123
+
124
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
125
+ """
93
126
  ...
94
127
 
95
128
  def id_properties_ensure(self):
96
- """ """
129
+ """
130
+
131
+ :return: the parent group for an RNA struct's custom IDProperties.
132
+ """
97
133
  ...
98
134
 
99
135
  def id_properties_ui(self):
100
- """ """
136
+ """
137
+
138
+ :return: Return an object used to manage an IDProperty's UI data.
139
+ """
101
140
  ...
102
141
 
103
142
  def is_extended(self):
104
143
  """ """
105
144
  ...
106
145
 
107
- def is_property_hidden(self):
108
- """ """
146
+ def is_property_hidden(self) -> bool:
147
+ """Check if a property is hidden.
148
+
149
+ :return: True when the property is hidden.
150
+ :rtype: bool
151
+ """
109
152
  ...
110
153
 
111
- def is_property_overridable_library(self):
112
- """ """
154
+ def is_property_overridable_library(self) -> bool:
155
+ """Check if a property is overridable.
156
+
157
+ :return: True when the property is overridable.
158
+ :rtype: bool
159
+ """
113
160
  ...
114
161
 
115
- def is_property_readonly(self):
116
- """ """
162
+ def is_property_readonly(self) -> bool:
163
+ """Check if a property is readonly.
164
+
165
+ :return: True when the property is readonly (not writable).
166
+ :rtype: bool
167
+ """
117
168
  ...
118
169
 
119
- def is_property_set(self):
120
- """ """
170
+ def is_property_set(self) -> bool:
171
+ """Check if a property is set, use for testing operator properties.
172
+
173
+ :return: True when the property has been set.
174
+ :rtype: bool
175
+ """
121
176
  ...
122
177
 
123
178
  def items(self):
124
- """ """
179
+ """Returns the items of this objects custom properties (matches Python's
180
+ dictionary function of the same name).
181
+
182
+ :return: custom property key, value pairs.
183
+ """
125
184
  ...
126
185
 
127
- def keyframe_delete(self):
128
- """ """
186
+ def keyframe_delete(self) -> bool:
187
+ """Remove a keyframe from this properties fcurve.
188
+
189
+ :return: Success of keyframe deletion.
190
+ :rtype: bool
191
+ """
129
192
  ...
130
193
 
131
- def keyframe_insert(self):
132
- """ """
194
+ def keyframe_insert(self) -> bool:
195
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
196
+
197
+ :return: Success of keyframe insertion.
198
+ :rtype: bool
199
+ """
133
200
  ...
134
201
 
135
202
  def keys(self):
136
- """ """
203
+ """Returns the keys of this objects custom properties (matches Python's
204
+ dictionary function of the same name).
205
+
206
+ :return: custom property keys.
207
+ """
137
208
  ...
138
209
 
139
- def path_from_id(self):
140
- """ """
210
+ def path_from_id(self) -> str:
211
+ """Returns the data path from the ID to this object (string).
212
+
213
+ :return: The path from `bpy.types.bpy_struct.id_data`
214
+ to this struct and property (when given).
215
+ :rtype: str
216
+ """
141
217
  ...
142
218
 
143
219
  def path_menu(
144
220
  self,
145
- searchpaths,
146
- operator,
147
- props_default,
148
- prop_filepath,
149
- filter_ext,
150
- filter_path,
151
- display_name,
152
- add_operator,
153
- add_operator_props,
221
+ searchpaths: list[str],
222
+ operator: str,
223
+ props_default: dict = None,
224
+ prop_filepath: str = "filepath",
225
+ filter_ext: typing.Callable = None,
226
+ filter_path=None,
227
+ display_name: typing.Callable = None,
228
+ add_operator=None,
229
+ add_operator_props=None,
154
230
  ):
155
- """
231
+ """Populate a menu from a list of paths.
156
232
 
157
- :param searchpaths:
158
- :param operator:
159
- :param props_default:
160
- :param prop_filepath:
161
- :param filter_ext:
162
- :param filter_path:
163
- :param display_name:
164
- :param add_operator:
165
- :param add_operator_props:
233
+ :param searchpaths: Paths to scan.
234
+ :type searchpaths: list[str]
235
+ :param operator: The operator id to use with each file.
236
+ :type operator: str
237
+ :param props_default: Properties to assign to each operator.
238
+ :type props_default: dict
239
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
240
+ :type prop_filepath: str
241
+ :param filter_ext: Optional callback that takes the file extensions.
242
+
243
+ Returning false excludes the file from the list.
244
+ :type filter_ext: typing.Callable
245
+ :param filter_path:
246
+ :param display_name: Optional callback that takes the full path, returns the name to display.
247
+ :type display_name: typing.Callable
248
+ :param add_operator:
249
+ :param add_operator_props:
166
250
  """
167
251
  ...
168
252
 
169
253
  def path_resolve(self):
170
- """ """
254
+ """Returns the property from the path, raise an exception when not found."""
171
255
  ...
172
256
 
173
257
  def pop(self):
174
- """ """
258
+ """Remove and return the value of the custom property assigned to key or default
259
+ when not found (matches Python's dictionary function of the same name).
260
+
261
+ """
175
262
  ...
176
263
 
177
264
  def prepend(self, draw_func):
178
- """
265
+ """Prepend a draw function to this menu, takes the same arguments as
266
+ the menus draw function
179
267
 
180
- :param draw_func:
268
+ :param draw_func:
181
269
  """
182
270
  ...
183
271
 
184
- def property_overridable_library_set(self):
185
- """ """
272
+ def property_overridable_library_set(self) -> bool:
273
+ """Define a property as overridable or not (only for custom properties!).
274
+
275
+ :return: True when the overridable status of the property was successfully set.
276
+ :rtype: bool
277
+ """
186
278
  ...
187
279
 
188
280
  def property_unset(self):
189
- """ """
281
+ """Unset a property, will use default value afterward."""
190
282
  ...
191
283
 
192
284
  def remove(self, draw_func):
193
- """
285
+ """Remove a draw function that has been added to this menu
194
286
 
195
287
  :param draw_func:
196
288
  """
197
289
  ...
198
290
 
199
291
  def type_recast(self):
200
- """ """
292
+ """Return a new instance, this is needed because types
293
+ such as textures can be changed at runtime.
294
+
295
+ :return: a new instance of this object with the type initialized again.
296
+ """
201
297
  ...
202
298
 
203
299
  def values(self):
204
- """ """
300
+ """Returns the values of this objects custom properties (matches Python's
301
+ dictionary function of the same name).
302
+
303
+ :return: custom property values.
304
+ """
205
305
  ...
206
306
 
207
307
  class MATERIAL_UL_matslots(bpy_types.UIList, bpy_types._GenericUI):
@@ -214,22 +314,35 @@ class MATERIAL_UL_matslots(bpy_types.UIList, bpy_types._GenericUI):
214
314
  """ """
215
315
 
216
316
  def append(self, draw_func):
217
- """
317
+ """Append a draw function to this menu,
318
+ takes the same arguments as the menus draw function
218
319
 
219
- :param draw_func:
320
+ :param draw_func:
220
321
  """
221
322
  ...
222
323
 
223
- def as_pointer(self):
224
- """ """
324
+ def as_pointer(self) -> int:
325
+ """Returns the memory address which holds a pointer to Blender's internal data
326
+
327
+ :return: int (memory address).
328
+ :rtype: int
329
+ """
225
330
  ...
226
331
 
227
- def bl_rna_get_subclass(self):
228
- """ """
332
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
333
+ """
334
+
335
+ :return: The RNA type or default when not found.
336
+ :rtype: bpy.types.Struct
337
+ """
229
338
  ...
230
339
 
231
- def bl_rna_get_subclass_py(self):
232
- """ """
340
+ def bl_rna_get_subclass_py(self) -> typing.Any:
341
+ """
342
+
343
+ :return: The class or default when not found.
344
+ :rtype: typing.Any
345
+ """
233
346
  ...
234
347
 
235
348
  def draw_item(
@@ -256,106 +369,179 @@ class MATERIAL_UL_matslots(bpy_types.UIList, bpy_types._GenericUI):
256
369
  """
257
370
  ...
258
371
 
259
- def driver_add(self):
260
- """ """
372
+ def driver_add(self) -> bpy.types.FCurve:
373
+ """Adds driver(s) to the given property
374
+
375
+ :return: The driver(s) added.
376
+ :rtype: bpy.types.FCurve
377
+ """
261
378
  ...
262
379
 
263
- def driver_remove(self):
264
- """ """
380
+ def driver_remove(self) -> bool:
381
+ """Remove driver(s) from the given property
382
+
383
+ :return: Success of driver removal.
384
+ :rtype: bool
385
+ """
265
386
  ...
266
387
 
267
388
  def get(self):
268
- """ """
389
+ """Returns the value of the custom property assigned to key or default
390
+ when not found (matches Python's dictionary function of the same name).
391
+
392
+ """
269
393
  ...
270
394
 
271
395
  def id_properties_clear(self):
272
- """ """
396
+ """
397
+
398
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
399
+ """
273
400
  ...
274
401
 
275
402
  def id_properties_ensure(self):
276
- """ """
403
+ """
404
+
405
+ :return: the parent group for an RNA struct's custom IDProperties.
406
+ """
277
407
  ...
278
408
 
279
409
  def id_properties_ui(self):
280
- """ """
410
+ """
411
+
412
+ :return: Return an object used to manage an IDProperty's UI data.
413
+ """
281
414
  ...
282
415
 
283
416
  def is_extended(self):
284
417
  """ """
285
418
  ...
286
419
 
287
- def is_property_hidden(self):
288
- """ """
420
+ def is_property_hidden(self) -> bool:
421
+ """Check if a property is hidden.
422
+
423
+ :return: True when the property is hidden.
424
+ :rtype: bool
425
+ """
289
426
  ...
290
427
 
291
- def is_property_overridable_library(self):
292
- """ """
428
+ def is_property_overridable_library(self) -> bool:
429
+ """Check if a property is overridable.
430
+
431
+ :return: True when the property is overridable.
432
+ :rtype: bool
433
+ """
293
434
  ...
294
435
 
295
- def is_property_readonly(self):
296
- """ """
436
+ def is_property_readonly(self) -> bool:
437
+ """Check if a property is readonly.
438
+
439
+ :return: True when the property is readonly (not writable).
440
+ :rtype: bool
441
+ """
297
442
  ...
298
443
 
299
- def is_property_set(self):
300
- """ """
444
+ def is_property_set(self) -> bool:
445
+ """Check if a property is set, use for testing operator properties.
446
+
447
+ :return: True when the property has been set.
448
+ :rtype: bool
449
+ """
301
450
  ...
302
451
 
303
452
  def items(self):
304
- """ """
453
+ """Returns the items of this objects custom properties (matches Python's
454
+ dictionary function of the same name).
455
+
456
+ :return: custom property key, value pairs.
457
+ """
305
458
  ...
306
459
 
307
- def keyframe_delete(self):
308
- """ """
460
+ def keyframe_delete(self) -> bool:
461
+ """Remove a keyframe from this properties fcurve.
462
+
463
+ :return: Success of keyframe deletion.
464
+ :rtype: bool
465
+ """
309
466
  ...
310
467
 
311
- def keyframe_insert(self):
312
- """ """
468
+ def keyframe_insert(self) -> bool:
469
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
470
+
471
+ :return: Success of keyframe insertion.
472
+ :rtype: bool
473
+ """
313
474
  ...
314
475
 
315
476
  def keys(self):
316
- """ """
477
+ """Returns the keys of this objects custom properties (matches Python's
478
+ dictionary function of the same name).
479
+
480
+ :return: custom property keys.
481
+ """
317
482
  ...
318
483
 
319
- def path_from_id(self):
320
- """ """
484
+ def path_from_id(self) -> str:
485
+ """Returns the data path from the ID to this object (string).
486
+
487
+ :return: The path from `bpy.types.bpy_struct.id_data`
488
+ to this struct and property (when given).
489
+ :rtype: str
490
+ """
321
491
  ...
322
492
 
323
493
  def path_resolve(self):
324
- """ """
494
+ """Returns the property from the path, raise an exception when not found."""
325
495
  ...
326
496
 
327
497
  def pop(self):
328
- """ """
498
+ """Remove and return the value of the custom property assigned to key or default
499
+ when not found (matches Python's dictionary function of the same name).
500
+
501
+ """
329
502
  ...
330
503
 
331
504
  def prepend(self, draw_func):
332
- """
505
+ """Prepend a draw function to this menu, takes the same arguments as
506
+ the menus draw function
333
507
 
334
- :param draw_func:
508
+ :param draw_func:
335
509
  """
336
510
  ...
337
511
 
338
- def property_overridable_library_set(self):
339
- """ """
512
+ def property_overridable_library_set(self) -> bool:
513
+ """Define a property as overridable or not (only for custom properties!).
514
+
515
+ :return: True when the overridable status of the property was successfully set.
516
+ :rtype: bool
517
+ """
340
518
  ...
341
519
 
342
520
  def property_unset(self):
343
- """ """
521
+ """Unset a property, will use default value afterward."""
344
522
  ...
345
523
 
346
524
  def remove(self, draw_func):
347
- """
525
+ """Remove a draw function that has been added to this menu
348
526
 
349
527
  :param draw_func:
350
528
  """
351
529
  ...
352
530
 
353
531
  def type_recast(self):
354
- """ """
532
+ """Return a new instance, this is needed because types
533
+ such as textures can be changed at runtime.
534
+
535
+ :return: a new instance of this object with the type initialized again.
536
+ """
355
537
  ...
356
538
 
357
539
  def values(self):
358
- """ """
540
+ """Returns the values of this objects custom properties (matches Python's
541
+ dictionary function of the same name).
542
+
543
+ :return: custom property values.
544
+ """
359
545
  ...
360
546
 
361
547
  class EEVEE_MATERIAL_PT_context_material(
@@ -388,22 +574,35 @@ class EEVEE_MATERIAL_PT_context_material(
388
574
  """ """
389
575
 
390
576
  def append(self, draw_func):
391
- """
577
+ """Append a draw function to this menu,
578
+ takes the same arguments as the menus draw function
392
579
 
393
- :param draw_func:
580
+ :param draw_func:
394
581
  """
395
582
  ...
396
583
 
397
- def as_pointer(self):
398
- """ """
584
+ def as_pointer(self) -> int:
585
+ """Returns the memory address which holds a pointer to Blender's internal data
586
+
587
+ :return: int (memory address).
588
+ :rtype: int
589
+ """
399
590
  ...
400
591
 
401
- def bl_rna_get_subclass(self):
402
- """ """
592
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
593
+ """
594
+
595
+ :return: The RNA type or default when not found.
596
+ :rtype: bpy.types.Struct
597
+ """
403
598
  ...
404
599
 
405
- def bl_rna_get_subclass_py(self):
406
- """ """
600
+ def bl_rna_get_subclass_py(self) -> typing.Any:
601
+ """
602
+
603
+ :return: The class or default when not found.
604
+ :rtype: typing.Any
605
+ """
407
606
  ...
408
607
 
409
608
  def draw(self, context):
@@ -413,72 +612,129 @@ class EEVEE_MATERIAL_PT_context_material(
413
612
  """
414
613
  ...
415
614
 
416
- def driver_add(self):
417
- """ """
615
+ def driver_add(self) -> bpy.types.FCurve:
616
+ """Adds driver(s) to the given property
617
+
618
+ :return: The driver(s) added.
619
+ :rtype: bpy.types.FCurve
620
+ """
418
621
  ...
419
622
 
420
- def driver_remove(self):
421
- """ """
623
+ def driver_remove(self) -> bool:
624
+ """Remove driver(s) from the given property
625
+
626
+ :return: Success of driver removal.
627
+ :rtype: bool
628
+ """
422
629
  ...
423
630
 
424
631
  def get(self):
425
- """ """
632
+ """Returns the value of the custom property assigned to key or default
633
+ when not found (matches Python's dictionary function of the same name).
634
+
635
+ """
426
636
  ...
427
637
 
428
638
  def id_properties_clear(self):
429
- """ """
639
+ """
640
+
641
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
642
+ """
430
643
  ...
431
644
 
432
645
  def id_properties_ensure(self):
433
- """ """
646
+ """
647
+
648
+ :return: the parent group for an RNA struct's custom IDProperties.
649
+ """
434
650
  ...
435
651
 
436
652
  def id_properties_ui(self):
437
- """ """
653
+ """
654
+
655
+ :return: Return an object used to manage an IDProperty's UI data.
656
+ """
438
657
  ...
439
658
 
440
659
  def is_extended(self):
441
660
  """ """
442
661
  ...
443
662
 
444
- def is_property_hidden(self):
445
- """ """
663
+ def is_property_hidden(self) -> bool:
664
+ """Check if a property is hidden.
665
+
666
+ :return: True when the property is hidden.
667
+ :rtype: bool
668
+ """
446
669
  ...
447
670
 
448
- def is_property_overridable_library(self):
449
- """ """
671
+ def is_property_overridable_library(self) -> bool:
672
+ """Check if a property is overridable.
673
+
674
+ :return: True when the property is overridable.
675
+ :rtype: bool
676
+ """
450
677
  ...
451
678
 
452
- def is_property_readonly(self):
453
- """ """
679
+ def is_property_readonly(self) -> bool:
680
+ """Check if a property is readonly.
681
+
682
+ :return: True when the property is readonly (not writable).
683
+ :rtype: bool
684
+ """
454
685
  ...
455
686
 
456
- def is_property_set(self):
457
- """ """
687
+ def is_property_set(self) -> bool:
688
+ """Check if a property is set, use for testing operator properties.
689
+
690
+ :return: True when the property has been set.
691
+ :rtype: bool
692
+ """
458
693
  ...
459
694
 
460
695
  def items(self):
461
- """ """
696
+ """Returns the items of this objects custom properties (matches Python's
697
+ dictionary function of the same name).
698
+
699
+ :return: custom property key, value pairs.
700
+ """
462
701
  ...
463
702
 
464
- def keyframe_delete(self):
465
- """ """
703
+ def keyframe_delete(self) -> bool:
704
+ """Remove a keyframe from this properties fcurve.
705
+
706
+ :return: Success of keyframe deletion.
707
+ :rtype: bool
708
+ """
466
709
  ...
467
710
 
468
- def keyframe_insert(self):
469
- """ """
711
+ def keyframe_insert(self) -> bool:
712
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
713
+
714
+ :return: Success of keyframe insertion.
715
+ :rtype: bool
716
+ """
470
717
  ...
471
718
 
472
719
  def keys(self):
473
- """ """
720
+ """Returns the keys of this objects custom properties (matches Python's
721
+ dictionary function of the same name).
722
+
723
+ :return: custom property keys.
724
+ """
474
725
  ...
475
726
 
476
- def path_from_id(self):
477
- """ """
727
+ def path_from_id(self) -> str:
728
+ """Returns the data path from the ID to this object (string).
729
+
730
+ :return: The path from `bpy.types.bpy_struct.id_data`
731
+ to this struct and property (when given).
732
+ :rtype: str
733
+ """
478
734
  ...
479
735
 
480
736
  def path_resolve(self):
481
- """ """
737
+ """Returns the property from the path, raise an exception when not found."""
482
738
  ...
483
739
 
484
740
  def poll(self, context):
@@ -489,37 +745,53 @@ class EEVEE_MATERIAL_PT_context_material(
489
745
  ...
490
746
 
491
747
  def pop(self):
492
- """ """
748
+ """Remove and return the value of the custom property assigned to key or default
749
+ when not found (matches Python's dictionary function of the same name).
750
+
751
+ """
493
752
  ...
494
753
 
495
754
  def prepend(self, draw_func):
496
- """
755
+ """Prepend a draw function to this menu, takes the same arguments as
756
+ the menus draw function
497
757
 
498
- :param draw_func:
758
+ :param draw_func:
499
759
  """
500
760
  ...
501
761
 
502
- def property_overridable_library_set(self):
503
- """ """
762
+ def property_overridable_library_set(self) -> bool:
763
+ """Define a property as overridable or not (only for custom properties!).
764
+
765
+ :return: True when the overridable status of the property was successfully set.
766
+ :rtype: bool
767
+ """
504
768
  ...
505
769
 
506
770
  def property_unset(self):
507
- """ """
771
+ """Unset a property, will use default value afterward."""
508
772
  ...
509
773
 
510
774
  def remove(self, draw_func):
511
- """
775
+ """Remove a draw function that has been added to this menu
512
776
 
513
777
  :param draw_func:
514
778
  """
515
779
  ...
516
780
 
517
781
  def type_recast(self):
518
- """ """
782
+ """Return a new instance, this is needed because types
783
+ such as textures can be changed at runtime.
784
+
785
+ :return: a new instance of this object with the type initialized again.
786
+ """
519
787
  ...
520
788
 
521
789
  def values(self):
522
- """ """
790
+ """Returns the values of this objects custom properties (matches Python's
791
+ dictionary function of the same name).
792
+
793
+ :return: custom property values.
794
+ """
523
795
  ...
524
796
 
525
797
  class EEVEE_MATERIAL_PT_displacement(
@@ -555,22 +827,35 @@ class EEVEE_MATERIAL_PT_displacement(
555
827
  """ """
556
828
 
557
829
  def append(self, draw_func):
558
- """
830
+ """Append a draw function to this menu,
831
+ takes the same arguments as the menus draw function
559
832
 
560
- :param draw_func:
833
+ :param draw_func:
561
834
  """
562
835
  ...
563
836
 
564
- def as_pointer(self):
565
- """ """
837
+ def as_pointer(self) -> int:
838
+ """Returns the memory address which holds a pointer to Blender's internal data
839
+
840
+ :return: int (memory address).
841
+ :rtype: int
842
+ """
566
843
  ...
567
844
 
568
- def bl_rna_get_subclass(self):
569
- """ """
845
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
846
+ """
847
+
848
+ :return: The RNA type or default when not found.
849
+ :rtype: bpy.types.Struct
850
+ """
570
851
  ...
571
852
 
572
- def bl_rna_get_subclass_py(self):
573
- """ """
853
+ def bl_rna_get_subclass_py(self) -> typing.Any:
854
+ """
855
+
856
+ :return: The class or default when not found.
857
+ :rtype: typing.Any
858
+ """
574
859
  ...
575
860
 
576
861
  def draw(self, context):
@@ -580,72 +865,129 @@ class EEVEE_MATERIAL_PT_displacement(
580
865
  """
581
866
  ...
582
867
 
583
- def driver_add(self):
584
- """ """
585
- ...
868
+ def driver_add(self) -> bpy.types.FCurve:
869
+ """Adds driver(s) to the given property
586
870
 
587
- def driver_remove(self):
588
- """ """
871
+ :return: The driver(s) added.
872
+ :rtype: bpy.types.FCurve
873
+ """
589
874
  ...
590
875
 
591
- def get(self):
592
- """ """
876
+ def driver_remove(self) -> bool:
877
+ """Remove driver(s) from the given property
878
+
879
+ :return: Success of driver removal.
880
+ :rtype: bool
881
+ """
882
+ ...
883
+
884
+ def get(self):
885
+ """Returns the value of the custom property assigned to key or default
886
+ when not found (matches Python's dictionary function of the same name).
887
+
888
+ """
593
889
  ...
594
890
 
595
891
  def id_properties_clear(self):
596
- """ """
892
+ """
893
+
894
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
895
+ """
597
896
  ...
598
897
 
599
898
  def id_properties_ensure(self):
600
- """ """
899
+ """
900
+
901
+ :return: the parent group for an RNA struct's custom IDProperties.
902
+ """
601
903
  ...
602
904
 
603
905
  def id_properties_ui(self):
604
- """ """
906
+ """
907
+
908
+ :return: Return an object used to manage an IDProperty's UI data.
909
+ """
605
910
  ...
606
911
 
607
912
  def is_extended(self):
608
913
  """ """
609
914
  ...
610
915
 
611
- def is_property_hidden(self):
612
- """ """
916
+ def is_property_hidden(self) -> bool:
917
+ """Check if a property is hidden.
918
+
919
+ :return: True when the property is hidden.
920
+ :rtype: bool
921
+ """
613
922
  ...
614
923
 
615
- def is_property_overridable_library(self):
616
- """ """
924
+ def is_property_overridable_library(self) -> bool:
925
+ """Check if a property is overridable.
926
+
927
+ :return: True when the property is overridable.
928
+ :rtype: bool
929
+ """
617
930
  ...
618
931
 
619
- def is_property_readonly(self):
620
- """ """
932
+ def is_property_readonly(self) -> bool:
933
+ """Check if a property is readonly.
934
+
935
+ :return: True when the property is readonly (not writable).
936
+ :rtype: bool
937
+ """
621
938
  ...
622
939
 
623
- def is_property_set(self):
624
- """ """
940
+ def is_property_set(self) -> bool:
941
+ """Check if a property is set, use for testing operator properties.
942
+
943
+ :return: True when the property has been set.
944
+ :rtype: bool
945
+ """
625
946
  ...
626
947
 
627
948
  def items(self):
628
- """ """
949
+ """Returns the items of this objects custom properties (matches Python's
950
+ dictionary function of the same name).
951
+
952
+ :return: custom property key, value pairs.
953
+ """
629
954
  ...
630
955
 
631
- def keyframe_delete(self):
632
- """ """
956
+ def keyframe_delete(self) -> bool:
957
+ """Remove a keyframe from this properties fcurve.
958
+
959
+ :return: Success of keyframe deletion.
960
+ :rtype: bool
961
+ """
633
962
  ...
634
963
 
635
- def keyframe_insert(self):
636
- """ """
964
+ def keyframe_insert(self) -> bool:
965
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
966
+
967
+ :return: Success of keyframe insertion.
968
+ :rtype: bool
969
+ """
637
970
  ...
638
971
 
639
972
  def keys(self):
640
- """ """
973
+ """Returns the keys of this objects custom properties (matches Python's
974
+ dictionary function of the same name).
975
+
976
+ :return: custom property keys.
977
+ """
641
978
  ...
642
979
 
643
- def path_from_id(self):
644
- """ """
980
+ def path_from_id(self) -> str:
981
+ """Returns the data path from the ID to this object (string).
982
+
983
+ :return: The path from `bpy.types.bpy_struct.id_data`
984
+ to this struct and property (when given).
985
+ :rtype: str
986
+ """
645
987
  ...
646
988
 
647
989
  def path_resolve(self):
648
- """ """
990
+ """Returns the property from the path, raise an exception when not found."""
649
991
  ...
650
992
 
651
993
  def poll(self, context):
@@ -656,37 +998,53 @@ class EEVEE_MATERIAL_PT_displacement(
656
998
  ...
657
999
 
658
1000
  def pop(self):
659
- """ """
1001
+ """Remove and return the value of the custom property assigned to key or default
1002
+ when not found (matches Python's dictionary function of the same name).
1003
+
1004
+ """
660
1005
  ...
661
1006
 
662
1007
  def prepend(self, draw_func):
663
- """
1008
+ """Prepend a draw function to this menu, takes the same arguments as
1009
+ the menus draw function
664
1010
 
665
- :param draw_func:
1011
+ :param draw_func:
666
1012
  """
667
1013
  ...
668
1014
 
669
- def property_overridable_library_set(self):
670
- """ """
1015
+ def property_overridable_library_set(self) -> bool:
1016
+ """Define a property as overridable or not (only for custom properties!).
1017
+
1018
+ :return: True when the overridable status of the property was successfully set.
1019
+ :rtype: bool
1020
+ """
671
1021
  ...
672
1022
 
673
1023
  def property_unset(self):
674
- """ """
1024
+ """Unset a property, will use default value afterward."""
675
1025
  ...
676
1026
 
677
1027
  def remove(self, draw_func):
678
- """
1028
+ """Remove a draw function that has been added to this menu
679
1029
 
680
1030
  :param draw_func:
681
1031
  """
682
1032
  ...
683
1033
 
684
1034
  def type_recast(self):
685
- """ """
1035
+ """Return a new instance, this is needed because types
1036
+ such as textures can be changed at runtime.
1037
+
1038
+ :return: a new instance of this object with the type initialized again.
1039
+ """
686
1040
  ...
687
1041
 
688
1042
  def values(self):
689
- """ """
1043
+ """Returns the values of this objects custom properties (matches Python's
1044
+ dictionary function of the same name).
1045
+
1046
+ :return: custom property values.
1047
+ """
690
1048
  ...
691
1049
 
692
1050
  class EEVEE_MATERIAL_PT_settings(
@@ -716,22 +1074,35 @@ class EEVEE_MATERIAL_PT_settings(
716
1074
  """ """
717
1075
 
718
1076
  def append(self, draw_func):
719
- """
1077
+ """Append a draw function to this menu,
1078
+ takes the same arguments as the menus draw function
720
1079
 
721
- :param draw_func:
1080
+ :param draw_func:
722
1081
  """
723
1082
  ...
724
1083
 
725
- def as_pointer(self):
726
- """ """
1084
+ def as_pointer(self) -> int:
1085
+ """Returns the memory address which holds a pointer to Blender's internal data
1086
+
1087
+ :return: int (memory address).
1088
+ :rtype: int
1089
+ """
727
1090
  ...
728
1091
 
729
- def bl_rna_get_subclass(self):
730
- """ """
1092
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1093
+ """
1094
+
1095
+ :return: The RNA type or default when not found.
1096
+ :rtype: bpy.types.Struct
1097
+ """
731
1098
  ...
732
1099
 
733
- def bl_rna_get_subclass_py(self):
734
- """ """
1100
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1101
+ """
1102
+
1103
+ :return: The class or default when not found.
1104
+ :rtype: typing.Any
1105
+ """
735
1106
  ...
736
1107
 
737
1108
  def draw(self, context):
@@ -741,72 +1112,129 @@ class EEVEE_MATERIAL_PT_settings(
741
1112
  """
742
1113
  ...
743
1114
 
744
- def driver_add(self):
745
- """ """
1115
+ def driver_add(self) -> bpy.types.FCurve:
1116
+ """Adds driver(s) to the given property
1117
+
1118
+ :return: The driver(s) added.
1119
+ :rtype: bpy.types.FCurve
1120
+ """
746
1121
  ...
747
1122
 
748
- def driver_remove(self):
749
- """ """
1123
+ def driver_remove(self) -> bool:
1124
+ """Remove driver(s) from the given property
1125
+
1126
+ :return: Success of driver removal.
1127
+ :rtype: bool
1128
+ """
750
1129
  ...
751
1130
 
752
1131
  def get(self):
753
- """ """
1132
+ """Returns the value of the custom property assigned to key or default
1133
+ when not found (matches Python's dictionary function of the same name).
1134
+
1135
+ """
754
1136
  ...
755
1137
 
756
1138
  def id_properties_clear(self):
757
- """ """
1139
+ """
1140
+
1141
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1142
+ """
758
1143
  ...
759
1144
 
760
1145
  def id_properties_ensure(self):
761
- """ """
1146
+ """
1147
+
1148
+ :return: the parent group for an RNA struct's custom IDProperties.
1149
+ """
762
1150
  ...
763
1151
 
764
1152
  def id_properties_ui(self):
765
- """ """
1153
+ """
1154
+
1155
+ :return: Return an object used to manage an IDProperty's UI data.
1156
+ """
766
1157
  ...
767
1158
 
768
1159
  def is_extended(self):
769
1160
  """ """
770
1161
  ...
771
1162
 
772
- def is_property_hidden(self):
773
- """ """
1163
+ def is_property_hidden(self) -> bool:
1164
+ """Check if a property is hidden.
1165
+
1166
+ :return: True when the property is hidden.
1167
+ :rtype: bool
1168
+ """
774
1169
  ...
775
1170
 
776
- def is_property_overridable_library(self):
777
- """ """
1171
+ def is_property_overridable_library(self) -> bool:
1172
+ """Check if a property is overridable.
1173
+
1174
+ :return: True when the property is overridable.
1175
+ :rtype: bool
1176
+ """
778
1177
  ...
779
1178
 
780
- def is_property_readonly(self):
781
- """ """
1179
+ def is_property_readonly(self) -> bool:
1180
+ """Check if a property is readonly.
1181
+
1182
+ :return: True when the property is readonly (not writable).
1183
+ :rtype: bool
1184
+ """
782
1185
  ...
783
1186
 
784
- def is_property_set(self):
785
- """ """
1187
+ def is_property_set(self) -> bool:
1188
+ """Check if a property is set, use for testing operator properties.
1189
+
1190
+ :return: True when the property has been set.
1191
+ :rtype: bool
1192
+ """
786
1193
  ...
787
1194
 
788
1195
  def items(self):
789
- """ """
1196
+ """Returns the items of this objects custom properties (matches Python's
1197
+ dictionary function of the same name).
1198
+
1199
+ :return: custom property key, value pairs.
1200
+ """
790
1201
  ...
791
1202
 
792
- def keyframe_delete(self):
793
- """ """
1203
+ def keyframe_delete(self) -> bool:
1204
+ """Remove a keyframe from this properties fcurve.
1205
+
1206
+ :return: Success of keyframe deletion.
1207
+ :rtype: bool
1208
+ """
794
1209
  ...
795
1210
 
796
- def keyframe_insert(self):
797
- """ """
1211
+ def keyframe_insert(self) -> bool:
1212
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1213
+
1214
+ :return: Success of keyframe insertion.
1215
+ :rtype: bool
1216
+ """
798
1217
  ...
799
1218
 
800
1219
  def keys(self):
801
- """ """
1220
+ """Returns the keys of this objects custom properties (matches Python's
1221
+ dictionary function of the same name).
1222
+
1223
+ :return: custom property keys.
1224
+ """
802
1225
  ...
803
1226
 
804
- def path_from_id(self):
805
- """ """
1227
+ def path_from_id(self) -> str:
1228
+ """Returns the data path from the ID to this object (string).
1229
+
1230
+ :return: The path from `bpy.types.bpy_struct.id_data`
1231
+ to this struct and property (when given).
1232
+ :rtype: str
1233
+ """
806
1234
  ...
807
1235
 
808
1236
  def path_resolve(self):
809
- """ """
1237
+ """Returns the property from the path, raise an exception when not found."""
810
1238
  ...
811
1239
 
812
1240
  def poll(self, context):
@@ -817,37 +1245,53 @@ class EEVEE_MATERIAL_PT_settings(
817
1245
  ...
818
1246
 
819
1247
  def pop(self):
820
- """ """
1248
+ """Remove and return the value of the custom property assigned to key or default
1249
+ when not found (matches Python's dictionary function of the same name).
1250
+
1251
+ """
821
1252
  ...
822
1253
 
823
1254
  def prepend(self, draw_func):
824
- """
1255
+ """Prepend a draw function to this menu, takes the same arguments as
1256
+ the menus draw function
825
1257
 
826
- :param draw_func:
1258
+ :param draw_func:
827
1259
  """
828
1260
  ...
829
1261
 
830
- def property_overridable_library_set(self):
831
- """ """
1262
+ def property_overridable_library_set(self) -> bool:
1263
+ """Define a property as overridable or not (only for custom properties!).
1264
+
1265
+ :return: True when the overridable status of the property was successfully set.
1266
+ :rtype: bool
1267
+ """
832
1268
  ...
833
1269
 
834
1270
  def property_unset(self):
835
- """ """
1271
+ """Unset a property, will use default value afterward."""
836
1272
  ...
837
1273
 
838
1274
  def remove(self, draw_func):
839
- """
1275
+ """Remove a draw function that has been added to this menu
840
1276
 
841
1277
  :param draw_func:
842
1278
  """
843
1279
  ...
844
1280
 
845
1281
  def type_recast(self):
846
- """ """
1282
+ """Return a new instance, this is needed because types
1283
+ such as textures can be changed at runtime.
1284
+
1285
+ :return: a new instance of this object with the type initialized again.
1286
+ """
847
1287
  ...
848
1288
 
849
1289
  def values(self):
850
- """ """
1290
+ """Returns the values of this objects custom properties (matches Python's
1291
+ dictionary function of the same name).
1292
+
1293
+ :return: custom property values.
1294
+ """
851
1295
  ...
852
1296
 
853
1297
  class EEVEE_MATERIAL_PT_surface(
@@ -877,22 +1321,35 @@ class EEVEE_MATERIAL_PT_surface(
877
1321
  """ """
878
1322
 
879
1323
  def append(self, draw_func):
880
- """
1324
+ """Append a draw function to this menu,
1325
+ takes the same arguments as the menus draw function
881
1326
 
882
- :param draw_func:
1327
+ :param draw_func:
883
1328
  """
884
1329
  ...
885
1330
 
886
- def as_pointer(self):
887
- """ """
1331
+ def as_pointer(self) -> int:
1332
+ """Returns the memory address which holds a pointer to Blender's internal data
1333
+
1334
+ :return: int (memory address).
1335
+ :rtype: int
1336
+ """
888
1337
  ...
889
1338
 
890
- def bl_rna_get_subclass(self):
891
- """ """
1339
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1340
+ """
1341
+
1342
+ :return: The RNA type or default when not found.
1343
+ :rtype: bpy.types.Struct
1344
+ """
892
1345
  ...
893
1346
 
894
- def bl_rna_get_subclass_py(self):
895
- """ """
1347
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1348
+ """
1349
+
1350
+ :return: The class or default when not found.
1351
+ :rtype: typing.Any
1352
+ """
896
1353
  ...
897
1354
 
898
1355
  def draw(self, context):
@@ -902,72 +1359,129 @@ class EEVEE_MATERIAL_PT_surface(
902
1359
  """
903
1360
  ...
904
1361
 
905
- def driver_add(self):
906
- """ """
1362
+ def driver_add(self) -> bpy.types.FCurve:
1363
+ """Adds driver(s) to the given property
1364
+
1365
+ :return: The driver(s) added.
1366
+ :rtype: bpy.types.FCurve
1367
+ """
907
1368
  ...
908
1369
 
909
- def driver_remove(self):
910
- """ """
1370
+ def driver_remove(self) -> bool:
1371
+ """Remove driver(s) from the given property
1372
+
1373
+ :return: Success of driver removal.
1374
+ :rtype: bool
1375
+ """
911
1376
  ...
912
1377
 
913
1378
  def get(self):
914
- """ """
1379
+ """Returns the value of the custom property assigned to key or default
1380
+ when not found (matches Python's dictionary function of the same name).
1381
+
1382
+ """
915
1383
  ...
916
1384
 
917
1385
  def id_properties_clear(self):
918
- """ """
1386
+ """
1387
+
1388
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1389
+ """
919
1390
  ...
920
1391
 
921
1392
  def id_properties_ensure(self):
922
- """ """
1393
+ """
1394
+
1395
+ :return: the parent group for an RNA struct's custom IDProperties.
1396
+ """
923
1397
  ...
924
1398
 
925
1399
  def id_properties_ui(self):
926
- """ """
1400
+ """
1401
+
1402
+ :return: Return an object used to manage an IDProperty's UI data.
1403
+ """
927
1404
  ...
928
1405
 
929
1406
  def is_extended(self):
930
1407
  """ """
931
1408
  ...
932
1409
 
933
- def is_property_hidden(self):
934
- """ """
1410
+ def is_property_hidden(self) -> bool:
1411
+ """Check if a property is hidden.
1412
+
1413
+ :return: True when the property is hidden.
1414
+ :rtype: bool
1415
+ """
935
1416
  ...
936
1417
 
937
- def is_property_overridable_library(self):
938
- """ """
1418
+ def is_property_overridable_library(self) -> bool:
1419
+ """Check if a property is overridable.
1420
+
1421
+ :return: True when the property is overridable.
1422
+ :rtype: bool
1423
+ """
939
1424
  ...
940
1425
 
941
- def is_property_readonly(self):
942
- """ """
1426
+ def is_property_readonly(self) -> bool:
1427
+ """Check if a property is readonly.
1428
+
1429
+ :return: True when the property is readonly (not writable).
1430
+ :rtype: bool
1431
+ """
943
1432
  ...
944
1433
 
945
- def is_property_set(self):
946
- """ """
1434
+ def is_property_set(self) -> bool:
1435
+ """Check if a property is set, use for testing operator properties.
1436
+
1437
+ :return: True when the property has been set.
1438
+ :rtype: bool
1439
+ """
947
1440
  ...
948
1441
 
949
1442
  def items(self):
950
- """ """
1443
+ """Returns the items of this objects custom properties (matches Python's
1444
+ dictionary function of the same name).
1445
+
1446
+ :return: custom property key, value pairs.
1447
+ """
951
1448
  ...
952
1449
 
953
- def keyframe_delete(self):
954
- """ """
1450
+ def keyframe_delete(self) -> bool:
1451
+ """Remove a keyframe from this properties fcurve.
1452
+
1453
+ :return: Success of keyframe deletion.
1454
+ :rtype: bool
1455
+ """
955
1456
  ...
956
1457
 
957
- def keyframe_insert(self):
958
- """ """
1458
+ def keyframe_insert(self) -> bool:
1459
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1460
+
1461
+ :return: Success of keyframe insertion.
1462
+ :rtype: bool
1463
+ """
959
1464
  ...
960
1465
 
961
1466
  def keys(self):
962
- """ """
1467
+ """Returns the keys of this objects custom properties (matches Python's
1468
+ dictionary function of the same name).
1469
+
1470
+ :return: custom property keys.
1471
+ """
963
1472
  ...
964
1473
 
965
- def path_from_id(self):
966
- """ """
1474
+ def path_from_id(self) -> str:
1475
+ """Returns the data path from the ID to this object (string).
1476
+
1477
+ :return: The path from `bpy.types.bpy_struct.id_data`
1478
+ to this struct and property (when given).
1479
+ :rtype: str
1480
+ """
967
1481
  ...
968
1482
 
969
1483
  def path_resolve(self):
970
- """ """
1484
+ """Returns the property from the path, raise an exception when not found."""
971
1485
  ...
972
1486
 
973
1487
  def poll(self, context):
@@ -978,37 +1492,53 @@ class EEVEE_MATERIAL_PT_surface(
978
1492
  ...
979
1493
 
980
1494
  def pop(self):
981
- """ """
1495
+ """Remove and return the value of the custom property assigned to key or default
1496
+ when not found (matches Python's dictionary function of the same name).
1497
+
1498
+ """
982
1499
  ...
983
1500
 
984
1501
  def prepend(self, draw_func):
985
- """
1502
+ """Prepend a draw function to this menu, takes the same arguments as
1503
+ the menus draw function
986
1504
 
987
- :param draw_func:
1505
+ :param draw_func:
988
1506
  """
989
1507
  ...
990
1508
 
991
- def property_overridable_library_set(self):
992
- """ """
1509
+ def property_overridable_library_set(self) -> bool:
1510
+ """Define a property as overridable or not (only for custom properties!).
1511
+
1512
+ :return: True when the overridable status of the property was successfully set.
1513
+ :rtype: bool
1514
+ """
993
1515
  ...
994
1516
 
995
1517
  def property_unset(self):
996
- """ """
1518
+ """Unset a property, will use default value afterward."""
997
1519
  ...
998
1520
 
999
1521
  def remove(self, draw_func):
1000
- """
1522
+ """Remove a draw function that has been added to this menu
1001
1523
 
1002
1524
  :param draw_func:
1003
1525
  """
1004
1526
  ...
1005
1527
 
1006
1528
  def type_recast(self):
1007
- """ """
1529
+ """Return a new instance, this is needed because types
1530
+ such as textures can be changed at runtime.
1531
+
1532
+ :return: a new instance of this object with the type initialized again.
1533
+ """
1008
1534
  ...
1009
1535
 
1010
1536
  def values(self):
1011
- """ """
1537
+ """Returns the values of this objects custom properties (matches Python's
1538
+ dictionary function of the same name).
1539
+
1540
+ :return: custom property values.
1541
+ """
1012
1542
  ...
1013
1543
 
1014
1544
  class EEVEE_MATERIAL_PT_thickness(
@@ -1044,22 +1574,35 @@ class EEVEE_MATERIAL_PT_thickness(
1044
1574
  """ """
1045
1575
 
1046
1576
  def append(self, draw_func):
1047
- """
1577
+ """Append a draw function to this menu,
1578
+ takes the same arguments as the menus draw function
1048
1579
 
1049
- :param draw_func:
1580
+ :param draw_func:
1050
1581
  """
1051
1582
  ...
1052
1583
 
1053
- def as_pointer(self):
1054
- """ """
1584
+ def as_pointer(self) -> int:
1585
+ """Returns the memory address which holds a pointer to Blender's internal data
1586
+
1587
+ :return: int (memory address).
1588
+ :rtype: int
1589
+ """
1055
1590
  ...
1056
1591
 
1057
- def bl_rna_get_subclass(self):
1058
- """ """
1592
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1593
+ """
1594
+
1595
+ :return: The RNA type or default when not found.
1596
+ :rtype: bpy.types.Struct
1597
+ """
1059
1598
  ...
1060
1599
 
1061
- def bl_rna_get_subclass_py(self):
1062
- """ """
1600
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1601
+ """
1602
+
1603
+ :return: The class or default when not found.
1604
+ :rtype: typing.Any
1605
+ """
1063
1606
  ...
1064
1607
 
1065
1608
  def draw(self, context):
@@ -1069,72 +1612,129 @@ class EEVEE_MATERIAL_PT_thickness(
1069
1612
  """
1070
1613
  ...
1071
1614
 
1072
- def driver_add(self):
1073
- """ """
1615
+ def driver_add(self) -> bpy.types.FCurve:
1616
+ """Adds driver(s) to the given property
1617
+
1618
+ :return: The driver(s) added.
1619
+ :rtype: bpy.types.FCurve
1620
+ """
1074
1621
  ...
1075
1622
 
1076
- def driver_remove(self):
1077
- """ """
1623
+ def driver_remove(self) -> bool:
1624
+ """Remove driver(s) from the given property
1625
+
1626
+ :return: Success of driver removal.
1627
+ :rtype: bool
1628
+ """
1078
1629
  ...
1079
1630
 
1080
1631
  def get(self):
1081
- """ """
1632
+ """Returns the value of the custom property assigned to key or default
1633
+ when not found (matches Python's dictionary function of the same name).
1634
+
1635
+ """
1082
1636
  ...
1083
1637
 
1084
1638
  def id_properties_clear(self):
1085
- """ """
1639
+ """
1640
+
1641
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1642
+ """
1086
1643
  ...
1087
1644
 
1088
1645
  def id_properties_ensure(self):
1089
- """ """
1646
+ """
1647
+
1648
+ :return: the parent group for an RNA struct's custom IDProperties.
1649
+ """
1090
1650
  ...
1091
1651
 
1092
1652
  def id_properties_ui(self):
1093
- """ """
1653
+ """
1654
+
1655
+ :return: Return an object used to manage an IDProperty's UI data.
1656
+ """
1094
1657
  ...
1095
1658
 
1096
1659
  def is_extended(self):
1097
1660
  """ """
1098
1661
  ...
1099
1662
 
1100
- def is_property_hidden(self):
1101
- """ """
1663
+ def is_property_hidden(self) -> bool:
1664
+ """Check if a property is hidden.
1665
+
1666
+ :return: True when the property is hidden.
1667
+ :rtype: bool
1668
+ """
1102
1669
  ...
1103
1670
 
1104
- def is_property_overridable_library(self):
1105
- """ """
1671
+ def is_property_overridable_library(self) -> bool:
1672
+ """Check if a property is overridable.
1673
+
1674
+ :return: True when the property is overridable.
1675
+ :rtype: bool
1676
+ """
1106
1677
  ...
1107
1678
 
1108
- def is_property_readonly(self):
1109
- """ """
1679
+ def is_property_readonly(self) -> bool:
1680
+ """Check if a property is readonly.
1681
+
1682
+ :return: True when the property is readonly (not writable).
1683
+ :rtype: bool
1684
+ """
1110
1685
  ...
1111
1686
 
1112
- def is_property_set(self):
1113
- """ """
1687
+ def is_property_set(self) -> bool:
1688
+ """Check if a property is set, use for testing operator properties.
1689
+
1690
+ :return: True when the property has been set.
1691
+ :rtype: bool
1692
+ """
1114
1693
  ...
1115
1694
 
1116
1695
  def items(self):
1117
- """ """
1696
+ """Returns the items of this objects custom properties (matches Python's
1697
+ dictionary function of the same name).
1698
+
1699
+ :return: custom property key, value pairs.
1700
+ """
1118
1701
  ...
1119
1702
 
1120
- def keyframe_delete(self):
1121
- """ """
1703
+ def keyframe_delete(self) -> bool:
1704
+ """Remove a keyframe from this properties fcurve.
1705
+
1706
+ :return: Success of keyframe deletion.
1707
+ :rtype: bool
1708
+ """
1122
1709
  ...
1123
1710
 
1124
- def keyframe_insert(self):
1125
- """ """
1711
+ def keyframe_insert(self) -> bool:
1712
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1713
+
1714
+ :return: Success of keyframe insertion.
1715
+ :rtype: bool
1716
+ """
1126
1717
  ...
1127
1718
 
1128
1719
  def keys(self):
1129
- """ """
1720
+ """Returns the keys of this objects custom properties (matches Python's
1721
+ dictionary function of the same name).
1722
+
1723
+ :return: custom property keys.
1724
+ """
1130
1725
  ...
1131
1726
 
1132
- def path_from_id(self):
1133
- """ """
1727
+ def path_from_id(self) -> str:
1728
+ """Returns the data path from the ID to this object (string).
1729
+
1730
+ :return: The path from `bpy.types.bpy_struct.id_data`
1731
+ to this struct and property (when given).
1732
+ :rtype: str
1733
+ """
1134
1734
  ...
1135
1735
 
1136
1736
  def path_resolve(self):
1137
- """ """
1737
+ """Returns the property from the path, raise an exception when not found."""
1138
1738
  ...
1139
1739
 
1140
1740
  def poll(self, context):
@@ -1145,37 +1745,53 @@ class EEVEE_MATERIAL_PT_thickness(
1145
1745
  ...
1146
1746
 
1147
1747
  def pop(self):
1148
- """ """
1748
+ """Remove and return the value of the custom property assigned to key or default
1749
+ when not found (matches Python's dictionary function of the same name).
1750
+
1751
+ """
1149
1752
  ...
1150
1753
 
1151
1754
  def prepend(self, draw_func):
1152
- """
1755
+ """Prepend a draw function to this menu, takes the same arguments as
1756
+ the menus draw function
1153
1757
 
1154
- :param draw_func:
1758
+ :param draw_func:
1155
1759
  """
1156
1760
  ...
1157
1761
 
1158
- def property_overridable_library_set(self):
1159
- """ """
1762
+ def property_overridable_library_set(self) -> bool:
1763
+ """Define a property as overridable or not (only for custom properties!).
1764
+
1765
+ :return: True when the overridable status of the property was successfully set.
1766
+ :rtype: bool
1767
+ """
1160
1768
  ...
1161
1769
 
1162
1770
  def property_unset(self):
1163
- """ """
1771
+ """Unset a property, will use default value afterward."""
1164
1772
  ...
1165
1773
 
1166
1774
  def remove(self, draw_func):
1167
- """
1775
+ """Remove a draw function that has been added to this menu
1168
1776
 
1169
1777
  :param draw_func:
1170
1778
  """
1171
1779
  ...
1172
1780
 
1173
1781
  def type_recast(self):
1174
- """ """
1782
+ """Return a new instance, this is needed because types
1783
+ such as textures can be changed at runtime.
1784
+
1785
+ :return: a new instance of this object with the type initialized again.
1786
+ """
1175
1787
  ...
1176
1788
 
1177
1789
  def values(self):
1178
- """ """
1790
+ """Returns the values of this objects custom properties (matches Python's
1791
+ dictionary function of the same name).
1792
+
1793
+ :return: custom property values.
1794
+ """
1179
1795
  ...
1180
1796
 
1181
1797
  class EEVEE_MATERIAL_PT_viewport_settings(
@@ -1208,22 +1824,35 @@ class EEVEE_MATERIAL_PT_viewport_settings(
1208
1824
  """ """
1209
1825
 
1210
1826
  def append(self, draw_func):
1211
- """
1827
+ """Append a draw function to this menu,
1828
+ takes the same arguments as the menus draw function
1212
1829
 
1213
- :param draw_func:
1830
+ :param draw_func:
1214
1831
  """
1215
1832
  ...
1216
1833
 
1217
- def as_pointer(self):
1218
- """ """
1834
+ def as_pointer(self) -> int:
1835
+ """Returns the memory address which holds a pointer to Blender's internal data
1836
+
1837
+ :return: int (memory address).
1838
+ :rtype: int
1839
+ """
1219
1840
  ...
1220
1841
 
1221
- def bl_rna_get_subclass(self):
1222
- """ """
1842
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1843
+ """
1844
+
1845
+ :return: The RNA type or default when not found.
1846
+ :rtype: bpy.types.Struct
1847
+ """
1223
1848
  ...
1224
1849
 
1225
- def bl_rna_get_subclass_py(self):
1226
- """ """
1850
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1851
+ """
1852
+
1853
+ :return: The class or default when not found.
1854
+ :rtype: typing.Any
1855
+ """
1227
1856
  ...
1228
1857
 
1229
1858
  def draw(self, context):
@@ -1233,72 +1862,129 @@ class EEVEE_MATERIAL_PT_viewport_settings(
1233
1862
  """
1234
1863
  ...
1235
1864
 
1236
- def driver_add(self):
1237
- """ """
1865
+ def driver_add(self) -> bpy.types.FCurve:
1866
+ """Adds driver(s) to the given property
1867
+
1868
+ :return: The driver(s) added.
1869
+ :rtype: bpy.types.FCurve
1870
+ """
1238
1871
  ...
1239
1872
 
1240
- def driver_remove(self):
1241
- """ """
1873
+ def driver_remove(self) -> bool:
1874
+ """Remove driver(s) from the given property
1875
+
1876
+ :return: Success of driver removal.
1877
+ :rtype: bool
1878
+ """
1242
1879
  ...
1243
1880
 
1244
1881
  def get(self):
1245
- """ """
1882
+ """Returns the value of the custom property assigned to key or default
1883
+ when not found (matches Python's dictionary function of the same name).
1884
+
1885
+ """
1246
1886
  ...
1247
1887
 
1248
1888
  def id_properties_clear(self):
1249
- """ """
1889
+ """
1890
+
1891
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1892
+ """
1250
1893
  ...
1251
1894
 
1252
1895
  def id_properties_ensure(self):
1253
- """ """
1896
+ """
1897
+
1898
+ :return: the parent group for an RNA struct's custom IDProperties.
1899
+ """
1254
1900
  ...
1255
1901
 
1256
1902
  def id_properties_ui(self):
1257
- """ """
1903
+ """
1904
+
1905
+ :return: Return an object used to manage an IDProperty's UI data.
1906
+ """
1258
1907
  ...
1259
1908
 
1260
1909
  def is_extended(self):
1261
1910
  """ """
1262
1911
  ...
1263
1912
 
1264
- def is_property_hidden(self):
1265
- """ """
1913
+ def is_property_hidden(self) -> bool:
1914
+ """Check if a property is hidden.
1915
+
1916
+ :return: True when the property is hidden.
1917
+ :rtype: bool
1918
+ """
1266
1919
  ...
1267
1920
 
1268
- def is_property_overridable_library(self):
1269
- """ """
1921
+ def is_property_overridable_library(self) -> bool:
1922
+ """Check if a property is overridable.
1923
+
1924
+ :return: True when the property is overridable.
1925
+ :rtype: bool
1926
+ """
1270
1927
  ...
1271
1928
 
1272
- def is_property_readonly(self):
1273
- """ """
1929
+ def is_property_readonly(self) -> bool:
1930
+ """Check if a property is readonly.
1931
+
1932
+ :return: True when the property is readonly (not writable).
1933
+ :rtype: bool
1934
+ """
1274
1935
  ...
1275
1936
 
1276
- def is_property_set(self):
1277
- """ """
1937
+ def is_property_set(self) -> bool:
1938
+ """Check if a property is set, use for testing operator properties.
1939
+
1940
+ :return: True when the property has been set.
1941
+ :rtype: bool
1942
+ """
1278
1943
  ...
1279
1944
 
1280
1945
  def items(self):
1281
- """ """
1946
+ """Returns the items of this objects custom properties (matches Python's
1947
+ dictionary function of the same name).
1948
+
1949
+ :return: custom property key, value pairs.
1950
+ """
1282
1951
  ...
1283
1952
 
1284
- def keyframe_delete(self):
1285
- """ """
1953
+ def keyframe_delete(self) -> bool:
1954
+ """Remove a keyframe from this properties fcurve.
1955
+
1956
+ :return: Success of keyframe deletion.
1957
+ :rtype: bool
1958
+ """
1286
1959
  ...
1287
1960
 
1288
- def keyframe_insert(self):
1289
- """ """
1961
+ def keyframe_insert(self) -> bool:
1962
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1963
+
1964
+ :return: Success of keyframe insertion.
1965
+ :rtype: bool
1966
+ """
1290
1967
  ...
1291
1968
 
1292
1969
  def keys(self):
1293
- """ """
1970
+ """Returns the keys of this objects custom properties (matches Python's
1971
+ dictionary function of the same name).
1972
+
1973
+ :return: custom property keys.
1974
+ """
1294
1975
  ...
1295
1976
 
1296
- def path_from_id(self):
1297
- """ """
1977
+ def path_from_id(self) -> str:
1978
+ """Returns the data path from the ID to this object (string).
1979
+
1980
+ :return: The path from `bpy.types.bpy_struct.id_data`
1981
+ to this struct and property (when given).
1982
+ :rtype: str
1983
+ """
1298
1984
  ...
1299
1985
 
1300
1986
  def path_resolve(self):
1301
- """ """
1987
+ """Returns the property from the path, raise an exception when not found."""
1302
1988
  ...
1303
1989
 
1304
1990
  def poll(self, context):
@@ -1309,37 +1995,53 @@ class EEVEE_MATERIAL_PT_viewport_settings(
1309
1995
  ...
1310
1996
 
1311
1997
  def pop(self):
1312
- """ """
1998
+ """Remove and return the value of the custom property assigned to key or default
1999
+ when not found (matches Python's dictionary function of the same name).
2000
+
2001
+ """
1313
2002
  ...
1314
2003
 
1315
2004
  def prepend(self, draw_func):
1316
- """
2005
+ """Prepend a draw function to this menu, takes the same arguments as
2006
+ the menus draw function
1317
2007
 
1318
- :param draw_func:
2008
+ :param draw_func:
1319
2009
  """
1320
2010
  ...
1321
2011
 
1322
- def property_overridable_library_set(self):
1323
- """ """
2012
+ def property_overridable_library_set(self) -> bool:
2013
+ """Define a property as overridable or not (only for custom properties!).
2014
+
2015
+ :return: True when the overridable status of the property was successfully set.
2016
+ :rtype: bool
2017
+ """
1324
2018
  ...
1325
2019
 
1326
2020
  def property_unset(self):
1327
- """ """
2021
+ """Unset a property, will use default value afterward."""
1328
2022
  ...
1329
2023
 
1330
2024
  def remove(self, draw_func):
1331
- """
2025
+ """Remove a draw function that has been added to this menu
1332
2026
 
1333
2027
  :param draw_func:
1334
2028
  """
1335
2029
  ...
1336
2030
 
1337
2031
  def type_recast(self):
1338
- """ """
2032
+ """Return a new instance, this is needed because types
2033
+ such as textures can be changed at runtime.
2034
+
2035
+ :return: a new instance of this object with the type initialized again.
2036
+ """
1339
2037
  ...
1340
2038
 
1341
2039
  def values(self):
1342
- """ """
2040
+ """Returns the values of this objects custom properties (matches Python's
2041
+ dictionary function of the same name).
2042
+
2043
+ :return: custom property values.
2044
+ """
1343
2045
  ...
1344
2046
 
1345
2047
  class EEVEE_MATERIAL_PT_volume(
@@ -1375,22 +2077,35 @@ class EEVEE_MATERIAL_PT_volume(
1375
2077
  """ """
1376
2078
 
1377
2079
  def append(self, draw_func):
1378
- """
2080
+ """Append a draw function to this menu,
2081
+ takes the same arguments as the menus draw function
1379
2082
 
1380
- :param draw_func:
2083
+ :param draw_func:
1381
2084
  """
1382
2085
  ...
1383
2086
 
1384
- def as_pointer(self):
1385
- """ """
2087
+ def as_pointer(self) -> int:
2088
+ """Returns the memory address which holds a pointer to Blender's internal data
2089
+
2090
+ :return: int (memory address).
2091
+ :rtype: int
2092
+ """
1386
2093
  ...
1387
2094
 
1388
- def bl_rna_get_subclass(self):
1389
- """ """
2095
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2096
+ """
2097
+
2098
+ :return: The RNA type or default when not found.
2099
+ :rtype: bpy.types.Struct
2100
+ """
1390
2101
  ...
1391
2102
 
1392
- def bl_rna_get_subclass_py(self):
1393
- """ """
2103
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2104
+ """
2105
+
2106
+ :return: The class or default when not found.
2107
+ :rtype: typing.Any
2108
+ """
1394
2109
  ...
1395
2110
 
1396
2111
  def draw(self, context):
@@ -1400,72 +2115,129 @@ class EEVEE_MATERIAL_PT_volume(
1400
2115
  """
1401
2116
  ...
1402
2117
 
1403
- def driver_add(self):
1404
- """ """
2118
+ def driver_add(self) -> bpy.types.FCurve:
2119
+ """Adds driver(s) to the given property
2120
+
2121
+ :return: The driver(s) added.
2122
+ :rtype: bpy.types.FCurve
2123
+ """
1405
2124
  ...
1406
2125
 
1407
- def driver_remove(self):
1408
- """ """
2126
+ def driver_remove(self) -> bool:
2127
+ """Remove driver(s) from the given property
2128
+
2129
+ :return: Success of driver removal.
2130
+ :rtype: bool
2131
+ """
1409
2132
  ...
1410
2133
 
1411
2134
  def get(self):
1412
- """ """
2135
+ """Returns the value of the custom property assigned to key or default
2136
+ when not found (matches Python's dictionary function of the same name).
2137
+
2138
+ """
1413
2139
  ...
1414
2140
 
1415
2141
  def id_properties_clear(self):
1416
- """ """
2142
+ """
2143
+
2144
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2145
+ """
1417
2146
  ...
1418
2147
 
1419
2148
  def id_properties_ensure(self):
1420
- """ """
2149
+ """
2150
+
2151
+ :return: the parent group for an RNA struct's custom IDProperties.
2152
+ """
1421
2153
  ...
1422
2154
 
1423
2155
  def id_properties_ui(self):
1424
- """ """
2156
+ """
2157
+
2158
+ :return: Return an object used to manage an IDProperty's UI data.
2159
+ """
1425
2160
  ...
1426
2161
 
1427
2162
  def is_extended(self):
1428
2163
  """ """
1429
2164
  ...
1430
2165
 
1431
- def is_property_hidden(self):
1432
- """ """
2166
+ def is_property_hidden(self) -> bool:
2167
+ """Check if a property is hidden.
2168
+
2169
+ :return: True when the property is hidden.
2170
+ :rtype: bool
2171
+ """
1433
2172
  ...
1434
2173
 
1435
- def is_property_overridable_library(self):
1436
- """ """
2174
+ def is_property_overridable_library(self) -> bool:
2175
+ """Check if a property is overridable.
2176
+
2177
+ :return: True when the property is overridable.
2178
+ :rtype: bool
2179
+ """
1437
2180
  ...
1438
2181
 
1439
- def is_property_readonly(self):
1440
- """ """
2182
+ def is_property_readonly(self) -> bool:
2183
+ """Check if a property is readonly.
2184
+
2185
+ :return: True when the property is readonly (not writable).
2186
+ :rtype: bool
2187
+ """
1441
2188
  ...
1442
2189
 
1443
- def is_property_set(self):
1444
- """ """
2190
+ def is_property_set(self) -> bool:
2191
+ """Check if a property is set, use for testing operator properties.
2192
+
2193
+ :return: True when the property has been set.
2194
+ :rtype: bool
2195
+ """
1445
2196
  ...
1446
2197
 
1447
2198
  def items(self):
1448
- """ """
2199
+ """Returns the items of this objects custom properties (matches Python's
2200
+ dictionary function of the same name).
2201
+
2202
+ :return: custom property key, value pairs.
2203
+ """
1449
2204
  ...
1450
2205
 
1451
- def keyframe_delete(self):
1452
- """ """
2206
+ def keyframe_delete(self) -> bool:
2207
+ """Remove a keyframe from this properties fcurve.
2208
+
2209
+ :return: Success of keyframe deletion.
2210
+ :rtype: bool
2211
+ """
1453
2212
  ...
1454
2213
 
1455
- def keyframe_insert(self):
1456
- """ """
2214
+ def keyframe_insert(self) -> bool:
2215
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2216
+
2217
+ :return: Success of keyframe insertion.
2218
+ :rtype: bool
2219
+ """
1457
2220
  ...
1458
2221
 
1459
2222
  def keys(self):
1460
- """ """
2223
+ """Returns the keys of this objects custom properties (matches Python's
2224
+ dictionary function of the same name).
2225
+
2226
+ :return: custom property keys.
2227
+ """
1461
2228
  ...
1462
2229
 
1463
- def path_from_id(self):
1464
- """ """
2230
+ def path_from_id(self) -> str:
2231
+ """Returns the data path from the ID to this object (string).
2232
+
2233
+ :return: The path from `bpy.types.bpy_struct.id_data`
2234
+ to this struct and property (when given).
2235
+ :rtype: str
2236
+ """
1465
2237
  ...
1466
2238
 
1467
2239
  def path_resolve(self):
1468
- """ """
2240
+ """Returns the property from the path, raise an exception when not found."""
1469
2241
  ...
1470
2242
 
1471
2243
  def poll(self, context):
@@ -1476,37 +2248,53 @@ class EEVEE_MATERIAL_PT_volume(
1476
2248
  ...
1477
2249
 
1478
2250
  def pop(self):
1479
- """ """
2251
+ """Remove and return the value of the custom property assigned to key or default
2252
+ when not found (matches Python's dictionary function of the same name).
2253
+
2254
+ """
1480
2255
  ...
1481
2256
 
1482
2257
  def prepend(self, draw_func):
1483
- """
2258
+ """Prepend a draw function to this menu, takes the same arguments as
2259
+ the menus draw function
1484
2260
 
1485
- :param draw_func:
2261
+ :param draw_func:
1486
2262
  """
1487
2263
  ...
1488
2264
 
1489
- def property_overridable_library_set(self):
1490
- """ """
2265
+ def property_overridable_library_set(self) -> bool:
2266
+ """Define a property as overridable or not (only for custom properties!).
2267
+
2268
+ :return: True when the overridable status of the property was successfully set.
2269
+ :rtype: bool
2270
+ """
1491
2271
  ...
1492
2272
 
1493
2273
  def property_unset(self):
1494
- """ """
2274
+ """Unset a property, will use default value afterward."""
1495
2275
  ...
1496
2276
 
1497
2277
  def remove(self, draw_func):
1498
- """
2278
+ """Remove a draw function that has been added to this menu
1499
2279
 
1500
2280
  :param draw_func:
1501
2281
  """
1502
2282
  ...
1503
2283
 
1504
2284
  def type_recast(self):
1505
- """ """
2285
+ """Return a new instance, this is needed because types
2286
+ such as textures can be changed at runtime.
2287
+
2288
+ :return: a new instance of this object with the type initialized again.
2289
+ """
1506
2290
  ...
1507
2291
 
1508
2292
  def values(self):
1509
- """ """
2293
+ """Returns the values of this objects custom properties (matches Python's
2294
+ dictionary function of the same name).
2295
+
2296
+ :return: custom property values.
2297
+ """
1510
2298
  ...
1511
2299
 
1512
2300
  class EEVEE_NEXT_MATERIAL_PT_settings(
@@ -1536,22 +2324,35 @@ class EEVEE_NEXT_MATERIAL_PT_settings(
1536
2324
  """ """
1537
2325
 
1538
2326
  def append(self, draw_func):
1539
- """
2327
+ """Append a draw function to this menu,
2328
+ takes the same arguments as the menus draw function
1540
2329
 
1541
- :param draw_func:
2330
+ :param draw_func:
1542
2331
  """
1543
2332
  ...
1544
2333
 
1545
- def as_pointer(self):
1546
- """ """
2334
+ def as_pointer(self) -> int:
2335
+ """Returns the memory address which holds a pointer to Blender's internal data
2336
+
2337
+ :return: int (memory address).
2338
+ :rtype: int
2339
+ """
1547
2340
  ...
1548
2341
 
1549
- def bl_rna_get_subclass(self):
1550
- """ """
2342
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2343
+ """
2344
+
2345
+ :return: The RNA type or default when not found.
2346
+ :rtype: bpy.types.Struct
2347
+ """
1551
2348
  ...
1552
2349
 
1553
- def bl_rna_get_subclass_py(self):
1554
- """ """
2350
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2351
+ """
2352
+
2353
+ :return: The class or default when not found.
2354
+ :rtype: typing.Any
2355
+ """
1555
2356
  ...
1556
2357
 
1557
2358
  def draw(self, context):
@@ -1561,72 +2362,129 @@ class EEVEE_NEXT_MATERIAL_PT_settings(
1561
2362
  """
1562
2363
  ...
1563
2364
 
1564
- def driver_add(self):
1565
- """ """
2365
+ def driver_add(self) -> bpy.types.FCurve:
2366
+ """Adds driver(s) to the given property
2367
+
2368
+ :return: The driver(s) added.
2369
+ :rtype: bpy.types.FCurve
2370
+ """
1566
2371
  ...
1567
2372
 
1568
- def driver_remove(self):
1569
- """ """
2373
+ def driver_remove(self) -> bool:
2374
+ """Remove driver(s) from the given property
2375
+
2376
+ :return: Success of driver removal.
2377
+ :rtype: bool
2378
+ """
1570
2379
  ...
1571
2380
 
1572
2381
  def get(self):
1573
- """ """
2382
+ """Returns the value of the custom property assigned to key or default
2383
+ when not found (matches Python's dictionary function of the same name).
2384
+
2385
+ """
1574
2386
  ...
1575
2387
 
1576
2388
  def id_properties_clear(self):
1577
- """ """
2389
+ """
2390
+
2391
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2392
+ """
1578
2393
  ...
1579
2394
 
1580
2395
  def id_properties_ensure(self):
1581
- """ """
2396
+ """
2397
+
2398
+ :return: the parent group for an RNA struct's custom IDProperties.
2399
+ """
1582
2400
  ...
1583
2401
 
1584
2402
  def id_properties_ui(self):
1585
- """ """
2403
+ """
2404
+
2405
+ :return: Return an object used to manage an IDProperty's UI data.
2406
+ """
1586
2407
  ...
1587
2408
 
1588
2409
  def is_extended(self):
1589
2410
  """ """
1590
2411
  ...
1591
2412
 
1592
- def is_property_hidden(self):
1593
- """ """
2413
+ def is_property_hidden(self) -> bool:
2414
+ """Check if a property is hidden.
2415
+
2416
+ :return: True when the property is hidden.
2417
+ :rtype: bool
2418
+ """
2419
+ ...
2420
+
2421
+ def is_property_overridable_library(self) -> bool:
2422
+ """Check if a property is overridable.
2423
+
2424
+ :return: True when the property is overridable.
2425
+ :rtype: bool
2426
+ """
1594
2427
  ...
1595
2428
 
1596
- def is_property_overridable_library(self):
1597
- """ """
1598
- ...
2429
+ def is_property_readonly(self) -> bool:
2430
+ """Check if a property is readonly.
1599
2431
 
1600
- def is_property_readonly(self):
1601
- """ """
2432
+ :return: True when the property is readonly (not writable).
2433
+ :rtype: bool
2434
+ """
1602
2435
  ...
1603
2436
 
1604
- def is_property_set(self):
1605
- """ """
2437
+ def is_property_set(self) -> bool:
2438
+ """Check if a property is set, use for testing operator properties.
2439
+
2440
+ :return: True when the property has been set.
2441
+ :rtype: bool
2442
+ """
1606
2443
  ...
1607
2444
 
1608
2445
  def items(self):
1609
- """ """
2446
+ """Returns the items of this objects custom properties (matches Python's
2447
+ dictionary function of the same name).
2448
+
2449
+ :return: custom property key, value pairs.
2450
+ """
1610
2451
  ...
1611
2452
 
1612
- def keyframe_delete(self):
1613
- """ """
2453
+ def keyframe_delete(self) -> bool:
2454
+ """Remove a keyframe from this properties fcurve.
2455
+
2456
+ :return: Success of keyframe deletion.
2457
+ :rtype: bool
2458
+ """
1614
2459
  ...
1615
2460
 
1616
- def keyframe_insert(self):
1617
- """ """
2461
+ def keyframe_insert(self) -> bool:
2462
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2463
+
2464
+ :return: Success of keyframe insertion.
2465
+ :rtype: bool
2466
+ """
1618
2467
  ...
1619
2468
 
1620
2469
  def keys(self):
1621
- """ """
2470
+ """Returns the keys of this objects custom properties (matches Python's
2471
+ dictionary function of the same name).
2472
+
2473
+ :return: custom property keys.
2474
+ """
1622
2475
  ...
1623
2476
 
1624
- def path_from_id(self):
1625
- """ """
2477
+ def path_from_id(self) -> str:
2478
+ """Returns the data path from the ID to this object (string).
2479
+
2480
+ :return: The path from `bpy.types.bpy_struct.id_data`
2481
+ to this struct and property (when given).
2482
+ :rtype: str
2483
+ """
1626
2484
  ...
1627
2485
 
1628
2486
  def path_resolve(self):
1629
- """ """
2487
+ """Returns the property from the path, raise an exception when not found."""
1630
2488
  ...
1631
2489
 
1632
2490
  def poll(self, context):
@@ -1637,37 +2495,53 @@ class EEVEE_NEXT_MATERIAL_PT_settings(
1637
2495
  ...
1638
2496
 
1639
2497
  def pop(self):
1640
- """ """
2498
+ """Remove and return the value of the custom property assigned to key or default
2499
+ when not found (matches Python's dictionary function of the same name).
2500
+
2501
+ """
1641
2502
  ...
1642
2503
 
1643
2504
  def prepend(self, draw_func):
1644
- """
2505
+ """Prepend a draw function to this menu, takes the same arguments as
2506
+ the menus draw function
1645
2507
 
1646
- :param draw_func:
2508
+ :param draw_func:
1647
2509
  """
1648
2510
  ...
1649
2511
 
1650
- def property_overridable_library_set(self):
1651
- """ """
2512
+ def property_overridable_library_set(self) -> bool:
2513
+ """Define a property as overridable or not (only for custom properties!).
2514
+
2515
+ :return: True when the overridable status of the property was successfully set.
2516
+ :rtype: bool
2517
+ """
1652
2518
  ...
1653
2519
 
1654
2520
  def property_unset(self):
1655
- """ """
2521
+ """Unset a property, will use default value afterward."""
1656
2522
  ...
1657
2523
 
1658
2524
  def remove(self, draw_func):
1659
- """
2525
+ """Remove a draw function that has been added to this menu
1660
2526
 
1661
2527
  :param draw_func:
1662
2528
  """
1663
2529
  ...
1664
2530
 
1665
2531
  def type_recast(self):
1666
- """ """
2532
+ """Return a new instance, this is needed because types
2533
+ such as textures can be changed at runtime.
2534
+
2535
+ :return: a new instance of this object with the type initialized again.
2536
+ """
1667
2537
  ...
1668
2538
 
1669
2539
  def values(self):
1670
- """ """
2540
+ """Returns the values of this objects custom properties (matches Python's
2541
+ dictionary function of the same name).
2542
+
2543
+ :return: custom property values.
2544
+ """
1671
2545
  ...
1672
2546
 
1673
2547
  class EEVEE_NEXT_MATERIAL_PT_settings_surface(
@@ -1700,22 +2574,35 @@ class EEVEE_NEXT_MATERIAL_PT_settings_surface(
1700
2574
  """ """
1701
2575
 
1702
2576
  def append(self, draw_func):
1703
- """
2577
+ """Append a draw function to this menu,
2578
+ takes the same arguments as the menus draw function
1704
2579
 
1705
- :param draw_func:
2580
+ :param draw_func:
1706
2581
  """
1707
2582
  ...
1708
2583
 
1709
- def as_pointer(self):
1710
- """ """
2584
+ def as_pointer(self) -> int:
2585
+ """Returns the memory address which holds a pointer to Blender's internal data
2586
+
2587
+ :return: int (memory address).
2588
+ :rtype: int
2589
+ """
1711
2590
  ...
1712
2591
 
1713
- def bl_rna_get_subclass(self):
1714
- """ """
2592
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2593
+ """
2594
+
2595
+ :return: The RNA type or default when not found.
2596
+ :rtype: bpy.types.Struct
2597
+ """
1715
2598
  ...
1716
2599
 
1717
- def bl_rna_get_subclass_py(self):
1718
- """ """
2600
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2601
+ """
2602
+
2603
+ :return: The class or default when not found.
2604
+ :rtype: typing.Any
2605
+ """
1719
2606
  ...
1720
2607
 
1721
2608
  def draw(self, context):
@@ -1725,72 +2612,129 @@ class EEVEE_NEXT_MATERIAL_PT_settings_surface(
1725
2612
  """
1726
2613
  ...
1727
2614
 
1728
- def driver_add(self):
1729
- """ """
2615
+ def driver_add(self) -> bpy.types.FCurve:
2616
+ """Adds driver(s) to the given property
2617
+
2618
+ :return: The driver(s) added.
2619
+ :rtype: bpy.types.FCurve
2620
+ """
1730
2621
  ...
1731
2622
 
1732
- def driver_remove(self):
1733
- """ """
2623
+ def driver_remove(self) -> bool:
2624
+ """Remove driver(s) from the given property
2625
+
2626
+ :return: Success of driver removal.
2627
+ :rtype: bool
2628
+ """
1734
2629
  ...
1735
2630
 
1736
2631
  def get(self):
1737
- """ """
2632
+ """Returns the value of the custom property assigned to key or default
2633
+ when not found (matches Python's dictionary function of the same name).
2634
+
2635
+ """
1738
2636
  ...
1739
2637
 
1740
2638
  def id_properties_clear(self):
1741
- """ """
2639
+ """
2640
+
2641
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2642
+ """
1742
2643
  ...
1743
2644
 
1744
2645
  def id_properties_ensure(self):
1745
- """ """
2646
+ """
2647
+
2648
+ :return: the parent group for an RNA struct's custom IDProperties.
2649
+ """
1746
2650
  ...
1747
2651
 
1748
2652
  def id_properties_ui(self):
1749
- """ """
2653
+ """
2654
+
2655
+ :return: Return an object used to manage an IDProperty's UI data.
2656
+ """
1750
2657
  ...
1751
2658
 
1752
2659
  def is_extended(self):
1753
2660
  """ """
1754
2661
  ...
1755
2662
 
1756
- def is_property_hidden(self):
1757
- """ """
2663
+ def is_property_hidden(self) -> bool:
2664
+ """Check if a property is hidden.
2665
+
2666
+ :return: True when the property is hidden.
2667
+ :rtype: bool
2668
+ """
1758
2669
  ...
1759
2670
 
1760
- def is_property_overridable_library(self):
1761
- """ """
2671
+ def is_property_overridable_library(self) -> bool:
2672
+ """Check if a property is overridable.
2673
+
2674
+ :return: True when the property is overridable.
2675
+ :rtype: bool
2676
+ """
1762
2677
  ...
1763
2678
 
1764
- def is_property_readonly(self):
1765
- """ """
2679
+ def is_property_readonly(self) -> bool:
2680
+ """Check if a property is readonly.
2681
+
2682
+ :return: True when the property is readonly (not writable).
2683
+ :rtype: bool
2684
+ """
1766
2685
  ...
1767
2686
 
1768
- def is_property_set(self):
1769
- """ """
2687
+ def is_property_set(self) -> bool:
2688
+ """Check if a property is set, use for testing operator properties.
2689
+
2690
+ :return: True when the property has been set.
2691
+ :rtype: bool
2692
+ """
1770
2693
  ...
1771
2694
 
1772
2695
  def items(self):
1773
- """ """
2696
+ """Returns the items of this objects custom properties (matches Python's
2697
+ dictionary function of the same name).
2698
+
2699
+ :return: custom property key, value pairs.
2700
+ """
1774
2701
  ...
1775
2702
 
1776
- def keyframe_delete(self):
1777
- """ """
2703
+ def keyframe_delete(self) -> bool:
2704
+ """Remove a keyframe from this properties fcurve.
2705
+
2706
+ :return: Success of keyframe deletion.
2707
+ :rtype: bool
2708
+ """
1778
2709
  ...
1779
2710
 
1780
- def keyframe_insert(self):
1781
- """ """
2711
+ def keyframe_insert(self) -> bool:
2712
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2713
+
2714
+ :return: Success of keyframe insertion.
2715
+ :rtype: bool
2716
+ """
1782
2717
  ...
1783
2718
 
1784
2719
  def keys(self):
1785
- """ """
2720
+ """Returns the keys of this objects custom properties (matches Python's
2721
+ dictionary function of the same name).
2722
+
2723
+ :return: custom property keys.
2724
+ """
1786
2725
  ...
1787
2726
 
1788
- def path_from_id(self):
1789
- """ """
2727
+ def path_from_id(self) -> str:
2728
+ """Returns the data path from the ID to this object (string).
2729
+
2730
+ :return: The path from `bpy.types.bpy_struct.id_data`
2731
+ to this struct and property (when given).
2732
+ :rtype: str
2733
+ """
1790
2734
  ...
1791
2735
 
1792
2736
  def path_resolve(self):
1793
- """ """
2737
+ """Returns the property from the path, raise an exception when not found."""
1794
2738
  ...
1795
2739
 
1796
2740
  def poll(self, context):
@@ -1801,37 +2745,53 @@ class EEVEE_NEXT_MATERIAL_PT_settings_surface(
1801
2745
  ...
1802
2746
 
1803
2747
  def pop(self):
1804
- """ """
2748
+ """Remove and return the value of the custom property assigned to key or default
2749
+ when not found (matches Python's dictionary function of the same name).
2750
+
2751
+ """
1805
2752
  ...
1806
2753
 
1807
2754
  def prepend(self, draw_func):
1808
- """
2755
+ """Prepend a draw function to this menu, takes the same arguments as
2756
+ the menus draw function
1809
2757
 
1810
- :param draw_func:
2758
+ :param draw_func:
1811
2759
  """
1812
2760
  ...
1813
2761
 
1814
- def property_overridable_library_set(self):
1815
- """ """
2762
+ def property_overridable_library_set(self) -> bool:
2763
+ """Define a property as overridable or not (only for custom properties!).
2764
+
2765
+ :return: True when the overridable status of the property was successfully set.
2766
+ :rtype: bool
2767
+ """
1816
2768
  ...
1817
2769
 
1818
2770
  def property_unset(self):
1819
- """ """
2771
+ """Unset a property, will use default value afterward."""
1820
2772
  ...
1821
2773
 
1822
2774
  def remove(self, draw_func):
1823
- """
2775
+ """Remove a draw function that has been added to this menu
1824
2776
 
1825
2777
  :param draw_func:
1826
2778
  """
1827
2779
  ...
1828
2780
 
1829
2781
  def type_recast(self):
1830
- """ """
2782
+ """Return a new instance, this is needed because types
2783
+ such as textures can be changed at runtime.
2784
+
2785
+ :return: a new instance of this object with the type initialized again.
2786
+ """
1831
2787
  ...
1832
2788
 
1833
2789
  def values(self):
1834
- """ """
2790
+ """Returns the values of this objects custom properties (matches Python's
2791
+ dictionary function of the same name).
2792
+
2793
+ :return: custom property values.
2794
+ """
1835
2795
  ...
1836
2796
 
1837
2797
  class EEVEE_NEXT_MATERIAL_PT_settings_volume(
@@ -1864,22 +2824,35 @@ class EEVEE_NEXT_MATERIAL_PT_settings_volume(
1864
2824
  """ """
1865
2825
 
1866
2826
  def append(self, draw_func):
1867
- """
2827
+ """Append a draw function to this menu,
2828
+ takes the same arguments as the menus draw function
1868
2829
 
1869
- :param draw_func:
2830
+ :param draw_func:
1870
2831
  """
1871
2832
  ...
1872
2833
 
1873
- def as_pointer(self):
1874
- """ """
2834
+ def as_pointer(self) -> int:
2835
+ """Returns the memory address which holds a pointer to Blender's internal data
2836
+
2837
+ :return: int (memory address).
2838
+ :rtype: int
2839
+ """
1875
2840
  ...
1876
2841
 
1877
- def bl_rna_get_subclass(self):
1878
- """ """
2842
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2843
+ """
2844
+
2845
+ :return: The RNA type or default when not found.
2846
+ :rtype: bpy.types.Struct
2847
+ """
1879
2848
  ...
1880
2849
 
1881
- def bl_rna_get_subclass_py(self):
1882
- """ """
2850
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2851
+ """
2852
+
2853
+ :return: The class or default when not found.
2854
+ :rtype: typing.Any
2855
+ """
1883
2856
  ...
1884
2857
 
1885
2858
  def draw(self, context):
@@ -1889,72 +2862,129 @@ class EEVEE_NEXT_MATERIAL_PT_settings_volume(
1889
2862
  """
1890
2863
  ...
1891
2864
 
1892
- def driver_add(self):
1893
- """ """
2865
+ def driver_add(self) -> bpy.types.FCurve:
2866
+ """Adds driver(s) to the given property
2867
+
2868
+ :return: The driver(s) added.
2869
+ :rtype: bpy.types.FCurve
2870
+ """
1894
2871
  ...
1895
2872
 
1896
- def driver_remove(self):
1897
- """ """
2873
+ def driver_remove(self) -> bool:
2874
+ """Remove driver(s) from the given property
2875
+
2876
+ :return: Success of driver removal.
2877
+ :rtype: bool
2878
+ """
1898
2879
  ...
1899
2880
 
1900
2881
  def get(self):
1901
- """ """
2882
+ """Returns the value of the custom property assigned to key or default
2883
+ when not found (matches Python's dictionary function of the same name).
2884
+
2885
+ """
1902
2886
  ...
1903
2887
 
1904
2888
  def id_properties_clear(self):
1905
- """ """
2889
+ """
2890
+
2891
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2892
+ """
1906
2893
  ...
1907
2894
 
1908
2895
  def id_properties_ensure(self):
1909
- """ """
2896
+ """
2897
+
2898
+ :return: the parent group for an RNA struct's custom IDProperties.
2899
+ """
1910
2900
  ...
1911
2901
 
1912
2902
  def id_properties_ui(self):
1913
- """ """
2903
+ """
2904
+
2905
+ :return: Return an object used to manage an IDProperty's UI data.
2906
+ """
1914
2907
  ...
1915
2908
 
1916
2909
  def is_extended(self):
1917
2910
  """ """
1918
2911
  ...
1919
2912
 
1920
- def is_property_hidden(self):
1921
- """ """
2913
+ def is_property_hidden(self) -> bool:
2914
+ """Check if a property is hidden.
2915
+
2916
+ :return: True when the property is hidden.
2917
+ :rtype: bool
2918
+ """
1922
2919
  ...
1923
2920
 
1924
- def is_property_overridable_library(self):
1925
- """ """
2921
+ def is_property_overridable_library(self) -> bool:
2922
+ """Check if a property is overridable.
2923
+
2924
+ :return: True when the property is overridable.
2925
+ :rtype: bool
2926
+ """
1926
2927
  ...
1927
2928
 
1928
- def is_property_readonly(self):
1929
- """ """
2929
+ def is_property_readonly(self) -> bool:
2930
+ """Check if a property is readonly.
2931
+
2932
+ :return: True when the property is readonly (not writable).
2933
+ :rtype: bool
2934
+ """
1930
2935
  ...
1931
2936
 
1932
- def is_property_set(self):
1933
- """ """
2937
+ def is_property_set(self) -> bool:
2938
+ """Check if a property is set, use for testing operator properties.
2939
+
2940
+ :return: True when the property has been set.
2941
+ :rtype: bool
2942
+ """
1934
2943
  ...
1935
2944
 
1936
2945
  def items(self):
1937
- """ """
2946
+ """Returns the items of this objects custom properties (matches Python's
2947
+ dictionary function of the same name).
2948
+
2949
+ :return: custom property key, value pairs.
2950
+ """
1938
2951
  ...
1939
2952
 
1940
- def keyframe_delete(self):
1941
- """ """
2953
+ def keyframe_delete(self) -> bool:
2954
+ """Remove a keyframe from this properties fcurve.
2955
+
2956
+ :return: Success of keyframe deletion.
2957
+ :rtype: bool
2958
+ """
1942
2959
  ...
1943
2960
 
1944
- def keyframe_insert(self):
1945
- """ """
2961
+ def keyframe_insert(self) -> bool:
2962
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2963
+
2964
+ :return: Success of keyframe insertion.
2965
+ :rtype: bool
2966
+ """
1946
2967
  ...
1947
2968
 
1948
2969
  def keys(self):
1949
- """ """
2970
+ """Returns the keys of this objects custom properties (matches Python's
2971
+ dictionary function of the same name).
2972
+
2973
+ :return: custom property keys.
2974
+ """
1950
2975
  ...
1951
2976
 
1952
- def path_from_id(self):
1953
- """ """
2977
+ def path_from_id(self) -> str:
2978
+ """Returns the data path from the ID to this object (string).
2979
+
2980
+ :return: The path from `bpy.types.bpy_struct.id_data`
2981
+ to this struct and property (when given).
2982
+ :rtype: str
2983
+ """
1954
2984
  ...
1955
2985
 
1956
2986
  def path_resolve(self):
1957
- """ """
2987
+ """Returns the property from the path, raise an exception when not found."""
1958
2988
  ...
1959
2989
 
1960
2990
  def poll(self, context):
@@ -1965,37 +2995,53 @@ class EEVEE_NEXT_MATERIAL_PT_settings_volume(
1965
2995
  ...
1966
2996
 
1967
2997
  def pop(self):
1968
- """ """
2998
+ """Remove and return the value of the custom property assigned to key or default
2999
+ when not found (matches Python's dictionary function of the same name).
3000
+
3001
+ """
1969
3002
  ...
1970
3003
 
1971
3004
  def prepend(self, draw_func):
1972
- """
3005
+ """Prepend a draw function to this menu, takes the same arguments as
3006
+ the menus draw function
1973
3007
 
1974
- :param draw_func:
3008
+ :param draw_func:
1975
3009
  """
1976
3010
  ...
1977
3011
 
1978
- def property_overridable_library_set(self):
1979
- """ """
3012
+ def property_overridable_library_set(self) -> bool:
3013
+ """Define a property as overridable or not (only for custom properties!).
3014
+
3015
+ :return: True when the overridable status of the property was successfully set.
3016
+ :rtype: bool
3017
+ """
1980
3018
  ...
1981
3019
 
1982
3020
  def property_unset(self):
1983
- """ """
3021
+ """Unset a property, will use default value afterward."""
1984
3022
  ...
1985
3023
 
1986
3024
  def remove(self, draw_func):
1987
- """
3025
+ """Remove a draw function that has been added to this menu
1988
3026
 
1989
3027
  :param draw_func:
1990
3028
  """
1991
3029
  ...
1992
3030
 
1993
3031
  def type_recast(self):
1994
- """ """
3032
+ """Return a new instance, this is needed because types
3033
+ such as textures can be changed at runtime.
3034
+
3035
+ :return: a new instance of this object with the type initialized again.
3036
+ """
1995
3037
  ...
1996
3038
 
1997
3039
  def values(self):
1998
- """ """
3040
+ """Returns the values of this objects custom properties (matches Python's
3041
+ dictionary function of the same name).
3042
+
3043
+ :return: custom property values.
3044
+ """
1999
3045
  ...
2000
3046
 
2001
3047
  class MATERIAL_PT_custom_props(
@@ -2004,7 +3050,9 @@ class MATERIAL_PT_custom_props(
2004
3050
  rna_prop_ui.PropertyPanel,
2005
3051
  bpy_types._GenericUI,
2006
3052
  ):
2007
- """ """
3053
+ """The subclass should have its own poll function
3054
+ and the variable '_context_path' MUST be set.
3055
+ """
2008
3056
 
2009
3057
  COMPAT_ENGINES: typing.Any
2010
3058
  """ """
@@ -2034,22 +3082,35 @@ class MATERIAL_PT_custom_props(
2034
3082
  """ """
2035
3083
 
2036
3084
  def append(self, draw_func):
2037
- """
3085
+ """Append a draw function to this menu,
3086
+ takes the same arguments as the menus draw function
2038
3087
 
2039
- :param draw_func:
3088
+ :param draw_func:
2040
3089
  """
2041
3090
  ...
2042
3091
 
2043
- def as_pointer(self):
2044
- """ """
3092
+ def as_pointer(self) -> int:
3093
+ """Returns the memory address which holds a pointer to Blender's internal data
3094
+
3095
+ :return: int (memory address).
3096
+ :rtype: int
3097
+ """
2045
3098
  ...
2046
3099
 
2047
- def bl_rna_get_subclass(self):
2048
- """ """
3100
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3101
+ """
3102
+
3103
+ :return: The RNA type or default when not found.
3104
+ :rtype: bpy.types.Struct
3105
+ """
2049
3106
  ...
2050
3107
 
2051
- def bl_rna_get_subclass_py(self):
2052
- """ """
3108
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3109
+ """
3110
+
3111
+ :return: The class or default when not found.
3112
+ :rtype: typing.Any
3113
+ """
2053
3114
  ...
2054
3115
 
2055
3116
  def draw(self, context):
@@ -2059,72 +3120,129 @@ class MATERIAL_PT_custom_props(
2059
3120
  """
2060
3121
  ...
2061
3122
 
2062
- def driver_add(self):
2063
- """ """
3123
+ def driver_add(self) -> bpy.types.FCurve:
3124
+ """Adds driver(s) to the given property
3125
+
3126
+ :return: The driver(s) added.
3127
+ :rtype: bpy.types.FCurve
3128
+ """
2064
3129
  ...
2065
3130
 
2066
- def driver_remove(self):
2067
- """ """
3131
+ def driver_remove(self) -> bool:
3132
+ """Remove driver(s) from the given property
3133
+
3134
+ :return: Success of driver removal.
3135
+ :rtype: bool
3136
+ """
2068
3137
  ...
2069
3138
 
2070
3139
  def get(self):
2071
- """ """
3140
+ """Returns the value of the custom property assigned to key or default
3141
+ when not found (matches Python's dictionary function of the same name).
3142
+
3143
+ """
2072
3144
  ...
2073
3145
 
2074
3146
  def id_properties_clear(self):
2075
- """ """
3147
+ """
3148
+
3149
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3150
+ """
2076
3151
  ...
2077
3152
 
2078
3153
  def id_properties_ensure(self):
2079
- """ """
3154
+ """
3155
+
3156
+ :return: the parent group for an RNA struct's custom IDProperties.
3157
+ """
2080
3158
  ...
2081
3159
 
2082
3160
  def id_properties_ui(self):
2083
- """ """
3161
+ """
3162
+
3163
+ :return: Return an object used to manage an IDProperty's UI data.
3164
+ """
2084
3165
  ...
2085
3166
 
2086
3167
  def is_extended(self):
2087
3168
  """ """
2088
3169
  ...
2089
3170
 
2090
- def is_property_hidden(self):
2091
- """ """
3171
+ def is_property_hidden(self) -> bool:
3172
+ """Check if a property is hidden.
3173
+
3174
+ :return: True when the property is hidden.
3175
+ :rtype: bool
3176
+ """
2092
3177
  ...
2093
3178
 
2094
- def is_property_overridable_library(self):
2095
- """ """
3179
+ def is_property_overridable_library(self) -> bool:
3180
+ """Check if a property is overridable.
3181
+
3182
+ :return: True when the property is overridable.
3183
+ :rtype: bool
3184
+ """
2096
3185
  ...
2097
3186
 
2098
- def is_property_readonly(self):
2099
- """ """
3187
+ def is_property_readonly(self) -> bool:
3188
+ """Check if a property is readonly.
3189
+
3190
+ :return: True when the property is readonly (not writable).
3191
+ :rtype: bool
3192
+ """
2100
3193
  ...
2101
3194
 
2102
- def is_property_set(self):
2103
- """ """
3195
+ def is_property_set(self) -> bool:
3196
+ """Check if a property is set, use for testing operator properties.
3197
+
3198
+ :return: True when the property has been set.
3199
+ :rtype: bool
3200
+ """
2104
3201
  ...
2105
3202
 
2106
3203
  def items(self):
2107
- """ """
3204
+ """Returns the items of this objects custom properties (matches Python's
3205
+ dictionary function of the same name).
3206
+
3207
+ :return: custom property key, value pairs.
3208
+ """
2108
3209
  ...
2109
3210
 
2110
- def keyframe_delete(self):
2111
- """ """
3211
+ def keyframe_delete(self) -> bool:
3212
+ """Remove a keyframe from this properties fcurve.
3213
+
3214
+ :return: Success of keyframe deletion.
3215
+ :rtype: bool
3216
+ """
2112
3217
  ...
2113
3218
 
2114
- def keyframe_insert(self):
2115
- """ """
3219
+ def keyframe_insert(self) -> bool:
3220
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3221
+
3222
+ :return: Success of keyframe insertion.
3223
+ :rtype: bool
3224
+ """
3225
+ ...
3226
+
3227
+ def keys(self):
3228
+ """Returns the keys of this objects custom properties (matches Python's
3229
+ dictionary function of the same name).
3230
+
3231
+ :return: custom property keys.
3232
+ """
2116
3233
  ...
2117
3234
 
2118
- def keys(self):
2119
- """ """
2120
- ...
3235
+ def path_from_id(self) -> str:
3236
+ """Returns the data path from the ID to this object (string).
2121
3237
 
2122
- def path_from_id(self):
2123
- """ """
3238
+ :return: The path from `bpy.types.bpy_struct.id_data`
3239
+ to this struct and property (when given).
3240
+ :rtype: str
3241
+ """
2124
3242
  ...
2125
3243
 
2126
3244
  def path_resolve(self):
2127
- """ """
3245
+ """Returns the property from the path, raise an exception when not found."""
2128
3246
  ...
2129
3247
 
2130
3248
  def poll(self, context):
@@ -2135,37 +3253,53 @@ class MATERIAL_PT_custom_props(
2135
3253
  ...
2136
3254
 
2137
3255
  def pop(self):
2138
- """ """
3256
+ """Remove and return the value of the custom property assigned to key or default
3257
+ when not found (matches Python's dictionary function of the same name).
3258
+
3259
+ """
2139
3260
  ...
2140
3261
 
2141
3262
  def prepend(self, draw_func):
2142
- """
3263
+ """Prepend a draw function to this menu, takes the same arguments as
3264
+ the menus draw function
2143
3265
 
2144
- :param draw_func:
3266
+ :param draw_func:
2145
3267
  """
2146
3268
  ...
2147
3269
 
2148
- def property_overridable_library_set(self):
2149
- """ """
3270
+ def property_overridable_library_set(self) -> bool:
3271
+ """Define a property as overridable or not (only for custom properties!).
3272
+
3273
+ :return: True when the overridable status of the property was successfully set.
3274
+ :rtype: bool
3275
+ """
2150
3276
  ...
2151
3277
 
2152
3278
  def property_unset(self):
2153
- """ """
3279
+ """Unset a property, will use default value afterward."""
2154
3280
  ...
2155
3281
 
2156
3282
  def remove(self, draw_func):
2157
- """
3283
+ """Remove a draw function that has been added to this menu
2158
3284
 
2159
3285
  :param draw_func:
2160
3286
  """
2161
3287
  ...
2162
3288
 
2163
3289
  def type_recast(self):
2164
- """ """
3290
+ """Return a new instance, this is needed because types
3291
+ such as textures can be changed at runtime.
3292
+
3293
+ :return: a new instance of this object with the type initialized again.
3294
+ """
2165
3295
  ...
2166
3296
 
2167
3297
  def values(self):
2168
- """ """
3298
+ """Returns the values of this objects custom properties (matches Python's
3299
+ dictionary function of the same name).
3300
+
3301
+ :return: custom property values.
3302
+ """
2169
3303
  ...
2170
3304
 
2171
3305
  class MATERIAL_PT_lineart(bpy_types.Panel, MaterialButtonsPanel, bpy_types._GenericUI):
@@ -2196,22 +3330,35 @@ class MATERIAL_PT_lineart(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2196
3330
  """ """
2197
3331
 
2198
3332
  def append(self, draw_func):
2199
- """
3333
+ """Append a draw function to this menu,
3334
+ takes the same arguments as the menus draw function
2200
3335
 
2201
- :param draw_func:
3336
+ :param draw_func:
2202
3337
  """
2203
3338
  ...
2204
3339
 
2205
- def as_pointer(self):
2206
- """ """
3340
+ def as_pointer(self) -> int:
3341
+ """Returns the memory address which holds a pointer to Blender's internal data
3342
+
3343
+ :return: int (memory address).
3344
+ :rtype: int
3345
+ """
2207
3346
  ...
2208
3347
 
2209
- def bl_rna_get_subclass(self):
2210
- """ """
3348
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3349
+ """
3350
+
3351
+ :return: The RNA type or default when not found.
3352
+ :rtype: bpy.types.Struct
3353
+ """
2211
3354
  ...
2212
3355
 
2213
- def bl_rna_get_subclass_py(self):
2214
- """ """
3356
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3357
+ """
3358
+
3359
+ :return: The class or default when not found.
3360
+ :rtype: typing.Any
3361
+ """
2215
3362
  ...
2216
3363
 
2217
3364
  def draw(self, context):
@@ -2221,72 +3368,129 @@ class MATERIAL_PT_lineart(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2221
3368
  """
2222
3369
  ...
2223
3370
 
2224
- def driver_add(self):
2225
- """ """
3371
+ def driver_add(self) -> bpy.types.FCurve:
3372
+ """Adds driver(s) to the given property
3373
+
3374
+ :return: The driver(s) added.
3375
+ :rtype: bpy.types.FCurve
3376
+ """
2226
3377
  ...
2227
3378
 
2228
- def driver_remove(self):
2229
- """ """
3379
+ def driver_remove(self) -> bool:
3380
+ """Remove driver(s) from the given property
3381
+
3382
+ :return: Success of driver removal.
3383
+ :rtype: bool
3384
+ """
2230
3385
  ...
2231
3386
 
2232
3387
  def get(self):
2233
- """ """
3388
+ """Returns the value of the custom property assigned to key or default
3389
+ when not found (matches Python's dictionary function of the same name).
3390
+
3391
+ """
2234
3392
  ...
2235
3393
 
2236
3394
  def id_properties_clear(self):
2237
- """ """
3395
+ """
3396
+
3397
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3398
+ """
2238
3399
  ...
2239
3400
 
2240
3401
  def id_properties_ensure(self):
2241
- """ """
3402
+ """
3403
+
3404
+ :return: the parent group for an RNA struct's custom IDProperties.
3405
+ """
2242
3406
  ...
2243
3407
 
2244
3408
  def id_properties_ui(self):
2245
- """ """
3409
+ """
3410
+
3411
+ :return: Return an object used to manage an IDProperty's UI data.
3412
+ """
2246
3413
  ...
2247
3414
 
2248
3415
  def is_extended(self):
2249
3416
  """ """
2250
3417
  ...
2251
3418
 
2252
- def is_property_hidden(self):
2253
- """ """
3419
+ def is_property_hidden(self) -> bool:
3420
+ """Check if a property is hidden.
3421
+
3422
+ :return: True when the property is hidden.
3423
+ :rtype: bool
3424
+ """
2254
3425
  ...
2255
3426
 
2256
- def is_property_overridable_library(self):
2257
- """ """
3427
+ def is_property_overridable_library(self) -> bool:
3428
+ """Check if a property is overridable.
3429
+
3430
+ :return: True when the property is overridable.
3431
+ :rtype: bool
3432
+ """
2258
3433
  ...
2259
3434
 
2260
- def is_property_readonly(self):
2261
- """ """
3435
+ def is_property_readonly(self) -> bool:
3436
+ """Check if a property is readonly.
3437
+
3438
+ :return: True when the property is readonly (not writable).
3439
+ :rtype: bool
3440
+ """
2262
3441
  ...
2263
3442
 
2264
- def is_property_set(self):
2265
- """ """
3443
+ def is_property_set(self) -> bool:
3444
+ """Check if a property is set, use for testing operator properties.
3445
+
3446
+ :return: True when the property has been set.
3447
+ :rtype: bool
3448
+ """
2266
3449
  ...
2267
3450
 
2268
3451
  def items(self):
2269
- """ """
3452
+ """Returns the items of this objects custom properties (matches Python's
3453
+ dictionary function of the same name).
3454
+
3455
+ :return: custom property key, value pairs.
3456
+ """
2270
3457
  ...
2271
3458
 
2272
- def keyframe_delete(self):
2273
- """ """
3459
+ def keyframe_delete(self) -> bool:
3460
+ """Remove a keyframe from this properties fcurve.
3461
+
3462
+ :return: Success of keyframe deletion.
3463
+ :rtype: bool
3464
+ """
2274
3465
  ...
2275
3466
 
2276
- def keyframe_insert(self):
2277
- """ """
3467
+ def keyframe_insert(self) -> bool:
3468
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3469
+
3470
+ :return: Success of keyframe insertion.
3471
+ :rtype: bool
3472
+ """
2278
3473
  ...
2279
3474
 
2280
3475
  def keys(self):
2281
- """ """
3476
+ """Returns the keys of this objects custom properties (matches Python's
3477
+ dictionary function of the same name).
3478
+
3479
+ :return: custom property keys.
3480
+ """
2282
3481
  ...
2283
3482
 
2284
- def path_from_id(self):
2285
- """ """
3483
+ def path_from_id(self) -> str:
3484
+ """Returns the data path from the ID to this object (string).
3485
+
3486
+ :return: The path from `bpy.types.bpy_struct.id_data`
3487
+ to this struct and property (when given).
3488
+ :rtype: str
3489
+ """
2286
3490
  ...
2287
3491
 
2288
3492
  def path_resolve(self):
2289
- """ """
3493
+ """Returns the property from the path, raise an exception when not found."""
2290
3494
  ...
2291
3495
 
2292
3496
  def poll(self, context):
@@ -2297,37 +3501,53 @@ class MATERIAL_PT_lineart(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2297
3501
  ...
2298
3502
 
2299
3503
  def pop(self):
2300
- """ """
3504
+ """Remove and return the value of the custom property assigned to key or default
3505
+ when not found (matches Python's dictionary function of the same name).
3506
+
3507
+ """
2301
3508
  ...
2302
3509
 
2303
3510
  def prepend(self, draw_func):
2304
- """
3511
+ """Prepend a draw function to this menu, takes the same arguments as
3512
+ the menus draw function
2305
3513
 
2306
- :param draw_func:
3514
+ :param draw_func:
2307
3515
  """
2308
3516
  ...
2309
3517
 
2310
- def property_overridable_library_set(self):
2311
- """ """
3518
+ def property_overridable_library_set(self) -> bool:
3519
+ """Define a property as overridable or not (only for custom properties!).
3520
+
3521
+ :return: True when the overridable status of the property was successfully set.
3522
+ :rtype: bool
3523
+ """
2312
3524
  ...
2313
3525
 
2314
3526
  def property_unset(self):
2315
- """ """
3527
+ """Unset a property, will use default value afterward."""
2316
3528
  ...
2317
3529
 
2318
3530
  def remove(self, draw_func):
2319
- """
3531
+ """Remove a draw function that has been added to this menu
2320
3532
 
2321
3533
  :param draw_func:
2322
3534
  """
2323
3535
  ...
2324
3536
 
2325
3537
  def type_recast(self):
2326
- """ """
3538
+ """Return a new instance, this is needed because types
3539
+ such as textures can be changed at runtime.
3540
+
3541
+ :return: a new instance of this object with the type initialized again.
3542
+ """
2327
3543
  ...
2328
3544
 
2329
3545
  def values(self):
2330
- """ """
3546
+ """Returns the values of this objects custom properties (matches Python's
3547
+ dictionary function of the same name).
3548
+
3549
+ :return: custom property values.
3550
+ """
2331
3551
  ...
2332
3552
 
2333
3553
  class MATERIAL_PT_preview(bpy_types.Panel, MaterialButtonsPanel, bpy_types._GenericUI):
@@ -2358,22 +3578,35 @@ class MATERIAL_PT_preview(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2358
3578
  """ """
2359
3579
 
2360
3580
  def append(self, draw_func):
2361
- """
3581
+ """Append a draw function to this menu,
3582
+ takes the same arguments as the menus draw function
2362
3583
 
2363
- :param draw_func:
3584
+ :param draw_func:
2364
3585
  """
2365
3586
  ...
2366
3587
 
2367
- def as_pointer(self):
2368
- """ """
3588
+ def as_pointer(self) -> int:
3589
+ """Returns the memory address which holds a pointer to Blender's internal data
3590
+
3591
+ :return: int (memory address).
3592
+ :rtype: int
3593
+ """
2369
3594
  ...
2370
3595
 
2371
- def bl_rna_get_subclass(self):
2372
- """ """
3596
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3597
+ """
3598
+
3599
+ :return: The RNA type or default when not found.
3600
+ :rtype: bpy.types.Struct
3601
+ """
2373
3602
  ...
2374
3603
 
2375
- def bl_rna_get_subclass_py(self):
2376
- """ """
3604
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3605
+ """
3606
+
3607
+ :return: The class or default when not found.
3608
+ :rtype: typing.Any
3609
+ """
2377
3610
  ...
2378
3611
 
2379
3612
  def draw(self, context):
@@ -2383,72 +3616,129 @@ class MATERIAL_PT_preview(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2383
3616
  """
2384
3617
  ...
2385
3618
 
2386
- def driver_add(self):
2387
- """ """
3619
+ def driver_add(self) -> bpy.types.FCurve:
3620
+ """Adds driver(s) to the given property
3621
+
3622
+ :return: The driver(s) added.
3623
+ :rtype: bpy.types.FCurve
3624
+ """
2388
3625
  ...
2389
3626
 
2390
- def driver_remove(self):
2391
- """ """
3627
+ def driver_remove(self) -> bool:
3628
+ """Remove driver(s) from the given property
3629
+
3630
+ :return: Success of driver removal.
3631
+ :rtype: bool
3632
+ """
2392
3633
  ...
2393
3634
 
2394
3635
  def get(self):
2395
- """ """
3636
+ """Returns the value of the custom property assigned to key or default
3637
+ when not found (matches Python's dictionary function of the same name).
3638
+
3639
+ """
2396
3640
  ...
2397
3641
 
2398
3642
  def id_properties_clear(self):
2399
- """ """
3643
+ """
3644
+
3645
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3646
+ """
2400
3647
  ...
2401
3648
 
2402
3649
  def id_properties_ensure(self):
2403
- """ """
3650
+ """
3651
+
3652
+ :return: the parent group for an RNA struct's custom IDProperties.
3653
+ """
2404
3654
  ...
2405
3655
 
2406
3656
  def id_properties_ui(self):
2407
- """ """
3657
+ """
3658
+
3659
+ :return: Return an object used to manage an IDProperty's UI data.
3660
+ """
2408
3661
  ...
2409
3662
 
2410
3663
  def is_extended(self):
2411
3664
  """ """
2412
3665
  ...
2413
3666
 
2414
- def is_property_hidden(self):
2415
- """ """
3667
+ def is_property_hidden(self) -> bool:
3668
+ """Check if a property is hidden.
3669
+
3670
+ :return: True when the property is hidden.
3671
+ :rtype: bool
3672
+ """
2416
3673
  ...
2417
3674
 
2418
- def is_property_overridable_library(self):
2419
- """ """
3675
+ def is_property_overridable_library(self) -> bool:
3676
+ """Check if a property is overridable.
3677
+
3678
+ :return: True when the property is overridable.
3679
+ :rtype: bool
3680
+ """
2420
3681
  ...
2421
3682
 
2422
- def is_property_readonly(self):
2423
- """ """
3683
+ def is_property_readonly(self) -> bool:
3684
+ """Check if a property is readonly.
3685
+
3686
+ :return: True when the property is readonly (not writable).
3687
+ :rtype: bool
3688
+ """
2424
3689
  ...
2425
3690
 
2426
- def is_property_set(self):
2427
- """ """
3691
+ def is_property_set(self) -> bool:
3692
+ """Check if a property is set, use for testing operator properties.
3693
+
3694
+ :return: True when the property has been set.
3695
+ :rtype: bool
3696
+ """
2428
3697
  ...
2429
3698
 
2430
3699
  def items(self):
2431
- """ """
3700
+ """Returns the items of this objects custom properties (matches Python's
3701
+ dictionary function of the same name).
3702
+
3703
+ :return: custom property key, value pairs.
3704
+ """
2432
3705
  ...
2433
3706
 
2434
- def keyframe_delete(self):
2435
- """ """
3707
+ def keyframe_delete(self) -> bool:
3708
+ """Remove a keyframe from this properties fcurve.
3709
+
3710
+ :return: Success of keyframe deletion.
3711
+ :rtype: bool
3712
+ """
2436
3713
  ...
2437
3714
 
2438
- def keyframe_insert(self):
2439
- """ """
3715
+ def keyframe_insert(self) -> bool:
3716
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3717
+
3718
+ :return: Success of keyframe insertion.
3719
+ :rtype: bool
3720
+ """
2440
3721
  ...
2441
3722
 
2442
3723
  def keys(self):
2443
- """ """
3724
+ """Returns the keys of this objects custom properties (matches Python's
3725
+ dictionary function of the same name).
3726
+
3727
+ :return: custom property keys.
3728
+ """
2444
3729
  ...
2445
3730
 
2446
- def path_from_id(self):
2447
- """ """
3731
+ def path_from_id(self) -> str:
3732
+ """Returns the data path from the ID to this object (string).
3733
+
3734
+ :return: The path from `bpy.types.bpy_struct.id_data`
3735
+ to this struct and property (when given).
3736
+ :rtype: str
3737
+ """
2448
3738
  ...
2449
3739
 
2450
3740
  def path_resolve(self):
2451
- """ """
3741
+ """Returns the property from the path, raise an exception when not found."""
2452
3742
  ...
2453
3743
 
2454
3744
  def poll(self, context):
@@ -2459,37 +3749,53 @@ class MATERIAL_PT_preview(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gene
2459
3749
  ...
2460
3750
 
2461
3751
  def pop(self):
2462
- """ """
3752
+ """Remove and return the value of the custom property assigned to key or default
3753
+ when not found (matches Python's dictionary function of the same name).
3754
+
3755
+ """
2463
3756
  ...
2464
3757
 
2465
3758
  def prepend(self, draw_func):
2466
- """
3759
+ """Prepend a draw function to this menu, takes the same arguments as
3760
+ the menus draw function
2467
3761
 
2468
- :param draw_func:
3762
+ :param draw_func:
2469
3763
  """
2470
3764
  ...
2471
3765
 
2472
- def property_overridable_library_set(self):
2473
- """ """
3766
+ def property_overridable_library_set(self) -> bool:
3767
+ """Define a property as overridable or not (only for custom properties!).
3768
+
3769
+ :return: True when the overridable status of the property was successfully set.
3770
+ :rtype: bool
3771
+ """
2474
3772
  ...
2475
3773
 
2476
3774
  def property_unset(self):
2477
- """ """
3775
+ """Unset a property, will use default value afterward."""
2478
3776
  ...
2479
3777
 
2480
3778
  def remove(self, draw_func):
2481
- """
3779
+ """Remove a draw function that has been added to this menu
2482
3780
 
2483
3781
  :param draw_func:
2484
3782
  """
2485
3783
  ...
2486
3784
 
2487
3785
  def type_recast(self):
2488
- """ """
3786
+ """Return a new instance, this is needed because types
3787
+ such as textures can be changed at runtime.
3788
+
3789
+ :return: a new instance of this object with the type initialized again.
3790
+ """
2489
3791
  ...
2490
3792
 
2491
3793
  def values(self):
2492
- """ """
3794
+ """Returns the values of this objects custom properties (matches Python's
3795
+ dictionary function of the same name).
3796
+
3797
+ :return: custom property values.
3798
+ """
2493
3799
  ...
2494
3800
 
2495
3801
  class MATERIAL_PT_viewport(bpy_types.Panel, MaterialButtonsPanel, bpy_types._GenericUI):
@@ -2520,22 +3826,35 @@ class MATERIAL_PT_viewport(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gen
2520
3826
  """ """
2521
3827
 
2522
3828
  def append(self, draw_func):
2523
- """
3829
+ """Append a draw function to this menu,
3830
+ takes the same arguments as the menus draw function
2524
3831
 
2525
- :param draw_func:
3832
+ :param draw_func:
2526
3833
  """
2527
3834
  ...
2528
3835
 
2529
- def as_pointer(self):
2530
- """ """
3836
+ def as_pointer(self) -> int:
3837
+ """Returns the memory address which holds a pointer to Blender's internal data
3838
+
3839
+ :return: int (memory address).
3840
+ :rtype: int
3841
+ """
2531
3842
  ...
2532
3843
 
2533
- def bl_rna_get_subclass(self):
2534
- """ """
3844
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3845
+ """
3846
+
3847
+ :return: The RNA type or default when not found.
3848
+ :rtype: bpy.types.Struct
3849
+ """
2535
3850
  ...
2536
3851
 
2537
- def bl_rna_get_subclass_py(self):
2538
- """ """
3852
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3853
+ """
3854
+
3855
+ :return: The class or default when not found.
3856
+ :rtype: typing.Any
3857
+ """
2539
3858
  ...
2540
3859
 
2541
3860
  def draw(self, context):
@@ -2545,72 +3864,129 @@ class MATERIAL_PT_viewport(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gen
2545
3864
  """
2546
3865
  ...
2547
3866
 
2548
- def driver_add(self):
2549
- """ """
3867
+ def driver_add(self) -> bpy.types.FCurve:
3868
+ """Adds driver(s) to the given property
3869
+
3870
+ :return: The driver(s) added.
3871
+ :rtype: bpy.types.FCurve
3872
+ """
2550
3873
  ...
2551
3874
 
2552
- def driver_remove(self):
2553
- """ """
3875
+ def driver_remove(self) -> bool:
3876
+ """Remove driver(s) from the given property
3877
+
3878
+ :return: Success of driver removal.
3879
+ :rtype: bool
3880
+ """
2554
3881
  ...
2555
3882
 
2556
3883
  def get(self):
2557
- """ """
3884
+ """Returns the value of the custom property assigned to key or default
3885
+ when not found (matches Python's dictionary function of the same name).
3886
+
3887
+ """
2558
3888
  ...
2559
3889
 
2560
3890
  def id_properties_clear(self):
2561
- """ """
3891
+ """
3892
+
3893
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3894
+ """
2562
3895
  ...
2563
3896
 
2564
3897
  def id_properties_ensure(self):
2565
- """ """
3898
+ """
3899
+
3900
+ :return: the parent group for an RNA struct's custom IDProperties.
3901
+ """
2566
3902
  ...
2567
3903
 
2568
3904
  def id_properties_ui(self):
2569
- """ """
3905
+ """
3906
+
3907
+ :return: Return an object used to manage an IDProperty's UI data.
3908
+ """
2570
3909
  ...
2571
3910
 
2572
3911
  def is_extended(self):
2573
3912
  """ """
2574
3913
  ...
2575
3914
 
2576
- def is_property_hidden(self):
2577
- """ """
3915
+ def is_property_hidden(self) -> bool:
3916
+ """Check if a property is hidden.
3917
+
3918
+ :return: True when the property is hidden.
3919
+ :rtype: bool
3920
+ """
2578
3921
  ...
2579
3922
 
2580
- def is_property_overridable_library(self):
2581
- """ """
3923
+ def is_property_overridable_library(self) -> bool:
3924
+ """Check if a property is overridable.
3925
+
3926
+ :return: True when the property is overridable.
3927
+ :rtype: bool
3928
+ """
2582
3929
  ...
2583
3930
 
2584
- def is_property_readonly(self):
2585
- """ """
3931
+ def is_property_readonly(self) -> bool:
3932
+ """Check if a property is readonly.
3933
+
3934
+ :return: True when the property is readonly (not writable).
3935
+ :rtype: bool
3936
+ """
2586
3937
  ...
2587
3938
 
2588
- def is_property_set(self):
2589
- """ """
3939
+ def is_property_set(self) -> bool:
3940
+ """Check if a property is set, use for testing operator properties.
3941
+
3942
+ :return: True when the property has been set.
3943
+ :rtype: bool
3944
+ """
2590
3945
  ...
2591
3946
 
2592
3947
  def items(self):
2593
- """ """
3948
+ """Returns the items of this objects custom properties (matches Python's
3949
+ dictionary function of the same name).
3950
+
3951
+ :return: custom property key, value pairs.
3952
+ """
2594
3953
  ...
2595
3954
 
2596
- def keyframe_delete(self):
2597
- """ """
3955
+ def keyframe_delete(self) -> bool:
3956
+ """Remove a keyframe from this properties fcurve.
3957
+
3958
+ :return: Success of keyframe deletion.
3959
+ :rtype: bool
3960
+ """
2598
3961
  ...
2599
3962
 
2600
- def keyframe_insert(self):
2601
- """ """
3963
+ def keyframe_insert(self) -> bool:
3964
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3965
+
3966
+ :return: Success of keyframe insertion.
3967
+ :rtype: bool
3968
+ """
2602
3969
  ...
2603
3970
 
2604
3971
  def keys(self):
2605
- """ """
3972
+ """Returns the keys of this objects custom properties (matches Python's
3973
+ dictionary function of the same name).
3974
+
3975
+ :return: custom property keys.
3976
+ """
2606
3977
  ...
2607
3978
 
2608
- def path_from_id(self):
2609
- """ """
3979
+ def path_from_id(self) -> str:
3980
+ """Returns the data path from the ID to this object (string).
3981
+
3982
+ :return: The path from `bpy.types.bpy_struct.id_data`
3983
+ to this struct and property (when given).
3984
+ :rtype: str
3985
+ """
2610
3986
  ...
2611
3987
 
2612
3988
  def path_resolve(self):
2613
- """ """
3989
+ """Returns the property from the path, raise an exception when not found."""
2614
3990
  ...
2615
3991
 
2616
3992
  def poll(self, context):
@@ -2621,37 +3997,53 @@ class MATERIAL_PT_viewport(bpy_types.Panel, MaterialButtonsPanel, bpy_types._Gen
2621
3997
  ...
2622
3998
 
2623
3999
  def pop(self):
2624
- """ """
4000
+ """Remove and return the value of the custom property assigned to key or default
4001
+ when not found (matches Python's dictionary function of the same name).
4002
+
4003
+ """
2625
4004
  ...
2626
4005
 
2627
4006
  def prepend(self, draw_func):
2628
- """
4007
+ """Prepend a draw function to this menu, takes the same arguments as
4008
+ the menus draw function
2629
4009
 
2630
- :param draw_func:
4010
+ :param draw_func:
2631
4011
  """
2632
4012
  ...
2633
4013
 
2634
- def property_overridable_library_set(self):
2635
- """ """
4014
+ def property_overridable_library_set(self) -> bool:
4015
+ """Define a property as overridable or not (only for custom properties!).
4016
+
4017
+ :return: True when the overridable status of the property was successfully set.
4018
+ :rtype: bool
4019
+ """
2636
4020
  ...
2637
4021
 
2638
4022
  def property_unset(self):
2639
- """ """
4023
+ """Unset a property, will use default value afterward."""
2640
4024
  ...
2641
4025
 
2642
4026
  def remove(self, draw_func):
2643
- """
4027
+ """Remove a draw function that has been added to this menu
2644
4028
 
2645
4029
  :param draw_func:
2646
4030
  """
2647
4031
  ...
2648
4032
 
2649
4033
  def type_recast(self):
2650
- """ """
4034
+ """Return a new instance, this is needed because types
4035
+ such as textures can be changed at runtime.
4036
+
4037
+ :return: a new instance of this object with the type initialized again.
4038
+ """
2651
4039
  ...
2652
4040
 
2653
4041
  def values(self):
2654
- """ """
4042
+ """Returns the values of this objects custom properties (matches Python's
4043
+ dictionary function of the same name).
4044
+
4045
+ :return: custom property values.
4046
+ """
2655
4047
  ...
2656
4048
 
2657
4049
  def draw_material_settings(context):