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