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 DataButtonsPanel:
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,31 +18,39 @@ class DataButtonsPanel:
24
18
  ...
25
19
 
26
20
  class VOLUME_UL_grids(bpy_types.UIList, bpy_types._GenericUI):
27
- """ """
28
-
29
21
  bl_rna: typing.Any
30
- """ """
31
-
32
22
  id_data: typing.Any
33
- """ """
34
23
 
35
24
  def append(self, draw_func):
36
- """
25
+ """Append a draw function to this menu,
26
+ takes the same arguments as the menus draw function
37
27
 
38
- :param draw_func:
28
+ :param draw_func:
39
29
  """
40
30
  ...
41
31
 
42
- def as_pointer(self):
43
- """ """
32
+ def as_pointer(self) -> int:
33
+ """Returns the memory address which holds a pointer to Blender's internal data
34
+
35
+ :return: int (memory address).
36
+ :rtype: int
37
+ """
44
38
  ...
45
39
 
46
- def bl_rna_get_subclass(self):
47
- """ """
40
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
41
+ """
42
+
43
+ :return: The RNA type or default when not found.
44
+ :rtype: bpy.types.Struct
45
+ """
48
46
  ...
49
47
 
50
- def bl_rna_get_subclass_py(self):
51
- """ """
48
+ def bl_rna_get_subclass_py(self) -> typing.Any:
49
+ """
50
+
51
+ :return: The class or default when not found.
52
+ :rtype: typing.Any
53
+ """
52
54
  ...
53
55
 
54
56
  def draw_item(
@@ -75,152 +77,218 @@ class VOLUME_UL_grids(bpy_types.UIList, bpy_types._GenericUI):
75
77
  """
76
78
  ...
77
79
 
78
- def driver_add(self):
79
- """ """
80
+ def driver_add(self) -> bpy.types.FCurve:
81
+ """Adds driver(s) to the given property
82
+
83
+ :return: The driver(s) added.
84
+ :rtype: bpy.types.FCurve
85
+ """
80
86
  ...
81
87
 
82
- def driver_remove(self):
83
- """ """
88
+ def driver_remove(self) -> bool:
89
+ """Remove driver(s) from the given property
90
+
91
+ :return: Success of driver removal.
92
+ :rtype: bool
93
+ """
84
94
  ...
85
95
 
86
96
  def get(self):
87
- """ """
97
+ """Returns the value of the custom property assigned to key or default
98
+ when not found (matches Python's dictionary function of the same name).
99
+
100
+ """
88
101
  ...
89
102
 
90
103
  def id_properties_clear(self):
91
- """ """
104
+ """
105
+
106
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
107
+ """
92
108
  ...
93
109
 
94
110
  def id_properties_ensure(self):
95
- """ """
111
+ """
112
+
113
+ :return: the parent group for an RNA struct's custom IDProperties.
114
+ """
96
115
  ...
97
116
 
98
117
  def id_properties_ui(self):
99
- """ """
100
- ...
118
+ """
101
119
 
102
- def is_extended(self):
103
- """ """
120
+ :return: Return an object used to manage an IDProperty's UI data.
121
+ """
104
122
  ...
105
123
 
106
- def is_property_hidden(self):
107
- """ """
124
+ def is_extended(self): ...
125
+ def is_property_hidden(self) -> bool:
126
+ """Check if a property is hidden.
127
+
128
+ :return: True when the property is hidden.
129
+ :rtype: bool
130
+ """
108
131
  ...
109
132
 
110
- def is_property_overridable_library(self):
111
- """ """
133
+ def is_property_overridable_library(self) -> bool:
134
+ """Check if a property is overridable.
135
+
136
+ :return: True when the property is overridable.
137
+ :rtype: bool
138
+ """
112
139
  ...
113
140
 
114
- def is_property_readonly(self):
115
- """ """
141
+ def is_property_readonly(self) -> bool:
142
+ """Check if a property is readonly.
143
+
144
+ :return: True when the property is readonly (not writable).
145
+ :rtype: bool
146
+ """
116
147
  ...
117
148
 
118
- def is_property_set(self):
119
- """ """
149
+ def is_property_set(self) -> bool:
150
+ """Check if a property is set, use for testing operator properties.
151
+
152
+ :return: True when the property has been set.
153
+ :rtype: bool
154
+ """
120
155
  ...
121
156
 
122
157
  def items(self):
123
- """ """
158
+ """Returns the items of this objects custom properties (matches Python's
159
+ dictionary function of the same name).
160
+
161
+ :return: custom property key, value pairs.
162
+ """
124
163
  ...
125
164
 
126
- def keyframe_delete(self):
127
- """ """
165
+ def keyframe_delete(self) -> bool:
166
+ """Remove a keyframe from this properties fcurve.
167
+
168
+ :return: Success of keyframe deletion.
169
+ :rtype: bool
170
+ """
128
171
  ...
129
172
 
130
- def keyframe_insert(self):
131
- """ """
173
+ def keyframe_insert(self) -> bool:
174
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
175
+
176
+ :return: Success of keyframe insertion.
177
+ :rtype: bool
178
+ """
132
179
  ...
133
180
 
134
181
  def keys(self):
135
- """ """
182
+ """Returns the keys of this objects custom properties (matches Python's
183
+ dictionary function of the same name).
184
+
185
+ :return: custom property keys.
186
+ """
136
187
  ...
137
188
 
138
- def path_from_id(self):
139
- """ """
189
+ def path_from_id(self) -> str:
190
+ """Returns the data path from the ID to this object (string).
191
+
192
+ :return: The path from `bpy.types.bpy_struct.id_data`
193
+ to this struct and property (when given).
194
+ :rtype: str
195
+ """
140
196
  ...
141
197
 
142
198
  def path_resolve(self):
143
- """ """
199
+ """Returns the property from the path, raise an exception when not found."""
144
200
  ...
145
201
 
146
202
  def pop(self):
147
- """ """
203
+ """Remove and return the value of the custom property assigned to key or default
204
+ when not found (matches Python's dictionary function of the same name).
205
+
206
+ """
148
207
  ...
149
208
 
150
209
  def prepend(self, draw_func):
151
- """
210
+ """Prepend a draw function to this menu, takes the same arguments as
211
+ the menus draw function
152
212
 
153
- :param draw_func:
213
+ :param draw_func:
154
214
  """
155
215
  ...
156
216
 
157
- def property_overridable_library_set(self):
158
- """ """
217
+ def property_overridable_library_set(self) -> bool:
218
+ """Define a property as overridable or not (only for custom properties!).
219
+
220
+ :return: True when the overridable status of the property was successfully set.
221
+ :rtype: bool
222
+ """
159
223
  ...
160
224
 
161
225
  def property_unset(self):
162
- """ """
226
+ """Unset a property, will use default value afterward."""
163
227
  ...
164
228
 
165
229
  def remove(self, draw_func):
166
- """
230
+ """Remove a draw function that has been added to this menu
167
231
 
168
232
  :param draw_func:
169
233
  """
170
234
  ...
171
235
 
172
236
  def type_recast(self):
173
- """ """
237
+ """Return a new instance, this is needed because types
238
+ such as textures can be changed at runtime.
239
+
240
+ :return: a new instance of this object with the type initialized again.
241
+ """
174
242
  ...
175
243
 
176
244
  def values(self):
177
- """ """
245
+ """Returns the values of this objects custom properties (matches Python's
246
+ dictionary function of the same name).
247
+
248
+ :return: custom property values.
249
+ """
178
250
  ...
179
251
 
180
252
  class DATA_PT_context_volume(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
181
- """ """
182
-
183
253
  COMPAT_ENGINES: typing.Any
184
- """ """
185
-
186
254
  bl_context: typing.Any
187
- """ """
188
-
189
255
  bl_label: typing.Any
190
- """ """
191
-
192
256
  bl_options: typing.Any
193
- """ """
194
-
195
257
  bl_region_type: typing.Any
196
- """ """
197
-
198
258
  bl_rna: typing.Any
199
- """ """
200
-
201
259
  bl_space_type: typing.Any
202
- """ """
203
-
204
260
  id_data: typing.Any
205
- """ """
206
261
 
207
262
  def append(self, draw_func):
208
- """
263
+ """Append a draw function to this menu,
264
+ takes the same arguments as the menus draw function
209
265
 
210
- :param draw_func:
266
+ :param draw_func:
211
267
  """
212
268
  ...
213
269
 
214
- def as_pointer(self):
215
- """ """
270
+ def as_pointer(self) -> int:
271
+ """Returns the memory address which holds a pointer to Blender's internal data
272
+
273
+ :return: int (memory address).
274
+ :rtype: int
275
+ """
216
276
  ...
217
277
 
218
- def bl_rna_get_subclass(self):
219
- """ """
278
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
279
+ """
280
+
281
+ :return: The RNA type or default when not found.
282
+ :rtype: bpy.types.Struct
283
+ """
220
284
  ...
221
285
 
222
- def bl_rna_get_subclass_py(self):
223
- """ """
286
+ def bl_rna_get_subclass_py(self) -> typing.Any:
287
+ """
288
+
289
+ :return: The class or default when not found.
290
+ :rtype: typing.Any
291
+ """
224
292
  ...
225
293
 
226
294
  def draw(self, context):
@@ -230,72 +298,126 @@ class DATA_PT_context_volume(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
230
298
  """
231
299
  ...
232
300
 
233
- def driver_add(self):
234
- """ """
301
+ def driver_add(self) -> bpy.types.FCurve:
302
+ """Adds driver(s) to the given property
303
+
304
+ :return: The driver(s) added.
305
+ :rtype: bpy.types.FCurve
306
+ """
235
307
  ...
236
308
 
237
- def driver_remove(self):
238
- """ """
309
+ def driver_remove(self) -> bool:
310
+ """Remove driver(s) from the given property
311
+
312
+ :return: Success of driver removal.
313
+ :rtype: bool
314
+ """
239
315
  ...
240
316
 
241
317
  def get(self):
242
- """ """
318
+ """Returns the value of the custom property assigned to key or default
319
+ when not found (matches Python's dictionary function of the same name).
320
+
321
+ """
243
322
  ...
244
323
 
245
324
  def id_properties_clear(self):
246
- """ """
325
+ """
326
+
327
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
328
+ """
247
329
  ...
248
330
 
249
331
  def id_properties_ensure(self):
250
- """ """
332
+ """
333
+
334
+ :return: the parent group for an RNA struct's custom IDProperties.
335
+ """
251
336
  ...
252
337
 
253
338
  def id_properties_ui(self):
254
- """ """
255
- ...
339
+ """
256
340
 
257
- def is_extended(self):
258
- """ """
341
+ :return: Return an object used to manage an IDProperty's UI data.
342
+ """
259
343
  ...
260
344
 
261
- def is_property_hidden(self):
262
- """ """
345
+ def is_extended(self): ...
346
+ def is_property_hidden(self) -> bool:
347
+ """Check if a property is hidden.
348
+
349
+ :return: True when the property is hidden.
350
+ :rtype: bool
351
+ """
263
352
  ...
264
353
 
265
- def is_property_overridable_library(self):
266
- """ """
354
+ def is_property_overridable_library(self) -> bool:
355
+ """Check if a property is overridable.
356
+
357
+ :return: True when the property is overridable.
358
+ :rtype: bool
359
+ """
267
360
  ...
268
361
 
269
- def is_property_readonly(self):
270
- """ """
362
+ def is_property_readonly(self) -> bool:
363
+ """Check if a property is readonly.
364
+
365
+ :return: True when the property is readonly (not writable).
366
+ :rtype: bool
367
+ """
271
368
  ...
272
369
 
273
- def is_property_set(self):
274
- """ """
370
+ def is_property_set(self) -> bool:
371
+ """Check if a property is set, use for testing operator properties.
372
+
373
+ :return: True when the property has been set.
374
+ :rtype: bool
375
+ """
275
376
  ...
276
377
 
277
378
  def items(self):
278
- """ """
379
+ """Returns the items of this objects custom properties (matches Python's
380
+ dictionary function of the same name).
381
+
382
+ :return: custom property key, value pairs.
383
+ """
279
384
  ...
280
385
 
281
- def keyframe_delete(self):
282
- """ """
386
+ def keyframe_delete(self) -> bool:
387
+ """Remove a keyframe from this properties fcurve.
388
+
389
+ :return: Success of keyframe deletion.
390
+ :rtype: bool
391
+ """
283
392
  ...
284
393
 
285
- def keyframe_insert(self):
286
- """ """
394
+ def keyframe_insert(self) -> bool:
395
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
396
+
397
+ :return: Success of keyframe insertion.
398
+ :rtype: bool
399
+ """
287
400
  ...
288
401
 
289
402
  def keys(self):
290
- """ """
403
+ """Returns the keys of this objects custom properties (matches Python's
404
+ dictionary function of the same name).
405
+
406
+ :return: custom property keys.
407
+ """
291
408
  ...
292
409
 
293
- def path_from_id(self):
294
- """ """
410
+ def path_from_id(self) -> str:
411
+ """Returns the data path from the ID to this object (string).
412
+
413
+ :return: The path from `bpy.types.bpy_struct.id_data`
414
+ to this struct and property (when given).
415
+ :rtype: str
416
+ """
295
417
  ...
296
418
 
297
419
  def path_resolve(self):
298
- """ """
420
+ """Returns the property from the path, raise an exception when not found."""
299
421
  ...
300
422
 
301
423
  def poll(self, context):
@@ -306,88 +428,102 @@ class DATA_PT_context_volume(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
306
428
  ...
307
429
 
308
430
  def pop(self):
309
- """ """
431
+ """Remove and return the value of the custom property assigned to key or default
432
+ when not found (matches Python's dictionary function of the same name).
433
+
434
+ """
310
435
  ...
311
436
 
312
437
  def prepend(self, draw_func):
313
- """
438
+ """Prepend a draw function to this menu, takes the same arguments as
439
+ the menus draw function
314
440
 
315
- :param draw_func:
441
+ :param draw_func:
316
442
  """
317
443
  ...
318
444
 
319
- def property_overridable_library_set(self):
320
- """ """
445
+ def property_overridable_library_set(self) -> bool:
446
+ """Define a property as overridable or not (only for custom properties!).
447
+
448
+ :return: True when the overridable status of the property was successfully set.
449
+ :rtype: bool
450
+ """
321
451
  ...
322
452
 
323
453
  def property_unset(self):
324
- """ """
454
+ """Unset a property, will use default value afterward."""
325
455
  ...
326
456
 
327
457
  def remove(self, draw_func):
328
- """
458
+ """Remove a draw function that has been added to this menu
329
459
 
330
460
  :param draw_func:
331
461
  """
332
462
  ...
333
463
 
334
464
  def type_recast(self):
335
- """ """
465
+ """Return a new instance, this is needed because types
466
+ such as textures can be changed at runtime.
467
+
468
+ :return: a new instance of this object with the type initialized again.
469
+ """
336
470
  ...
337
471
 
338
472
  def values(self):
339
- """ """
473
+ """Returns the values of this objects custom properties (matches Python's
474
+ dictionary function of the same name).
475
+
476
+ :return: custom property values.
477
+ """
340
478
  ...
341
479
 
342
480
  class DATA_PT_custom_props_volume(
343
481
  bpy_types.Panel, DataButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
344
482
  ):
345
- """ """
483
+ """The subclass should have its own poll function
484
+ and the variable '_context_path' MUST be set.
485
+ """
346
486
 
347
487
  COMPAT_ENGINES: typing.Any
348
- """ """
349
-
350
488
  bl_context: typing.Any
351
- """ """
352
-
353
489
  bl_label: typing.Any
354
- """ """
355
-
356
490
  bl_options: typing.Any
357
- """ """
358
-
359
491
  bl_order: typing.Any
360
- """ """
361
-
362
492
  bl_region_type: typing.Any
363
- """ """
364
-
365
493
  bl_rna: typing.Any
366
- """ """
367
-
368
494
  bl_space_type: typing.Any
369
- """ """
370
-
371
495
  id_data: typing.Any
372
- """ """
373
496
 
374
497
  def append(self, draw_func):
375
- """
498
+ """Append a draw function to this menu,
499
+ takes the same arguments as the menus draw function
376
500
 
377
- :param draw_func:
501
+ :param draw_func:
378
502
  """
379
503
  ...
380
504
 
381
- def as_pointer(self):
382
- """ """
505
+ def as_pointer(self) -> int:
506
+ """Returns the memory address which holds a pointer to Blender's internal data
507
+
508
+ :return: int (memory address).
509
+ :rtype: int
510
+ """
383
511
  ...
384
512
 
385
- def bl_rna_get_subclass(self):
386
- """ """
513
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
514
+ """
515
+
516
+ :return: The RNA type or default when not found.
517
+ :rtype: bpy.types.Struct
518
+ """
387
519
  ...
388
520
 
389
- def bl_rna_get_subclass_py(self):
390
- """ """
521
+ def bl_rna_get_subclass_py(self) -> typing.Any:
522
+ """
523
+
524
+ :return: The class or default when not found.
525
+ :rtype: typing.Any
526
+ """
391
527
  ...
392
528
 
393
529
  def draw(self, context):
@@ -397,72 +533,126 @@ class DATA_PT_custom_props_volume(
397
533
  """
398
534
  ...
399
535
 
400
- def driver_add(self):
401
- """ """
536
+ def driver_add(self) -> bpy.types.FCurve:
537
+ """Adds driver(s) to the given property
538
+
539
+ :return: The driver(s) added.
540
+ :rtype: bpy.types.FCurve
541
+ """
402
542
  ...
403
543
 
404
- def driver_remove(self):
405
- """ """
544
+ def driver_remove(self) -> bool:
545
+ """Remove driver(s) from the given property
546
+
547
+ :return: Success of driver removal.
548
+ :rtype: bool
549
+ """
406
550
  ...
407
551
 
408
552
  def get(self):
409
- """ """
553
+ """Returns the value of the custom property assigned to key or default
554
+ when not found (matches Python's dictionary function of the same name).
555
+
556
+ """
410
557
  ...
411
558
 
412
559
  def id_properties_clear(self):
413
- """ """
560
+ """
561
+
562
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
563
+ """
414
564
  ...
415
565
 
416
566
  def id_properties_ensure(self):
417
- """ """
567
+ """
568
+
569
+ :return: the parent group for an RNA struct's custom IDProperties.
570
+ """
418
571
  ...
419
572
 
420
573
  def id_properties_ui(self):
421
- """ """
422
- ...
574
+ """
423
575
 
424
- def is_extended(self):
425
- """ """
576
+ :return: Return an object used to manage an IDProperty's UI data.
577
+ """
426
578
  ...
427
579
 
428
- def is_property_hidden(self):
429
- """ """
580
+ def is_extended(self): ...
581
+ def is_property_hidden(self) -> bool:
582
+ """Check if a property is hidden.
583
+
584
+ :return: True when the property is hidden.
585
+ :rtype: bool
586
+ """
430
587
  ...
431
588
 
432
- def is_property_overridable_library(self):
433
- """ """
589
+ def is_property_overridable_library(self) -> bool:
590
+ """Check if a property is overridable.
591
+
592
+ :return: True when the property is overridable.
593
+ :rtype: bool
594
+ """
434
595
  ...
435
596
 
436
- def is_property_readonly(self):
437
- """ """
597
+ def is_property_readonly(self) -> bool:
598
+ """Check if a property is readonly.
599
+
600
+ :return: True when the property is readonly (not writable).
601
+ :rtype: bool
602
+ """
438
603
  ...
439
604
 
440
- def is_property_set(self):
441
- """ """
605
+ def is_property_set(self) -> bool:
606
+ """Check if a property is set, use for testing operator properties.
607
+
608
+ :return: True when the property has been set.
609
+ :rtype: bool
610
+ """
442
611
  ...
443
612
 
444
613
  def items(self):
445
- """ """
614
+ """Returns the items of this objects custom properties (matches Python's
615
+ dictionary function of the same name).
616
+
617
+ :return: custom property key, value pairs.
618
+ """
446
619
  ...
447
620
 
448
- def keyframe_delete(self):
449
- """ """
621
+ def keyframe_delete(self) -> bool:
622
+ """Remove a keyframe from this properties fcurve.
623
+
624
+ :return: Success of keyframe deletion.
625
+ :rtype: bool
626
+ """
450
627
  ...
451
628
 
452
- def keyframe_insert(self):
453
- """ """
629
+ def keyframe_insert(self) -> bool:
630
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
631
+
632
+ :return: Success of keyframe insertion.
633
+ :rtype: bool
634
+ """
454
635
  ...
455
636
 
456
637
  def keys(self):
457
- """ """
638
+ """Returns the keys of this objects custom properties (matches Python's
639
+ dictionary function of the same name).
640
+
641
+ :return: custom property keys.
642
+ """
458
643
  ...
459
644
 
460
- def path_from_id(self):
461
- """ """
645
+ def path_from_id(self) -> str:
646
+ """Returns the data path from the ID to this object (string).
647
+
648
+ :return: The path from `bpy.types.bpy_struct.id_data`
649
+ to this struct and property (when given).
650
+ :rtype: str
651
+ """
462
652
  ...
463
653
 
464
654
  def path_resolve(self):
465
- """ """
655
+ """Returns the property from the path, raise an exception when not found."""
466
656
  ...
467
657
 
468
658
  def poll(self, context):
@@ -473,80 +663,94 @@ class DATA_PT_custom_props_volume(
473
663
  ...
474
664
 
475
665
  def pop(self):
476
- """ """
666
+ """Remove and return the value of the custom property assigned to key or default
667
+ when not found (matches Python's dictionary function of the same name).
668
+
669
+ """
477
670
  ...
478
671
 
479
672
  def prepend(self, draw_func):
480
- """
673
+ """Prepend a draw function to this menu, takes the same arguments as
674
+ the menus draw function
481
675
 
482
- :param draw_func:
676
+ :param draw_func:
483
677
  """
484
678
  ...
485
679
 
486
- def property_overridable_library_set(self):
487
- """ """
680
+ def property_overridable_library_set(self) -> bool:
681
+ """Define a property as overridable or not (only for custom properties!).
682
+
683
+ :return: True when the overridable status of the property was successfully set.
684
+ :rtype: bool
685
+ """
488
686
  ...
489
687
 
490
688
  def property_unset(self):
491
- """ """
689
+ """Unset a property, will use default value afterward."""
492
690
  ...
493
691
 
494
692
  def remove(self, draw_func):
495
- """
693
+ """Remove a draw function that has been added to this menu
496
694
 
497
695
  :param draw_func:
498
696
  """
499
697
  ...
500
698
 
501
699
  def type_recast(self):
502
- """ """
700
+ """Return a new instance, this is needed because types
701
+ such as textures can be changed at runtime.
702
+
703
+ :return: a new instance of this object with the type initialized again.
704
+ """
503
705
  ...
504
706
 
505
707
  def values(self):
506
- """ """
708
+ """Returns the values of this objects custom properties (matches Python's
709
+ dictionary function of the same name).
710
+
711
+ :return: custom property values.
712
+ """
507
713
  ...
508
714
 
509
715
  class DATA_PT_volume_file(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
510
- """ """
511
-
512
716
  COMPAT_ENGINES: typing.Any
513
- """ """
514
-
515
717
  bl_context: typing.Any
516
- """ """
517
-
518
718
  bl_label: typing.Any
519
- """ """
520
-
521
719
  bl_region_type: typing.Any
522
- """ """
523
-
524
720
  bl_rna: typing.Any
525
- """ """
526
-
527
721
  bl_space_type: typing.Any
528
- """ """
529
-
530
722
  id_data: typing.Any
531
- """ """
532
723
 
533
724
  def append(self, draw_func):
534
- """
725
+ """Append a draw function to this menu,
726
+ takes the same arguments as the menus draw function
535
727
 
536
- :param draw_func:
728
+ :param draw_func:
537
729
  """
538
730
  ...
539
731
 
540
- def as_pointer(self):
541
- """ """
732
+ def as_pointer(self) -> int:
733
+ """Returns the memory address which holds a pointer to Blender's internal data
734
+
735
+ :return: int (memory address).
736
+ :rtype: int
737
+ """
542
738
  ...
543
739
 
544
- def bl_rna_get_subclass(self):
545
- """ """
740
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
741
+ """
742
+
743
+ :return: The RNA type or default when not found.
744
+ :rtype: bpy.types.Struct
745
+ """
546
746
  ...
547
747
 
548
- def bl_rna_get_subclass_py(self):
549
- """ """
748
+ def bl_rna_get_subclass_py(self) -> typing.Any:
749
+ """
750
+
751
+ :return: The class or default when not found.
752
+ :rtype: typing.Any
753
+ """
550
754
  ...
551
755
 
552
756
  def draw(self, context):
@@ -556,72 +760,126 @@ class DATA_PT_volume_file(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericU
556
760
  """
557
761
  ...
558
762
 
559
- def driver_add(self):
560
- """ """
763
+ def driver_add(self) -> bpy.types.FCurve:
764
+ """Adds driver(s) to the given property
765
+
766
+ :return: The driver(s) added.
767
+ :rtype: bpy.types.FCurve
768
+ """
561
769
  ...
562
770
 
563
- def driver_remove(self):
564
- """ """
771
+ def driver_remove(self) -> bool:
772
+ """Remove driver(s) from the given property
773
+
774
+ :return: Success of driver removal.
775
+ :rtype: bool
776
+ """
565
777
  ...
566
778
 
567
779
  def get(self):
568
- """ """
780
+ """Returns the value of the custom property assigned to key or default
781
+ when not found (matches Python's dictionary function of the same name).
782
+
783
+ """
569
784
  ...
570
785
 
571
786
  def id_properties_clear(self):
572
- """ """
787
+ """
788
+
789
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
790
+ """
573
791
  ...
574
792
 
575
793
  def id_properties_ensure(self):
576
- """ """
794
+ """
795
+
796
+ :return: the parent group for an RNA struct's custom IDProperties.
797
+ """
577
798
  ...
578
799
 
579
800
  def id_properties_ui(self):
580
- """ """
581
- ...
801
+ """
582
802
 
583
- def is_extended(self):
584
- """ """
803
+ :return: Return an object used to manage an IDProperty's UI data.
804
+ """
585
805
  ...
586
806
 
587
- def is_property_hidden(self):
588
- """ """
807
+ def is_extended(self): ...
808
+ def is_property_hidden(self) -> bool:
809
+ """Check if a property is hidden.
810
+
811
+ :return: True when the property is hidden.
812
+ :rtype: bool
813
+ """
589
814
  ...
590
815
 
591
- def is_property_overridable_library(self):
592
- """ """
816
+ def is_property_overridable_library(self) -> bool:
817
+ """Check if a property is overridable.
818
+
819
+ :return: True when the property is overridable.
820
+ :rtype: bool
821
+ """
593
822
  ...
594
823
 
595
- def is_property_readonly(self):
596
- """ """
824
+ def is_property_readonly(self) -> bool:
825
+ """Check if a property is readonly.
826
+
827
+ :return: True when the property is readonly (not writable).
828
+ :rtype: bool
829
+ """
597
830
  ...
598
831
 
599
- def is_property_set(self):
600
- """ """
832
+ def is_property_set(self) -> bool:
833
+ """Check if a property is set, use for testing operator properties.
834
+
835
+ :return: True when the property has been set.
836
+ :rtype: bool
837
+ """
601
838
  ...
602
839
 
603
840
  def items(self):
604
- """ """
841
+ """Returns the items of this objects custom properties (matches Python's
842
+ dictionary function of the same name).
843
+
844
+ :return: custom property key, value pairs.
845
+ """
605
846
  ...
606
847
 
607
- def keyframe_delete(self):
608
- """ """
848
+ def keyframe_delete(self) -> bool:
849
+ """Remove a keyframe from this properties fcurve.
850
+
851
+ :return: Success of keyframe deletion.
852
+ :rtype: bool
853
+ """
609
854
  ...
610
855
 
611
- def keyframe_insert(self):
612
- """ """
856
+ def keyframe_insert(self) -> bool:
857
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
858
+
859
+ :return: Success of keyframe insertion.
860
+ :rtype: bool
861
+ """
613
862
  ...
614
863
 
615
864
  def keys(self):
616
- """ """
865
+ """Returns the keys of this objects custom properties (matches Python's
866
+ dictionary function of the same name).
867
+
868
+ :return: custom property keys.
869
+ """
617
870
  ...
618
871
 
619
- def path_from_id(self):
620
- """ """
872
+ def path_from_id(self) -> str:
873
+ """Returns the data path from the ID to this object (string).
874
+
875
+ :return: The path from `bpy.types.bpy_struct.id_data`
876
+ to this struct and property (when given).
877
+ :rtype: str
878
+ """
621
879
  ...
622
880
 
623
881
  def path_resolve(self):
624
- """ """
882
+ """Returns the property from the path, raise an exception when not found."""
625
883
  ...
626
884
 
627
885
  def poll(self, context):
@@ -632,80 +890,94 @@ class DATA_PT_volume_file(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericU
632
890
  ...
633
891
 
634
892
  def pop(self):
635
- """ """
893
+ """Remove and return the value of the custom property assigned to key or default
894
+ when not found (matches Python's dictionary function of the same name).
895
+
896
+ """
636
897
  ...
637
898
 
638
899
  def prepend(self, draw_func):
639
- """
900
+ """Prepend a draw function to this menu, takes the same arguments as
901
+ the menus draw function
640
902
 
641
- :param draw_func:
903
+ :param draw_func:
642
904
  """
643
905
  ...
644
906
 
645
- def property_overridable_library_set(self):
646
- """ """
907
+ def property_overridable_library_set(self) -> bool:
908
+ """Define a property as overridable or not (only for custom properties!).
909
+
910
+ :return: True when the overridable status of the property was successfully set.
911
+ :rtype: bool
912
+ """
647
913
  ...
648
914
 
649
915
  def property_unset(self):
650
- """ """
916
+ """Unset a property, will use default value afterward."""
651
917
  ...
652
918
 
653
919
  def remove(self, draw_func):
654
- """
920
+ """Remove a draw function that has been added to this menu
655
921
 
656
922
  :param draw_func:
657
923
  """
658
924
  ...
659
925
 
660
926
  def type_recast(self):
661
- """ """
927
+ """Return a new instance, this is needed because types
928
+ such as textures can be changed at runtime.
929
+
930
+ :return: a new instance of this object with the type initialized again.
931
+ """
662
932
  ...
663
933
 
664
934
  def values(self):
665
- """ """
935
+ """Returns the values of this objects custom properties (matches Python's
936
+ dictionary function of the same name).
937
+
938
+ :return: custom property values.
939
+ """
666
940
  ...
667
941
 
668
942
  class DATA_PT_volume_grids(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
669
- """ """
670
-
671
943
  COMPAT_ENGINES: typing.Any
672
- """ """
673
-
674
944
  bl_context: typing.Any
675
- """ """
676
-
677
945
  bl_label: typing.Any
678
- """ """
679
-
680
946
  bl_region_type: typing.Any
681
- """ """
682
-
683
947
  bl_rna: typing.Any
684
- """ """
685
-
686
948
  bl_space_type: typing.Any
687
- """ """
688
-
689
949
  id_data: typing.Any
690
- """ """
691
950
 
692
951
  def append(self, draw_func):
693
- """
952
+ """Append a draw function to this menu,
953
+ takes the same arguments as the menus draw function
694
954
 
695
- :param draw_func:
955
+ :param draw_func:
696
956
  """
697
957
  ...
698
958
 
699
- def as_pointer(self):
700
- """ """
959
+ def as_pointer(self) -> int:
960
+ """Returns the memory address which holds a pointer to Blender's internal data
961
+
962
+ :return: int (memory address).
963
+ :rtype: int
964
+ """
701
965
  ...
702
966
 
703
- def bl_rna_get_subclass(self):
704
- """ """
967
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
968
+ """
969
+
970
+ :return: The RNA type or default when not found.
971
+ :rtype: bpy.types.Struct
972
+ """
705
973
  ...
706
974
 
707
- def bl_rna_get_subclass_py(self):
708
- """ """
975
+ def bl_rna_get_subclass_py(self) -> typing.Any:
976
+ """
977
+
978
+ :return: The class or default when not found.
979
+ :rtype: typing.Any
980
+ """
709
981
  ...
710
982
 
711
983
  def draw(self, context):
@@ -715,72 +987,126 @@ class DATA_PT_volume_grids(bpy_types.Panel, DataButtonsPanel, bpy_types._Generic
715
987
  """
716
988
  ...
717
989
 
718
- def driver_add(self):
719
- """ """
990
+ def driver_add(self) -> bpy.types.FCurve:
991
+ """Adds driver(s) to the given property
992
+
993
+ :return: The driver(s) added.
994
+ :rtype: bpy.types.FCurve
995
+ """
720
996
  ...
721
997
 
722
- def driver_remove(self):
723
- """ """
998
+ def driver_remove(self) -> bool:
999
+ """Remove driver(s) from the given property
1000
+
1001
+ :return: Success of driver removal.
1002
+ :rtype: bool
1003
+ """
724
1004
  ...
725
1005
 
726
1006
  def get(self):
727
- """ """
1007
+ """Returns the value of the custom property assigned to key or default
1008
+ when not found (matches Python's dictionary function of the same name).
1009
+
1010
+ """
728
1011
  ...
729
1012
 
730
1013
  def id_properties_clear(self):
731
- """ """
1014
+ """
1015
+
1016
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1017
+ """
732
1018
  ...
733
1019
 
734
1020
  def id_properties_ensure(self):
735
- """ """
1021
+ """
1022
+
1023
+ :return: the parent group for an RNA struct's custom IDProperties.
1024
+ """
736
1025
  ...
737
1026
 
738
1027
  def id_properties_ui(self):
739
- """ """
740
- ...
1028
+ """
741
1029
 
742
- def is_extended(self):
743
- """ """
1030
+ :return: Return an object used to manage an IDProperty's UI data.
1031
+ """
744
1032
  ...
745
1033
 
746
- def is_property_hidden(self):
747
- """ """
1034
+ def is_extended(self): ...
1035
+ def is_property_hidden(self) -> bool:
1036
+ """Check if a property is hidden.
1037
+
1038
+ :return: True when the property is hidden.
1039
+ :rtype: bool
1040
+ """
748
1041
  ...
749
1042
 
750
- def is_property_overridable_library(self):
751
- """ """
1043
+ def is_property_overridable_library(self) -> bool:
1044
+ """Check if a property is overridable.
1045
+
1046
+ :return: True when the property is overridable.
1047
+ :rtype: bool
1048
+ """
752
1049
  ...
753
1050
 
754
- def is_property_readonly(self):
755
- """ """
1051
+ def is_property_readonly(self) -> bool:
1052
+ """Check if a property is readonly.
1053
+
1054
+ :return: True when the property is readonly (not writable).
1055
+ :rtype: bool
1056
+ """
756
1057
  ...
757
1058
 
758
- def is_property_set(self):
759
- """ """
1059
+ def is_property_set(self) -> bool:
1060
+ """Check if a property is set, use for testing operator properties.
1061
+
1062
+ :return: True when the property has been set.
1063
+ :rtype: bool
1064
+ """
760
1065
  ...
761
1066
 
762
1067
  def items(self):
763
- """ """
1068
+ """Returns the items of this objects custom properties (matches Python's
1069
+ dictionary function of the same name).
1070
+
1071
+ :return: custom property key, value pairs.
1072
+ """
764
1073
  ...
765
1074
 
766
- def keyframe_delete(self):
767
- """ """
1075
+ def keyframe_delete(self) -> bool:
1076
+ """Remove a keyframe from this properties fcurve.
1077
+
1078
+ :return: Success of keyframe deletion.
1079
+ :rtype: bool
1080
+ """
768
1081
  ...
769
1082
 
770
- def keyframe_insert(self):
771
- """ """
1083
+ def keyframe_insert(self) -> bool:
1084
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1085
+
1086
+ :return: Success of keyframe insertion.
1087
+ :rtype: bool
1088
+ """
772
1089
  ...
773
1090
 
774
1091
  def keys(self):
775
- """ """
1092
+ """Returns the keys of this objects custom properties (matches Python's
1093
+ dictionary function of the same name).
1094
+
1095
+ :return: custom property keys.
1096
+ """
776
1097
  ...
777
1098
 
778
- def path_from_id(self):
779
- """ """
1099
+ def path_from_id(self) -> str:
1100
+ """Returns the data path from the ID to this object (string).
1101
+
1102
+ :return: The path from `bpy.types.bpy_struct.id_data`
1103
+ to this struct and property (when given).
1104
+ :rtype: str
1105
+ """
780
1106
  ...
781
1107
 
782
1108
  def path_resolve(self):
783
- """ """
1109
+ """Returns the property from the path, raise an exception when not found."""
784
1110
  ...
785
1111
 
786
1112
  def poll(self, context):
@@ -791,80 +1117,94 @@ class DATA_PT_volume_grids(bpy_types.Panel, DataButtonsPanel, bpy_types._Generic
791
1117
  ...
792
1118
 
793
1119
  def pop(self):
794
- """ """
1120
+ """Remove and return the value of the custom property assigned to key or default
1121
+ when not found (matches Python's dictionary function of the same name).
1122
+
1123
+ """
795
1124
  ...
796
1125
 
797
1126
  def prepend(self, draw_func):
798
- """
1127
+ """Prepend a draw function to this menu, takes the same arguments as
1128
+ the menus draw function
799
1129
 
800
- :param draw_func:
1130
+ :param draw_func:
801
1131
  """
802
1132
  ...
803
1133
 
804
- def property_overridable_library_set(self):
805
- """ """
1134
+ def property_overridable_library_set(self) -> bool:
1135
+ """Define a property as overridable or not (only for custom properties!).
1136
+
1137
+ :return: True when the overridable status of the property was successfully set.
1138
+ :rtype: bool
1139
+ """
806
1140
  ...
807
1141
 
808
1142
  def property_unset(self):
809
- """ """
1143
+ """Unset a property, will use default value afterward."""
810
1144
  ...
811
1145
 
812
1146
  def remove(self, draw_func):
813
- """
1147
+ """Remove a draw function that has been added to this menu
814
1148
 
815
1149
  :param draw_func:
816
1150
  """
817
1151
  ...
818
1152
 
819
1153
  def type_recast(self):
820
- """ """
1154
+ """Return a new instance, this is needed because types
1155
+ such as textures can be changed at runtime.
1156
+
1157
+ :return: a new instance of this object with the type initialized again.
1158
+ """
821
1159
  ...
822
1160
 
823
1161
  def values(self):
824
- """ """
1162
+ """Returns the values of this objects custom properties (matches Python's
1163
+ dictionary function of the same name).
1164
+
1165
+ :return: custom property values.
1166
+ """
825
1167
  ...
826
1168
 
827
1169
  class DATA_PT_volume_render(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
828
- """ """
829
-
830
1170
  COMPAT_ENGINES: typing.Any
831
- """ """
832
-
833
1171
  bl_context: typing.Any
834
- """ """
835
-
836
1172
  bl_label: typing.Any
837
- """ """
838
-
839
1173
  bl_region_type: typing.Any
840
- """ """
841
-
842
1174
  bl_rna: typing.Any
843
- """ """
844
-
845
1175
  bl_space_type: typing.Any
846
- """ """
847
-
848
1176
  id_data: typing.Any
849
- """ """
850
1177
 
851
1178
  def append(self, draw_func):
852
- """
1179
+ """Append a draw function to this menu,
1180
+ takes the same arguments as the menus draw function
853
1181
 
854
- :param draw_func:
1182
+ :param draw_func:
855
1183
  """
856
1184
  ...
857
1185
 
858
- def as_pointer(self):
859
- """ """
1186
+ def as_pointer(self) -> int:
1187
+ """Returns the memory address which holds a pointer to Blender's internal data
1188
+
1189
+ :return: int (memory address).
1190
+ :rtype: int
1191
+ """
860
1192
  ...
861
1193
 
862
- def bl_rna_get_subclass(self):
863
- """ """
1194
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1195
+ """
1196
+
1197
+ :return: The RNA type or default when not found.
1198
+ :rtype: bpy.types.Struct
1199
+ """
864
1200
  ...
865
1201
 
866
- def bl_rna_get_subclass_py(self):
867
- """ """
1202
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1203
+ """
1204
+
1205
+ :return: The class or default when not found.
1206
+ :rtype: typing.Any
1207
+ """
868
1208
  ...
869
1209
 
870
1210
  def draw(self, context):
@@ -874,72 +1214,126 @@ class DATA_PT_volume_render(bpy_types.Panel, DataButtonsPanel, bpy_types._Generi
874
1214
  """
875
1215
  ...
876
1216
 
877
- def driver_add(self):
878
- """ """
1217
+ def driver_add(self) -> bpy.types.FCurve:
1218
+ """Adds driver(s) to the given property
1219
+
1220
+ :return: The driver(s) added.
1221
+ :rtype: bpy.types.FCurve
1222
+ """
879
1223
  ...
880
1224
 
881
- def driver_remove(self):
882
- """ """
1225
+ def driver_remove(self) -> bool:
1226
+ """Remove driver(s) from the given property
1227
+
1228
+ :return: Success of driver removal.
1229
+ :rtype: bool
1230
+ """
883
1231
  ...
884
1232
 
885
1233
  def get(self):
886
- """ """
1234
+ """Returns the value of the custom property assigned to key or default
1235
+ when not found (matches Python's dictionary function of the same name).
1236
+
1237
+ """
887
1238
  ...
888
1239
 
889
1240
  def id_properties_clear(self):
890
- """ """
1241
+ """
1242
+
1243
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1244
+ """
891
1245
  ...
892
1246
 
893
1247
  def id_properties_ensure(self):
894
- """ """
1248
+ """
1249
+
1250
+ :return: the parent group for an RNA struct's custom IDProperties.
1251
+ """
895
1252
  ...
896
1253
 
897
1254
  def id_properties_ui(self):
898
- """ """
899
- ...
1255
+ """
900
1256
 
901
- def is_extended(self):
902
- """ """
1257
+ :return: Return an object used to manage an IDProperty's UI data.
1258
+ """
903
1259
  ...
904
1260
 
905
- def is_property_hidden(self):
906
- """ """
1261
+ def is_extended(self): ...
1262
+ def is_property_hidden(self) -> bool:
1263
+ """Check if a property is hidden.
1264
+
1265
+ :return: True when the property is hidden.
1266
+ :rtype: bool
1267
+ """
907
1268
  ...
908
1269
 
909
- def is_property_overridable_library(self):
910
- """ """
1270
+ def is_property_overridable_library(self) -> bool:
1271
+ """Check if a property is overridable.
1272
+
1273
+ :return: True when the property is overridable.
1274
+ :rtype: bool
1275
+ """
911
1276
  ...
912
1277
 
913
- def is_property_readonly(self):
914
- """ """
1278
+ def is_property_readonly(self) -> bool:
1279
+ """Check if a property is readonly.
1280
+
1281
+ :return: True when the property is readonly (not writable).
1282
+ :rtype: bool
1283
+ """
915
1284
  ...
916
1285
 
917
- def is_property_set(self):
918
- """ """
1286
+ def is_property_set(self) -> bool:
1287
+ """Check if a property is set, use for testing operator properties.
1288
+
1289
+ :return: True when the property has been set.
1290
+ :rtype: bool
1291
+ """
919
1292
  ...
920
1293
 
921
1294
  def items(self):
922
- """ """
1295
+ """Returns the items of this objects custom properties (matches Python's
1296
+ dictionary function of the same name).
1297
+
1298
+ :return: custom property key, value pairs.
1299
+ """
923
1300
  ...
924
1301
 
925
- def keyframe_delete(self):
926
- """ """
1302
+ def keyframe_delete(self) -> bool:
1303
+ """Remove a keyframe from this properties fcurve.
1304
+
1305
+ :return: Success of keyframe deletion.
1306
+ :rtype: bool
1307
+ """
927
1308
  ...
928
1309
 
929
- def keyframe_insert(self):
930
- """ """
1310
+ def keyframe_insert(self) -> bool:
1311
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1312
+
1313
+ :return: Success of keyframe insertion.
1314
+ :rtype: bool
1315
+ """
931
1316
  ...
932
1317
 
933
1318
  def keys(self):
934
- """ """
1319
+ """Returns the keys of this objects custom properties (matches Python's
1320
+ dictionary function of the same name).
1321
+
1322
+ :return: custom property keys.
1323
+ """
935
1324
  ...
936
1325
 
937
- def path_from_id(self):
938
- """ """
1326
+ def path_from_id(self) -> str:
1327
+ """Returns the data path from the ID to this object (string).
1328
+
1329
+ :return: The path from `bpy.types.bpy_struct.id_data`
1330
+ to this struct and property (when given).
1331
+ :rtype: str
1332
+ """
939
1333
  ...
940
1334
 
941
1335
  def path_resolve(self):
942
- """ """
1336
+ """Returns the property from the path, raise an exception when not found."""
943
1337
  ...
944
1338
 
945
1339
  def poll(self, context):
@@ -950,82 +1344,96 @@ class DATA_PT_volume_render(bpy_types.Panel, DataButtonsPanel, bpy_types._Generi
950
1344
  ...
951
1345
 
952
1346
  def pop(self):
953
- """ """
1347
+ """Remove and return the value of the custom property assigned to key or default
1348
+ when not found (matches Python's dictionary function of the same name).
1349
+
1350
+ """
954
1351
  ...
955
1352
 
956
1353
  def prepend(self, draw_func):
957
- """
1354
+ """Prepend a draw function to this menu, takes the same arguments as
1355
+ the menus draw function
958
1356
 
959
- :param draw_func:
1357
+ :param draw_func:
960
1358
  """
961
1359
  ...
962
1360
 
963
- def property_overridable_library_set(self):
964
- """ """
1361
+ def property_overridable_library_set(self) -> bool:
1362
+ """Define a property as overridable or not (only for custom properties!).
1363
+
1364
+ :return: True when the overridable status of the property was successfully set.
1365
+ :rtype: bool
1366
+ """
965
1367
  ...
966
1368
 
967
1369
  def property_unset(self):
968
- """ """
1370
+ """Unset a property, will use default value afterward."""
969
1371
  ...
970
1372
 
971
1373
  def remove(self, draw_func):
972
- """
1374
+ """Remove a draw function that has been added to this menu
973
1375
 
974
1376
  :param draw_func:
975
1377
  """
976
1378
  ...
977
1379
 
978
1380
  def type_recast(self):
979
- """ """
1381
+ """Return a new instance, this is needed because types
1382
+ such as textures can be changed at runtime.
1383
+
1384
+ :return: a new instance of this object with the type initialized again.
1385
+ """
980
1386
  ...
981
1387
 
982
1388
  def values(self):
983
- """ """
1389
+ """Returns the values of this objects custom properties (matches Python's
1390
+ dictionary function of the same name).
1391
+
1392
+ :return: custom property values.
1393
+ """
984
1394
  ...
985
1395
 
986
1396
  class DATA_PT_volume_viewport_display(
987
1397
  bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI
988
1398
  ):
989
- """ """
990
-
991
1399
  COMPAT_ENGINES: typing.Any
992
- """ """
993
-
994
1400
  bl_context: typing.Any
995
- """ """
996
-
997
1401
  bl_label: typing.Any
998
- """ """
999
-
1000
1402
  bl_region_type: typing.Any
1001
- """ """
1002
-
1003
1403
  bl_rna: typing.Any
1004
- """ """
1005
-
1006
1404
  bl_space_type: typing.Any
1007
- """ """
1008
-
1009
1405
  id_data: typing.Any
1010
- """ """
1011
1406
 
1012
1407
  def append(self, draw_func):
1013
- """
1408
+ """Append a draw function to this menu,
1409
+ takes the same arguments as the menus draw function
1014
1410
 
1015
- :param draw_func:
1411
+ :param draw_func:
1016
1412
  """
1017
1413
  ...
1018
1414
 
1019
- def as_pointer(self):
1020
- """ """
1415
+ def as_pointer(self) -> int:
1416
+ """Returns the memory address which holds a pointer to Blender's internal data
1417
+
1418
+ :return: int (memory address).
1419
+ :rtype: int
1420
+ """
1021
1421
  ...
1022
1422
 
1023
- def bl_rna_get_subclass(self):
1024
- """ """
1423
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1424
+ """
1425
+
1426
+ :return: The RNA type or default when not found.
1427
+ :rtype: bpy.types.Struct
1428
+ """
1025
1429
  ...
1026
1430
 
1027
- def bl_rna_get_subclass_py(self):
1028
- """ """
1431
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1432
+ """
1433
+
1434
+ :return: The class or default when not found.
1435
+ :rtype: typing.Any
1436
+ """
1029
1437
  ...
1030
1438
 
1031
1439
  def draw(self, context):
@@ -1035,72 +1443,126 @@ class DATA_PT_volume_viewport_display(
1035
1443
  """
1036
1444
  ...
1037
1445
 
1038
- def driver_add(self):
1039
- """ """
1446
+ def driver_add(self) -> bpy.types.FCurve:
1447
+ """Adds driver(s) to the given property
1448
+
1449
+ :return: The driver(s) added.
1450
+ :rtype: bpy.types.FCurve
1451
+ """
1040
1452
  ...
1041
1453
 
1042
- def driver_remove(self):
1043
- """ """
1454
+ def driver_remove(self) -> bool:
1455
+ """Remove driver(s) from the given property
1456
+
1457
+ :return: Success of driver removal.
1458
+ :rtype: bool
1459
+ """
1044
1460
  ...
1045
1461
 
1046
1462
  def get(self):
1047
- """ """
1463
+ """Returns the value of the custom property assigned to key or default
1464
+ when not found (matches Python's dictionary function of the same name).
1465
+
1466
+ """
1048
1467
  ...
1049
1468
 
1050
1469
  def id_properties_clear(self):
1051
- """ """
1470
+ """
1471
+
1472
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1473
+ """
1052
1474
  ...
1053
1475
 
1054
1476
  def id_properties_ensure(self):
1055
- """ """
1477
+ """
1478
+
1479
+ :return: the parent group for an RNA struct's custom IDProperties.
1480
+ """
1056
1481
  ...
1057
1482
 
1058
1483
  def id_properties_ui(self):
1059
- """ """
1060
- ...
1484
+ """
1061
1485
 
1062
- def is_extended(self):
1063
- """ """
1486
+ :return: Return an object used to manage an IDProperty's UI data.
1487
+ """
1064
1488
  ...
1065
1489
 
1066
- def is_property_hidden(self):
1067
- """ """
1490
+ def is_extended(self): ...
1491
+ def is_property_hidden(self) -> bool:
1492
+ """Check if a property is hidden.
1493
+
1494
+ :return: True when the property is hidden.
1495
+ :rtype: bool
1496
+ """
1068
1497
  ...
1069
1498
 
1070
- def is_property_overridable_library(self):
1071
- """ """
1499
+ def is_property_overridable_library(self) -> bool:
1500
+ """Check if a property is overridable.
1501
+
1502
+ :return: True when the property is overridable.
1503
+ :rtype: bool
1504
+ """
1072
1505
  ...
1073
1506
 
1074
- def is_property_readonly(self):
1075
- """ """
1507
+ def is_property_readonly(self) -> bool:
1508
+ """Check if a property is readonly.
1509
+
1510
+ :return: True when the property is readonly (not writable).
1511
+ :rtype: bool
1512
+ """
1076
1513
  ...
1077
1514
 
1078
- def is_property_set(self):
1079
- """ """
1515
+ def is_property_set(self) -> bool:
1516
+ """Check if a property is set, use for testing operator properties.
1517
+
1518
+ :return: True when the property has been set.
1519
+ :rtype: bool
1520
+ """
1080
1521
  ...
1081
1522
 
1082
1523
  def items(self):
1083
- """ """
1524
+ """Returns the items of this objects custom properties (matches Python's
1525
+ dictionary function of the same name).
1526
+
1527
+ :return: custom property key, value pairs.
1528
+ """
1084
1529
  ...
1085
1530
 
1086
- def keyframe_delete(self):
1087
- """ """
1531
+ def keyframe_delete(self) -> bool:
1532
+ """Remove a keyframe from this properties fcurve.
1533
+
1534
+ :return: Success of keyframe deletion.
1535
+ :rtype: bool
1536
+ """
1088
1537
  ...
1089
1538
 
1090
- def keyframe_insert(self):
1091
- """ """
1539
+ def keyframe_insert(self) -> bool:
1540
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1541
+
1542
+ :return: Success of keyframe insertion.
1543
+ :rtype: bool
1544
+ """
1092
1545
  ...
1093
1546
 
1094
1547
  def keys(self):
1095
- """ """
1548
+ """Returns the keys of this objects custom properties (matches Python's
1549
+ dictionary function of the same name).
1550
+
1551
+ :return: custom property keys.
1552
+ """
1096
1553
  ...
1097
1554
 
1098
- def path_from_id(self):
1099
- """ """
1555
+ def path_from_id(self) -> str:
1556
+ """Returns the data path from the ID to this object (string).
1557
+
1558
+ :return: The path from `bpy.types.bpy_struct.id_data`
1559
+ to this struct and property (when given).
1560
+ :rtype: str
1561
+ """
1100
1562
  ...
1101
1563
 
1102
1564
  def path_resolve(self):
1103
- """ """
1565
+ """Returns the property from the path, raise an exception when not found."""
1104
1566
  ...
1105
1567
 
1106
1568
  def poll(self, context):
@@ -1111,85 +1573,97 @@ class DATA_PT_volume_viewport_display(
1111
1573
  ...
1112
1574
 
1113
1575
  def pop(self):
1114
- """ """
1576
+ """Remove and return the value of the custom property assigned to key or default
1577
+ when not found (matches Python's dictionary function of the same name).
1578
+
1579
+ """
1115
1580
  ...
1116
1581
 
1117
1582
  def prepend(self, draw_func):
1118
- """
1583
+ """Prepend a draw function to this menu, takes the same arguments as
1584
+ the menus draw function
1119
1585
 
1120
- :param draw_func:
1586
+ :param draw_func:
1121
1587
  """
1122
1588
  ...
1123
1589
 
1124
- def property_overridable_library_set(self):
1125
- """ """
1590
+ def property_overridable_library_set(self) -> bool:
1591
+ """Define a property as overridable or not (only for custom properties!).
1592
+
1593
+ :return: True when the overridable status of the property was successfully set.
1594
+ :rtype: bool
1595
+ """
1126
1596
  ...
1127
1597
 
1128
1598
  def property_unset(self):
1129
- """ """
1599
+ """Unset a property, will use default value afterward."""
1130
1600
  ...
1131
1601
 
1132
1602
  def remove(self, draw_func):
1133
- """
1603
+ """Remove a draw function that has been added to this menu
1134
1604
 
1135
1605
  :param draw_func:
1136
1606
  """
1137
1607
  ...
1138
1608
 
1139
1609
  def type_recast(self):
1140
- """ """
1610
+ """Return a new instance, this is needed because types
1611
+ such as textures can be changed at runtime.
1612
+
1613
+ :return: a new instance of this object with the type initialized again.
1614
+ """
1141
1615
  ...
1142
1616
 
1143
1617
  def values(self):
1144
- """ """
1618
+ """Returns the values of this objects custom properties (matches Python's
1619
+ dictionary function of the same name).
1620
+
1621
+ :return: custom property values.
1622
+ """
1145
1623
  ...
1146
1624
 
1147
1625
  class DATA_PT_volume_viewport_display_slicing(
1148
1626
  bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI
1149
1627
  ):
1150
- """ """
1151
-
1152
1628
  COMPAT_ENGINES: typing.Any
1153
- """ """
1154
-
1155
1629
  bl_context: typing.Any
1156
- """ """
1157
-
1158
1630
  bl_label: typing.Any
1159
- """ """
1160
-
1161
1631
  bl_parent_id: typing.Any
1162
- """ """
1163
-
1164
1632
  bl_region_type: typing.Any
1165
- """ """
1166
-
1167
1633
  bl_rna: typing.Any
1168
- """ """
1169
-
1170
1634
  bl_space_type: typing.Any
1171
- """ """
1172
-
1173
1635
  id_data: typing.Any
1174
- """ """
1175
1636
 
1176
1637
  def append(self, draw_func):
1177
- """
1638
+ """Append a draw function to this menu,
1639
+ takes the same arguments as the menus draw function
1178
1640
 
1179
- :param draw_func:
1641
+ :param draw_func:
1180
1642
  """
1181
1643
  ...
1182
1644
 
1183
- def as_pointer(self):
1184
- """ """
1645
+ def as_pointer(self) -> int:
1646
+ """Returns the memory address which holds a pointer to Blender's internal data
1647
+
1648
+ :return: int (memory address).
1649
+ :rtype: int
1650
+ """
1185
1651
  ...
1186
1652
 
1187
- def bl_rna_get_subclass(self):
1188
- """ """
1653
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1654
+ """
1655
+
1656
+ :return: The RNA type or default when not found.
1657
+ :rtype: bpy.types.Struct
1658
+ """
1189
1659
  ...
1190
1660
 
1191
- def bl_rna_get_subclass_py(self):
1192
- """ """
1661
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1662
+ """
1663
+
1664
+ :return: The class or default when not found.
1665
+ :rtype: typing.Any
1666
+ """
1193
1667
  ...
1194
1668
 
1195
1669
  def draw(self, context):
@@ -1206,72 +1680,126 @@ class DATA_PT_volume_viewport_display_slicing(
1206
1680
  """
1207
1681
  ...
1208
1682
 
1209
- def driver_add(self):
1210
- """ """
1683
+ def driver_add(self) -> bpy.types.FCurve:
1684
+ """Adds driver(s) to the given property
1685
+
1686
+ :return: The driver(s) added.
1687
+ :rtype: bpy.types.FCurve
1688
+ """
1211
1689
  ...
1212
1690
 
1213
- def driver_remove(self):
1214
- """ """
1691
+ def driver_remove(self) -> bool:
1692
+ """Remove driver(s) from the given property
1693
+
1694
+ :return: Success of driver removal.
1695
+ :rtype: bool
1696
+ """
1215
1697
  ...
1216
1698
 
1217
1699
  def get(self):
1218
- """ """
1700
+ """Returns the value of the custom property assigned to key or default
1701
+ when not found (matches Python's dictionary function of the same name).
1702
+
1703
+ """
1219
1704
  ...
1220
1705
 
1221
1706
  def id_properties_clear(self):
1222
- """ """
1707
+ """
1708
+
1709
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1710
+ """
1223
1711
  ...
1224
1712
 
1225
1713
  def id_properties_ensure(self):
1226
- """ """
1714
+ """
1715
+
1716
+ :return: the parent group for an RNA struct's custom IDProperties.
1717
+ """
1227
1718
  ...
1228
1719
 
1229
1720
  def id_properties_ui(self):
1230
- """ """
1231
- ...
1721
+ """
1232
1722
 
1233
- def is_extended(self):
1234
- """ """
1723
+ :return: Return an object used to manage an IDProperty's UI data.
1724
+ """
1235
1725
  ...
1236
1726
 
1237
- def is_property_hidden(self):
1238
- """ """
1727
+ def is_extended(self): ...
1728
+ def is_property_hidden(self) -> bool:
1729
+ """Check if a property is hidden.
1730
+
1731
+ :return: True when the property is hidden.
1732
+ :rtype: bool
1733
+ """
1239
1734
  ...
1240
1735
 
1241
- def is_property_overridable_library(self):
1242
- """ """
1736
+ def is_property_overridable_library(self) -> bool:
1737
+ """Check if a property is overridable.
1738
+
1739
+ :return: True when the property is overridable.
1740
+ :rtype: bool
1741
+ """
1243
1742
  ...
1244
1743
 
1245
- def is_property_readonly(self):
1246
- """ """
1744
+ def is_property_readonly(self) -> bool:
1745
+ """Check if a property is readonly.
1746
+
1747
+ :return: True when the property is readonly (not writable).
1748
+ :rtype: bool
1749
+ """
1247
1750
  ...
1248
1751
 
1249
- def is_property_set(self):
1250
- """ """
1752
+ def is_property_set(self) -> bool:
1753
+ """Check if a property is set, use for testing operator properties.
1754
+
1755
+ :return: True when the property has been set.
1756
+ :rtype: bool
1757
+ """
1251
1758
  ...
1252
1759
 
1253
1760
  def items(self):
1254
- """ """
1761
+ """Returns the items of this objects custom properties (matches Python's
1762
+ dictionary function of the same name).
1763
+
1764
+ :return: custom property key, value pairs.
1765
+ """
1255
1766
  ...
1256
1767
 
1257
- def keyframe_delete(self):
1258
- """ """
1768
+ def keyframe_delete(self) -> bool:
1769
+ """Remove a keyframe from this properties fcurve.
1770
+
1771
+ :return: Success of keyframe deletion.
1772
+ :rtype: bool
1773
+ """
1259
1774
  ...
1260
1775
 
1261
- def keyframe_insert(self):
1262
- """ """
1776
+ def keyframe_insert(self) -> bool:
1777
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1778
+
1779
+ :return: Success of keyframe insertion.
1780
+ :rtype: bool
1781
+ """
1263
1782
  ...
1264
1783
 
1265
1784
  def keys(self):
1266
- """ """
1785
+ """Returns the keys of this objects custom properties (matches Python's
1786
+ dictionary function of the same name).
1787
+
1788
+ :return: custom property keys.
1789
+ """
1267
1790
  ...
1268
1791
 
1269
- def path_from_id(self):
1270
- """ """
1792
+ def path_from_id(self) -> str:
1793
+ """Returns the data path from the ID to this object (string).
1794
+
1795
+ :return: The path from `bpy.types.bpy_struct.id_data`
1796
+ to this struct and property (when given).
1797
+ :rtype: str
1798
+ """
1271
1799
  ...
1272
1800
 
1273
1801
  def path_resolve(self):
1274
- """ """
1802
+ """Returns the property from the path, raise an exception when not found."""
1275
1803
  ...
1276
1804
 
1277
1805
  def poll(self, context):
@@ -1282,35 +1810,51 @@ class DATA_PT_volume_viewport_display_slicing(
1282
1810
  ...
1283
1811
 
1284
1812
  def pop(self):
1285
- """ """
1813
+ """Remove and return the value of the custom property assigned to key or default
1814
+ when not found (matches Python's dictionary function of the same name).
1815
+
1816
+ """
1286
1817
  ...
1287
1818
 
1288
1819
  def prepend(self, draw_func):
1289
- """
1820
+ """Prepend a draw function to this menu, takes the same arguments as
1821
+ the menus draw function
1290
1822
 
1291
- :param draw_func:
1823
+ :param draw_func:
1292
1824
  """
1293
1825
  ...
1294
1826
 
1295
- def property_overridable_library_set(self):
1296
- """ """
1827
+ def property_overridable_library_set(self) -> bool:
1828
+ """Define a property as overridable or not (only for custom properties!).
1829
+
1830
+ :return: True when the overridable status of the property was successfully set.
1831
+ :rtype: bool
1832
+ """
1297
1833
  ...
1298
1834
 
1299
1835
  def property_unset(self):
1300
- """ """
1836
+ """Unset a property, will use default value afterward."""
1301
1837
  ...
1302
1838
 
1303
1839
  def remove(self, draw_func):
1304
- """
1840
+ """Remove a draw function that has been added to this menu
1305
1841
 
1306
1842
  :param draw_func:
1307
1843
  """
1308
1844
  ...
1309
1845
 
1310
1846
  def type_recast(self):
1311
- """ """
1847
+ """Return a new instance, this is needed because types
1848
+ such as textures can be changed at runtime.
1849
+
1850
+ :return: a new instance of this object with the type initialized again.
1851
+ """
1312
1852
  ...
1313
1853
 
1314
1854
  def values(self):
1315
- """ """
1855
+ """Returns the values of this objects custom properties (matches Python's
1856
+ dictionary function of the same name).
1857
+
1858
+ :return: custom property values.
1859
+ """
1316
1860
  ...