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

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

Potentially problematic release.


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

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