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

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

Potentially problematic release.


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

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