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