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