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
 
@@ -17,22 +18,35 @@ class VIEWLAYER_MT_lightgroup_sync(bpy_types.Menu, bpy_types._GenericUI):
17
18
  """ """
18
19
 
19
20
  def append(self, draw_func):
20
- """
21
+ """Append a draw function to this menu,
22
+ takes the same arguments as the menus draw function
21
23
 
22
- :param draw_func:
24
+ :param draw_func:
23
25
  """
24
26
  ...
25
27
 
26
- def as_pointer(self):
27
- """ """
28
+ def as_pointer(self) -> int:
29
+ """Returns the memory address which holds a pointer to Blender's internal data
30
+
31
+ :return: int (memory address).
32
+ :rtype: int
33
+ """
28
34
  ...
29
35
 
30
- def bl_rna_get_subclass(self):
31
- """ """
36
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
37
+ """
38
+
39
+ :return: The RNA type or default when not found.
40
+ :rtype: bpy.types.Struct
41
+ """
32
42
  ...
33
43
 
34
- def bl_rna_get_subclass_py(self):
35
- """ """
44
+ def bl_rna_get_subclass_py(self) -> typing.Any:
45
+ """
46
+
47
+ :return: The class or default when not found.
48
+ :rtype: typing.Any
49
+ """
36
50
  ...
37
51
 
38
52
  def draw(self, _context):
@@ -51,138 +65,224 @@ class VIEWLAYER_MT_lightgroup_sync(bpy_types.Menu, bpy_types._GenericUI):
51
65
  ...
52
66
 
53
67
  def draw_preset(self, _context):
54
- """
68
+ """Define these on the subclass:
69
+ - preset_operator (string)
70
+ - preset_subdir (string)Optionally:
71
+ - preset_add_operator (string)
72
+ - preset_extensions (set of strings)
73
+ - preset_operator_defaults (dict of keyword args)
55
74
 
56
- :param _context:
75
+ :param _context:
57
76
  """
58
77
  ...
59
78
 
60
- def driver_add(self):
61
- """ """
79
+ def driver_add(self) -> bpy.types.FCurve:
80
+ """Adds driver(s) to the given property
81
+
82
+ :return: The driver(s) added.
83
+ :rtype: bpy.types.FCurve
84
+ """
62
85
  ...
63
86
 
64
- def driver_remove(self):
65
- """ """
87
+ def driver_remove(self) -> bool:
88
+ """Remove driver(s) from the given property
89
+
90
+ :return: Success of driver removal.
91
+ :rtype: bool
92
+ """
66
93
  ...
67
94
 
68
95
  def get(self):
69
- """ """
96
+ """Returns the value of the custom property assigned to key or default
97
+ when not found (matches Python's dictionary function of the same name).
98
+
99
+ """
70
100
  ...
71
101
 
72
102
  def id_properties_clear(self):
73
- """ """
103
+ """
104
+
105
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
106
+ """
74
107
  ...
75
108
 
76
109
  def id_properties_ensure(self):
77
- """ """
110
+ """
111
+
112
+ :return: the parent group for an RNA struct's custom IDProperties.
113
+ """
78
114
  ...
79
115
 
80
116
  def id_properties_ui(self):
81
- """ """
117
+ """
118
+
119
+ :return: Return an object used to manage an IDProperty's UI data.
120
+ """
82
121
  ...
83
122
 
84
123
  def is_extended(self):
85
124
  """ """
86
125
  ...
87
126
 
88
- def is_property_hidden(self):
89
- """ """
127
+ def is_property_hidden(self) -> bool:
128
+ """Check if a property is hidden.
129
+
130
+ :return: True when the property is hidden.
131
+ :rtype: bool
132
+ """
90
133
  ...
91
134
 
92
- def is_property_overridable_library(self):
93
- """ """
135
+ def is_property_overridable_library(self) -> bool:
136
+ """Check if a property is overridable.
137
+
138
+ :return: True when the property is overridable.
139
+ :rtype: bool
140
+ """
94
141
  ...
95
142
 
96
- def is_property_readonly(self):
97
- """ """
143
+ def is_property_readonly(self) -> bool:
144
+ """Check if a property is readonly.
145
+
146
+ :return: True when the property is readonly (not writable).
147
+ :rtype: bool
148
+ """
98
149
  ...
99
150
 
100
- def is_property_set(self):
101
- """ """
151
+ def is_property_set(self) -> bool:
152
+ """Check if a property is set, use for testing operator properties.
153
+
154
+ :return: True when the property has been set.
155
+ :rtype: bool
156
+ """
102
157
  ...
103
158
 
104
159
  def items(self):
105
- """ """
160
+ """Returns the items of this objects custom properties (matches Python's
161
+ dictionary function of the same name).
162
+
163
+ :return: custom property key, value pairs.
164
+ """
106
165
  ...
107
166
 
108
- def keyframe_delete(self):
109
- """ """
167
+ def keyframe_delete(self) -> bool:
168
+ """Remove a keyframe from this properties fcurve.
169
+
170
+ :return: Success of keyframe deletion.
171
+ :rtype: bool
172
+ """
110
173
  ...
111
174
 
112
- def keyframe_insert(self):
113
- """ """
175
+ def keyframe_insert(self) -> bool:
176
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
177
+
178
+ :return: Success of keyframe insertion.
179
+ :rtype: bool
180
+ """
114
181
  ...
115
182
 
116
183
  def keys(self):
117
- """ """
184
+ """Returns the keys of this objects custom properties (matches Python's
185
+ dictionary function of the same name).
186
+
187
+ :return: custom property keys.
188
+ """
118
189
  ...
119
190
 
120
- def path_from_id(self):
121
- """ """
191
+ def path_from_id(self) -> str:
192
+ """Returns the data path from the ID to this object (string).
193
+
194
+ :return: The path from `bpy.types.bpy_struct.id_data`
195
+ to this struct and property (when given).
196
+ :rtype: str
197
+ """
122
198
  ...
123
199
 
124
200
  def path_menu(
125
201
  self,
126
- searchpaths,
127
- operator,
128
- props_default,
129
- prop_filepath,
130
- filter_ext,
131
- filter_path,
132
- display_name,
133
- add_operator,
134
- add_operator_props,
202
+ searchpaths: list[str],
203
+ operator: str,
204
+ props_default: dict = None,
205
+ prop_filepath: str = "filepath",
206
+ filter_ext: typing.Callable = None,
207
+ filter_path=None,
208
+ display_name: typing.Callable = None,
209
+ add_operator=None,
210
+ add_operator_props=None,
135
211
  ):
136
- """
212
+ """Populate a menu from a list of paths.
137
213
 
138
- :param searchpaths:
139
- :param operator:
140
- :param props_default:
141
- :param prop_filepath:
142
- :param filter_ext:
143
- :param filter_path:
144
- :param display_name:
145
- :param add_operator:
146
- :param add_operator_props:
214
+ :param searchpaths: Paths to scan.
215
+ :type searchpaths: list[str]
216
+ :param operator: The operator id to use with each file.
217
+ :type operator: str
218
+ :param props_default: Properties to assign to each operator.
219
+ :type props_default: dict
220
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
221
+ :type prop_filepath: str
222
+ :param filter_ext: Optional callback that takes the file extensions.
223
+
224
+ Returning false excludes the file from the list.
225
+ :type filter_ext: typing.Callable
226
+ :param filter_path:
227
+ :param display_name: Optional callback that takes the full path, returns the name to display.
228
+ :type display_name: typing.Callable
229
+ :param add_operator:
230
+ :param add_operator_props:
147
231
  """
148
232
  ...
149
233
 
150
234
  def path_resolve(self):
151
- """ """
235
+ """Returns the property from the path, raise an exception when not found."""
152
236
  ...
153
237
 
154
238
  def pop(self):
155
- """ """
239
+ """Remove and return the value of the custom property assigned to key or default
240
+ when not found (matches Python's dictionary function of the same name).
241
+
242
+ """
156
243
  ...
157
244
 
158
245
  def prepend(self, draw_func):
159
- """
246
+ """Prepend a draw function to this menu, takes the same arguments as
247
+ the menus draw function
160
248
 
161
- :param draw_func:
249
+ :param draw_func:
162
250
  """
163
251
  ...
164
252
 
165
- def property_overridable_library_set(self):
166
- """ """
253
+ def property_overridable_library_set(self) -> bool:
254
+ """Define a property as overridable or not (only for custom properties!).
255
+
256
+ :return: True when the overridable status of the property was successfully set.
257
+ :rtype: bool
258
+ """
167
259
  ...
168
260
 
169
261
  def property_unset(self):
170
- """ """
262
+ """Unset a property, will use default value afterward."""
171
263
  ...
172
264
 
173
265
  def remove(self, draw_func):
174
- """
266
+ """Remove a draw function that has been added to this menu
175
267
 
176
268
  :param draw_func:
177
269
  """
178
270
  ...
179
271
 
180
272
  def type_recast(self):
181
- """ """
273
+ """Return a new instance, this is needed because types
274
+ such as textures can be changed at runtime.
275
+
276
+ :return: a new instance of this object with the type initialized again.
277
+ """
182
278
  ...
183
279
 
184
280
  def values(self):
185
- """ """
281
+ """Returns the values of this objects custom properties (matches Python's
282
+ dictionary function of the same name).
283
+
284
+ :return: custom property values.
285
+ """
186
286
  ...
187
287
 
188
288
  class ViewLayerButtonsPanel:
@@ -207,7 +307,9 @@ class ViewLayerButtonsPanel:
207
307
  class VIEWLAYER_PT_layer_custom_props(
208
308
  bpy_types.Panel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
209
309
  ):
210
- """ """
310
+ """The subclass should have its own poll function
311
+ and the variable '_context_path' MUST be set.
312
+ """
211
313
 
212
314
  bl_context: typing.Any
213
315
  """ """
@@ -234,22 +336,35 @@ class VIEWLAYER_PT_layer_custom_props(
234
336
  """ """
235
337
 
236
338
  def append(self, draw_func):
237
- """
339
+ """Append a draw function to this menu,
340
+ takes the same arguments as the menus draw function
238
341
 
239
- :param draw_func:
342
+ :param draw_func:
240
343
  """
241
344
  ...
242
345
 
243
- def as_pointer(self):
244
- """ """
346
+ def as_pointer(self) -> int:
347
+ """Returns the memory address which holds a pointer to Blender's internal data
348
+
349
+ :return: int (memory address).
350
+ :rtype: int
351
+ """
245
352
  ...
246
353
 
247
- def bl_rna_get_subclass(self):
248
- """ """
354
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
355
+ """
356
+
357
+ :return: The RNA type or default when not found.
358
+ :rtype: bpy.types.Struct
359
+ """
249
360
  ...
250
361
 
251
- def bl_rna_get_subclass_py(self):
252
- """ """
362
+ def bl_rna_get_subclass_py(self) -> typing.Any:
363
+ """
364
+
365
+ :return: The class or default when not found.
366
+ :rtype: typing.Any
367
+ """
253
368
  ...
254
369
 
255
370
  def draw(self, context):
@@ -259,72 +374,129 @@ class VIEWLAYER_PT_layer_custom_props(
259
374
  """
260
375
  ...
261
376
 
262
- def driver_add(self):
263
- """ """
377
+ def driver_add(self) -> bpy.types.FCurve:
378
+ """Adds driver(s) to the given property
379
+
380
+ :return: The driver(s) added.
381
+ :rtype: bpy.types.FCurve
382
+ """
264
383
  ...
265
384
 
266
- def driver_remove(self):
267
- """ """
385
+ def driver_remove(self) -> bool:
386
+ """Remove driver(s) from the given property
387
+
388
+ :return: Success of driver removal.
389
+ :rtype: bool
390
+ """
268
391
  ...
269
392
 
270
393
  def get(self):
271
- """ """
394
+ """Returns the value of the custom property assigned to key or default
395
+ when not found (matches Python's dictionary function of the same name).
396
+
397
+ """
272
398
  ...
273
399
 
274
400
  def id_properties_clear(self):
275
- """ """
401
+ """
402
+
403
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
404
+ """
276
405
  ...
277
406
 
278
407
  def id_properties_ensure(self):
279
- """ """
408
+ """
409
+
410
+ :return: the parent group for an RNA struct's custom IDProperties.
411
+ """
280
412
  ...
281
413
 
282
414
  def id_properties_ui(self):
283
- """ """
415
+ """
416
+
417
+ :return: Return an object used to manage an IDProperty's UI data.
418
+ """
284
419
  ...
285
420
 
286
421
  def is_extended(self):
287
422
  """ """
288
423
  ...
289
424
 
290
- def is_property_hidden(self):
291
- """ """
425
+ def is_property_hidden(self) -> bool:
426
+ """Check if a property is hidden.
427
+
428
+ :return: True when the property is hidden.
429
+ :rtype: bool
430
+ """
292
431
  ...
293
432
 
294
- def is_property_overridable_library(self):
295
- """ """
433
+ def is_property_overridable_library(self) -> bool:
434
+ """Check if a property is overridable.
435
+
436
+ :return: True when the property is overridable.
437
+ :rtype: bool
438
+ """
296
439
  ...
297
440
 
298
- def is_property_readonly(self):
299
- """ """
441
+ def is_property_readonly(self) -> bool:
442
+ """Check if a property is readonly.
443
+
444
+ :return: True when the property is readonly (not writable).
445
+ :rtype: bool
446
+ """
300
447
  ...
301
448
 
302
- def is_property_set(self):
303
- """ """
449
+ def is_property_set(self) -> bool:
450
+ """Check if a property is set, use for testing operator properties.
451
+
452
+ :return: True when the property has been set.
453
+ :rtype: bool
454
+ """
304
455
  ...
305
456
 
306
457
  def items(self):
307
- """ """
458
+ """Returns the items of this objects custom properties (matches Python's
459
+ dictionary function of the same name).
460
+
461
+ :return: custom property key, value pairs.
462
+ """
308
463
  ...
309
464
 
310
- def keyframe_delete(self):
311
- """ """
465
+ def keyframe_delete(self) -> bool:
466
+ """Remove a keyframe from this properties fcurve.
467
+
468
+ :return: Success of keyframe deletion.
469
+ :rtype: bool
470
+ """
312
471
  ...
313
472
 
314
- def keyframe_insert(self):
315
- """ """
473
+ def keyframe_insert(self) -> bool:
474
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
475
+
476
+ :return: Success of keyframe insertion.
477
+ :rtype: bool
478
+ """
316
479
  ...
317
480
 
318
481
  def keys(self):
319
- """ """
482
+ """Returns the keys of this objects custom properties (matches Python's
483
+ dictionary function of the same name).
484
+
485
+ :return: custom property keys.
486
+ """
320
487
  ...
321
488
 
322
- def path_from_id(self):
323
- """ """
489
+ def path_from_id(self) -> str:
490
+ """Returns the data path from the ID to this object (string).
491
+
492
+ :return: The path from `bpy.types.bpy_struct.id_data`
493
+ to this struct and property (when given).
494
+ :rtype: str
495
+ """
324
496
  ...
325
497
 
326
498
  def path_resolve(self):
327
- """ """
499
+ """Returns the property from the path, raise an exception when not found."""
328
500
  ...
329
501
 
330
502
  def poll(self, context):
@@ -335,37 +507,53 @@ class VIEWLAYER_PT_layer_custom_props(
335
507
  ...
336
508
 
337
509
  def pop(self):
338
- """ """
510
+ """Remove and return the value of the custom property assigned to key or default
511
+ when not found (matches Python's dictionary function of the same name).
512
+
513
+ """
339
514
  ...
340
515
 
341
516
  def prepend(self, draw_func):
342
- """
517
+ """Prepend a draw function to this menu, takes the same arguments as
518
+ the menus draw function
343
519
 
344
- :param draw_func:
520
+ :param draw_func:
345
521
  """
346
522
  ...
347
523
 
348
- def property_overridable_library_set(self):
349
- """ """
524
+ def property_overridable_library_set(self) -> bool:
525
+ """Define a property as overridable or not (only for custom properties!).
526
+
527
+ :return: True when the overridable status of the property was successfully set.
528
+ :rtype: bool
529
+ """
350
530
  ...
351
531
 
352
532
  def property_unset(self):
353
- """ """
533
+ """Unset a property, will use default value afterward."""
354
534
  ...
355
535
 
356
536
  def remove(self, draw_func):
357
- """
537
+ """Remove a draw function that has been added to this menu
358
538
 
359
539
  :param draw_func:
360
540
  """
361
541
  ...
362
542
 
363
543
  def type_recast(self):
364
- """ """
544
+ """Return a new instance, this is needed because types
545
+ such as textures can be changed at runtime.
546
+
547
+ :return: a new instance of this object with the type initialized again.
548
+ """
365
549
  ...
366
550
 
367
551
  def values(self):
368
- """ """
552
+ """Returns the values of this objects custom properties (matches Python's
553
+ dictionary function of the same name).
554
+
555
+ :return: custom property values.
556
+ """
369
557
  ...
370
558
 
371
559
  class VIEWLAYER_UL_aov(bpy_types.UIList, bpy_types._GenericUI):
@@ -378,22 +566,35 @@ class VIEWLAYER_UL_aov(bpy_types.UIList, bpy_types._GenericUI):
378
566
  """ """
379
567
 
380
568
  def append(self, draw_func):
381
- """
569
+ """Append a draw function to this menu,
570
+ takes the same arguments as the menus draw function
382
571
 
383
- :param draw_func:
572
+ :param draw_func:
384
573
  """
385
574
  ...
386
575
 
387
- def as_pointer(self):
388
- """ """
576
+ def as_pointer(self) -> int:
577
+ """Returns the memory address which holds a pointer to Blender's internal data
578
+
579
+ :return: int (memory address).
580
+ :rtype: int
581
+ """
389
582
  ...
390
583
 
391
- def bl_rna_get_subclass(self):
392
- """ """
584
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
585
+ """
586
+
587
+ :return: The RNA type or default when not found.
588
+ :rtype: bpy.types.Struct
589
+ """
393
590
  ...
394
591
 
395
- def bl_rna_get_subclass_py(self):
396
- """ """
592
+ def bl_rna_get_subclass_py(self) -> typing.Any:
593
+ """
594
+
595
+ :return: The class or default when not found.
596
+ :rtype: typing.Any
597
+ """
397
598
  ...
398
599
 
399
600
  def draw_item(
@@ -411,106 +612,179 @@ class VIEWLAYER_UL_aov(bpy_types.UIList, bpy_types._GenericUI):
411
612
  """
412
613
  ...
413
614
 
414
- def driver_add(self):
415
- """ """
615
+ def driver_add(self) -> bpy.types.FCurve:
616
+ """Adds driver(s) to the given property
617
+
618
+ :return: The driver(s) added.
619
+ :rtype: bpy.types.FCurve
620
+ """
416
621
  ...
417
622
 
418
- def driver_remove(self):
419
- """ """
623
+ def driver_remove(self) -> bool:
624
+ """Remove driver(s) from the given property
625
+
626
+ :return: Success of driver removal.
627
+ :rtype: bool
628
+ """
420
629
  ...
421
630
 
422
631
  def get(self):
423
- """ """
632
+ """Returns the value of the custom property assigned to key or default
633
+ when not found (matches Python's dictionary function of the same name).
634
+
635
+ """
424
636
  ...
425
637
 
426
638
  def id_properties_clear(self):
427
- """ """
639
+ """
640
+
641
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
642
+ """
428
643
  ...
429
644
 
430
645
  def id_properties_ensure(self):
431
- """ """
646
+ """
647
+
648
+ :return: the parent group for an RNA struct's custom IDProperties.
649
+ """
432
650
  ...
433
651
 
434
652
  def id_properties_ui(self):
435
- """ """
653
+ """
654
+
655
+ :return: Return an object used to manage an IDProperty's UI data.
656
+ """
436
657
  ...
437
658
 
438
659
  def is_extended(self):
439
660
  """ """
440
661
  ...
441
662
 
442
- def is_property_hidden(self):
443
- """ """
663
+ def is_property_hidden(self) -> bool:
664
+ """Check if a property is hidden.
665
+
666
+ :return: True when the property is hidden.
667
+ :rtype: bool
668
+ """
444
669
  ...
445
670
 
446
- def is_property_overridable_library(self):
447
- """ """
671
+ def is_property_overridable_library(self) -> bool:
672
+ """Check if a property is overridable.
673
+
674
+ :return: True when the property is overridable.
675
+ :rtype: bool
676
+ """
448
677
  ...
449
678
 
450
- def is_property_readonly(self):
451
- """ """
679
+ def is_property_readonly(self) -> bool:
680
+ """Check if a property is readonly.
681
+
682
+ :return: True when the property is readonly (not writable).
683
+ :rtype: bool
684
+ """
452
685
  ...
453
686
 
454
- def is_property_set(self):
455
- """ """
687
+ def is_property_set(self) -> bool:
688
+ """Check if a property is set, use for testing operator properties.
689
+
690
+ :return: True when the property has been set.
691
+ :rtype: bool
692
+ """
456
693
  ...
457
694
 
458
695
  def items(self):
459
- """ """
696
+ """Returns the items of this objects custom properties (matches Python's
697
+ dictionary function of the same name).
698
+
699
+ :return: custom property key, value pairs.
700
+ """
460
701
  ...
461
702
 
462
- def keyframe_delete(self):
463
- """ """
703
+ def keyframe_delete(self) -> bool:
704
+ """Remove a keyframe from this properties fcurve.
705
+
706
+ :return: Success of keyframe deletion.
707
+ :rtype: bool
708
+ """
464
709
  ...
465
710
 
466
- def keyframe_insert(self):
467
- """ """
711
+ def keyframe_insert(self) -> bool:
712
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
713
+
714
+ :return: Success of keyframe insertion.
715
+ :rtype: bool
716
+ """
468
717
  ...
469
718
 
470
719
  def keys(self):
471
- """ """
720
+ """Returns the keys of this objects custom properties (matches Python's
721
+ dictionary function of the same name).
722
+
723
+ :return: custom property keys.
724
+ """
472
725
  ...
473
726
 
474
- def path_from_id(self):
475
- """ """
727
+ def path_from_id(self) -> str:
728
+ """Returns the data path from the ID to this object (string).
729
+
730
+ :return: The path from `bpy.types.bpy_struct.id_data`
731
+ to this struct and property (when given).
732
+ :rtype: str
733
+ """
476
734
  ...
477
735
 
478
736
  def path_resolve(self):
479
- """ """
737
+ """Returns the property from the path, raise an exception when not found."""
480
738
  ...
481
739
 
482
740
  def pop(self):
483
- """ """
741
+ """Remove and return the value of the custom property assigned to key or default
742
+ when not found (matches Python's dictionary function of the same name).
743
+
744
+ """
484
745
  ...
485
746
 
486
747
  def prepend(self, draw_func):
487
- """
748
+ """Prepend a draw function to this menu, takes the same arguments as
749
+ the menus draw function
488
750
 
489
- :param draw_func:
751
+ :param draw_func:
490
752
  """
491
753
  ...
492
754
 
493
- def property_overridable_library_set(self):
494
- """ """
755
+ def property_overridable_library_set(self) -> bool:
756
+ """Define a property as overridable or not (only for custom properties!).
757
+
758
+ :return: True when the overridable status of the property was successfully set.
759
+ :rtype: bool
760
+ """
495
761
  ...
496
762
 
497
763
  def property_unset(self):
498
- """ """
764
+ """Unset a property, will use default value afterward."""
499
765
  ...
500
766
 
501
767
  def remove(self, draw_func):
502
- """
768
+ """Remove a draw function that has been added to this menu
503
769
 
504
770
  :param draw_func:
505
771
  """
506
772
  ...
507
773
 
508
774
  def type_recast(self):
509
- """ """
775
+ """Return a new instance, this is needed because types
776
+ such as textures can be changed at runtime.
777
+
778
+ :return: a new instance of this object with the type initialized again.
779
+ """
510
780
  ...
511
781
 
512
782
  def values(self):
513
- """ """
783
+ """Returns the values of this objects custom properties (matches Python's
784
+ dictionary function of the same name).
785
+
786
+ :return: custom property values.
787
+ """
514
788
  ...
515
789
 
516
790
  class VIEWLAYER_PT_eevee_layer_passes_data(
@@ -543,22 +817,35 @@ class VIEWLAYER_PT_eevee_layer_passes_data(
543
817
  """ """
544
818
 
545
819
  def append(self, draw_func):
546
- """
820
+ """Append a draw function to this menu,
821
+ takes the same arguments as the menus draw function
547
822
 
548
- :param draw_func:
823
+ :param draw_func:
549
824
  """
550
825
  ...
551
826
 
552
- def as_pointer(self):
553
- """ """
827
+ def as_pointer(self) -> int:
828
+ """Returns the memory address which holds a pointer to Blender's internal data
829
+
830
+ :return: int (memory address).
831
+ :rtype: int
832
+ """
554
833
  ...
555
834
 
556
- def bl_rna_get_subclass(self):
557
- """ """
835
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
836
+ """
837
+
838
+ :return: The RNA type or default when not found.
839
+ :rtype: bpy.types.Struct
840
+ """
558
841
  ...
559
842
 
560
- def bl_rna_get_subclass_py(self):
561
- """ """
843
+ def bl_rna_get_subclass_py(self) -> typing.Any:
844
+ """
845
+
846
+ :return: The class or default when not found.
847
+ :rtype: typing.Any
848
+ """
562
849
  ...
563
850
 
564
851
  def draw(self, context):
@@ -568,72 +855,129 @@ class VIEWLAYER_PT_eevee_layer_passes_data(
568
855
  """
569
856
  ...
570
857
 
571
- def driver_add(self):
572
- """ """
573
- ...
858
+ def driver_add(self) -> bpy.types.FCurve:
859
+ """Adds driver(s) to the given property
574
860
 
575
- def driver_remove(self):
576
- """ """
861
+ :return: The driver(s) added.
862
+ :rtype: bpy.types.FCurve
863
+ """
864
+ ...
865
+
866
+ def driver_remove(self) -> bool:
867
+ """Remove driver(s) from the given property
868
+
869
+ :return: Success of driver removal.
870
+ :rtype: bool
871
+ """
577
872
  ...
578
873
 
579
874
  def get(self):
580
- """ """
875
+ """Returns the value of the custom property assigned to key or default
876
+ when not found (matches Python's dictionary function of the same name).
877
+
878
+ """
581
879
  ...
582
880
 
583
881
  def id_properties_clear(self):
584
- """ """
882
+ """
883
+
884
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
885
+ """
585
886
  ...
586
887
 
587
888
  def id_properties_ensure(self):
588
- """ """
889
+ """
890
+
891
+ :return: the parent group for an RNA struct's custom IDProperties.
892
+ """
589
893
  ...
590
894
 
591
895
  def id_properties_ui(self):
592
- """ """
896
+ """
897
+
898
+ :return: Return an object used to manage an IDProperty's UI data.
899
+ """
593
900
  ...
594
901
 
595
902
  def is_extended(self):
596
903
  """ """
597
904
  ...
598
905
 
599
- def is_property_hidden(self):
600
- """ """
906
+ def is_property_hidden(self) -> bool:
907
+ """Check if a property is hidden.
908
+
909
+ :return: True when the property is hidden.
910
+ :rtype: bool
911
+ """
601
912
  ...
602
913
 
603
- def is_property_overridable_library(self):
604
- """ """
914
+ def is_property_overridable_library(self) -> bool:
915
+ """Check if a property is overridable.
916
+
917
+ :return: True when the property is overridable.
918
+ :rtype: bool
919
+ """
605
920
  ...
606
921
 
607
- def is_property_readonly(self):
608
- """ """
922
+ def is_property_readonly(self) -> bool:
923
+ """Check if a property is readonly.
924
+
925
+ :return: True when the property is readonly (not writable).
926
+ :rtype: bool
927
+ """
609
928
  ...
610
929
 
611
- def is_property_set(self):
612
- """ """
930
+ def is_property_set(self) -> bool:
931
+ """Check if a property is set, use for testing operator properties.
932
+
933
+ :return: True when the property has been set.
934
+ :rtype: bool
935
+ """
613
936
  ...
614
937
 
615
938
  def items(self):
616
- """ """
939
+ """Returns the items of this objects custom properties (matches Python's
940
+ dictionary function of the same name).
941
+
942
+ :return: custom property key, value pairs.
943
+ """
617
944
  ...
618
945
 
619
- def keyframe_delete(self):
620
- """ """
946
+ def keyframe_delete(self) -> bool:
947
+ """Remove a keyframe from this properties fcurve.
948
+
949
+ :return: Success of keyframe deletion.
950
+ :rtype: bool
951
+ """
621
952
  ...
622
953
 
623
- def keyframe_insert(self):
624
- """ """
954
+ def keyframe_insert(self) -> bool:
955
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
956
+
957
+ :return: Success of keyframe insertion.
958
+ :rtype: bool
959
+ """
625
960
  ...
626
961
 
627
962
  def keys(self):
628
- """ """
963
+ """Returns the keys of this objects custom properties (matches Python's
964
+ dictionary function of the same name).
965
+
966
+ :return: custom property keys.
967
+ """
629
968
  ...
630
969
 
631
- def path_from_id(self):
632
- """ """
970
+ def path_from_id(self) -> str:
971
+ """Returns the data path from the ID to this object (string).
972
+
973
+ :return: The path from `bpy.types.bpy_struct.id_data`
974
+ to this struct and property (when given).
975
+ :rtype: str
976
+ """
633
977
  ...
634
978
 
635
979
  def path_resolve(self):
636
- """ """
980
+ """Returns the property from the path, raise an exception when not found."""
637
981
  ...
638
982
 
639
983
  def poll(self, context):
@@ -644,37 +988,53 @@ class VIEWLAYER_PT_eevee_layer_passes_data(
644
988
  ...
645
989
 
646
990
  def pop(self):
647
- """ """
991
+ """Remove and return the value of the custom property assigned to key or default
992
+ when not found (matches Python's dictionary function of the same name).
993
+
994
+ """
648
995
  ...
649
996
 
650
997
  def prepend(self, draw_func):
651
- """
998
+ """Prepend a draw function to this menu, takes the same arguments as
999
+ the menus draw function
652
1000
 
653
- :param draw_func:
1001
+ :param draw_func:
654
1002
  """
655
1003
  ...
656
1004
 
657
- def property_overridable_library_set(self):
658
- """ """
1005
+ def property_overridable_library_set(self) -> bool:
1006
+ """Define a property as overridable or not (only for custom properties!).
1007
+
1008
+ :return: True when the overridable status of the property was successfully set.
1009
+ :rtype: bool
1010
+ """
659
1011
  ...
660
1012
 
661
1013
  def property_unset(self):
662
- """ """
1014
+ """Unset a property, will use default value afterward."""
663
1015
  ...
664
1016
 
665
1017
  def remove(self, draw_func):
666
- """
1018
+ """Remove a draw function that has been added to this menu
667
1019
 
668
1020
  :param draw_func:
669
1021
  """
670
1022
  ...
671
1023
 
672
1024
  def type_recast(self):
673
- """ """
1025
+ """Return a new instance, this is needed because types
1026
+ such as textures can be changed at runtime.
1027
+
1028
+ :return: a new instance of this object with the type initialized again.
1029
+ """
674
1030
  ...
675
1031
 
676
1032
  def values(self):
677
- """ """
1033
+ """Returns the values of this objects custom properties (matches Python's
1034
+ dictionary function of the same name).
1035
+
1036
+ :return: custom property values.
1037
+ """
678
1038
  ...
679
1039
 
680
1040
  class VIEWLAYER_PT_eevee_layer_passes_effects(
@@ -707,22 +1067,35 @@ class VIEWLAYER_PT_eevee_layer_passes_effects(
707
1067
  """ """
708
1068
 
709
1069
  def append(self, draw_func):
710
- """
1070
+ """Append a draw function to this menu,
1071
+ takes the same arguments as the menus draw function
711
1072
 
712
- :param draw_func:
1073
+ :param draw_func:
713
1074
  """
714
1075
  ...
715
1076
 
716
- def as_pointer(self):
717
- """ """
1077
+ def as_pointer(self) -> int:
1078
+ """Returns the memory address which holds a pointer to Blender's internal data
1079
+
1080
+ :return: int (memory address).
1081
+ :rtype: int
1082
+ """
718
1083
  ...
719
1084
 
720
- def bl_rna_get_subclass(self):
721
- """ """
1085
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1086
+ """
1087
+
1088
+ :return: The RNA type or default when not found.
1089
+ :rtype: bpy.types.Struct
1090
+ """
722
1091
  ...
723
1092
 
724
- def bl_rna_get_subclass_py(self):
725
- """ """
1093
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1094
+ """
1095
+
1096
+ :return: The class or default when not found.
1097
+ :rtype: typing.Any
1098
+ """
726
1099
  ...
727
1100
 
728
1101
  def draw(self, context):
@@ -732,72 +1105,129 @@ class VIEWLAYER_PT_eevee_layer_passes_effects(
732
1105
  """
733
1106
  ...
734
1107
 
735
- def driver_add(self):
736
- """ """
1108
+ def driver_add(self) -> bpy.types.FCurve:
1109
+ """Adds driver(s) to the given property
1110
+
1111
+ :return: The driver(s) added.
1112
+ :rtype: bpy.types.FCurve
1113
+ """
737
1114
  ...
738
1115
 
739
- def driver_remove(self):
740
- """ """
1116
+ def driver_remove(self) -> bool:
1117
+ """Remove driver(s) from the given property
1118
+
1119
+ :return: Success of driver removal.
1120
+ :rtype: bool
1121
+ """
741
1122
  ...
742
1123
 
743
1124
  def get(self):
744
- """ """
1125
+ """Returns the value of the custom property assigned to key or default
1126
+ when not found (matches Python's dictionary function of the same name).
1127
+
1128
+ """
745
1129
  ...
746
1130
 
747
1131
  def id_properties_clear(self):
748
- """ """
1132
+ """
1133
+
1134
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1135
+ """
749
1136
  ...
750
1137
 
751
1138
  def id_properties_ensure(self):
752
- """ """
1139
+ """
1140
+
1141
+ :return: the parent group for an RNA struct's custom IDProperties.
1142
+ """
753
1143
  ...
754
1144
 
755
1145
  def id_properties_ui(self):
756
- """ """
1146
+ """
1147
+
1148
+ :return: Return an object used to manage an IDProperty's UI data.
1149
+ """
757
1150
  ...
758
1151
 
759
1152
  def is_extended(self):
760
1153
  """ """
761
1154
  ...
762
1155
 
763
- def is_property_hidden(self):
764
- """ """
1156
+ def is_property_hidden(self) -> bool:
1157
+ """Check if a property is hidden.
1158
+
1159
+ :return: True when the property is hidden.
1160
+ :rtype: bool
1161
+ """
765
1162
  ...
766
1163
 
767
- def is_property_overridable_library(self):
768
- """ """
1164
+ def is_property_overridable_library(self) -> bool:
1165
+ """Check if a property is overridable.
1166
+
1167
+ :return: True when the property is overridable.
1168
+ :rtype: bool
1169
+ """
769
1170
  ...
770
1171
 
771
- def is_property_readonly(self):
772
- """ """
1172
+ def is_property_readonly(self) -> bool:
1173
+ """Check if a property is readonly.
1174
+
1175
+ :return: True when the property is readonly (not writable).
1176
+ :rtype: bool
1177
+ """
773
1178
  ...
774
1179
 
775
- def is_property_set(self):
776
- """ """
1180
+ def is_property_set(self) -> bool:
1181
+ """Check if a property is set, use for testing operator properties.
1182
+
1183
+ :return: True when the property has been set.
1184
+ :rtype: bool
1185
+ """
777
1186
  ...
778
1187
 
779
1188
  def items(self):
780
- """ """
1189
+ """Returns the items of this objects custom properties (matches Python's
1190
+ dictionary function of the same name).
1191
+
1192
+ :return: custom property key, value pairs.
1193
+ """
781
1194
  ...
782
1195
 
783
- def keyframe_delete(self):
784
- """ """
1196
+ def keyframe_delete(self) -> bool:
1197
+ """Remove a keyframe from this properties fcurve.
1198
+
1199
+ :return: Success of keyframe deletion.
1200
+ :rtype: bool
1201
+ """
785
1202
  ...
786
1203
 
787
- def keyframe_insert(self):
788
- """ """
1204
+ def keyframe_insert(self) -> bool:
1205
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1206
+
1207
+ :return: Success of keyframe insertion.
1208
+ :rtype: bool
1209
+ """
789
1210
  ...
790
1211
 
791
1212
  def keys(self):
792
- """ """
1213
+ """Returns the keys of this objects custom properties (matches Python's
1214
+ dictionary function of the same name).
1215
+
1216
+ :return: custom property keys.
1217
+ """
793
1218
  ...
794
1219
 
795
- def path_from_id(self):
796
- """ """
1220
+ def path_from_id(self) -> str:
1221
+ """Returns the data path from the ID to this object (string).
1222
+
1223
+ :return: The path from `bpy.types.bpy_struct.id_data`
1224
+ to this struct and property (when given).
1225
+ :rtype: str
1226
+ """
797
1227
  ...
798
1228
 
799
1229
  def path_resolve(self):
800
- """ """
1230
+ """Returns the property from the path, raise an exception when not found."""
801
1231
  ...
802
1232
 
803
1233
  def poll(self, context):
@@ -808,37 +1238,53 @@ class VIEWLAYER_PT_eevee_layer_passes_effects(
808
1238
  ...
809
1239
 
810
1240
  def pop(self):
811
- """ """
1241
+ """Remove and return the value of the custom property assigned to key or default
1242
+ when not found (matches Python's dictionary function of the same name).
1243
+
1244
+ """
812
1245
  ...
813
1246
 
814
1247
  def prepend(self, draw_func):
815
- """
1248
+ """Prepend a draw function to this menu, takes the same arguments as
1249
+ the menus draw function
816
1250
 
817
- :param draw_func:
1251
+ :param draw_func:
818
1252
  """
819
1253
  ...
820
1254
 
821
- def property_overridable_library_set(self):
822
- """ """
1255
+ def property_overridable_library_set(self) -> bool:
1256
+ """Define a property as overridable or not (only for custom properties!).
1257
+
1258
+ :return: True when the overridable status of the property was successfully set.
1259
+ :rtype: bool
1260
+ """
823
1261
  ...
824
1262
 
825
1263
  def property_unset(self):
826
- """ """
1264
+ """Unset a property, will use default value afterward."""
827
1265
  ...
828
1266
 
829
1267
  def remove(self, draw_func):
830
- """
1268
+ """Remove a draw function that has been added to this menu
831
1269
 
832
1270
  :param draw_func:
833
1271
  """
834
1272
  ...
835
1273
 
836
1274
  def type_recast(self):
837
- """ """
1275
+ """Return a new instance, this is needed because types
1276
+ such as textures can be changed at runtime.
1277
+
1278
+ :return: a new instance of this object with the type initialized again.
1279
+ """
838
1280
  ...
839
1281
 
840
1282
  def values(self):
841
- """ """
1283
+ """Returns the values of this objects custom properties (matches Python's
1284
+ dictionary function of the same name).
1285
+
1286
+ :return: custom property values.
1287
+ """
842
1288
  ...
843
1289
 
844
1290
  class VIEWLAYER_PT_eevee_layer_passes_light(
@@ -871,22 +1317,35 @@ class VIEWLAYER_PT_eevee_layer_passes_light(
871
1317
  """ """
872
1318
 
873
1319
  def append(self, draw_func):
874
- """
1320
+ """Append a draw function to this menu,
1321
+ takes the same arguments as the menus draw function
875
1322
 
876
- :param draw_func:
1323
+ :param draw_func:
877
1324
  """
878
1325
  ...
879
1326
 
880
- def as_pointer(self):
881
- """ """
1327
+ def as_pointer(self) -> int:
1328
+ """Returns the memory address which holds a pointer to Blender's internal data
1329
+
1330
+ :return: int (memory address).
1331
+ :rtype: int
1332
+ """
882
1333
  ...
883
1334
 
884
- def bl_rna_get_subclass(self):
885
- """ """
1335
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1336
+ """
1337
+
1338
+ :return: The RNA type or default when not found.
1339
+ :rtype: bpy.types.Struct
1340
+ """
886
1341
  ...
887
1342
 
888
- def bl_rna_get_subclass_py(self):
889
- """ """
1343
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1344
+ """
1345
+
1346
+ :return: The class or default when not found.
1347
+ :rtype: typing.Any
1348
+ """
890
1349
  ...
891
1350
 
892
1351
  def draw(self, context):
@@ -896,72 +1355,129 @@ class VIEWLAYER_PT_eevee_layer_passes_light(
896
1355
  """
897
1356
  ...
898
1357
 
899
- def driver_add(self):
900
- """ """
1358
+ def driver_add(self) -> bpy.types.FCurve:
1359
+ """Adds driver(s) to the given property
1360
+
1361
+ :return: The driver(s) added.
1362
+ :rtype: bpy.types.FCurve
1363
+ """
901
1364
  ...
902
1365
 
903
- def driver_remove(self):
904
- """ """
1366
+ def driver_remove(self) -> bool:
1367
+ """Remove driver(s) from the given property
1368
+
1369
+ :return: Success of driver removal.
1370
+ :rtype: bool
1371
+ """
905
1372
  ...
906
1373
 
907
1374
  def get(self):
908
- """ """
1375
+ """Returns the value of the custom property assigned to key or default
1376
+ when not found (matches Python's dictionary function of the same name).
1377
+
1378
+ """
909
1379
  ...
910
1380
 
911
1381
  def id_properties_clear(self):
912
- """ """
1382
+ """
1383
+
1384
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1385
+ """
913
1386
  ...
914
1387
 
915
1388
  def id_properties_ensure(self):
916
- """ """
1389
+ """
1390
+
1391
+ :return: the parent group for an RNA struct's custom IDProperties.
1392
+ """
917
1393
  ...
918
1394
 
919
1395
  def id_properties_ui(self):
920
- """ """
1396
+ """
1397
+
1398
+ :return: Return an object used to manage an IDProperty's UI data.
1399
+ """
921
1400
  ...
922
1401
 
923
1402
  def is_extended(self):
924
1403
  """ """
925
1404
  ...
926
1405
 
927
- def is_property_hidden(self):
928
- """ """
1406
+ def is_property_hidden(self) -> bool:
1407
+ """Check if a property is hidden.
1408
+
1409
+ :return: True when the property is hidden.
1410
+ :rtype: bool
1411
+ """
929
1412
  ...
930
1413
 
931
- def is_property_overridable_library(self):
932
- """ """
1414
+ def is_property_overridable_library(self) -> bool:
1415
+ """Check if a property is overridable.
1416
+
1417
+ :return: True when the property is overridable.
1418
+ :rtype: bool
1419
+ """
933
1420
  ...
934
1421
 
935
- def is_property_readonly(self):
936
- """ """
1422
+ def is_property_readonly(self) -> bool:
1423
+ """Check if a property is readonly.
1424
+
1425
+ :return: True when the property is readonly (not writable).
1426
+ :rtype: bool
1427
+ """
937
1428
  ...
938
1429
 
939
- def is_property_set(self):
940
- """ """
1430
+ def is_property_set(self) -> bool:
1431
+ """Check if a property is set, use for testing operator properties.
1432
+
1433
+ :return: True when the property has been set.
1434
+ :rtype: bool
1435
+ """
941
1436
  ...
942
1437
 
943
1438
  def items(self):
944
- """ """
1439
+ """Returns the items of this objects custom properties (matches Python's
1440
+ dictionary function of the same name).
1441
+
1442
+ :return: custom property key, value pairs.
1443
+ """
945
1444
  ...
946
1445
 
947
- def keyframe_delete(self):
948
- """ """
1446
+ def keyframe_delete(self) -> bool:
1447
+ """Remove a keyframe from this properties fcurve.
1448
+
1449
+ :return: Success of keyframe deletion.
1450
+ :rtype: bool
1451
+ """
949
1452
  ...
950
1453
 
951
- def keyframe_insert(self):
952
- """ """
1454
+ def keyframe_insert(self) -> bool:
1455
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1456
+
1457
+ :return: Success of keyframe insertion.
1458
+ :rtype: bool
1459
+ """
953
1460
  ...
954
1461
 
955
1462
  def keys(self):
956
- """ """
1463
+ """Returns the keys of this objects custom properties (matches Python's
1464
+ dictionary function of the same name).
1465
+
1466
+ :return: custom property keys.
1467
+ """
957
1468
  ...
958
1469
 
959
- def path_from_id(self):
960
- """ """
1470
+ def path_from_id(self) -> str:
1471
+ """Returns the data path from the ID to this object (string).
1472
+
1473
+ :return: The path from `bpy.types.bpy_struct.id_data`
1474
+ to this struct and property (when given).
1475
+ :rtype: str
1476
+ """
961
1477
  ...
962
1478
 
963
1479
  def path_resolve(self):
964
- """ """
1480
+ """Returns the property from the path, raise an exception when not found."""
965
1481
  ...
966
1482
 
967
1483
  def poll(self, context):
@@ -972,37 +1488,53 @@ class VIEWLAYER_PT_eevee_layer_passes_light(
972
1488
  ...
973
1489
 
974
1490
  def pop(self):
975
- """ """
1491
+ """Remove and return the value of the custom property assigned to key or default
1492
+ when not found (matches Python's dictionary function of the same name).
1493
+
1494
+ """
976
1495
  ...
977
1496
 
978
1497
  def prepend(self, draw_func):
979
- """
1498
+ """Prepend a draw function to this menu, takes the same arguments as
1499
+ the menus draw function
980
1500
 
981
- :param draw_func:
1501
+ :param draw_func:
982
1502
  """
983
1503
  ...
984
1504
 
985
- def property_overridable_library_set(self):
986
- """ """
1505
+ def property_overridable_library_set(self) -> bool:
1506
+ """Define a property as overridable or not (only for custom properties!).
1507
+
1508
+ :return: True when the overridable status of the property was successfully set.
1509
+ :rtype: bool
1510
+ """
987
1511
  ...
988
1512
 
989
1513
  def property_unset(self):
990
- """ """
1514
+ """Unset a property, will use default value afterward."""
991
1515
  ...
992
1516
 
993
1517
  def remove(self, draw_func):
994
- """
1518
+ """Remove a draw function that has been added to this menu
995
1519
 
996
1520
  :param draw_func:
997
1521
  """
998
1522
  ...
999
1523
 
1000
1524
  def type_recast(self):
1001
- """ """
1525
+ """Return a new instance, this is needed because types
1526
+ such as textures can be changed at runtime.
1527
+
1528
+ :return: a new instance of this object with the type initialized again.
1529
+ """
1002
1530
  ...
1003
1531
 
1004
1532
  def values(self):
1005
- """ """
1533
+ """Returns the values of this objects custom properties (matches Python's
1534
+ dictionary function of the same name).
1535
+
1536
+ :return: custom property values.
1537
+ """
1006
1538
  ...
1007
1539
 
1008
1540
  class VIEWLAYER_PT_eevee_next_layer_passes_data(
@@ -1035,22 +1567,35 @@ class VIEWLAYER_PT_eevee_next_layer_passes_data(
1035
1567
  """ """
1036
1568
 
1037
1569
  def append(self, draw_func):
1038
- """
1570
+ """Append a draw function to this menu,
1571
+ takes the same arguments as the menus draw function
1039
1572
 
1040
- :param draw_func:
1573
+ :param draw_func:
1041
1574
  """
1042
1575
  ...
1043
1576
 
1044
- def as_pointer(self):
1045
- """ """
1577
+ def as_pointer(self) -> int:
1578
+ """Returns the memory address which holds a pointer to Blender's internal data
1579
+
1580
+ :return: int (memory address).
1581
+ :rtype: int
1582
+ """
1046
1583
  ...
1047
1584
 
1048
- def bl_rna_get_subclass(self):
1049
- """ """
1585
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1586
+ """
1587
+
1588
+ :return: The RNA type or default when not found.
1589
+ :rtype: bpy.types.Struct
1590
+ """
1050
1591
  ...
1051
1592
 
1052
- def bl_rna_get_subclass_py(self):
1053
- """ """
1593
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1594
+ """
1595
+
1596
+ :return: The class or default when not found.
1597
+ :rtype: typing.Any
1598
+ """
1054
1599
  ...
1055
1600
 
1056
1601
  def draw(self, context):
@@ -1060,72 +1605,129 @@ class VIEWLAYER_PT_eevee_next_layer_passes_data(
1060
1605
  """
1061
1606
  ...
1062
1607
 
1063
- def driver_add(self):
1064
- """ """
1608
+ def driver_add(self) -> bpy.types.FCurve:
1609
+ """Adds driver(s) to the given property
1610
+
1611
+ :return: The driver(s) added.
1612
+ :rtype: bpy.types.FCurve
1613
+ """
1065
1614
  ...
1066
1615
 
1067
- def driver_remove(self):
1068
- """ """
1616
+ def driver_remove(self) -> bool:
1617
+ """Remove driver(s) from the given property
1618
+
1619
+ :return: Success of driver removal.
1620
+ :rtype: bool
1621
+ """
1069
1622
  ...
1070
1623
 
1071
1624
  def get(self):
1072
- """ """
1625
+ """Returns the value of the custom property assigned to key or default
1626
+ when not found (matches Python's dictionary function of the same name).
1627
+
1628
+ """
1073
1629
  ...
1074
1630
 
1075
1631
  def id_properties_clear(self):
1076
- """ """
1632
+ """
1633
+
1634
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1635
+ """
1077
1636
  ...
1078
1637
 
1079
1638
  def id_properties_ensure(self):
1080
- """ """
1639
+ """
1640
+
1641
+ :return: the parent group for an RNA struct's custom IDProperties.
1642
+ """
1081
1643
  ...
1082
1644
 
1083
1645
  def id_properties_ui(self):
1084
- """ """
1646
+ """
1647
+
1648
+ :return: Return an object used to manage an IDProperty's UI data.
1649
+ """
1085
1650
  ...
1086
1651
 
1087
1652
  def is_extended(self):
1088
1653
  """ """
1089
1654
  ...
1090
1655
 
1091
- def is_property_hidden(self):
1092
- """ """
1656
+ def is_property_hidden(self) -> bool:
1657
+ """Check if a property is hidden.
1658
+
1659
+ :return: True when the property is hidden.
1660
+ :rtype: bool
1661
+ """
1093
1662
  ...
1094
1663
 
1095
- def is_property_overridable_library(self):
1096
- """ """
1664
+ def is_property_overridable_library(self) -> bool:
1665
+ """Check if a property is overridable.
1666
+
1667
+ :return: True when the property is overridable.
1668
+ :rtype: bool
1669
+ """
1097
1670
  ...
1098
1671
 
1099
- def is_property_readonly(self):
1100
- """ """
1672
+ def is_property_readonly(self) -> bool:
1673
+ """Check if a property is readonly.
1674
+
1675
+ :return: True when the property is readonly (not writable).
1676
+ :rtype: bool
1677
+ """
1101
1678
  ...
1102
1679
 
1103
- def is_property_set(self):
1104
- """ """
1680
+ def is_property_set(self) -> bool:
1681
+ """Check if a property is set, use for testing operator properties.
1682
+
1683
+ :return: True when the property has been set.
1684
+ :rtype: bool
1685
+ """
1105
1686
  ...
1106
1687
 
1107
1688
  def items(self):
1108
- """ """
1689
+ """Returns the items of this objects custom properties (matches Python's
1690
+ dictionary function of the same name).
1691
+
1692
+ :return: custom property key, value pairs.
1693
+ """
1109
1694
  ...
1110
1695
 
1111
- def keyframe_delete(self):
1112
- """ """
1696
+ def keyframe_delete(self) -> bool:
1697
+ """Remove a keyframe from this properties fcurve.
1698
+
1699
+ :return: Success of keyframe deletion.
1700
+ :rtype: bool
1701
+ """
1113
1702
  ...
1114
1703
 
1115
- def keyframe_insert(self):
1116
- """ """
1704
+ def keyframe_insert(self) -> bool:
1705
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1706
+
1707
+ :return: Success of keyframe insertion.
1708
+ :rtype: bool
1709
+ """
1117
1710
  ...
1118
1711
 
1119
1712
  def keys(self):
1120
- """ """
1713
+ """Returns the keys of this objects custom properties (matches Python's
1714
+ dictionary function of the same name).
1715
+
1716
+ :return: custom property keys.
1717
+ """
1121
1718
  ...
1122
1719
 
1123
- def path_from_id(self):
1124
- """ """
1720
+ def path_from_id(self) -> str:
1721
+ """Returns the data path from the ID to this object (string).
1722
+
1723
+ :return: The path from `bpy.types.bpy_struct.id_data`
1724
+ to this struct and property (when given).
1725
+ :rtype: str
1726
+ """
1125
1727
  ...
1126
1728
 
1127
1729
  def path_resolve(self):
1128
- """ """
1730
+ """Returns the property from the path, raise an exception when not found."""
1129
1731
  ...
1130
1732
 
1131
1733
  def poll(self, context):
@@ -1136,37 +1738,53 @@ class VIEWLAYER_PT_eevee_next_layer_passes_data(
1136
1738
  ...
1137
1739
 
1138
1740
  def pop(self):
1139
- """ """
1741
+ """Remove and return the value of the custom property assigned to key or default
1742
+ when not found (matches Python's dictionary function of the same name).
1743
+
1744
+ """
1140
1745
  ...
1141
1746
 
1142
1747
  def prepend(self, draw_func):
1143
- """
1748
+ """Prepend a draw function to this menu, takes the same arguments as
1749
+ the menus draw function
1144
1750
 
1145
- :param draw_func:
1751
+ :param draw_func:
1146
1752
  """
1147
1753
  ...
1148
1754
 
1149
- def property_overridable_library_set(self):
1150
- """ """
1755
+ def property_overridable_library_set(self) -> bool:
1756
+ """Define a property as overridable or not (only for custom properties!).
1757
+
1758
+ :return: True when the overridable status of the property was successfully set.
1759
+ :rtype: bool
1760
+ """
1151
1761
  ...
1152
1762
 
1153
1763
  def property_unset(self):
1154
- """ """
1764
+ """Unset a property, will use default value afterward."""
1155
1765
  ...
1156
1766
 
1157
1767
  def remove(self, draw_func):
1158
- """
1768
+ """Remove a draw function that has been added to this menu
1159
1769
 
1160
1770
  :param draw_func:
1161
1771
  """
1162
1772
  ...
1163
1773
 
1164
1774
  def type_recast(self):
1165
- """ """
1775
+ """Return a new instance, this is needed because types
1776
+ such as textures can be changed at runtime.
1777
+
1778
+ :return: a new instance of this object with the type initialized again.
1779
+ """
1166
1780
  ...
1167
1781
 
1168
1782
  def values(self):
1169
- """ """
1783
+ """Returns the values of this objects custom properties (matches Python's
1784
+ dictionary function of the same name).
1785
+
1786
+ :return: custom property values.
1787
+ """
1170
1788
  ...
1171
1789
 
1172
1790
  class VIEWLAYER_PT_eevee_next_layer_passes_light(
@@ -1199,22 +1817,35 @@ class VIEWLAYER_PT_eevee_next_layer_passes_light(
1199
1817
  """ """
1200
1818
 
1201
1819
  def append(self, draw_func):
1202
- """
1820
+ """Append a draw function to this menu,
1821
+ takes the same arguments as the menus draw function
1203
1822
 
1204
- :param draw_func:
1823
+ :param draw_func:
1205
1824
  """
1206
1825
  ...
1207
1826
 
1208
- def as_pointer(self):
1209
- """ """
1827
+ def as_pointer(self) -> int:
1828
+ """Returns the memory address which holds a pointer to Blender's internal data
1829
+
1830
+ :return: int (memory address).
1831
+ :rtype: int
1832
+ """
1210
1833
  ...
1211
1834
 
1212
- def bl_rna_get_subclass(self):
1213
- """ """
1835
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1836
+ """
1837
+
1838
+ :return: The RNA type or default when not found.
1839
+ :rtype: bpy.types.Struct
1840
+ """
1214
1841
  ...
1215
1842
 
1216
- def bl_rna_get_subclass_py(self):
1217
- """ """
1843
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1844
+ """
1845
+
1846
+ :return: The class or default when not found.
1847
+ :rtype: typing.Any
1848
+ """
1218
1849
  ...
1219
1850
 
1220
1851
  def draw(self, context):
@@ -1224,72 +1855,129 @@ class VIEWLAYER_PT_eevee_next_layer_passes_light(
1224
1855
  """
1225
1856
  ...
1226
1857
 
1227
- def driver_add(self):
1228
- """ """
1858
+ def driver_add(self) -> bpy.types.FCurve:
1859
+ """Adds driver(s) to the given property
1860
+
1861
+ :return: The driver(s) added.
1862
+ :rtype: bpy.types.FCurve
1863
+ """
1229
1864
  ...
1230
1865
 
1231
- def driver_remove(self):
1232
- """ """
1866
+ def driver_remove(self) -> bool:
1867
+ """Remove driver(s) from the given property
1868
+
1869
+ :return: Success of driver removal.
1870
+ :rtype: bool
1871
+ """
1233
1872
  ...
1234
1873
 
1235
1874
  def get(self):
1236
- """ """
1875
+ """Returns the value of the custom property assigned to key or default
1876
+ when not found (matches Python's dictionary function of the same name).
1877
+
1878
+ """
1237
1879
  ...
1238
1880
 
1239
1881
  def id_properties_clear(self):
1240
- """ """
1882
+ """
1883
+
1884
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1885
+ """
1241
1886
  ...
1242
1887
 
1243
1888
  def id_properties_ensure(self):
1244
- """ """
1889
+ """
1890
+
1891
+ :return: the parent group for an RNA struct's custom IDProperties.
1892
+ """
1245
1893
  ...
1246
1894
 
1247
1895
  def id_properties_ui(self):
1248
- """ """
1896
+ """
1897
+
1898
+ :return: Return an object used to manage an IDProperty's UI data.
1899
+ """
1249
1900
  ...
1250
1901
 
1251
1902
  def is_extended(self):
1252
1903
  """ """
1253
1904
  ...
1254
1905
 
1255
- def is_property_hidden(self):
1256
- """ """
1906
+ def is_property_hidden(self) -> bool:
1907
+ """Check if a property is hidden.
1908
+
1909
+ :return: True when the property is hidden.
1910
+ :rtype: bool
1911
+ """
1257
1912
  ...
1258
1913
 
1259
- def is_property_overridable_library(self):
1260
- """ """
1914
+ def is_property_overridable_library(self) -> bool:
1915
+ """Check if a property is overridable.
1916
+
1917
+ :return: True when the property is overridable.
1918
+ :rtype: bool
1919
+ """
1261
1920
  ...
1262
1921
 
1263
- def is_property_readonly(self):
1264
- """ """
1922
+ def is_property_readonly(self) -> bool:
1923
+ """Check if a property is readonly.
1924
+
1925
+ :return: True when the property is readonly (not writable).
1926
+ :rtype: bool
1927
+ """
1265
1928
  ...
1266
1929
 
1267
- def is_property_set(self):
1268
- """ """
1930
+ def is_property_set(self) -> bool:
1931
+ """Check if a property is set, use for testing operator properties.
1932
+
1933
+ :return: True when the property has been set.
1934
+ :rtype: bool
1935
+ """
1269
1936
  ...
1270
1937
 
1271
1938
  def items(self):
1272
- """ """
1939
+ """Returns the items of this objects custom properties (matches Python's
1940
+ dictionary function of the same name).
1941
+
1942
+ :return: custom property key, value pairs.
1943
+ """
1273
1944
  ...
1274
1945
 
1275
- def keyframe_delete(self):
1276
- """ """
1946
+ def keyframe_delete(self) -> bool:
1947
+ """Remove a keyframe from this properties fcurve.
1948
+
1949
+ :return: Success of keyframe deletion.
1950
+ :rtype: bool
1951
+ """
1277
1952
  ...
1278
1953
 
1279
- def keyframe_insert(self):
1280
- """ """
1954
+ def keyframe_insert(self) -> bool:
1955
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1956
+
1957
+ :return: Success of keyframe insertion.
1958
+ :rtype: bool
1959
+ """
1281
1960
  ...
1282
1961
 
1283
1962
  def keys(self):
1284
- """ """
1963
+ """Returns the keys of this objects custom properties (matches Python's
1964
+ dictionary function of the same name).
1965
+
1966
+ :return: custom property keys.
1967
+ """
1285
1968
  ...
1286
1969
 
1287
- def path_from_id(self):
1288
- """ """
1970
+ def path_from_id(self) -> str:
1971
+ """Returns the data path from the ID to this object (string).
1972
+
1973
+ :return: The path from `bpy.types.bpy_struct.id_data`
1974
+ to this struct and property (when given).
1975
+ :rtype: str
1976
+ """
1289
1977
  ...
1290
1978
 
1291
1979
  def path_resolve(self):
1292
- """ """
1980
+ """Returns the property from the path, raise an exception when not found."""
1293
1981
  ...
1294
1982
 
1295
1983
  def poll(self, context):
@@ -1300,37 +1988,53 @@ class VIEWLAYER_PT_eevee_next_layer_passes_light(
1300
1988
  ...
1301
1989
 
1302
1990
  def pop(self):
1303
- """ """
1991
+ """Remove and return the value of the custom property assigned to key or default
1992
+ when not found (matches Python's dictionary function of the same name).
1993
+
1994
+ """
1304
1995
  ...
1305
1996
 
1306
1997
  def prepend(self, draw_func):
1307
- """
1998
+ """Prepend a draw function to this menu, takes the same arguments as
1999
+ the menus draw function
1308
2000
 
1309
- :param draw_func:
2001
+ :param draw_func:
1310
2002
  """
1311
2003
  ...
1312
2004
 
1313
- def property_overridable_library_set(self):
1314
- """ """
2005
+ def property_overridable_library_set(self) -> bool:
2006
+ """Define a property as overridable or not (only for custom properties!).
2007
+
2008
+ :return: True when the overridable status of the property was successfully set.
2009
+ :rtype: bool
2010
+ """
1315
2011
  ...
1316
2012
 
1317
2013
  def property_unset(self):
1318
- """ """
2014
+ """Unset a property, will use default value afterward."""
1319
2015
  ...
1320
2016
 
1321
2017
  def remove(self, draw_func):
1322
- """
2018
+ """Remove a draw function that has been added to this menu
1323
2019
 
1324
2020
  :param draw_func:
1325
2021
  """
1326
2022
  ...
1327
2023
 
1328
2024
  def type_recast(self):
1329
- """ """
2025
+ """Return a new instance, this is needed because types
2026
+ such as textures can be changed at runtime.
2027
+
2028
+ :return: a new instance of this object with the type initialized again.
2029
+ """
1330
2030
  ...
1331
2031
 
1332
2032
  def values(self):
1333
- """ """
2033
+ """Returns the values of this objects custom properties (matches Python's
2034
+ dictionary function of the same name).
2035
+
2036
+ :return: custom property values.
2037
+ """
1334
2038
  ...
1335
2039
 
1336
2040
  class VIEWLAYER_PT_filter(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._GenericUI):
@@ -1361,22 +2065,35 @@ class VIEWLAYER_PT_filter(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gen
1361
2065
  """ """
1362
2066
 
1363
2067
  def append(self, draw_func):
1364
- """
2068
+ """Append a draw function to this menu,
2069
+ takes the same arguments as the menus draw function
1365
2070
 
1366
- :param draw_func:
2071
+ :param draw_func:
1367
2072
  """
1368
2073
  ...
1369
2074
 
1370
- def as_pointer(self):
1371
- """ """
2075
+ def as_pointer(self) -> int:
2076
+ """Returns the memory address which holds a pointer to Blender's internal data
2077
+
2078
+ :return: int (memory address).
2079
+ :rtype: int
2080
+ """
1372
2081
  ...
1373
2082
 
1374
- def bl_rna_get_subclass(self):
1375
- """ """
2083
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2084
+ """
2085
+
2086
+ :return: The RNA type or default when not found.
2087
+ :rtype: bpy.types.Struct
2088
+ """
1376
2089
  ...
1377
2090
 
1378
- def bl_rna_get_subclass_py(self):
1379
- """ """
2091
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2092
+ """
2093
+
2094
+ :return: The class or default when not found.
2095
+ :rtype: typing.Any
2096
+ """
1380
2097
  ...
1381
2098
 
1382
2099
  def draw(self, context):
@@ -1386,72 +2103,129 @@ class VIEWLAYER_PT_filter(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gen
1386
2103
  """
1387
2104
  ...
1388
2105
 
1389
- def driver_add(self):
1390
- """ """
2106
+ def driver_add(self) -> bpy.types.FCurve:
2107
+ """Adds driver(s) to the given property
2108
+
2109
+ :return: The driver(s) added.
2110
+ :rtype: bpy.types.FCurve
2111
+ """
1391
2112
  ...
1392
2113
 
1393
- def driver_remove(self):
1394
- """ """
2114
+ def driver_remove(self) -> bool:
2115
+ """Remove driver(s) from the given property
2116
+
2117
+ :return: Success of driver removal.
2118
+ :rtype: bool
2119
+ """
1395
2120
  ...
1396
2121
 
1397
2122
  def get(self):
1398
- """ """
2123
+ """Returns the value of the custom property assigned to key or default
2124
+ when not found (matches Python's dictionary function of the same name).
2125
+
2126
+ """
1399
2127
  ...
1400
2128
 
1401
2129
  def id_properties_clear(self):
1402
- """ """
2130
+ """
2131
+
2132
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2133
+ """
1403
2134
  ...
1404
2135
 
1405
2136
  def id_properties_ensure(self):
1406
- """ """
2137
+ """
2138
+
2139
+ :return: the parent group for an RNA struct's custom IDProperties.
2140
+ """
1407
2141
  ...
1408
2142
 
1409
2143
  def id_properties_ui(self):
1410
- """ """
2144
+ """
2145
+
2146
+ :return: Return an object used to manage an IDProperty's UI data.
2147
+ """
1411
2148
  ...
1412
2149
 
1413
2150
  def is_extended(self):
1414
2151
  """ """
1415
2152
  ...
1416
2153
 
1417
- def is_property_hidden(self):
1418
- """ """
2154
+ def is_property_hidden(self) -> bool:
2155
+ """Check if a property is hidden.
2156
+
2157
+ :return: True when the property is hidden.
2158
+ :rtype: bool
2159
+ """
1419
2160
  ...
1420
2161
 
1421
- def is_property_overridable_library(self):
1422
- """ """
2162
+ def is_property_overridable_library(self) -> bool:
2163
+ """Check if a property is overridable.
2164
+
2165
+ :return: True when the property is overridable.
2166
+ :rtype: bool
2167
+ """
1423
2168
  ...
1424
2169
 
1425
- def is_property_readonly(self):
1426
- """ """
2170
+ def is_property_readonly(self) -> bool:
2171
+ """Check if a property is readonly.
2172
+
2173
+ :return: True when the property is readonly (not writable).
2174
+ :rtype: bool
2175
+ """
1427
2176
  ...
1428
2177
 
1429
- def is_property_set(self):
1430
- """ """
2178
+ def is_property_set(self) -> bool:
2179
+ """Check if a property is set, use for testing operator properties.
2180
+
2181
+ :return: True when the property has been set.
2182
+ :rtype: bool
2183
+ """
1431
2184
  ...
1432
2185
 
1433
2186
  def items(self):
1434
- """ """
2187
+ """Returns the items of this objects custom properties (matches Python's
2188
+ dictionary function of the same name).
2189
+
2190
+ :return: custom property key, value pairs.
2191
+ """
1435
2192
  ...
1436
2193
 
1437
- def keyframe_delete(self):
1438
- """ """
2194
+ def keyframe_delete(self) -> bool:
2195
+ """Remove a keyframe from this properties fcurve.
2196
+
2197
+ :return: Success of keyframe deletion.
2198
+ :rtype: bool
2199
+ """
1439
2200
  ...
1440
2201
 
1441
- def keyframe_insert(self):
1442
- """ """
2202
+ def keyframe_insert(self) -> bool:
2203
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2204
+
2205
+ :return: Success of keyframe insertion.
2206
+ :rtype: bool
2207
+ """
1443
2208
  ...
1444
2209
 
1445
2210
  def keys(self):
1446
- """ """
2211
+ """Returns the keys of this objects custom properties (matches Python's
2212
+ dictionary function of the same name).
2213
+
2214
+ :return: custom property keys.
2215
+ """
1447
2216
  ...
1448
2217
 
1449
- def path_from_id(self):
1450
- """ """
2218
+ def path_from_id(self) -> str:
2219
+ """Returns the data path from the ID to this object (string).
2220
+
2221
+ :return: The path from `bpy.types.bpy_struct.id_data`
2222
+ to this struct and property (when given).
2223
+ :rtype: str
2224
+ """
1451
2225
  ...
1452
2226
 
1453
2227
  def path_resolve(self):
1454
- """ """
2228
+ """Returns the property from the path, raise an exception when not found."""
1455
2229
  ...
1456
2230
 
1457
2231
  def poll(self, context):
@@ -1462,37 +2236,53 @@ class VIEWLAYER_PT_filter(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gen
1462
2236
  ...
1463
2237
 
1464
2238
  def pop(self):
1465
- """ """
2239
+ """Remove and return the value of the custom property assigned to key or default
2240
+ when not found (matches Python's dictionary function of the same name).
2241
+
2242
+ """
1466
2243
  ...
1467
2244
 
1468
2245
  def prepend(self, draw_func):
1469
- """
2246
+ """Prepend a draw function to this menu, takes the same arguments as
2247
+ the menus draw function
1470
2248
 
1471
- :param draw_func:
2249
+ :param draw_func:
1472
2250
  """
1473
2251
  ...
1474
2252
 
1475
- def property_overridable_library_set(self):
1476
- """ """
2253
+ def property_overridable_library_set(self) -> bool:
2254
+ """Define a property as overridable or not (only for custom properties!).
2255
+
2256
+ :return: True when the overridable status of the property was successfully set.
2257
+ :rtype: bool
2258
+ """
1477
2259
  ...
1478
2260
 
1479
2261
  def property_unset(self):
1480
- """ """
2262
+ """Unset a property, will use default value afterward."""
1481
2263
  ...
1482
2264
 
1483
2265
  def remove(self, draw_func):
1484
- """
2266
+ """Remove a draw function that has been added to this menu
1485
2267
 
1486
2268
  :param draw_func:
1487
2269
  """
1488
2270
  ...
1489
2271
 
1490
2272
  def type_recast(self):
1491
- """ """
2273
+ """Return a new instance, this is needed because types
2274
+ such as textures can be changed at runtime.
2275
+
2276
+ :return: a new instance of this object with the type initialized again.
2277
+ """
1492
2278
  ...
1493
2279
 
1494
2280
  def values(self):
1495
- """ """
2281
+ """Returns the values of this objects custom properties (matches Python's
2282
+ dictionary function of the same name).
2283
+
2284
+ :return: custom property values.
2285
+ """
1496
2286
  ...
1497
2287
 
1498
2288
  class VIEWLAYER_PT_layer(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._GenericUI):
@@ -1520,22 +2310,35 @@ class VIEWLAYER_PT_layer(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gene
1520
2310
  """ """
1521
2311
 
1522
2312
  def append(self, draw_func):
1523
- """
2313
+ """Append a draw function to this menu,
2314
+ takes the same arguments as the menus draw function
1524
2315
 
1525
- :param draw_func:
2316
+ :param draw_func:
1526
2317
  """
1527
2318
  ...
1528
2319
 
1529
- def as_pointer(self):
1530
- """ """
2320
+ def as_pointer(self) -> int:
2321
+ """Returns the memory address which holds a pointer to Blender's internal data
2322
+
2323
+ :return: int (memory address).
2324
+ :rtype: int
2325
+ """
1531
2326
  ...
1532
2327
 
1533
- def bl_rna_get_subclass(self):
1534
- """ """
2328
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2329
+ """
2330
+
2331
+ :return: The RNA type or default when not found.
2332
+ :rtype: bpy.types.Struct
2333
+ """
1535
2334
  ...
1536
2335
 
1537
- def bl_rna_get_subclass_py(self):
1538
- """ """
2336
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2337
+ """
2338
+
2339
+ :return: The class or default when not found.
2340
+ :rtype: typing.Any
2341
+ """
1539
2342
  ...
1540
2343
 
1541
2344
  def draw(self, context):
@@ -1545,72 +2348,129 @@ class VIEWLAYER_PT_layer(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gene
1545
2348
  """
1546
2349
  ...
1547
2350
 
1548
- def driver_add(self):
1549
- """ """
2351
+ def driver_add(self) -> bpy.types.FCurve:
2352
+ """Adds driver(s) to the given property
2353
+
2354
+ :return: The driver(s) added.
2355
+ :rtype: bpy.types.FCurve
2356
+ """
1550
2357
  ...
1551
2358
 
1552
- def driver_remove(self):
1553
- """ """
2359
+ def driver_remove(self) -> bool:
2360
+ """Remove driver(s) from the given property
2361
+
2362
+ :return: Success of driver removal.
2363
+ :rtype: bool
2364
+ """
1554
2365
  ...
1555
2366
 
1556
2367
  def get(self):
1557
- """ """
2368
+ """Returns the value of the custom property assigned to key or default
2369
+ when not found (matches Python's dictionary function of the same name).
2370
+
2371
+ """
1558
2372
  ...
1559
2373
 
1560
2374
  def id_properties_clear(self):
1561
- """ """
2375
+ """
2376
+
2377
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2378
+ """
1562
2379
  ...
1563
2380
 
1564
2381
  def id_properties_ensure(self):
1565
- """ """
2382
+ """
2383
+
2384
+ :return: the parent group for an RNA struct's custom IDProperties.
2385
+ """
1566
2386
  ...
1567
2387
 
1568
2388
  def id_properties_ui(self):
1569
- """ """
2389
+ """
2390
+
2391
+ :return: Return an object used to manage an IDProperty's UI data.
2392
+ """
1570
2393
  ...
1571
2394
 
1572
2395
  def is_extended(self):
1573
2396
  """ """
1574
2397
  ...
1575
2398
 
1576
- def is_property_hidden(self):
1577
- """ """
2399
+ def is_property_hidden(self) -> bool:
2400
+ """Check if a property is hidden.
2401
+
2402
+ :return: True when the property is hidden.
2403
+ :rtype: bool
2404
+ """
1578
2405
  ...
1579
2406
 
1580
- def is_property_overridable_library(self):
1581
- """ """
2407
+ def is_property_overridable_library(self) -> bool:
2408
+ """Check if a property is overridable.
2409
+
2410
+ :return: True when the property is overridable.
2411
+ :rtype: bool
2412
+ """
1582
2413
  ...
1583
2414
 
1584
- def is_property_readonly(self):
1585
- """ """
2415
+ def is_property_readonly(self) -> bool:
2416
+ """Check if a property is readonly.
2417
+
2418
+ :return: True when the property is readonly (not writable).
2419
+ :rtype: bool
2420
+ """
1586
2421
  ...
1587
2422
 
1588
- def is_property_set(self):
1589
- """ """
2423
+ def is_property_set(self) -> bool:
2424
+ """Check if a property is set, use for testing operator properties.
2425
+
2426
+ :return: True when the property has been set.
2427
+ :rtype: bool
2428
+ """
1590
2429
  ...
1591
2430
 
1592
2431
  def items(self):
1593
- """ """
2432
+ """Returns the items of this objects custom properties (matches Python's
2433
+ dictionary function of the same name).
2434
+
2435
+ :return: custom property key, value pairs.
2436
+ """
1594
2437
  ...
1595
2438
 
1596
- def keyframe_delete(self):
1597
- """ """
2439
+ def keyframe_delete(self) -> bool:
2440
+ """Remove a keyframe from this properties fcurve.
2441
+
2442
+ :return: Success of keyframe deletion.
2443
+ :rtype: bool
2444
+ """
1598
2445
  ...
1599
2446
 
1600
- def keyframe_insert(self):
1601
- """ """
2447
+ def keyframe_insert(self) -> bool:
2448
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2449
+
2450
+ :return: Success of keyframe insertion.
2451
+ :rtype: bool
2452
+ """
1602
2453
  ...
1603
2454
 
1604
2455
  def keys(self):
1605
- """ """
1606
- ...
2456
+ """Returns the keys of this objects custom properties (matches Python's
2457
+ dictionary function of the same name).
1607
2458
 
1608
- def path_from_id(self):
1609
- """ """
2459
+ :return: custom property keys.
2460
+ """
2461
+ ...
2462
+
2463
+ def path_from_id(self) -> str:
2464
+ """Returns the data path from the ID to this object (string).
2465
+
2466
+ :return: The path from `bpy.types.bpy_struct.id_data`
2467
+ to this struct and property (when given).
2468
+ :rtype: str
2469
+ """
1610
2470
  ...
1611
2471
 
1612
2472
  def path_resolve(self):
1613
- """ """
2473
+ """Returns the property from the path, raise an exception when not found."""
1614
2474
  ...
1615
2475
 
1616
2476
  def poll(self, context):
@@ -1621,37 +2481,53 @@ class VIEWLAYER_PT_layer(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gene
1621
2481
  ...
1622
2482
 
1623
2483
  def pop(self):
1624
- """ """
2484
+ """Remove and return the value of the custom property assigned to key or default
2485
+ when not found (matches Python's dictionary function of the same name).
2486
+
2487
+ """
1625
2488
  ...
1626
2489
 
1627
2490
  def prepend(self, draw_func):
1628
- """
2491
+ """Prepend a draw function to this menu, takes the same arguments as
2492
+ the menus draw function
1629
2493
 
1630
- :param draw_func:
2494
+ :param draw_func:
1631
2495
  """
1632
2496
  ...
1633
2497
 
1634
- def property_overridable_library_set(self):
1635
- """ """
2498
+ def property_overridable_library_set(self) -> bool:
2499
+ """Define a property as overridable or not (only for custom properties!).
2500
+
2501
+ :return: True when the overridable status of the property was successfully set.
2502
+ :rtype: bool
2503
+ """
1636
2504
  ...
1637
2505
 
1638
2506
  def property_unset(self):
1639
- """ """
2507
+ """Unset a property, will use default value afterward."""
1640
2508
  ...
1641
2509
 
1642
2510
  def remove(self, draw_func):
1643
- """
2511
+ """Remove a draw function that has been added to this menu
1644
2512
 
1645
2513
  :param draw_func:
1646
2514
  """
1647
2515
  ...
1648
2516
 
1649
2517
  def type_recast(self):
1650
- """ """
2518
+ """Return a new instance, this is needed because types
2519
+ such as textures can be changed at runtime.
2520
+
2521
+ :return: a new instance of this object with the type initialized again.
2522
+ """
1651
2523
  ...
1652
2524
 
1653
2525
  def values(self):
1654
- """ """
2526
+ """Returns the values of this objects custom properties (matches Python's
2527
+ dictionary function of the same name).
2528
+
2529
+ :return: custom property values.
2530
+ """
1655
2531
  ...
1656
2532
 
1657
2533
  class VIEWLAYER_PT_layer_passes(
@@ -1681,22 +2557,35 @@ class VIEWLAYER_PT_layer_passes(
1681
2557
  """ """
1682
2558
 
1683
2559
  def append(self, draw_func):
1684
- """
2560
+ """Append a draw function to this menu,
2561
+ takes the same arguments as the menus draw function
1685
2562
 
1686
- :param draw_func:
2563
+ :param draw_func:
1687
2564
  """
1688
2565
  ...
1689
2566
 
1690
- def as_pointer(self):
1691
- """ """
2567
+ def as_pointer(self) -> int:
2568
+ """Returns the memory address which holds a pointer to Blender's internal data
2569
+
2570
+ :return: int (memory address).
2571
+ :rtype: int
2572
+ """
1692
2573
  ...
1693
2574
 
1694
- def bl_rna_get_subclass(self):
1695
- """ """
2575
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2576
+ """
2577
+
2578
+ :return: The RNA type or default when not found.
2579
+ :rtype: bpy.types.Struct
2580
+ """
1696
2581
  ...
1697
2582
 
1698
- def bl_rna_get_subclass_py(self):
1699
- """ """
2583
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2584
+ """
2585
+
2586
+ :return: The class or default when not found.
2587
+ :rtype: typing.Any
2588
+ """
1700
2589
  ...
1701
2590
 
1702
2591
  def draw(self, context):
@@ -1706,72 +2595,129 @@ class VIEWLAYER_PT_layer_passes(
1706
2595
  """
1707
2596
  ...
1708
2597
 
1709
- def driver_add(self):
1710
- """ """
2598
+ def driver_add(self) -> bpy.types.FCurve:
2599
+ """Adds driver(s) to the given property
2600
+
2601
+ :return: The driver(s) added.
2602
+ :rtype: bpy.types.FCurve
2603
+ """
1711
2604
  ...
1712
2605
 
1713
- def driver_remove(self):
1714
- """ """
2606
+ def driver_remove(self) -> bool:
2607
+ """Remove driver(s) from the given property
2608
+
2609
+ :return: Success of driver removal.
2610
+ :rtype: bool
2611
+ """
1715
2612
  ...
1716
2613
 
1717
2614
  def get(self):
1718
- """ """
2615
+ """Returns the value of the custom property assigned to key or default
2616
+ when not found (matches Python's dictionary function of the same name).
2617
+
2618
+ """
1719
2619
  ...
1720
2620
 
1721
2621
  def id_properties_clear(self):
1722
- """ """
2622
+ """
2623
+
2624
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2625
+ """
1723
2626
  ...
1724
2627
 
1725
2628
  def id_properties_ensure(self):
1726
- """ """
2629
+ """
2630
+
2631
+ :return: the parent group for an RNA struct's custom IDProperties.
2632
+ """
1727
2633
  ...
1728
2634
 
1729
2635
  def id_properties_ui(self):
1730
- """ """
2636
+ """
2637
+
2638
+ :return: Return an object used to manage an IDProperty's UI data.
2639
+ """
1731
2640
  ...
1732
2641
 
1733
2642
  def is_extended(self):
1734
2643
  """ """
1735
2644
  ...
1736
2645
 
1737
- def is_property_hidden(self):
1738
- """ """
2646
+ def is_property_hidden(self) -> bool:
2647
+ """Check if a property is hidden.
2648
+
2649
+ :return: True when the property is hidden.
2650
+ :rtype: bool
2651
+ """
1739
2652
  ...
1740
2653
 
1741
- def is_property_overridable_library(self):
1742
- """ """
2654
+ def is_property_overridable_library(self) -> bool:
2655
+ """Check if a property is overridable.
2656
+
2657
+ :return: True when the property is overridable.
2658
+ :rtype: bool
2659
+ """
1743
2660
  ...
1744
2661
 
1745
- def is_property_readonly(self):
1746
- """ """
2662
+ def is_property_readonly(self) -> bool:
2663
+ """Check if a property is readonly.
2664
+
2665
+ :return: True when the property is readonly (not writable).
2666
+ :rtype: bool
2667
+ """
1747
2668
  ...
1748
2669
 
1749
- def is_property_set(self):
1750
- """ """
2670
+ def is_property_set(self) -> bool:
2671
+ """Check if a property is set, use for testing operator properties.
2672
+
2673
+ :return: True when the property has been set.
2674
+ :rtype: bool
2675
+ """
1751
2676
  ...
1752
2677
 
1753
2678
  def items(self):
1754
- """ """
2679
+ """Returns the items of this objects custom properties (matches Python's
2680
+ dictionary function of the same name).
2681
+
2682
+ :return: custom property key, value pairs.
2683
+ """
1755
2684
  ...
1756
2685
 
1757
- def keyframe_delete(self):
1758
- """ """
2686
+ def keyframe_delete(self) -> bool:
2687
+ """Remove a keyframe from this properties fcurve.
2688
+
2689
+ :return: Success of keyframe deletion.
2690
+ :rtype: bool
2691
+ """
1759
2692
  ...
1760
2693
 
1761
- def keyframe_insert(self):
1762
- """ """
2694
+ def keyframe_insert(self) -> bool:
2695
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2696
+
2697
+ :return: Success of keyframe insertion.
2698
+ :rtype: bool
2699
+ """
1763
2700
  ...
1764
2701
 
1765
2702
  def keys(self):
1766
- """ """
2703
+ """Returns the keys of this objects custom properties (matches Python's
2704
+ dictionary function of the same name).
2705
+
2706
+ :return: custom property keys.
2707
+ """
1767
2708
  ...
1768
2709
 
1769
- def path_from_id(self):
1770
- """ """
2710
+ def path_from_id(self) -> str:
2711
+ """Returns the data path from the ID to this object (string).
2712
+
2713
+ :return: The path from `bpy.types.bpy_struct.id_data`
2714
+ to this struct and property (when given).
2715
+ :rtype: str
2716
+ """
1771
2717
  ...
1772
2718
 
1773
2719
  def path_resolve(self):
1774
- """ """
2720
+ """Returns the property from the path, raise an exception when not found."""
1775
2721
  ...
1776
2722
 
1777
2723
  def poll(self, context):
@@ -1782,37 +2728,53 @@ class VIEWLAYER_PT_layer_passes(
1782
2728
  ...
1783
2729
 
1784
2730
  def pop(self):
1785
- """ """
2731
+ """Remove and return the value of the custom property assigned to key or default
2732
+ when not found (matches Python's dictionary function of the same name).
2733
+
2734
+ """
1786
2735
  ...
1787
2736
 
1788
2737
  def prepend(self, draw_func):
1789
- """
2738
+ """Prepend a draw function to this menu, takes the same arguments as
2739
+ the menus draw function
1790
2740
 
1791
- :param draw_func:
2741
+ :param draw_func:
1792
2742
  """
1793
2743
  ...
1794
2744
 
1795
- def property_overridable_library_set(self):
1796
- """ """
2745
+ def property_overridable_library_set(self) -> bool:
2746
+ """Define a property as overridable or not (only for custom properties!).
2747
+
2748
+ :return: True when the overridable status of the property was successfully set.
2749
+ :rtype: bool
2750
+ """
1797
2751
  ...
1798
2752
 
1799
2753
  def property_unset(self):
1800
- """ """
2754
+ """Unset a property, will use default value afterward."""
1801
2755
  ...
1802
2756
 
1803
2757
  def remove(self, draw_func):
1804
- """
2758
+ """Remove a draw function that has been added to this menu
1805
2759
 
1806
2760
  :param draw_func:
1807
2761
  """
1808
2762
  ...
1809
2763
 
1810
2764
  def type_recast(self):
1811
- """ """
2765
+ """Return a new instance, this is needed because types
2766
+ such as textures can be changed at runtime.
2767
+
2768
+ :return: a new instance of this object with the type initialized again.
2769
+ """
1812
2770
  ...
1813
2771
 
1814
2772
  def values(self):
1815
- """ """
2773
+ """Returns the values of this objects custom properties (matches Python's
2774
+ dictionary function of the same name).
2775
+
2776
+ :return: custom property values.
2777
+ """
1816
2778
  ...
1817
2779
 
1818
2780
  class VIEWLAYER_PT_workbench_layer_passes_data(
@@ -1845,22 +2807,35 @@ class VIEWLAYER_PT_workbench_layer_passes_data(
1845
2807
  """ """
1846
2808
 
1847
2809
  def append(self, draw_func):
1848
- """
2810
+ """Append a draw function to this menu,
2811
+ takes the same arguments as the menus draw function
1849
2812
 
1850
- :param draw_func:
2813
+ :param draw_func:
1851
2814
  """
1852
2815
  ...
1853
2816
 
1854
- def as_pointer(self):
1855
- """ """
2817
+ def as_pointer(self) -> int:
2818
+ """Returns the memory address which holds a pointer to Blender's internal data
2819
+
2820
+ :return: int (memory address).
2821
+ :rtype: int
2822
+ """
1856
2823
  ...
1857
2824
 
1858
- def bl_rna_get_subclass(self):
1859
- """ """
2825
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2826
+ """
2827
+
2828
+ :return: The RNA type or default when not found.
2829
+ :rtype: bpy.types.Struct
2830
+ """
1860
2831
  ...
1861
2832
 
1862
- def bl_rna_get_subclass_py(self):
1863
- """ """
2833
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2834
+ """
2835
+
2836
+ :return: The class or default when not found.
2837
+ :rtype: typing.Any
2838
+ """
1864
2839
  ...
1865
2840
 
1866
2841
  def draw(self, context):
@@ -1870,72 +2845,129 @@ class VIEWLAYER_PT_workbench_layer_passes_data(
1870
2845
  """
1871
2846
  ...
1872
2847
 
1873
- def driver_add(self):
1874
- """ """
2848
+ def driver_add(self) -> bpy.types.FCurve:
2849
+ """Adds driver(s) to the given property
2850
+
2851
+ :return: The driver(s) added.
2852
+ :rtype: bpy.types.FCurve
2853
+ """
1875
2854
  ...
1876
2855
 
1877
- def driver_remove(self):
1878
- """ """
2856
+ def driver_remove(self) -> bool:
2857
+ """Remove driver(s) from the given property
2858
+
2859
+ :return: Success of driver removal.
2860
+ :rtype: bool
2861
+ """
1879
2862
  ...
1880
2863
 
1881
2864
  def get(self):
1882
- """ """
2865
+ """Returns the value of the custom property assigned to key or default
2866
+ when not found (matches Python's dictionary function of the same name).
2867
+
2868
+ """
1883
2869
  ...
1884
2870
 
1885
2871
  def id_properties_clear(self):
1886
- """ """
2872
+ """
2873
+
2874
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2875
+ """
1887
2876
  ...
1888
2877
 
1889
2878
  def id_properties_ensure(self):
1890
- """ """
2879
+ """
2880
+
2881
+ :return: the parent group for an RNA struct's custom IDProperties.
2882
+ """
1891
2883
  ...
1892
2884
 
1893
2885
  def id_properties_ui(self):
1894
- """ """
2886
+ """
2887
+
2888
+ :return: Return an object used to manage an IDProperty's UI data.
2889
+ """
1895
2890
  ...
1896
2891
 
1897
2892
  def is_extended(self):
1898
2893
  """ """
1899
2894
  ...
1900
2895
 
1901
- def is_property_hidden(self):
1902
- """ """
2896
+ def is_property_hidden(self) -> bool:
2897
+ """Check if a property is hidden.
2898
+
2899
+ :return: True when the property is hidden.
2900
+ :rtype: bool
2901
+ """
1903
2902
  ...
1904
2903
 
1905
- def is_property_overridable_library(self):
1906
- """ """
2904
+ def is_property_overridable_library(self) -> bool:
2905
+ """Check if a property is overridable.
2906
+
2907
+ :return: True when the property is overridable.
2908
+ :rtype: bool
2909
+ """
1907
2910
  ...
1908
2911
 
1909
- def is_property_readonly(self):
1910
- """ """
2912
+ def is_property_readonly(self) -> bool:
2913
+ """Check if a property is readonly.
2914
+
2915
+ :return: True when the property is readonly (not writable).
2916
+ :rtype: bool
2917
+ """
1911
2918
  ...
1912
2919
 
1913
- def is_property_set(self):
1914
- """ """
2920
+ def is_property_set(self) -> bool:
2921
+ """Check if a property is set, use for testing operator properties.
2922
+
2923
+ :return: True when the property has been set.
2924
+ :rtype: bool
2925
+ """
1915
2926
  ...
1916
2927
 
1917
2928
  def items(self):
1918
- """ """
2929
+ """Returns the items of this objects custom properties (matches Python's
2930
+ dictionary function of the same name).
2931
+
2932
+ :return: custom property key, value pairs.
2933
+ """
1919
2934
  ...
1920
2935
 
1921
- def keyframe_delete(self):
1922
- """ """
2936
+ def keyframe_delete(self) -> bool:
2937
+ """Remove a keyframe from this properties fcurve.
2938
+
2939
+ :return: Success of keyframe deletion.
2940
+ :rtype: bool
2941
+ """
1923
2942
  ...
1924
2943
 
1925
- def keyframe_insert(self):
1926
- """ """
2944
+ def keyframe_insert(self) -> bool:
2945
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2946
+
2947
+ :return: Success of keyframe insertion.
2948
+ :rtype: bool
2949
+ """
1927
2950
  ...
1928
2951
 
1929
2952
  def keys(self):
1930
- """ """
2953
+ """Returns the keys of this objects custom properties (matches Python's
2954
+ dictionary function of the same name).
2955
+
2956
+ :return: custom property keys.
2957
+ """
1931
2958
  ...
1932
2959
 
1933
- def path_from_id(self):
1934
- """ """
2960
+ def path_from_id(self) -> str:
2961
+ """Returns the data path from the ID to this object (string).
2962
+
2963
+ :return: The path from `bpy.types.bpy_struct.id_data`
2964
+ to this struct and property (when given).
2965
+ :rtype: str
2966
+ """
1935
2967
  ...
1936
2968
 
1937
2969
  def path_resolve(self):
1938
- """ """
2970
+ """Returns the property from the path, raise an exception when not found."""
1939
2971
  ...
1940
2972
 
1941
2973
  def poll(self, context):
@@ -1946,37 +2978,53 @@ class VIEWLAYER_PT_workbench_layer_passes_data(
1946
2978
  ...
1947
2979
 
1948
2980
  def pop(self):
1949
- """ """
2981
+ """Remove and return the value of the custom property assigned to key or default
2982
+ when not found (matches Python's dictionary function of the same name).
2983
+
2984
+ """
1950
2985
  ...
1951
2986
 
1952
2987
  def prepend(self, draw_func):
1953
- """
2988
+ """Prepend a draw function to this menu, takes the same arguments as
2989
+ the menus draw function
1954
2990
 
1955
- :param draw_func:
2991
+ :param draw_func:
1956
2992
  """
1957
2993
  ...
1958
2994
 
1959
- def property_overridable_library_set(self):
1960
- """ """
2995
+ def property_overridable_library_set(self) -> bool:
2996
+ """Define a property as overridable or not (only for custom properties!).
2997
+
2998
+ :return: True when the overridable status of the property was successfully set.
2999
+ :rtype: bool
3000
+ """
1961
3001
  ...
1962
3002
 
1963
3003
  def property_unset(self):
1964
- """ """
3004
+ """Unset a property, will use default value afterward."""
1965
3005
  ...
1966
3006
 
1967
3007
  def remove(self, draw_func):
1968
- """
3008
+ """Remove a draw function that has been added to this menu
1969
3009
 
1970
3010
  :param draw_func:
1971
3011
  """
1972
3012
  ...
1973
3013
 
1974
3014
  def type_recast(self):
1975
- """ """
3015
+ """Return a new instance, this is needed because types
3016
+ such as textures can be changed at runtime.
3017
+
3018
+ :return: a new instance of this object with the type initialized again.
3019
+ """
1976
3020
  ...
1977
3021
 
1978
3022
  def values(self):
1979
- """ """
3023
+ """Returns the values of this objects custom properties (matches Python's
3024
+ dictionary function of the same name).
3025
+
3026
+ :return: custom property values.
3027
+ """
1980
3028
  ...
1981
3029
 
1982
3030
  class ViewLayerAOVPanel(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._GenericUI):
@@ -2001,22 +3049,35 @@ class ViewLayerAOVPanel(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gener
2001
3049
  """ """
2002
3050
 
2003
3051
  def append(self, draw_func):
2004
- """
3052
+ """Append a draw function to this menu,
3053
+ takes the same arguments as the menus draw function
2005
3054
 
2006
- :param draw_func:
3055
+ :param draw_func:
2007
3056
  """
2008
3057
  ...
2009
3058
 
2010
- def as_pointer(self):
2011
- """ """
3059
+ def as_pointer(self) -> int:
3060
+ """Returns the memory address which holds a pointer to Blender's internal data
3061
+
3062
+ :return: int (memory address).
3063
+ :rtype: int
3064
+ """
2012
3065
  ...
2013
3066
 
2014
- def bl_rna_get_subclass(self):
2015
- """ """
3067
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3068
+ """
3069
+
3070
+ :return: The RNA type or default when not found.
3071
+ :rtype: bpy.types.Struct
3072
+ """
2016
3073
  ...
2017
3074
 
2018
- def bl_rna_get_subclass_py(self):
2019
- """ """
3075
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3076
+ """
3077
+
3078
+ :return: The class or default when not found.
3079
+ :rtype: typing.Any
3080
+ """
2020
3081
  ...
2021
3082
 
2022
3083
  def draw(self, context):
@@ -2026,72 +3087,129 @@ class ViewLayerAOVPanel(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gener
2026
3087
  """
2027
3088
  ...
2028
3089
 
2029
- def driver_add(self):
2030
- """ """
3090
+ def driver_add(self) -> bpy.types.FCurve:
3091
+ """Adds driver(s) to the given property
3092
+
3093
+ :return: The driver(s) added.
3094
+ :rtype: bpy.types.FCurve
3095
+ """
2031
3096
  ...
2032
3097
 
2033
- def driver_remove(self):
2034
- """ """
3098
+ def driver_remove(self) -> bool:
3099
+ """Remove driver(s) from the given property
3100
+
3101
+ :return: Success of driver removal.
3102
+ :rtype: bool
3103
+ """
2035
3104
  ...
2036
3105
 
2037
3106
  def get(self):
2038
- """ """
3107
+ """Returns the value of the custom property assigned to key or default
3108
+ when not found (matches Python's dictionary function of the same name).
3109
+
3110
+ """
2039
3111
  ...
2040
3112
 
2041
3113
  def id_properties_clear(self):
2042
- """ """
3114
+ """
3115
+
3116
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3117
+ """
2043
3118
  ...
2044
3119
 
2045
3120
  def id_properties_ensure(self):
2046
- """ """
3121
+ """
3122
+
3123
+ :return: the parent group for an RNA struct's custom IDProperties.
3124
+ """
2047
3125
  ...
2048
3126
 
2049
3127
  def id_properties_ui(self):
2050
- """ """
3128
+ """
3129
+
3130
+ :return: Return an object used to manage an IDProperty's UI data.
3131
+ """
2051
3132
  ...
2052
3133
 
2053
3134
  def is_extended(self):
2054
3135
  """ """
2055
3136
  ...
2056
3137
 
2057
- def is_property_hidden(self):
2058
- """ """
3138
+ def is_property_hidden(self) -> bool:
3139
+ """Check if a property is hidden.
3140
+
3141
+ :return: True when the property is hidden.
3142
+ :rtype: bool
3143
+ """
2059
3144
  ...
2060
3145
 
2061
- def is_property_overridable_library(self):
2062
- """ """
3146
+ def is_property_overridable_library(self) -> bool:
3147
+ """Check if a property is overridable.
3148
+
3149
+ :return: True when the property is overridable.
3150
+ :rtype: bool
3151
+ """
2063
3152
  ...
2064
3153
 
2065
- def is_property_readonly(self):
2066
- """ """
3154
+ def is_property_readonly(self) -> bool:
3155
+ """Check if a property is readonly.
3156
+
3157
+ :return: True when the property is readonly (not writable).
3158
+ :rtype: bool
3159
+ """
2067
3160
  ...
2068
3161
 
2069
- def is_property_set(self):
2070
- """ """
3162
+ def is_property_set(self) -> bool:
3163
+ """Check if a property is set, use for testing operator properties.
3164
+
3165
+ :return: True when the property has been set.
3166
+ :rtype: bool
3167
+ """
2071
3168
  ...
2072
3169
 
2073
3170
  def items(self):
2074
- """ """
3171
+ """Returns the items of this objects custom properties (matches Python's
3172
+ dictionary function of the same name).
3173
+
3174
+ :return: custom property key, value pairs.
3175
+ """
2075
3176
  ...
2076
3177
 
2077
- def keyframe_delete(self):
2078
- """ """
3178
+ def keyframe_delete(self) -> bool:
3179
+ """Remove a keyframe from this properties fcurve.
3180
+
3181
+ :return: Success of keyframe deletion.
3182
+ :rtype: bool
3183
+ """
2079
3184
  ...
2080
3185
 
2081
- def keyframe_insert(self):
2082
- """ """
3186
+ def keyframe_insert(self) -> bool:
3187
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3188
+
3189
+ :return: Success of keyframe insertion.
3190
+ :rtype: bool
3191
+ """
2083
3192
  ...
2084
3193
 
2085
3194
  def keys(self):
2086
- """ """
3195
+ """Returns the keys of this objects custom properties (matches Python's
3196
+ dictionary function of the same name).
3197
+
3198
+ :return: custom property keys.
3199
+ """
2087
3200
  ...
2088
3201
 
2089
- def path_from_id(self):
2090
- """ """
3202
+ def path_from_id(self) -> str:
3203
+ """Returns the data path from the ID to this object (string).
3204
+
3205
+ :return: The path from `bpy.types.bpy_struct.id_data`
3206
+ to this struct and property (when given).
3207
+ :rtype: str
3208
+ """
2091
3209
  ...
2092
3210
 
2093
3211
  def path_resolve(self):
2094
- """ """
3212
+ """Returns the property from the path, raise an exception when not found."""
2095
3213
  ...
2096
3214
 
2097
3215
  def poll(self, context):
@@ -2102,37 +3220,53 @@ class ViewLayerAOVPanel(bpy_types.Panel, ViewLayerButtonsPanel, bpy_types._Gener
2102
3220
  ...
2103
3221
 
2104
3222
  def pop(self):
2105
- """ """
3223
+ """Remove and return the value of the custom property assigned to key or default
3224
+ when not found (matches Python's dictionary function of the same name).
3225
+
3226
+ """
2106
3227
  ...
2107
3228
 
2108
3229
  def prepend(self, draw_func):
2109
- """
3230
+ """Prepend a draw function to this menu, takes the same arguments as
3231
+ the menus draw function
2110
3232
 
2111
- :param draw_func:
3233
+ :param draw_func:
2112
3234
  """
2113
3235
  ...
2114
3236
 
2115
- def property_overridable_library_set(self):
2116
- """ """
3237
+ def property_overridable_library_set(self) -> bool:
3238
+ """Define a property as overridable or not (only for custom properties!).
3239
+
3240
+ :return: True when the overridable status of the property was successfully set.
3241
+ :rtype: bool
3242
+ """
2117
3243
  ...
2118
3244
 
2119
3245
  def property_unset(self):
2120
- """ """
3246
+ """Unset a property, will use default value afterward."""
2121
3247
  ...
2122
3248
 
2123
3249
  def remove(self, draw_func):
2124
- """
3250
+ """Remove a draw function that has been added to this menu
2125
3251
 
2126
3252
  :param draw_func:
2127
3253
  """
2128
3254
  ...
2129
3255
 
2130
3256
  def type_recast(self):
2131
- """ """
3257
+ """Return a new instance, this is needed because types
3258
+ such as textures can be changed at runtime.
3259
+
3260
+ :return: a new instance of this object with the type initialized again.
3261
+ """
2132
3262
  ...
2133
3263
 
2134
3264
  def values(self):
2135
- """ """
3265
+ """Returns the values of this objects custom properties (matches Python's
3266
+ dictionary function of the same name).
3267
+
3268
+ :return: custom property values.
3269
+ """
2136
3270
  ...
2137
3271
 
2138
3272
  class ViewLayerCryptomattePanel(
@@ -2159,22 +3293,35 @@ class ViewLayerCryptomattePanel(
2159
3293
  """ """
2160
3294
 
2161
3295
  def append(self, draw_func):
2162
- """
3296
+ """Append a draw function to this menu,
3297
+ takes the same arguments as the menus draw function
2163
3298
 
2164
- :param draw_func:
3299
+ :param draw_func:
2165
3300
  """
2166
3301
  ...
2167
3302
 
2168
- def as_pointer(self):
2169
- """ """
3303
+ def as_pointer(self) -> int:
3304
+ """Returns the memory address which holds a pointer to Blender's internal data
3305
+
3306
+ :return: int (memory address).
3307
+ :rtype: int
3308
+ """
2170
3309
  ...
2171
3310
 
2172
- def bl_rna_get_subclass(self):
2173
- """ """
3311
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3312
+ """
3313
+
3314
+ :return: The RNA type or default when not found.
3315
+ :rtype: bpy.types.Struct
3316
+ """
2174
3317
  ...
2175
3318
 
2176
- def bl_rna_get_subclass_py(self):
2177
- """ """
3319
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3320
+ """
3321
+
3322
+ :return: The class or default when not found.
3323
+ :rtype: typing.Any
3324
+ """
2178
3325
  ...
2179
3326
 
2180
3327
  def draw(self, context):
@@ -2184,72 +3331,129 @@ class ViewLayerCryptomattePanel(
2184
3331
  """
2185
3332
  ...
2186
3333
 
2187
- def driver_add(self):
2188
- """ """
3334
+ def driver_add(self) -> bpy.types.FCurve:
3335
+ """Adds driver(s) to the given property
3336
+
3337
+ :return: The driver(s) added.
3338
+ :rtype: bpy.types.FCurve
3339
+ """
2189
3340
  ...
2190
3341
 
2191
- def driver_remove(self):
2192
- """ """
3342
+ def driver_remove(self) -> bool:
3343
+ """Remove driver(s) from the given property
3344
+
3345
+ :return: Success of driver removal.
3346
+ :rtype: bool
3347
+ """
2193
3348
  ...
2194
3349
 
2195
3350
  def get(self):
2196
- """ """
3351
+ """Returns the value of the custom property assigned to key or default
3352
+ when not found (matches Python's dictionary function of the same name).
3353
+
3354
+ """
2197
3355
  ...
2198
3356
 
2199
3357
  def id_properties_clear(self):
2200
- """ """
3358
+ """
3359
+
3360
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3361
+ """
2201
3362
  ...
2202
3363
 
2203
3364
  def id_properties_ensure(self):
2204
- """ """
3365
+ """
3366
+
3367
+ :return: the parent group for an RNA struct's custom IDProperties.
3368
+ """
2205
3369
  ...
2206
3370
 
2207
3371
  def id_properties_ui(self):
2208
- """ """
3372
+ """
3373
+
3374
+ :return: Return an object used to manage an IDProperty's UI data.
3375
+ """
2209
3376
  ...
2210
3377
 
2211
3378
  def is_extended(self):
2212
3379
  """ """
2213
3380
  ...
2214
3381
 
2215
- def is_property_hidden(self):
2216
- """ """
3382
+ def is_property_hidden(self) -> bool:
3383
+ """Check if a property is hidden.
3384
+
3385
+ :return: True when the property is hidden.
3386
+ :rtype: bool
3387
+ """
2217
3388
  ...
2218
3389
 
2219
- def is_property_overridable_library(self):
2220
- """ """
3390
+ def is_property_overridable_library(self) -> bool:
3391
+ """Check if a property is overridable.
3392
+
3393
+ :return: True when the property is overridable.
3394
+ :rtype: bool
3395
+ """
2221
3396
  ...
2222
3397
 
2223
- def is_property_readonly(self):
2224
- """ """
3398
+ def is_property_readonly(self) -> bool:
3399
+ """Check if a property is readonly.
3400
+
3401
+ :return: True when the property is readonly (not writable).
3402
+ :rtype: bool
3403
+ """
2225
3404
  ...
2226
3405
 
2227
- def is_property_set(self):
2228
- """ """
3406
+ def is_property_set(self) -> bool:
3407
+ """Check if a property is set, use for testing operator properties.
3408
+
3409
+ :return: True when the property has been set.
3410
+ :rtype: bool
3411
+ """
2229
3412
  ...
2230
3413
 
2231
3414
  def items(self):
2232
- """ """
3415
+ """Returns the items of this objects custom properties (matches Python's
3416
+ dictionary function of the same name).
3417
+
3418
+ :return: custom property key, value pairs.
3419
+ """
2233
3420
  ...
2234
3421
 
2235
- def keyframe_delete(self):
2236
- """ """
3422
+ def keyframe_delete(self) -> bool:
3423
+ """Remove a keyframe from this properties fcurve.
3424
+
3425
+ :return: Success of keyframe deletion.
3426
+ :rtype: bool
3427
+ """
2237
3428
  ...
2238
3429
 
2239
- def keyframe_insert(self):
2240
- """ """
3430
+ def keyframe_insert(self) -> bool:
3431
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3432
+
3433
+ :return: Success of keyframe insertion.
3434
+ :rtype: bool
3435
+ """
2241
3436
  ...
2242
3437
 
2243
3438
  def keys(self):
2244
- """ """
3439
+ """Returns the keys of this objects custom properties (matches Python's
3440
+ dictionary function of the same name).
3441
+
3442
+ :return: custom property keys.
3443
+ """
2245
3444
  ...
2246
3445
 
2247
- def path_from_id(self):
2248
- """ """
3446
+ def path_from_id(self) -> str:
3447
+ """Returns the data path from the ID to this object (string).
3448
+
3449
+ :return: The path from `bpy.types.bpy_struct.id_data`
3450
+ to this struct and property (when given).
3451
+ :rtype: str
3452
+ """
2249
3453
  ...
2250
3454
 
2251
3455
  def path_resolve(self):
2252
- """ """
3456
+ """Returns the property from the path, raise an exception when not found."""
2253
3457
  ...
2254
3458
 
2255
3459
  def poll(self, context):
@@ -2260,37 +3464,53 @@ class ViewLayerCryptomattePanel(
2260
3464
  ...
2261
3465
 
2262
3466
  def pop(self):
2263
- """ """
3467
+ """Remove and return the value of the custom property assigned to key or default
3468
+ when not found (matches Python's dictionary function of the same name).
3469
+
3470
+ """
2264
3471
  ...
2265
3472
 
2266
3473
  def prepend(self, draw_func):
2267
- """
3474
+ """Prepend a draw function to this menu, takes the same arguments as
3475
+ the menus draw function
2268
3476
 
2269
- :param draw_func:
3477
+ :param draw_func:
2270
3478
  """
2271
3479
  ...
2272
3480
 
2273
- def property_overridable_library_set(self):
2274
- """ """
3481
+ def property_overridable_library_set(self) -> bool:
3482
+ """Define a property as overridable or not (only for custom properties!).
3483
+
3484
+ :return: True when the overridable status of the property was successfully set.
3485
+ :rtype: bool
3486
+ """
2275
3487
  ...
2276
3488
 
2277
3489
  def property_unset(self):
2278
- """ """
3490
+ """Unset a property, will use default value afterward."""
2279
3491
  ...
2280
3492
 
2281
3493
  def remove(self, draw_func):
2282
- """
3494
+ """Remove a draw function that has been added to this menu
2283
3495
 
2284
3496
  :param draw_func:
2285
3497
  """
2286
3498
  ...
2287
3499
 
2288
3500
  def type_recast(self):
2289
- """ """
3501
+ """Return a new instance, this is needed because types
3502
+ such as textures can be changed at runtime.
3503
+
3504
+ :return: a new instance of this object with the type initialized again.
3505
+ """
2290
3506
  ...
2291
3507
 
2292
3508
  def values(self):
2293
- """ """
3509
+ """Returns the values of this objects custom properties (matches Python's
3510
+ dictionary function of the same name).
3511
+
3512
+ :return: custom property values.
3513
+ """
2294
3514
  ...
2295
3515
 
2296
3516
  class ViewLayerLightgroupsPanel(
@@ -2317,22 +3537,35 @@ class ViewLayerLightgroupsPanel(
2317
3537
  """ """
2318
3538
 
2319
3539
  def append(self, draw_func):
2320
- """
3540
+ """Append a draw function to this menu,
3541
+ takes the same arguments as the menus draw function
2321
3542
 
2322
- :param draw_func:
3543
+ :param draw_func:
2323
3544
  """
2324
3545
  ...
2325
3546
 
2326
- def as_pointer(self):
2327
- """ """
3547
+ def as_pointer(self) -> int:
3548
+ """Returns the memory address which holds a pointer to Blender's internal data
3549
+
3550
+ :return: int (memory address).
3551
+ :rtype: int
3552
+ """
2328
3553
  ...
2329
3554
 
2330
- def bl_rna_get_subclass(self):
2331
- """ """
3555
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3556
+ """
3557
+
3558
+ :return: The RNA type or default when not found.
3559
+ :rtype: bpy.types.Struct
3560
+ """
2332
3561
  ...
2333
3562
 
2334
- def bl_rna_get_subclass_py(self):
2335
- """ """
3563
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3564
+ """
3565
+
3566
+ :return: The class or default when not found.
3567
+ :rtype: typing.Any
3568
+ """
2336
3569
  ...
2337
3570
 
2338
3571
  def draw(self, context):
@@ -2342,72 +3575,129 @@ class ViewLayerLightgroupsPanel(
2342
3575
  """
2343
3576
  ...
2344
3577
 
2345
- def driver_add(self):
2346
- """ """
3578
+ def driver_add(self) -> bpy.types.FCurve:
3579
+ """Adds driver(s) to the given property
3580
+
3581
+ :return: The driver(s) added.
3582
+ :rtype: bpy.types.FCurve
3583
+ """
2347
3584
  ...
2348
3585
 
2349
- def driver_remove(self):
2350
- """ """
3586
+ def driver_remove(self) -> bool:
3587
+ """Remove driver(s) from the given property
3588
+
3589
+ :return: Success of driver removal.
3590
+ :rtype: bool
3591
+ """
2351
3592
  ...
2352
3593
 
2353
3594
  def get(self):
2354
- """ """
3595
+ """Returns the value of the custom property assigned to key or default
3596
+ when not found (matches Python's dictionary function of the same name).
3597
+
3598
+ """
2355
3599
  ...
2356
3600
 
2357
3601
  def id_properties_clear(self):
2358
- """ """
3602
+ """
3603
+
3604
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3605
+ """
2359
3606
  ...
2360
3607
 
2361
3608
  def id_properties_ensure(self):
2362
- """ """
3609
+ """
3610
+
3611
+ :return: the parent group for an RNA struct's custom IDProperties.
3612
+ """
2363
3613
  ...
2364
3614
 
2365
3615
  def id_properties_ui(self):
2366
- """ """
3616
+ """
3617
+
3618
+ :return: Return an object used to manage an IDProperty's UI data.
3619
+ """
2367
3620
  ...
2368
3621
 
2369
3622
  def is_extended(self):
2370
3623
  """ """
2371
3624
  ...
2372
3625
 
2373
- def is_property_hidden(self):
2374
- """ """
3626
+ def is_property_hidden(self) -> bool:
3627
+ """Check if a property is hidden.
3628
+
3629
+ :return: True when the property is hidden.
3630
+ :rtype: bool
3631
+ """
2375
3632
  ...
2376
3633
 
2377
- def is_property_overridable_library(self):
2378
- """ """
3634
+ def is_property_overridable_library(self) -> bool:
3635
+ """Check if a property is overridable.
3636
+
3637
+ :return: True when the property is overridable.
3638
+ :rtype: bool
3639
+ """
2379
3640
  ...
2380
3641
 
2381
- def is_property_readonly(self):
2382
- """ """
3642
+ def is_property_readonly(self) -> bool:
3643
+ """Check if a property is readonly.
3644
+
3645
+ :return: True when the property is readonly (not writable).
3646
+ :rtype: bool
3647
+ """
2383
3648
  ...
2384
3649
 
2385
- def is_property_set(self):
2386
- """ """
3650
+ def is_property_set(self) -> bool:
3651
+ """Check if a property is set, use for testing operator properties.
3652
+
3653
+ :return: True when the property has been set.
3654
+ :rtype: bool
3655
+ """
2387
3656
  ...
2388
3657
 
2389
3658
  def items(self):
2390
- """ """
3659
+ """Returns the items of this objects custom properties (matches Python's
3660
+ dictionary function of the same name).
3661
+
3662
+ :return: custom property key, value pairs.
3663
+ """
2391
3664
  ...
2392
3665
 
2393
- def keyframe_delete(self):
2394
- """ """
3666
+ def keyframe_delete(self) -> bool:
3667
+ """Remove a keyframe from this properties fcurve.
3668
+
3669
+ :return: Success of keyframe deletion.
3670
+ :rtype: bool
3671
+ """
2395
3672
  ...
2396
3673
 
2397
- def keyframe_insert(self):
2398
- """ """
3674
+ def keyframe_insert(self) -> bool:
3675
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3676
+
3677
+ :return: Success of keyframe insertion.
3678
+ :rtype: bool
3679
+ """
3680
+ ...
3681
+
3682
+ def keys(self):
3683
+ """Returns the keys of this objects custom properties (matches Python's
3684
+ dictionary function of the same name).
3685
+
3686
+ :return: custom property keys.
3687
+ """
2399
3688
  ...
2400
3689
 
2401
- def keys(self):
2402
- """ """
2403
- ...
3690
+ def path_from_id(self) -> str:
3691
+ """Returns the data path from the ID to this object (string).
2404
3692
 
2405
- def path_from_id(self):
2406
- """ """
3693
+ :return: The path from `bpy.types.bpy_struct.id_data`
3694
+ to this struct and property (when given).
3695
+ :rtype: str
3696
+ """
2407
3697
  ...
2408
3698
 
2409
3699
  def path_resolve(self):
2410
- """ """
3700
+ """Returns the property from the path, raise an exception when not found."""
2411
3701
  ...
2412
3702
 
2413
3703
  def poll(self, context):
@@ -2418,37 +3708,53 @@ class ViewLayerLightgroupsPanel(
2418
3708
  ...
2419
3709
 
2420
3710
  def pop(self):
2421
- """ """
3711
+ """Remove and return the value of the custom property assigned to key or default
3712
+ when not found (matches Python's dictionary function of the same name).
3713
+
3714
+ """
2422
3715
  ...
2423
3716
 
2424
3717
  def prepend(self, draw_func):
2425
- """
3718
+ """Prepend a draw function to this menu, takes the same arguments as
3719
+ the menus draw function
2426
3720
 
2427
- :param draw_func:
3721
+ :param draw_func:
2428
3722
  """
2429
3723
  ...
2430
3724
 
2431
- def property_overridable_library_set(self):
2432
- """ """
3725
+ def property_overridable_library_set(self) -> bool:
3726
+ """Define a property as overridable or not (only for custom properties!).
3727
+
3728
+ :return: True when the overridable status of the property was successfully set.
3729
+ :rtype: bool
3730
+ """
2433
3731
  ...
2434
3732
 
2435
3733
  def property_unset(self):
2436
- """ """
3734
+ """Unset a property, will use default value afterward."""
2437
3735
  ...
2438
3736
 
2439
3737
  def remove(self, draw_func):
2440
- """
3738
+ """Remove a draw function that has been added to this menu
2441
3739
 
2442
3740
  :param draw_func:
2443
3741
  """
2444
3742
  ...
2445
3743
 
2446
3744
  def type_recast(self):
2447
- """ """
3745
+ """Return a new instance, this is needed because types
3746
+ such as textures can be changed at runtime.
3747
+
3748
+ :return: a new instance of this object with the type initialized again.
3749
+ """
2448
3750
  ...
2449
3751
 
2450
3752
  def values(self):
2451
- """ """
3753
+ """Returns the values of this objects custom properties (matches Python's
3754
+ dictionary function of the same name).
3755
+
3756
+ :return: custom property values.
3757
+ """
2452
3758
  ...
2453
3759
 
2454
3760
  class VIEWLAYER_PT_layer_passes_aov(
@@ -2481,22 +3787,35 @@ class VIEWLAYER_PT_layer_passes_aov(
2481
3787
  """ """
2482
3788
 
2483
3789
  def append(self, draw_func):
2484
- """
3790
+ """Append a draw function to this menu,
3791
+ takes the same arguments as the menus draw function
2485
3792
 
2486
- :param draw_func:
3793
+ :param draw_func:
2487
3794
  """
2488
3795
  ...
2489
3796
 
2490
- def as_pointer(self):
2491
- """ """
3797
+ def as_pointer(self) -> int:
3798
+ """Returns the memory address which holds a pointer to Blender's internal data
3799
+
3800
+ :return: int (memory address).
3801
+ :rtype: int
3802
+ """
2492
3803
  ...
2493
3804
 
2494
- def bl_rna_get_subclass(self):
2495
- """ """
3805
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3806
+ """
3807
+
3808
+ :return: The RNA type or default when not found.
3809
+ :rtype: bpy.types.Struct
3810
+ """
2496
3811
  ...
2497
3812
 
2498
- def bl_rna_get_subclass_py(self):
2499
- """ """
3813
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3814
+ """
3815
+
3816
+ :return: The class or default when not found.
3817
+ :rtype: typing.Any
3818
+ """
2500
3819
  ...
2501
3820
 
2502
3821
  def draw(self, context):
@@ -2506,72 +3825,129 @@ class VIEWLAYER_PT_layer_passes_aov(
2506
3825
  """
2507
3826
  ...
2508
3827
 
2509
- def driver_add(self):
2510
- """ """
3828
+ def driver_add(self) -> bpy.types.FCurve:
3829
+ """Adds driver(s) to the given property
3830
+
3831
+ :return: The driver(s) added.
3832
+ :rtype: bpy.types.FCurve
3833
+ """
2511
3834
  ...
2512
3835
 
2513
- def driver_remove(self):
2514
- """ """
3836
+ def driver_remove(self) -> bool:
3837
+ """Remove driver(s) from the given property
3838
+
3839
+ :return: Success of driver removal.
3840
+ :rtype: bool
3841
+ """
2515
3842
  ...
2516
3843
 
2517
3844
  def get(self):
2518
- """ """
3845
+ """Returns the value of the custom property assigned to key or default
3846
+ when not found (matches Python's dictionary function of the same name).
3847
+
3848
+ """
2519
3849
  ...
2520
3850
 
2521
3851
  def id_properties_clear(self):
2522
- """ """
3852
+ """
3853
+
3854
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3855
+ """
2523
3856
  ...
2524
3857
 
2525
3858
  def id_properties_ensure(self):
2526
- """ """
3859
+ """
3860
+
3861
+ :return: the parent group for an RNA struct's custom IDProperties.
3862
+ """
2527
3863
  ...
2528
3864
 
2529
3865
  def id_properties_ui(self):
2530
- """ """
3866
+ """
3867
+
3868
+ :return: Return an object used to manage an IDProperty's UI data.
3869
+ """
2531
3870
  ...
2532
3871
 
2533
3872
  def is_extended(self):
2534
3873
  """ """
2535
3874
  ...
2536
3875
 
2537
- def is_property_hidden(self):
2538
- """ """
3876
+ def is_property_hidden(self) -> bool:
3877
+ """Check if a property is hidden.
3878
+
3879
+ :return: True when the property is hidden.
3880
+ :rtype: bool
3881
+ """
2539
3882
  ...
2540
3883
 
2541
- def is_property_overridable_library(self):
2542
- """ """
3884
+ def is_property_overridable_library(self) -> bool:
3885
+ """Check if a property is overridable.
3886
+
3887
+ :return: True when the property is overridable.
3888
+ :rtype: bool
3889
+ """
2543
3890
  ...
2544
3891
 
2545
- def is_property_readonly(self):
2546
- """ """
3892
+ def is_property_readonly(self) -> bool:
3893
+ """Check if a property is readonly.
3894
+
3895
+ :return: True when the property is readonly (not writable).
3896
+ :rtype: bool
3897
+ """
2547
3898
  ...
2548
3899
 
2549
- def is_property_set(self):
2550
- """ """
3900
+ def is_property_set(self) -> bool:
3901
+ """Check if a property is set, use for testing operator properties.
3902
+
3903
+ :return: True when the property has been set.
3904
+ :rtype: bool
3905
+ """
2551
3906
  ...
2552
3907
 
2553
3908
  def items(self):
2554
- """ """
3909
+ """Returns the items of this objects custom properties (matches Python's
3910
+ dictionary function of the same name).
3911
+
3912
+ :return: custom property key, value pairs.
3913
+ """
2555
3914
  ...
2556
3915
 
2557
- def keyframe_delete(self):
2558
- """ """
3916
+ def keyframe_delete(self) -> bool:
3917
+ """Remove a keyframe from this properties fcurve.
3918
+
3919
+ :return: Success of keyframe deletion.
3920
+ :rtype: bool
3921
+ """
2559
3922
  ...
2560
3923
 
2561
- def keyframe_insert(self):
2562
- """ """
3924
+ def keyframe_insert(self) -> bool:
3925
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3926
+
3927
+ :return: Success of keyframe insertion.
3928
+ :rtype: bool
3929
+ """
2563
3930
  ...
2564
3931
 
2565
3932
  def keys(self):
2566
- """ """
3933
+ """Returns the keys of this objects custom properties (matches Python's
3934
+ dictionary function of the same name).
3935
+
3936
+ :return: custom property keys.
3937
+ """
2567
3938
  ...
2568
3939
 
2569
- def path_from_id(self):
2570
- """ """
3940
+ def path_from_id(self) -> str:
3941
+ """Returns the data path from the ID to this object (string).
3942
+
3943
+ :return: The path from `bpy.types.bpy_struct.id_data`
3944
+ to this struct and property (when given).
3945
+ :rtype: str
3946
+ """
2571
3947
  ...
2572
3948
 
2573
3949
  def path_resolve(self):
2574
- """ """
3950
+ """Returns the property from the path, raise an exception when not found."""
2575
3951
  ...
2576
3952
 
2577
3953
  def poll(self, context):
@@ -2582,37 +3958,53 @@ class VIEWLAYER_PT_layer_passes_aov(
2582
3958
  ...
2583
3959
 
2584
3960
  def pop(self):
2585
- """ """
3961
+ """Remove and return the value of the custom property assigned to key or default
3962
+ when not found (matches Python's dictionary function of the same name).
3963
+
3964
+ """
2586
3965
  ...
2587
3966
 
2588
3967
  def prepend(self, draw_func):
2589
- """
3968
+ """Prepend a draw function to this menu, takes the same arguments as
3969
+ the menus draw function
2590
3970
 
2591
- :param draw_func:
3971
+ :param draw_func:
2592
3972
  """
2593
3973
  ...
2594
3974
 
2595
- def property_overridable_library_set(self):
2596
- """ """
3975
+ def property_overridable_library_set(self) -> bool:
3976
+ """Define a property as overridable or not (only for custom properties!).
3977
+
3978
+ :return: True when the overridable status of the property was successfully set.
3979
+ :rtype: bool
3980
+ """
2597
3981
  ...
2598
3982
 
2599
3983
  def property_unset(self):
2600
- """ """
3984
+ """Unset a property, will use default value afterward."""
2601
3985
  ...
2602
3986
 
2603
3987
  def remove(self, draw_func):
2604
- """
3988
+ """Remove a draw function that has been added to this menu
2605
3989
 
2606
3990
  :param draw_func:
2607
3991
  """
2608
3992
  ...
2609
3993
 
2610
3994
  def type_recast(self):
2611
- """ """
3995
+ """Return a new instance, this is needed because types
3996
+ such as textures can be changed at runtime.
3997
+
3998
+ :return: a new instance of this object with the type initialized again.
3999
+ """
2612
4000
  ...
2613
4001
 
2614
4002
  def values(self):
2615
- """ """
4003
+ """Returns the values of this objects custom properties (matches Python's
4004
+ dictionary function of the same name).
4005
+
4006
+ :return: custom property values.
4007
+ """
2616
4008
  ...
2617
4009
 
2618
4010
  class VIEWLAYER_PT_layer_passes_cryptomatte(
@@ -2648,22 +4040,35 @@ class VIEWLAYER_PT_layer_passes_cryptomatte(
2648
4040
  """ """
2649
4041
 
2650
4042
  def append(self, draw_func):
2651
- """
4043
+ """Append a draw function to this menu,
4044
+ takes the same arguments as the menus draw function
2652
4045
 
2653
- :param draw_func:
4046
+ :param draw_func:
2654
4047
  """
2655
4048
  ...
2656
4049
 
2657
- def as_pointer(self):
2658
- """ """
4050
+ def as_pointer(self) -> int:
4051
+ """Returns the memory address which holds a pointer to Blender's internal data
4052
+
4053
+ :return: int (memory address).
4054
+ :rtype: int
4055
+ """
2659
4056
  ...
2660
4057
 
2661
- def bl_rna_get_subclass(self):
2662
- """ """
4058
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4059
+ """
4060
+
4061
+ :return: The RNA type or default when not found.
4062
+ :rtype: bpy.types.Struct
4063
+ """
2663
4064
  ...
2664
4065
 
2665
- def bl_rna_get_subclass_py(self):
2666
- """ """
4066
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4067
+ """
4068
+
4069
+ :return: The class or default when not found.
4070
+ :rtype: typing.Any
4071
+ """
2667
4072
  ...
2668
4073
 
2669
4074
  def draw(self, context):
@@ -2673,72 +4078,129 @@ class VIEWLAYER_PT_layer_passes_cryptomatte(
2673
4078
  """
2674
4079
  ...
2675
4080
 
2676
- def driver_add(self):
2677
- """ """
4081
+ def driver_add(self) -> bpy.types.FCurve:
4082
+ """Adds driver(s) to the given property
4083
+
4084
+ :return: The driver(s) added.
4085
+ :rtype: bpy.types.FCurve
4086
+ """
2678
4087
  ...
2679
4088
 
2680
- def driver_remove(self):
2681
- """ """
4089
+ def driver_remove(self) -> bool:
4090
+ """Remove driver(s) from the given property
4091
+
4092
+ :return: Success of driver removal.
4093
+ :rtype: bool
4094
+ """
2682
4095
  ...
2683
4096
 
2684
4097
  def get(self):
2685
- """ """
4098
+ """Returns the value of the custom property assigned to key or default
4099
+ when not found (matches Python's dictionary function of the same name).
4100
+
4101
+ """
2686
4102
  ...
2687
4103
 
2688
4104
  def id_properties_clear(self):
2689
- """ """
4105
+ """
4106
+
4107
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4108
+ """
2690
4109
  ...
2691
4110
 
2692
4111
  def id_properties_ensure(self):
2693
- """ """
4112
+ """
4113
+
4114
+ :return: the parent group for an RNA struct's custom IDProperties.
4115
+ """
2694
4116
  ...
2695
4117
 
2696
4118
  def id_properties_ui(self):
2697
- """ """
4119
+ """
4120
+
4121
+ :return: Return an object used to manage an IDProperty's UI data.
4122
+ """
2698
4123
  ...
2699
4124
 
2700
4125
  def is_extended(self):
2701
4126
  """ """
2702
4127
  ...
2703
4128
 
2704
- def is_property_hidden(self):
2705
- """ """
4129
+ def is_property_hidden(self) -> bool:
4130
+ """Check if a property is hidden.
4131
+
4132
+ :return: True when the property is hidden.
4133
+ :rtype: bool
4134
+ """
2706
4135
  ...
2707
4136
 
2708
- def is_property_overridable_library(self):
2709
- """ """
4137
+ def is_property_overridable_library(self) -> bool:
4138
+ """Check if a property is overridable.
4139
+
4140
+ :return: True when the property is overridable.
4141
+ :rtype: bool
4142
+ """
2710
4143
  ...
2711
4144
 
2712
- def is_property_readonly(self):
2713
- """ """
4145
+ def is_property_readonly(self) -> bool:
4146
+ """Check if a property is readonly.
4147
+
4148
+ :return: True when the property is readonly (not writable).
4149
+ :rtype: bool
4150
+ """
2714
4151
  ...
2715
4152
 
2716
- def is_property_set(self):
2717
- """ """
4153
+ def is_property_set(self) -> bool:
4154
+ """Check if a property is set, use for testing operator properties.
4155
+
4156
+ :return: True when the property has been set.
4157
+ :rtype: bool
4158
+ """
2718
4159
  ...
2719
4160
 
2720
4161
  def items(self):
2721
- """ """
4162
+ """Returns the items of this objects custom properties (matches Python's
4163
+ dictionary function of the same name).
4164
+
4165
+ :return: custom property key, value pairs.
4166
+ """
2722
4167
  ...
2723
4168
 
2724
- def keyframe_delete(self):
2725
- """ """
4169
+ def keyframe_delete(self) -> bool:
4170
+ """Remove a keyframe from this properties fcurve.
4171
+
4172
+ :return: Success of keyframe deletion.
4173
+ :rtype: bool
4174
+ """
2726
4175
  ...
2727
4176
 
2728
- def keyframe_insert(self):
2729
- """ """
4177
+ def keyframe_insert(self) -> bool:
4178
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4179
+
4180
+ :return: Success of keyframe insertion.
4181
+ :rtype: bool
4182
+ """
2730
4183
  ...
2731
4184
 
2732
4185
  def keys(self):
2733
- """ """
4186
+ """Returns the keys of this objects custom properties (matches Python's
4187
+ dictionary function of the same name).
4188
+
4189
+ :return: custom property keys.
4190
+ """
2734
4191
  ...
2735
4192
 
2736
- def path_from_id(self):
2737
- """ """
4193
+ def path_from_id(self) -> str:
4194
+ """Returns the data path from the ID to this object (string).
4195
+
4196
+ :return: The path from `bpy.types.bpy_struct.id_data`
4197
+ to this struct and property (when given).
4198
+ :rtype: str
4199
+ """
2738
4200
  ...
2739
4201
 
2740
4202
  def path_resolve(self):
2741
- """ """
4203
+ """Returns the property from the path, raise an exception when not found."""
2742
4204
  ...
2743
4205
 
2744
4206
  def poll(self, context):
@@ -2749,37 +4211,53 @@ class VIEWLAYER_PT_layer_passes_cryptomatte(
2749
4211
  ...
2750
4212
 
2751
4213
  def pop(self):
2752
- """ """
4214
+ """Remove and return the value of the custom property assigned to key or default
4215
+ when not found (matches Python's dictionary function of the same name).
4216
+
4217
+ """
2753
4218
  ...
2754
4219
 
2755
4220
  def prepend(self, draw_func):
2756
- """
4221
+ """Prepend a draw function to this menu, takes the same arguments as
4222
+ the menus draw function
2757
4223
 
2758
- :param draw_func:
4224
+ :param draw_func:
2759
4225
  """
2760
4226
  ...
2761
4227
 
2762
- def property_overridable_library_set(self):
2763
- """ """
4228
+ def property_overridable_library_set(self) -> bool:
4229
+ """Define a property as overridable or not (only for custom properties!).
4230
+
4231
+ :return: True when the overridable status of the property was successfully set.
4232
+ :rtype: bool
4233
+ """
2764
4234
  ...
2765
4235
 
2766
4236
  def property_unset(self):
2767
- """ """
4237
+ """Unset a property, will use default value afterward."""
2768
4238
  ...
2769
4239
 
2770
4240
  def remove(self, draw_func):
2771
- """
4241
+ """Remove a draw function that has been added to this menu
2772
4242
 
2773
4243
  :param draw_func:
2774
4244
  """
2775
4245
  ...
2776
4246
 
2777
4247
  def type_recast(self):
2778
- """ """
4248
+ """Return a new instance, this is needed because types
4249
+ such as textures can be changed at runtime.
4250
+
4251
+ :return: a new instance of this object with the type initialized again.
4252
+ """
2779
4253
  ...
2780
4254
 
2781
4255
  def values(self):
2782
- """ """
4256
+ """Returns the values of this objects custom properties (matches Python's
4257
+ dictionary function of the same name).
4258
+
4259
+ :return: custom property values.
4260
+ """
2783
4261
  ...
2784
4262
 
2785
4263
  class VIEWLAYER_PT_layer_passes_lightgroups(
@@ -2815,22 +4293,35 @@ class VIEWLAYER_PT_layer_passes_lightgroups(
2815
4293
  """ """
2816
4294
 
2817
4295
  def append(self, draw_func):
2818
- """
4296
+ """Append a draw function to this menu,
4297
+ takes the same arguments as the menus draw function
2819
4298
 
2820
- :param draw_func:
4299
+ :param draw_func:
2821
4300
  """
2822
4301
  ...
2823
4302
 
2824
- def as_pointer(self):
2825
- """ """
4303
+ def as_pointer(self) -> int:
4304
+ """Returns the memory address which holds a pointer to Blender's internal data
4305
+
4306
+ :return: int (memory address).
4307
+ :rtype: int
4308
+ """
2826
4309
  ...
2827
4310
 
2828
- def bl_rna_get_subclass(self):
2829
- """ """
4311
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4312
+ """
4313
+
4314
+ :return: The RNA type or default when not found.
4315
+ :rtype: bpy.types.Struct
4316
+ """
2830
4317
  ...
2831
4318
 
2832
- def bl_rna_get_subclass_py(self):
2833
- """ """
4319
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4320
+ """
4321
+
4322
+ :return: The class or default when not found.
4323
+ :rtype: typing.Any
4324
+ """
2834
4325
  ...
2835
4326
 
2836
4327
  def draw(self, context):
@@ -2840,72 +4331,129 @@ class VIEWLAYER_PT_layer_passes_lightgroups(
2840
4331
  """
2841
4332
  ...
2842
4333
 
2843
- def driver_add(self):
2844
- """ """
4334
+ def driver_add(self) -> bpy.types.FCurve:
4335
+ """Adds driver(s) to the given property
4336
+
4337
+ :return: The driver(s) added.
4338
+ :rtype: bpy.types.FCurve
4339
+ """
2845
4340
  ...
2846
4341
 
2847
- def driver_remove(self):
2848
- """ """
4342
+ def driver_remove(self) -> bool:
4343
+ """Remove driver(s) from the given property
4344
+
4345
+ :return: Success of driver removal.
4346
+ :rtype: bool
4347
+ """
2849
4348
  ...
2850
4349
 
2851
4350
  def get(self):
2852
- """ """
4351
+ """Returns the value of the custom property assigned to key or default
4352
+ when not found (matches Python's dictionary function of the same name).
4353
+
4354
+ """
2853
4355
  ...
2854
4356
 
2855
4357
  def id_properties_clear(self):
2856
- """ """
4358
+ """
4359
+
4360
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4361
+ """
2857
4362
  ...
2858
4363
 
2859
4364
  def id_properties_ensure(self):
2860
- """ """
4365
+ """
4366
+
4367
+ :return: the parent group for an RNA struct's custom IDProperties.
4368
+ """
2861
4369
  ...
2862
4370
 
2863
4371
  def id_properties_ui(self):
2864
- """ """
4372
+ """
4373
+
4374
+ :return: Return an object used to manage an IDProperty's UI data.
4375
+ """
2865
4376
  ...
2866
4377
 
2867
4378
  def is_extended(self):
2868
4379
  """ """
2869
4380
  ...
2870
4381
 
2871
- def is_property_hidden(self):
2872
- """ """
4382
+ def is_property_hidden(self) -> bool:
4383
+ """Check if a property is hidden.
4384
+
4385
+ :return: True when the property is hidden.
4386
+ :rtype: bool
4387
+ """
2873
4388
  ...
2874
4389
 
2875
- def is_property_overridable_library(self):
2876
- """ """
4390
+ def is_property_overridable_library(self) -> bool:
4391
+ """Check if a property is overridable.
4392
+
4393
+ :return: True when the property is overridable.
4394
+ :rtype: bool
4395
+ """
2877
4396
  ...
2878
4397
 
2879
- def is_property_readonly(self):
2880
- """ """
4398
+ def is_property_readonly(self) -> bool:
4399
+ """Check if a property is readonly.
4400
+
4401
+ :return: True when the property is readonly (not writable).
4402
+ :rtype: bool
4403
+ """
2881
4404
  ...
2882
4405
 
2883
- def is_property_set(self):
2884
- """ """
4406
+ def is_property_set(self) -> bool:
4407
+ """Check if a property is set, use for testing operator properties.
4408
+
4409
+ :return: True when the property has been set.
4410
+ :rtype: bool
4411
+ """
2885
4412
  ...
2886
4413
 
2887
4414
  def items(self):
2888
- """ """
4415
+ """Returns the items of this objects custom properties (matches Python's
4416
+ dictionary function of the same name).
4417
+
4418
+ :return: custom property key, value pairs.
4419
+ """
2889
4420
  ...
2890
4421
 
2891
- def keyframe_delete(self):
2892
- """ """
4422
+ def keyframe_delete(self) -> bool:
4423
+ """Remove a keyframe from this properties fcurve.
4424
+
4425
+ :return: Success of keyframe deletion.
4426
+ :rtype: bool
4427
+ """
2893
4428
  ...
2894
4429
 
2895
- def keyframe_insert(self):
2896
- """ """
4430
+ def keyframe_insert(self) -> bool:
4431
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4432
+
4433
+ :return: Success of keyframe insertion.
4434
+ :rtype: bool
4435
+ """
2897
4436
  ...
2898
4437
 
2899
4438
  def keys(self):
2900
- """ """
4439
+ """Returns the keys of this objects custom properties (matches Python's
4440
+ dictionary function of the same name).
4441
+
4442
+ :return: custom property keys.
4443
+ """
2901
4444
  ...
2902
4445
 
2903
- def path_from_id(self):
2904
- """ """
4446
+ def path_from_id(self) -> str:
4447
+ """Returns the data path from the ID to this object (string).
4448
+
4449
+ :return: The path from `bpy.types.bpy_struct.id_data`
4450
+ to this struct and property (when given).
4451
+ :rtype: str
4452
+ """
2905
4453
  ...
2906
4454
 
2907
4455
  def path_resolve(self):
2908
- """ """
4456
+ """Returns the property from the path, raise an exception when not found."""
2909
4457
  ...
2910
4458
 
2911
4459
  def poll(self, context):
@@ -2916,35 +4464,51 @@ class VIEWLAYER_PT_layer_passes_lightgroups(
2916
4464
  ...
2917
4465
 
2918
4466
  def pop(self):
2919
- """ """
4467
+ """Remove and return the value of the custom property assigned to key or default
4468
+ when not found (matches Python's dictionary function of the same name).
4469
+
4470
+ """
2920
4471
  ...
2921
4472
 
2922
4473
  def prepend(self, draw_func):
2923
- """
4474
+ """Prepend a draw function to this menu, takes the same arguments as
4475
+ the menus draw function
2924
4476
 
2925
- :param draw_func:
4477
+ :param draw_func:
2926
4478
  """
2927
4479
  ...
2928
4480
 
2929
- def property_overridable_library_set(self):
2930
- """ """
4481
+ def property_overridable_library_set(self) -> bool:
4482
+ """Define a property as overridable or not (only for custom properties!).
4483
+
4484
+ :return: True when the overridable status of the property was successfully set.
4485
+ :rtype: bool
4486
+ """
2931
4487
  ...
2932
4488
 
2933
4489
  def property_unset(self):
2934
- """ """
4490
+ """Unset a property, will use default value afterward."""
2935
4491
  ...
2936
4492
 
2937
4493
  def remove(self, draw_func):
2938
- """
4494
+ """Remove a draw function that has been added to this menu
2939
4495
 
2940
4496
  :param draw_func:
2941
4497
  """
2942
4498
  ...
2943
4499
 
2944
4500
  def type_recast(self):
2945
- """ """
4501
+ """Return a new instance, this is needed because types
4502
+ such as textures can be changed at runtime.
4503
+
4504
+ :return: a new instance of this object with the type initialized again.
4505
+ """
2946
4506
  ...
2947
4507
 
2948
4508
  def values(self):
2949
- """ """
4509
+ """Returns the values of this objects custom properties (matches Python's
4510
+ dictionary function of the same name).
4511
+
4512
+ :return: custom property values.
4513
+ """
2950
4514
  ...