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