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

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

Potentially problematic release.


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

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