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

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

Potentially problematic release.


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

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