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

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

Potentially problematic release.


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

Files changed (549) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +17 -84
  2. addon_utils/__init__.pyi +44 -38
  3. animsys_refactor/__init__.pyi +7 -27
  4. aud/__init__.pyi +8 -11
  5. bgl/__init__.pyi +121 -1812
  6. bl_app_override/__init__.pyi +8 -19
  7. bl_app_override/helpers/__init__.pyi +5 -23
  8. bl_app_template_utils/__init__.pyi +5 -17
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
  14. bl_i18n_utils/merge_po/__init__.pyi +1 -4
  15. bl_i18n_utils/settings/__init__.pyi +6 -24
  16. bl_i18n_utils/utils/__init__.pyi +93 -122
  17. bl_i18n_utils/utils_cli/__init__.pyi +6 -29
  18. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
  19. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  20. bl_keymap_utils/io/__init__.pyi +9 -40
  21. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  22. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
  23. bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
  24. bl_keymap_utils/versioning/__init__.pyi +1 -4
  25. bl_operators/__init__.pyi +2 -9
  26. bl_operators/add_mesh_torus/__init__.pyi +128 -59
  27. bl_operators/anim/__init__.pyi +1001 -398
  28. bl_operators/assets/__init__.pyi +376 -152
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
  30. bl_operators/clip/__init__.pyi +1264 -532
  31. bl_operators/console/__init__.pyi +626 -242
  32. bl_operators/constraint/__init__.pyi +502 -201
  33. bl_operators/file/__init__.pyi +376 -150
  34. bl_operators/freestyle/__init__.pyi +501 -200
  35. bl_operators/geometry_nodes/__init__.pyi +514 -266
  36. bl_operators/image/__init__.pyi +621 -251
  37. bl_operators/mesh/__init__.pyi +376 -150
  38. bl_operators/node/__init__.pyi +1253 -516
  39. bl_operators/object/__init__.pyi +1879 -755
  40. bl_operators/object_align/__init__.pyi +129 -64
  41. bl_operators/object_quick_effects/__init__.pyi +504 -213
  42. bl_operators/object_randomize_transform/__init__.pyi +129 -54
  43. bl_operators/presets/__init__.pyi +3072 -1403
  44. bl_operators/rigidbody/__init__.pyi +376 -150
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
  46. bl_operators/sequencer/__init__.pyi +1010 -434
  47. bl_operators/spreadsheet/__init__.pyi +126 -50
  48. bl_operators/userpref/__init__.pyi +3253 -1267
  49. bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
  50. bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
  51. bl_operators/uvcalc_transform/__init__.pyi +297 -159
  52. bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
  53. bl_operators/view3d/__init__.pyi +868 -342
  54. bl_operators/wm/__init__.pyi +5795 -2388
  55. bl_operators/world/__init__.pyi +126 -50
  56. bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
  57. bl_rna_utils/data_path/__init__.pyi +8 -4
  58. bl_text_utils/external_editor/__init__.pyi +1 -4
  59. bl_ui/__init__.pyi +366 -269
  60. bl_ui/anim/__init__.pyi +164 -74
  61. bl_ui/asset_shelf/__init__.pyi +129 -56
  62. bl_ui/generic_ui_list/__init__.pyi +412 -163
  63. bl_ui/node_add_menu/__init__.pyi +171 -94
  64. bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
  65. bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
  66. bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
  67. bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
  68. bl_ui/properties_animviz/__init__.pyi +2 -16
  69. bl_ui/properties_collection/__init__.pyi +807 -379
  70. bl_ui/properties_constraint/__init__.pyi +10292 -4941
  71. bl_ui/properties_data_armature/__init__.pyi +1615 -753
  72. bl_ui/properties_data_bone/__init__.pyi +1284 -608
  73. bl_ui/properties_data_camera/__init__.pyi +1854 -927
  74. bl_ui/properties_data_curve/__init__.pyi +1927 -937
  75. bl_ui/properties_data_curves/__init__.pyi +806 -375
  76. bl_ui/properties_data_empty/__init__.pyi +257 -125
  77. bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
  79. bl_ui/properties_data_lattice/__init__.pyi +388 -188
  80. bl_ui/properties_data_light/__init__.pyi +1540 -756
  81. bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
  82. bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
  83. bl_ui/properties_data_metaball/__init__.pyi +644 -308
  84. bl_ui/properties_data_modifier/__init__.pyi +1353 -671
  85. bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
  86. bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
  87. bl_ui/properties_data_speaker/__init__.pyi +644 -316
  88. bl_ui/properties_data_volume/__init__.pyi +1028 -484
  89. bl_ui/properties_freestyle/__init__.pyi +3112 -1619
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
  91. bl_ui/properties_mask_common/__init__.pyi +1102 -523
  92. bl_ui/properties_material/__init__.pyi +2089 -1009
  93. bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
  94. bl_ui/properties_object/__init__.pyi +1832 -873
  95. bl_ui/properties_output/__init__.pyi +2405 -1173
  96. bl_ui/properties_paint_common/__init__.pyi +416 -386
  97. bl_ui/properties_particle/__init__.pyi +6740 -3346
  98. bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
  99. bl_ui/properties_physics_common/__init__.pyi +135 -98
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
  101. bl_ui/properties_physics_field/__init__.pyi +1282 -627
  102. bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
  106. bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
  107. bl_ui/properties_render/__init__.pyi +6843 -3367
  108. bl_ui/properties_scene/__init__.pyi +1924 -913
  109. bl_ui/properties_texture/__init__.pyi +3371 -1667
  110. bl_ui/properties_view_layer/__init__.pyi +2344 -1107
  111. bl_ui/properties_workspace/__init__.pyi +516 -244
  112. bl_ui/properties_world/__init__.pyi +1284 -630
  113. bl_ui/space_clip/__init__.pyi +10172 -4695
  114. bl_ui/space_console/__init__.pyi +940 -423
  115. bl_ui/space_dopesheet/__init__.pyi +4325 -2013
  116. bl_ui/space_filebrowser/__init__.pyi +4172 -1903
  117. bl_ui/space_graph/__init__.pyi +3107 -1394
  118. bl_ui/space_image/__init__.pyi +9764 -4614
  119. bl_ui/space_info/__init__.pyi +939 -421
  120. bl_ui/space_nla/__init__.pyi +2623 -1183
  121. bl_ui/space_node/__init__.pyi +3995 -1840
  122. bl_ui/space_outliner/__init__.pyi +2203 -991
  123. bl_ui/space_properties/__init__.pyi +386 -165
  124. bl_ui/space_sequencer/__init__.pyi +10809 -4978
  125. bl_ui/space_spreadsheet/__init__.pyi +130 -53
  126. bl_ui/space_statusbar/__init__.pyi +129 -52
  127. bl_ui/space_text/__init__.pyi +2457 -1100
  128. bl_ui/space_time/__init__.pyi +1034 -481
  129. bl_ui/space_toolsystem_common/__init__.pyi +56 -211
  130. bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
  131. bl_ui/space_topbar/__init__.pyi +3982 -1805
  132. bl_ui/space_userpref/__init__.pyi +11383 -5290
  133. bl_ui/space_view3d/__init__.pyi +40873 -18532
  134. bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
  135. bl_ui/temp_anim_layers/__init__.pyi +130 -62
  136. bl_ui/utils/__init__.pyi +28 -27
  137. bl_ui_utils/bug_report_url/__init__.pyi +1 -4
  138. bl_ui_utils/layout/__init__.pyi +1 -1
  139. blend_render_info/__init__.pyi +3 -10
  140. blf/__init__.pyi +4 -4
  141. bmesh/geometry/__init__.pyi +2 -3
  142. bmesh/ops/__init__.pyi +372 -419
  143. bmesh/types/__init__.pyi +39 -56
  144. bmesh/utils/__init__.pyi +10 -13
  145. bpy/app/__init__.pyi +4 -4
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -8
  148. bpy/app/timers/__init__.pyi +10 -10
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +2 -4
  151. bpy/ops/action/__init__.pyi +316 -394
  152. bpy/ops/anim/__init__.pyi +442 -548
  153. bpy/ops/armature/__init__.pyi +374 -470
  154. bpy/ops/asset/__init__.pyi +152 -184
  155. bpy/ops/bl_pkg/__init__.pyi +221 -272
  156. bpy/ops/boid/__init__.pyi +50 -66
  157. bpy/ops/brush/__init__.pyi +72 -90
  158. bpy/ops/buttons/__init__.pyi +132 -144
  159. bpy/ops/cachefile/__init__.pyi +128 -138
  160. bpy/ops/camera/__init__.pyi +26 -30
  161. bpy/ops/clip/__init__.pyi +777 -964
  162. bpy/ops/cloth/__init__.pyi +12 -14
  163. bpy/ops/collection/__init__.pyi +68 -86
  164. bpy/ops/console/__init__.pyi +158 -200
  165. bpy/ops/constraint/__init__.pyi +178 -214
  166. bpy/ops/curve/__init__.pyi +473 -576
  167. bpy/ops/curves/__init__.pyi +247 -302
  168. bpy/ops/cycles/__init__.pyi +28 -34
  169. bpy/ops/dpaint/__init__.pyi +34 -44
  170. bpy/ops/ed/__init__.pyi +126 -150
  171. bpy/ops/export_anim/__init__.pyi +22 -24
  172. bpy/ops/export_scene/__init__.pyi +302 -336
  173. bpy/ops/file/__init__.pyi +352 -432
  174. bpy/ops/fluid/__init__.pyi +90 -118
  175. bpy/ops/font/__init__.pyi +258 -304
  176. bpy/ops/geometry/__init__.pyi +100 -120
  177. bpy/ops/gizmogroup/__init__.pyi +22 -26
  178. bpy/ops/gpencil/__init__.pyi +1469 -1778
  179. bpy/ops/graph/__init__.pyi +644 -776
  180. bpy/ops/grease_pencil/__init__.pyi +597 -748
  181. bpy/ops/image/__init__.pyi +648 -744
  182. bpy/ops/import_anim/__init__.pyi +30 -32
  183. bpy/ops/import_curve/__init__.pyi +10 -12
  184. bpy/ops/import_scene/__init__.pyi +88 -96
  185. bpy/ops/info/__init__.pyi +60 -74
  186. bpy/ops/lattice/__init__.pyi +64 -80
  187. bpy/ops/marker/__init__.pyi +108 -130
  188. bpy/ops/mask/__init__.pyi +322 -402
  189. bpy/ops/material/__init__.pyi +18 -24
  190. bpy/ops/mball/__init__.pyi +70 -86
  191. bpy/ops/mesh/__init__.pyi +1986 -2322
  192. bpy/ops/nla/__init__.pyi +333 -411
  193. bpy/ops/node/__init__.pyi +886 -1100
  194. bpy/ops/object/__init__.pyi +2585 -3078
  195. bpy/ops/outliner/__init__.pyi +498 -636
  196. bpy/ops/paint/__init__.pyi +565 -680
  197. bpy/ops/paintcurve/__init__.pyi +64 -80
  198. bpy/ops/palette/__init__.pyi +50 -64
  199. bpy/ops/particle/__init__.pyi +267 -340
  200. bpy/ops/pose/__init__.pyi +336 -414
  201. bpy/ops/poselib/__init__.pyi +72 -90
  202. bpy/ops/preferences/__init__.pyi +386 -463
  203. bpy/ops/ptcache/__init__.pyi +46 -60
  204. bpy/ops/render/__init__.pyi +130 -154
  205. bpy/ops/rigidbody/__init__.pyi +102 -128
  206. bpy/ops/scene/__init__.pyi +280 -358
  207. bpy/ops/screen/__init__.pyi +382 -460
  208. bpy/ops/script/__init__.pyi +24 -30
  209. bpy/ops/sculpt/__init__.pyi +458 -532
  210. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  211. bpy/ops/sequencer/__init__.pyi +1066 -1244
  212. bpy/ops/sound/__init__.pyi +216 -230
  213. bpy/ops/spreadsheet/__init__.pyi +30 -38
  214. bpy/ops/surface/__init__.pyi +108 -120
  215. bpy/ops/text/__init__.pyi +390 -476
  216. bpy/ops/text_editor/__init__.pyi +12 -14
  217. bpy/ops/texture/__init__.pyi +26 -34
  218. bpy/ops/transform/__init__.pyi +792 -878
  219. bpy/ops/ui/__init__.pyi +228 -294
  220. bpy/ops/uilist/__init__.pyi +32 -38
  221. bpy/ops/uv/__init__.pyi +602 -704
  222. bpy/ops/view2d/__init__.pyi +156 -184
  223. bpy/ops/view3d/__init__.pyi +582 -718
  224. bpy/ops/wm/__init__.pyi +2683 -2928
  225. bpy/ops/workspace/__init__.pyi +46 -60
  226. bpy/ops/world/__init__.pyi +12 -16
  227. bpy/path/__init__.pyi +179 -75
  228. bpy/props/__init__.pyi +261 -263
  229. bpy/types/__init__.pyi +17058 -26311
  230. bpy/utils/__init__.pyi +247 -179
  231. bpy/utils/previews/__init__.pyi +58 -28
  232. bpy/utils/units/__init__.pyi +20 -20
  233. bpy_extras/anim_utils/__init__.pyi +68 -29
  234. bpy_extras/asset_utils/__init__.pyi +0 -10
  235. bpy_extras/bmesh_utils/__init__.pyi +9 -6
  236. bpy_extras/extensions/junction_module/__init__.pyi +6 -8
  237. bpy_extras/id_map_utils/__init__.pyi +3 -3
  238. bpy_extras/image_utils/__init__.pyi +44 -11
  239. bpy_extras/io_utils/__init__.pyi +116 -41
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -11
  241. bpy_extras/mesh_utils/__init__.pyi +71 -19
  242. bpy_extras/node_shader_utils/__init__.pyi +52 -288
  243. bpy_extras/node_utils/__init__.pyi +10 -10
  244. bpy_extras/object_utils/__init__.pyi +71 -14
  245. bpy_extras/view3d_utils/__init__.pyi +80 -10
  246. bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
  247. bpy_restrict_state/__init__.pyi +1 -14
  248. bpy_types/__init__.pyi +4203 -1605
  249. console_python/__init__.pyi +12 -37
  250. console_shell/__init__.pyi +5 -24
  251. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20240518.dist-info/RECORD +353 -0
  253. freestyle/chainingiterators/__init__.pyi +14 -44
  254. freestyle/functions/__init__.pyi +7 -33
  255. freestyle/predicates/__init__.pyi +44 -217
  256. freestyle/shaders/__init__.pyi +2 -12
  257. freestyle/types/__init__.pyi +84 -96
  258. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  259. freestyle/utils/__init__.pyi +6 -18
  260. gpu/matrix/__init__.pyi +6 -8
  261. gpu/state/__init__.pyi +2 -2
  262. gpu/types/__init__.pyi +12 -12
  263. gpu_extras/presets/__init__.pyi +2 -5
  264. graphviz_export/__init__.pyi +4 -9
  265. idprop/types/__init__.pyi +8 -35
  266. imbuf/__init__.pyi +4 -4
  267. imbuf/types/__init__.pyi +0 -2
  268. keyingsets_builtins/__init__.pyi +2692 -997
  269. keyingsets_utils/__init__.pyi +14 -69
  270. mathutils/__init__.pyi +194 -238
  271. mathutils/bvhtree/__init__.pyi +4 -6
  272. mathutils/geometry/__init__.pyi +153 -155
  273. mathutils/kdtree/__init__.pyi +8 -12
  274. mathutils/noise/__init__.pyi +26 -26
  275. nodeitems_builtins/__init__.pyi +5 -30
  276. nodeitems_utils/__init__.pyi +8 -45
  277. rna_info/__init__.pyi +39 -215
  278. rna_keymap_ui/__init__.pyi +6 -29
  279. rna_prop_ui/__init__.pyi +24 -62
  280. rna_xml/__init__.pyi +16 -39
  281. sys_info/__init__.pyi +1 -4
  282. _bpy_internal/freedesktop/py.typed +0 -0
  283. bl_app_override/helpers/py.typed +0 -0
  284. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  285. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  286. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  287. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  288. bl_console_utils/autocomplete/py.typed +0 -0
  289. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  290. bl_i18n_utils/merge_po/py.typed +0 -0
  291. bl_i18n_utils/settings/py.typed +0 -0
  292. bl_i18n_utils/utils/py.typed +0 -0
  293. bl_i18n_utils/utils_cli/py.typed +0 -0
  294. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  295. bl_i18n_utils/utils_rtl/py.typed +0 -0
  296. bl_keymap_utils/io/py.typed +0 -0
  297. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  298. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  299. bl_keymap_utils/platform_helpers/py.typed +0 -0
  300. bl_keymap_utils/versioning/py.typed +0 -0
  301. bl_operators/add_mesh_torus/py.typed +0 -0
  302. bl_operators/anim/py.typed +0 -0
  303. bl_operators/assets/py.typed +0 -0
  304. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  305. bl_operators/bmesh/py.typed +0 -0
  306. bl_operators/clip/py.typed +0 -0
  307. bl_operators/console/py.typed +0 -0
  308. bl_operators/constraint/py.typed +0 -0
  309. bl_operators/file/py.typed +0 -0
  310. bl_operators/freestyle/py.typed +0 -0
  311. bl_operators/geometry_nodes/py.typed +0 -0
  312. bl_operators/image/py.typed +0 -0
  313. bl_operators/mesh/py.typed +0 -0
  314. bl_operators/node/py.typed +0 -0
  315. bl_operators/object/py.typed +0 -0
  316. bl_operators/object_align/py.typed +0 -0
  317. bl_operators/object_quick_effects/py.typed +0 -0
  318. bl_operators/object_randomize_transform/py.typed +0 -0
  319. bl_operators/presets/py.typed +0 -0
  320. bl_operators/rigidbody/py.typed +0 -0
  321. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  322. bl_operators/sequencer/py.typed +0 -0
  323. bl_operators/spreadsheet/py.typed +0 -0
  324. bl_operators/userpref/py.typed +0 -0
  325. bl_operators/uvcalc_follow_active/py.typed +0 -0
  326. bl_operators/uvcalc_lightmap/py.typed +0 -0
  327. bl_operators/uvcalc_transform/py.typed +0 -0
  328. bl_operators/vertexpaint_dirt/py.typed +0 -0
  329. bl_operators/view3d/py.typed +0 -0
  330. bl_operators/wm/py.typed +0 -0
  331. bl_operators/world/py.typed +0 -0
  332. bl_previews_utils/bl_previews_render/py.typed +0 -0
  333. bl_rna_utils/data_path/py.typed +0 -0
  334. bl_text_utils/external_editor/py.typed +0 -0
  335. bl_ui/anim/py.typed +0 -0
  336. bl_ui/asset_shelf/py.typed +0 -0
  337. bl_ui/generic_ui_list/py.typed +0 -0
  338. bl_ui/node_add_menu/py.typed +0 -0
  339. bl_ui/node_add_menu_compositor/py.typed +0 -0
  340. bl_ui/node_add_menu_geometry/py.typed +0 -0
  341. bl_ui/node_add_menu_shader/py.typed +0 -0
  342. bl_ui/node_add_menu_texture/py.typed +0 -0
  343. bl_ui/properties_animviz/py.typed +0 -0
  344. bl_ui/properties_collection/py.typed +0 -0
  345. bl_ui/properties_constraint/py.typed +0 -0
  346. bl_ui/properties_data_armature/py.typed +0 -0
  347. bl_ui/properties_data_bone/py.typed +0 -0
  348. bl_ui/properties_data_camera/py.typed +0 -0
  349. bl_ui/properties_data_curve/py.typed +0 -0
  350. bl_ui/properties_data_curves/py.typed +0 -0
  351. bl_ui/properties_data_empty/py.typed +0 -0
  352. bl_ui/properties_data_gpencil/py.typed +0 -0
  353. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  354. bl_ui/properties_data_lattice/py.typed +0 -0
  355. bl_ui/properties_data_light/py.typed +0 -0
  356. bl_ui/properties_data_lightprobe/py.typed +0 -0
  357. bl_ui/properties_data_mesh/py.typed +0 -0
  358. bl_ui/properties_data_metaball/py.typed +0 -0
  359. bl_ui/properties_data_modifier/py.typed +0 -0
  360. bl_ui/properties_data_pointcloud/py.typed +0 -0
  361. bl_ui/properties_data_shaderfx/py.typed +0 -0
  362. bl_ui/properties_data_speaker/py.typed +0 -0
  363. bl_ui/properties_data_volume/py.typed +0 -0
  364. bl_ui/properties_freestyle/py.typed +0 -0
  365. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  366. bl_ui/properties_mask_common/py.typed +0 -0
  367. bl_ui/properties_material/py.typed +0 -0
  368. bl_ui/properties_material_gpencil/py.typed +0 -0
  369. bl_ui/properties_object/py.typed +0 -0
  370. bl_ui/properties_output/py.typed +0 -0
  371. bl_ui/properties_paint_common/py.typed +0 -0
  372. bl_ui/properties_particle/py.typed +0 -0
  373. bl_ui/properties_physics_cloth/py.typed +0 -0
  374. bl_ui/properties_physics_common/py.typed +0 -0
  375. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  376. bl_ui/properties_physics_field/py.typed +0 -0
  377. bl_ui/properties_physics_fluid/py.typed +0 -0
  378. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  379. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  380. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  381. bl_ui/properties_physics_softbody/py.typed +0 -0
  382. bl_ui/properties_render/py.typed +0 -0
  383. bl_ui/properties_scene/py.typed +0 -0
  384. bl_ui/properties_texture/py.typed +0 -0
  385. bl_ui/properties_view_layer/py.typed +0 -0
  386. bl_ui/properties_workspace/py.typed +0 -0
  387. bl_ui/properties_world/py.typed +0 -0
  388. bl_ui/space_clip/py.typed +0 -0
  389. bl_ui/space_console/py.typed +0 -0
  390. bl_ui/space_dopesheet/py.typed +0 -0
  391. bl_ui/space_filebrowser/py.typed +0 -0
  392. bl_ui/space_graph/py.typed +0 -0
  393. bl_ui/space_image/py.typed +0 -0
  394. bl_ui/space_info/py.typed +0 -0
  395. bl_ui/space_nla/py.typed +0 -0
  396. bl_ui/space_node/py.typed +0 -0
  397. bl_ui/space_outliner/py.typed +0 -0
  398. bl_ui/space_properties/py.typed +0 -0
  399. bl_ui/space_sequencer/py.typed +0 -0
  400. bl_ui/space_spreadsheet/py.typed +0 -0
  401. bl_ui/space_statusbar/py.typed +0 -0
  402. bl_ui/space_text/py.typed +0 -0
  403. bl_ui/space_time/py.typed +0 -0
  404. bl_ui/space_toolsystem_common/py.typed +0 -0
  405. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  406. bl_ui/space_topbar/py.typed +0 -0
  407. bl_ui/space_userpref/py.typed +0 -0
  408. bl_ui/space_view3d/py.typed +0 -0
  409. bl_ui/space_view3d_toolbar/py.typed +0 -0
  410. bl_ui/temp_anim_layers/py.typed +0 -0
  411. bl_ui/utils/py.typed +0 -0
  412. bl_ui_utils/bug_report_url/py.typed +0 -0
  413. bl_ui_utils/layout/py.typed +0 -0
  414. bmesh/geometry/py.typed +0 -0
  415. bmesh/ops/py.typed +0 -0
  416. bmesh/types/py.typed +0 -0
  417. bmesh/utils/py.typed +0 -0
  418. bpy/app/handlers/py.typed +0 -0
  419. bpy/app/icons/py.typed +0 -0
  420. bpy/app/py.typed +0 -0
  421. bpy/app/timers/py.typed +0 -0
  422. bpy/app/translations/py.typed +0 -0
  423. bpy/msgbus/py.typed +0 -0
  424. bpy/ops/action/py.typed +0 -0
  425. bpy/ops/anim/py.typed +0 -0
  426. bpy/ops/armature/py.typed +0 -0
  427. bpy/ops/asset/py.typed +0 -0
  428. bpy/ops/bl_pkg/py.typed +0 -0
  429. bpy/ops/boid/py.typed +0 -0
  430. bpy/ops/brush/py.typed +0 -0
  431. bpy/ops/buttons/py.typed +0 -0
  432. bpy/ops/cachefile/py.typed +0 -0
  433. bpy/ops/camera/py.typed +0 -0
  434. bpy/ops/clip/py.typed +0 -0
  435. bpy/ops/cloth/py.typed +0 -0
  436. bpy/ops/collection/py.typed +0 -0
  437. bpy/ops/console/py.typed +0 -0
  438. bpy/ops/constraint/py.typed +0 -0
  439. bpy/ops/curve/py.typed +0 -0
  440. bpy/ops/curves/py.typed +0 -0
  441. bpy/ops/cycles/py.typed +0 -0
  442. bpy/ops/dpaint/py.typed +0 -0
  443. bpy/ops/ed/py.typed +0 -0
  444. bpy/ops/export_anim/py.typed +0 -0
  445. bpy/ops/export_scene/py.typed +0 -0
  446. bpy/ops/file/py.typed +0 -0
  447. bpy/ops/fluid/py.typed +0 -0
  448. bpy/ops/font/py.typed +0 -0
  449. bpy/ops/geometry/py.typed +0 -0
  450. bpy/ops/gizmogroup/py.typed +0 -0
  451. bpy/ops/gpencil/py.typed +0 -0
  452. bpy/ops/graph/py.typed +0 -0
  453. bpy/ops/grease_pencil/py.typed +0 -0
  454. bpy/ops/image/py.typed +0 -0
  455. bpy/ops/import_anim/py.typed +0 -0
  456. bpy/ops/import_curve/py.typed +0 -0
  457. bpy/ops/import_scene/py.typed +0 -0
  458. bpy/ops/info/py.typed +0 -0
  459. bpy/ops/lattice/py.typed +0 -0
  460. bpy/ops/marker/py.typed +0 -0
  461. bpy/ops/mask/py.typed +0 -0
  462. bpy/ops/material/py.typed +0 -0
  463. bpy/ops/mball/py.typed +0 -0
  464. bpy/ops/mesh/py.typed +0 -0
  465. bpy/ops/nla/py.typed +0 -0
  466. bpy/ops/node/py.typed +0 -0
  467. bpy/ops/object/py.typed +0 -0
  468. bpy/ops/outliner/py.typed +0 -0
  469. bpy/ops/paint/py.typed +0 -0
  470. bpy/ops/paintcurve/py.typed +0 -0
  471. bpy/ops/palette/py.typed +0 -0
  472. bpy/ops/particle/py.typed +0 -0
  473. bpy/ops/pose/py.typed +0 -0
  474. bpy/ops/poselib/py.typed +0 -0
  475. bpy/ops/preferences/py.typed +0 -0
  476. bpy/ops/ptcache/py.typed +0 -0
  477. bpy/ops/py.typed +0 -0
  478. bpy/ops/render/py.typed +0 -0
  479. bpy/ops/rigidbody/py.typed +0 -0
  480. bpy/ops/scene/py.typed +0 -0
  481. bpy/ops/screen/py.typed +0 -0
  482. bpy/ops/script/py.typed +0 -0
  483. bpy/ops/sculpt/py.typed +0 -0
  484. bpy/ops/sculpt_curves/py.typed +0 -0
  485. bpy/ops/sequencer/py.typed +0 -0
  486. bpy/ops/sound/py.typed +0 -0
  487. bpy/ops/spreadsheet/py.typed +0 -0
  488. bpy/ops/surface/py.typed +0 -0
  489. bpy/ops/text/py.typed +0 -0
  490. bpy/ops/text_editor/py.typed +0 -0
  491. bpy/ops/texture/py.typed +0 -0
  492. bpy/ops/transform/py.typed +0 -0
  493. bpy/ops/ui/py.typed +0 -0
  494. bpy/ops/uilist/py.typed +0 -0
  495. bpy/ops/uv/py.typed +0 -0
  496. bpy/ops/view2d/py.typed +0 -0
  497. bpy/ops/view3d/py.typed +0 -0
  498. bpy/ops/wm/py.typed +0 -0
  499. bpy/ops/workspace/py.typed +0 -0
  500. bpy/ops/world/py.typed +0 -0
  501. bpy/path/py.typed +0 -0
  502. bpy/props/py.typed +0 -0
  503. bpy/types/py.typed +0 -0
  504. bpy/utils/previews/py.typed +0 -0
  505. bpy/utils/py.typed +0 -0
  506. bpy/utils/units/py.typed +0 -0
  507. bpy_extras/anim_utils/py.typed +0 -0
  508. bpy_extras/asset_utils/py.typed +0 -0
  509. bpy_extras/bmesh_utils/py.typed +0 -0
  510. bpy_extras/extensions/junction_module/py.typed +0 -0
  511. bpy_extras/extensions/py.typed +0 -0
  512. bpy_extras/id_map_utils/py.typed +0 -0
  513. bpy_extras/image_utils/py.typed +0 -0
  514. bpy_extras/io_utils/py.typed +0 -0
  515. bpy_extras/keyconfig_utils/py.typed +0 -0
  516. bpy_extras/mesh_utils/py.typed +0 -0
  517. bpy_extras/node_shader_utils/py.typed +0 -0
  518. bpy_extras/node_utils/py.typed +0 -0
  519. bpy_extras/object_utils/py.typed +0 -0
  520. bpy_extras/view3d_utils/py.typed +0 -0
  521. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  522. bpy_extras/wm_utils/py.typed +0 -0
  523. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  524. freestyle/chainingiterators/py.typed +0 -0
  525. freestyle/functions/py.typed +0 -0
  526. freestyle/predicates/py.typed +0 -0
  527. freestyle/shaders/py.typed +0 -0
  528. freestyle/types/py.typed +0 -0
  529. freestyle/utils/ContextFunctions/py.typed +0 -0
  530. freestyle/utils/py.typed +0 -0
  531. gpu/capabilities/py.typed +0 -0
  532. gpu/matrix/py.typed +0 -0
  533. gpu/platform/py.typed +0 -0
  534. gpu/select/py.typed +0 -0
  535. gpu/shader/py.typed +0 -0
  536. gpu/state/py.typed +0 -0
  537. gpu/texture/py.typed +0 -0
  538. gpu/types/py.typed +0 -0
  539. gpu_extras/batch/py.typed +0 -0
  540. gpu_extras/presets/py.typed +0 -0
  541. idprop/types/py.typed +0 -0
  542. imbuf/types/py.typed +0 -0
  543. mathutils/bvhtree/py.typed +0 -0
  544. mathutils/geometry/py.typed +0 -0
  545. mathutils/interpolate/py.typed +0 -0
  546. mathutils/kdtree/py.typed +0 -0
  547. mathutils/noise/py.typed +0 -0
  548. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
  549. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
@@ -1,20 +1,14 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
  import rna_prop_ui
4
5
 
5
6
  GenericType = typing.TypeVar("GenericType")
6
7
 
7
8
  class CURVES_MT_add_attribute(bpy_types.Menu, bpy_types._GenericUI):
8
- """ """
9
-
10
9
  bl_label: typing.Any
11
- """ """
12
-
13
10
  bl_rna: typing.Any
14
- """ """
15
-
16
11
  id_data: typing.Any
17
- """ """
18
12
 
19
13
  def add_standard_attribute(self, layout, curves, name, data_type, domain):
20
14
  """
@@ -28,22 +22,35 @@ class CURVES_MT_add_attribute(bpy_types.Menu, bpy_types._GenericUI):
28
22
  ...
29
23
 
30
24
  def append(self, draw_func):
31
- """
25
+ """Append a draw function to this menu,
26
+ takes the same arguments as the menus draw function
32
27
 
33
- :param draw_func:
28
+ :param draw_func:
34
29
  """
35
30
  ...
36
31
 
37
- def as_pointer(self):
38
- """ """
32
+ def as_pointer(self) -> int:
33
+ """Returns the memory address which holds a pointer to Blender's internal data
34
+
35
+ :return: int (memory address).
36
+ :rtype: int
37
+ """
39
38
  ...
40
39
 
41
- def bl_rna_get_subclass(self):
42
- """ """
40
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
41
+ """
42
+
43
+ :return: The RNA type or default when not found.
44
+ :rtype: bpy.types.Struct
45
+ """
43
46
  ...
44
47
 
45
- def bl_rna_get_subclass_py(self):
46
- """ """
48
+ def bl_rna_get_subclass_py(self) -> typing.Any:
49
+ """
50
+
51
+ :return: The class or default when not found.
52
+ :rtype: typing.Any
53
+ """
47
54
  ...
48
55
 
49
56
  def draw(self, context):
@@ -62,166 +69,257 @@ class CURVES_MT_add_attribute(bpy_types.Menu, bpy_types._GenericUI):
62
69
  ...
63
70
 
64
71
  def draw_preset(self, _context):
65
- """
72
+ """Define these on the subclass:
73
+ - preset_operator (string)
74
+ - preset_subdir (string)Optionally:
75
+ - preset_add_operator (string)
76
+ - preset_extensions (set of strings)
77
+ - preset_operator_defaults (dict of keyword args)
66
78
 
67
- :param _context:
79
+ :param _context:
68
80
  """
69
81
  ...
70
82
 
71
- def driver_add(self):
72
- """ """
83
+ def driver_add(self) -> bpy.types.FCurve:
84
+ """Adds driver(s) to the given property
85
+
86
+ :return: The driver(s) added.
87
+ :rtype: bpy.types.FCurve
88
+ """
73
89
  ...
74
90
 
75
- def driver_remove(self):
76
- """ """
91
+ def driver_remove(self) -> bool:
92
+ """Remove driver(s) from the given property
93
+
94
+ :return: Success of driver removal.
95
+ :rtype: bool
96
+ """
77
97
  ...
78
98
 
79
99
  def get(self):
80
- """ """
100
+ """Returns the value of the custom property assigned to key or default
101
+ when not found (matches Python's dictionary function of the same name).
102
+
103
+ """
81
104
  ...
82
105
 
83
106
  def id_properties_clear(self):
84
- """ """
107
+ """
108
+
109
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
110
+ """
85
111
  ...
86
112
 
87
113
  def id_properties_ensure(self):
88
- """ """
114
+ """
115
+
116
+ :return: the parent group for an RNA struct's custom IDProperties.
117
+ """
89
118
  ...
90
119
 
91
120
  def id_properties_ui(self):
92
- """ """
93
- ...
121
+ """
94
122
 
95
- def is_extended(self):
96
- """ """
123
+ :return: Return an object used to manage an IDProperty's UI data.
124
+ """
97
125
  ...
98
126
 
99
- def is_property_hidden(self):
100
- """ """
127
+ def is_extended(self): ...
128
+ def is_property_hidden(self) -> bool:
129
+ """Check if a property is hidden.
130
+
131
+ :return: True when the property is hidden.
132
+ :rtype: bool
133
+ """
101
134
  ...
102
135
 
103
- def is_property_overridable_library(self):
104
- """ """
136
+ def is_property_overridable_library(self) -> bool:
137
+ """Check if a property is overridable.
138
+
139
+ :return: True when the property is overridable.
140
+ :rtype: bool
141
+ """
105
142
  ...
106
143
 
107
- def is_property_readonly(self):
108
- """ """
144
+ def is_property_readonly(self) -> bool:
145
+ """Check if a property is readonly.
146
+
147
+ :return: True when the property is readonly (not writable).
148
+ :rtype: bool
149
+ """
109
150
  ...
110
151
 
111
- def is_property_set(self):
112
- """ """
152
+ def is_property_set(self) -> bool:
153
+ """Check if a property is set, use for testing operator properties.
154
+
155
+ :return: True when the property has been set.
156
+ :rtype: bool
157
+ """
113
158
  ...
114
159
 
115
160
  def items(self):
116
- """ """
161
+ """Returns the items of this objects custom properties (matches Python's
162
+ dictionary function of the same name).
163
+
164
+ :return: custom property key, value pairs.
165
+ """
117
166
  ...
118
167
 
119
- def keyframe_delete(self):
120
- """ """
168
+ def keyframe_delete(self) -> bool:
169
+ """Remove a keyframe from this properties fcurve.
170
+
171
+ :return: Success of keyframe deletion.
172
+ :rtype: bool
173
+ """
121
174
  ...
122
175
 
123
- def keyframe_insert(self):
124
- """ """
176
+ def keyframe_insert(self) -> bool:
177
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
178
+
179
+ :return: Success of keyframe insertion.
180
+ :rtype: bool
181
+ """
125
182
  ...
126
183
 
127
184
  def keys(self):
128
- """ """
185
+ """Returns the keys of this objects custom properties (matches Python's
186
+ dictionary function of the same name).
187
+
188
+ :return: custom property keys.
189
+ """
129
190
  ...
130
191
 
131
- def path_from_id(self):
132
- """ """
192
+ def path_from_id(self) -> str:
193
+ """Returns the data path from the ID to this object (string).
194
+
195
+ :return: The path from `bpy.types.bpy_struct.id_data`
196
+ to this struct and property (when given).
197
+ :rtype: str
198
+ """
133
199
  ...
134
200
 
135
201
  def path_menu(
136
202
  self,
137
- searchpaths,
138
- operator,
139
- props_default,
140
- prop_filepath,
141
- filter_ext,
142
- filter_path,
143
- display_name,
144
- add_operator,
145
- add_operator_props,
203
+ searchpaths: list[str],
204
+ operator: str,
205
+ props_default: dict = None,
206
+ prop_filepath: str = "filepath",
207
+ filter_ext: typing.Callable = None,
208
+ filter_path=None,
209
+ display_name: typing.Callable = None,
210
+ add_operator=None,
211
+ add_operator_props=None,
146
212
  ):
147
- """
213
+ """Populate a menu from a list of paths.
148
214
 
149
- :param searchpaths:
150
- :param operator:
151
- :param props_default:
152
- :param prop_filepath:
153
- :param filter_ext:
154
- :param filter_path:
155
- :param display_name:
156
- :param add_operator:
157
- :param add_operator_props:
215
+ :param searchpaths: Paths to scan.
216
+ :type searchpaths: list[str]
217
+ :param operator: The operator id to use with each file.
218
+ :type operator: str
219
+ :param props_default: Properties to assign to each operator.
220
+ :type props_default: dict
221
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
222
+ :type prop_filepath: str
223
+ :param filter_ext: Optional callback that takes the file extensions.
224
+
225
+ Returning false excludes the file from the list.
226
+ :type filter_ext: typing.Callable
227
+ :param filter_path:
228
+ :param display_name: Optional callback that takes the full path, returns the name to display.
229
+ :type display_name: typing.Callable
230
+ :param add_operator:
231
+ :param add_operator_props:
158
232
  """
159
233
  ...
160
234
 
161
235
  def path_resolve(self):
162
- """ """
236
+ """Returns the property from the path, raise an exception when not found."""
163
237
  ...
164
238
 
165
239
  def pop(self):
166
- """ """
240
+ """Remove and return the value of the custom property assigned to key or default
241
+ when not found (matches Python's dictionary function of the same name).
242
+
243
+ """
167
244
  ...
168
245
 
169
246
  def prepend(self, draw_func):
170
- """
247
+ """Prepend a draw function to this menu, takes the same arguments as
248
+ the menus draw function
171
249
 
172
- :param draw_func:
250
+ :param draw_func:
173
251
  """
174
252
  ...
175
253
 
176
- def property_overridable_library_set(self):
177
- """ """
254
+ def property_overridable_library_set(self) -> bool:
255
+ """Define a property as overridable or not (only for custom properties!).
256
+
257
+ :return: True when the overridable status of the property was successfully set.
258
+ :rtype: bool
259
+ """
178
260
  ...
179
261
 
180
262
  def property_unset(self):
181
- """ """
263
+ """Unset a property, will use default value afterward."""
182
264
  ...
183
265
 
184
266
  def remove(self, draw_func):
185
- """
267
+ """Remove a draw function that has been added to this menu
186
268
 
187
269
  :param draw_func:
188
270
  """
189
271
  ...
190
272
 
191
273
  def type_recast(self):
192
- """ """
274
+ """Return a new instance, this is needed because types
275
+ such as textures can be changed at runtime.
276
+
277
+ :return: a new instance of this object with the type initialized again.
278
+ """
193
279
  ...
194
280
 
195
281
  def values(self):
196
- """ """
282
+ """Returns the values of this objects custom properties (matches Python's
283
+ dictionary function of the same name).
284
+
285
+ :return: custom property values.
286
+ """
197
287
  ...
198
288
 
199
289
  class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
200
- """ """
201
-
202
290
  bl_rna: typing.Any
203
- """ """
204
-
205
291
  id_data: typing.Any
206
- """ """
207
292
 
208
293
  def append(self, draw_func):
209
- """
294
+ """Append a draw function to this menu,
295
+ takes the same arguments as the menus draw function
210
296
 
211
- :param draw_func:
297
+ :param draw_func:
212
298
  """
213
299
  ...
214
300
 
215
- def as_pointer(self):
216
- """ """
301
+ def as_pointer(self) -> int:
302
+ """Returns the memory address which holds a pointer to Blender's internal data
303
+
304
+ :return: int (memory address).
305
+ :rtype: int
306
+ """
217
307
  ...
218
308
 
219
- def bl_rna_get_subclass(self):
220
- """ """
309
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
310
+ """
311
+
312
+ :return: The RNA type or default when not found.
313
+ :rtype: bpy.types.Struct
314
+ """
221
315
  ...
222
316
 
223
- def bl_rna_get_subclass_py(self):
224
- """ """
317
+ def bl_rna_get_subclass_py(self) -> typing.Any:
318
+ """
319
+
320
+ :return: The class or default when not found.
321
+ :rtype: typing.Any
322
+ """
225
323
  ...
226
324
 
227
325
  def draw_item(
@@ -248,12 +346,20 @@ class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
248
346
  """
249
347
  ...
250
348
 
251
- def driver_add(self):
252
- """ """
349
+ def driver_add(self) -> bpy.types.FCurve:
350
+ """Adds driver(s) to the given property
351
+
352
+ :return: The driver(s) added.
353
+ :rtype: bpy.types.FCurve
354
+ """
253
355
  ...
254
356
 
255
- def driver_remove(self):
256
- """ """
357
+ def driver_remove(self) -> bool:
358
+ """Remove driver(s) from the given property
359
+
360
+ :return: Success of driver removal.
361
+ :rtype: bool
362
+ """
257
363
  ...
258
364
 
259
365
  def filter_items(self, _context, data, property):
@@ -266,110 +372,165 @@ class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
266
372
  ...
267
373
 
268
374
  def get(self):
269
- """ """
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
+ """
270
379
  ...
271
380
 
272
381
  def id_properties_clear(self):
273
- """ """
382
+ """
383
+
384
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
385
+ """
274
386
  ...
275
387
 
276
388
  def id_properties_ensure(self):
277
- """ """
389
+ """
390
+
391
+ :return: the parent group for an RNA struct's custom IDProperties.
392
+ """
278
393
  ...
279
394
 
280
395
  def id_properties_ui(self):
281
- """ """
282
- ...
396
+ """
283
397
 
284
- def is_extended(self):
285
- """ """
398
+ :return: Return an object used to manage an IDProperty's UI data.
399
+ """
286
400
  ...
287
401
 
288
- def is_property_hidden(self):
289
- """ """
402
+ def is_extended(self): ...
403
+ def is_property_hidden(self) -> bool:
404
+ """Check if a property is hidden.
405
+
406
+ :return: True when the property is hidden.
407
+ :rtype: bool
408
+ """
290
409
  ...
291
410
 
292
- def is_property_overridable_library(self):
293
- """ """
411
+ def is_property_overridable_library(self) -> bool:
412
+ """Check if a property is overridable.
413
+
414
+ :return: True when the property is overridable.
415
+ :rtype: bool
416
+ """
294
417
  ...
295
418
 
296
- def is_property_readonly(self):
297
- """ """
419
+ def is_property_readonly(self) -> bool:
420
+ """Check if a property is readonly.
421
+
422
+ :return: True when the property is readonly (not writable).
423
+ :rtype: bool
424
+ """
298
425
  ...
299
426
 
300
- def is_property_set(self):
301
- """ """
427
+ def is_property_set(self) -> bool:
428
+ """Check if a property is set, use for testing operator properties.
429
+
430
+ :return: True when the property has been set.
431
+ :rtype: bool
432
+ """
302
433
  ...
303
434
 
304
435
  def items(self):
305
- """ """
436
+ """Returns the items of this objects custom properties (matches Python's
437
+ dictionary function of the same name).
438
+
439
+ :return: custom property key, value pairs.
440
+ """
306
441
  ...
307
442
 
308
- def keyframe_delete(self):
309
- """ """
443
+ def keyframe_delete(self) -> bool:
444
+ """Remove a keyframe from this properties fcurve.
445
+
446
+ :return: Success of keyframe deletion.
447
+ :rtype: bool
448
+ """
310
449
  ...
311
450
 
312
- def keyframe_insert(self):
313
- """ """
451
+ def keyframe_insert(self) -> bool:
452
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
453
+
454
+ :return: Success of keyframe insertion.
455
+ :rtype: bool
456
+ """
314
457
  ...
315
458
 
316
459
  def keys(self):
317
- """ """
460
+ """Returns the keys of this objects custom properties (matches Python's
461
+ dictionary function of the same name).
462
+
463
+ :return: custom property keys.
464
+ """
318
465
  ...
319
466
 
320
- def path_from_id(self):
321
- """ """
467
+ def path_from_id(self) -> str:
468
+ """Returns the data path from the ID to this object (string).
469
+
470
+ :return: The path from `bpy.types.bpy_struct.id_data`
471
+ to this struct and property (when given).
472
+ :rtype: str
473
+ """
322
474
  ...
323
475
 
324
476
  def path_resolve(self):
325
- """ """
477
+ """Returns the property from the path, raise an exception when not found."""
326
478
  ...
327
479
 
328
480
  def pop(self):
329
- """ """
481
+ """Remove and return the value of the custom property assigned to key or default
482
+ when not found (matches Python's dictionary function of the same name).
483
+
484
+ """
330
485
  ...
331
486
 
332
487
  def prepend(self, draw_func):
333
- """
488
+ """Prepend a draw function to this menu, takes the same arguments as
489
+ the menus draw function
334
490
 
335
- :param draw_func:
491
+ :param draw_func:
336
492
  """
337
493
  ...
338
494
 
339
- def property_overridable_library_set(self):
340
- """ """
495
+ def property_overridable_library_set(self) -> bool:
496
+ """Define a property as overridable or not (only for custom properties!).
497
+
498
+ :return: True when the overridable status of the property was successfully set.
499
+ :rtype: bool
500
+ """
341
501
  ...
342
502
 
343
503
  def property_unset(self):
344
- """ """
504
+ """Unset a property, will use default value afterward."""
345
505
  ...
346
506
 
347
507
  def remove(self, draw_func):
348
- """
508
+ """Remove a draw function that has been added to this menu
349
509
 
350
510
  :param draw_func:
351
511
  """
352
512
  ...
353
513
 
354
514
  def type_recast(self):
355
- """ """
515
+ """Return a new instance, this is needed because types
516
+ such as textures can be changed at runtime.
517
+
518
+ :return: a new instance of this object with the type initialized again.
519
+ """
356
520
  ...
357
521
 
358
522
  def values(self):
359
- """ """
523
+ """Returns the values of this objects custom properties (matches Python's
524
+ dictionary function of the same name).
525
+
526
+ :return: custom property values.
527
+ """
360
528
  ...
361
529
 
362
530
  class DataButtonsPanel:
363
- """ """
364
-
365
531
  bl_context: typing.Any
366
- """ """
367
-
368
532
  bl_region_type: typing.Any
369
- """ """
370
-
371
533
  bl_space_type: typing.Any
372
- """ """
373
534
 
374
535
  def poll(self, context):
375
536
  """
@@ -381,46 +542,44 @@ class DataButtonsPanel:
381
542
  class DATA_PT_CURVES_attributes(
382
543
  bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI
383
544
  ):
384
- """ """
385
-
386
545
  COMPAT_ENGINES: typing.Any
387
- """ """
388
-
389
546
  bl_context: typing.Any
390
- """ """
391
-
392
547
  bl_label: typing.Any
393
- """ """
394
-
395
548
  bl_region_type: typing.Any
396
- """ """
397
-
398
549
  bl_rna: typing.Any
399
- """ """
400
-
401
550
  bl_space_type: typing.Any
402
- """ """
403
-
404
551
  id_data: typing.Any
405
- """ """
406
552
 
407
553
  def append(self, draw_func):
408
- """
554
+ """Append a draw function to this menu,
555
+ takes the same arguments as the menus draw function
409
556
 
410
- :param draw_func:
557
+ :param draw_func:
411
558
  """
412
559
  ...
413
560
 
414
- def as_pointer(self):
415
- """ """
561
+ def as_pointer(self) -> int:
562
+ """Returns the memory address which holds a pointer to Blender's internal data
563
+
564
+ :return: int (memory address).
565
+ :rtype: int
566
+ """
416
567
  ...
417
568
 
418
- def bl_rna_get_subclass(self):
419
- """ """
569
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
570
+ """
571
+
572
+ :return: The RNA type or default when not found.
573
+ :rtype: bpy.types.Struct
574
+ """
420
575
  ...
421
576
 
422
- def bl_rna_get_subclass_py(self):
423
- """ """
577
+ def bl_rna_get_subclass_py(self) -> typing.Any:
578
+ """
579
+
580
+ :return: The class or default when not found.
581
+ :rtype: typing.Any
582
+ """
424
583
  ...
425
584
 
426
585
  def draw(self, context):
@@ -430,72 +589,126 @@ class DATA_PT_CURVES_attributes(
430
589
  """
431
590
  ...
432
591
 
433
- def driver_add(self):
434
- """ """
592
+ def driver_add(self) -> bpy.types.FCurve:
593
+ """Adds driver(s) to the given property
594
+
595
+ :return: The driver(s) added.
596
+ :rtype: bpy.types.FCurve
597
+ """
435
598
  ...
436
599
 
437
- def driver_remove(self):
438
- """ """
600
+ def driver_remove(self) -> bool:
601
+ """Remove driver(s) from the given property
602
+
603
+ :return: Success of driver removal.
604
+ :rtype: bool
605
+ """
439
606
  ...
440
607
 
441
608
  def get(self):
442
- """ """
609
+ """Returns the value of the custom property assigned to key or default
610
+ when not found (matches Python's dictionary function of the same name).
611
+
612
+ """
443
613
  ...
444
614
 
445
615
  def id_properties_clear(self):
446
- """ """
616
+ """
617
+
618
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
619
+ """
447
620
  ...
448
621
 
449
622
  def id_properties_ensure(self):
450
- """ """
623
+ """
624
+
625
+ :return: the parent group for an RNA struct's custom IDProperties.
626
+ """
451
627
  ...
452
628
 
453
629
  def id_properties_ui(self):
454
- """ """
455
- ...
630
+ """
456
631
 
457
- def is_extended(self):
458
- """ """
632
+ :return: Return an object used to manage an IDProperty's UI data.
633
+ """
459
634
  ...
460
635
 
461
- def is_property_hidden(self):
462
- """ """
636
+ def is_extended(self): ...
637
+ def is_property_hidden(self) -> bool:
638
+ """Check if a property is hidden.
639
+
640
+ :return: True when the property is hidden.
641
+ :rtype: bool
642
+ """
463
643
  ...
464
644
 
465
- def is_property_overridable_library(self):
466
- """ """
645
+ def is_property_overridable_library(self) -> bool:
646
+ """Check if a property is overridable.
647
+
648
+ :return: True when the property is overridable.
649
+ :rtype: bool
650
+ """
467
651
  ...
468
652
 
469
- def is_property_readonly(self):
470
- """ """
653
+ def is_property_readonly(self) -> bool:
654
+ """Check if a property is readonly.
655
+
656
+ :return: True when the property is readonly (not writable).
657
+ :rtype: bool
658
+ """
471
659
  ...
472
660
 
473
- def is_property_set(self):
474
- """ """
661
+ def is_property_set(self) -> bool:
662
+ """Check if a property is set, use for testing operator properties.
663
+
664
+ :return: True when the property has been set.
665
+ :rtype: bool
666
+ """
475
667
  ...
476
668
 
477
669
  def items(self):
478
- """ """
670
+ """Returns the items of this objects custom properties (matches Python's
671
+ dictionary function of the same name).
672
+
673
+ :return: custom property key, value pairs.
674
+ """
479
675
  ...
480
676
 
481
- def keyframe_delete(self):
482
- """ """
677
+ def keyframe_delete(self) -> bool:
678
+ """Remove a keyframe from this properties fcurve.
679
+
680
+ :return: Success of keyframe deletion.
681
+ :rtype: bool
682
+ """
483
683
  ...
484
684
 
485
- def keyframe_insert(self):
486
- """ """
685
+ def keyframe_insert(self) -> bool:
686
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
687
+
688
+ :return: Success of keyframe insertion.
689
+ :rtype: bool
690
+ """
487
691
  ...
488
692
 
489
693
  def keys(self):
490
- """ """
694
+ """Returns the keys of this objects custom properties (matches Python's
695
+ dictionary function of the same name).
696
+
697
+ :return: custom property keys.
698
+ """
491
699
  ...
492
700
 
493
- def path_from_id(self):
494
- """ """
701
+ def path_from_id(self) -> str:
702
+ """Returns the data path from the ID to this object (string).
703
+
704
+ :return: The path from `bpy.types.bpy_struct.id_data`
705
+ to this struct and property (when given).
706
+ :rtype: str
707
+ """
495
708
  ...
496
709
 
497
710
  def path_resolve(self):
498
- """ """
711
+ """Returns the property from the path, raise an exception when not found."""
499
712
  ...
500
713
 
501
714
  def poll(self, context):
@@ -506,83 +719,95 @@ class DATA_PT_CURVES_attributes(
506
719
  ...
507
720
 
508
721
  def pop(self):
509
- """ """
722
+ """Remove and return the value of the custom property assigned to key or default
723
+ when not found (matches Python's dictionary function of the same name).
724
+
725
+ """
510
726
  ...
511
727
 
512
728
  def prepend(self, draw_func):
513
- """
729
+ """Prepend a draw function to this menu, takes the same arguments as
730
+ the menus draw function
514
731
 
515
- :param draw_func:
732
+ :param draw_func:
516
733
  """
517
734
  ...
518
735
 
519
- def property_overridable_library_set(self):
520
- """ """
736
+ def property_overridable_library_set(self) -> bool:
737
+ """Define a property as overridable or not (only for custom properties!).
738
+
739
+ :return: True when the overridable status of the property was successfully set.
740
+ :rtype: bool
741
+ """
521
742
  ...
522
743
 
523
744
  def property_unset(self):
524
- """ """
745
+ """Unset a property, will use default value afterward."""
525
746
  ...
526
747
 
527
748
  def remove(self, draw_func):
528
- """
749
+ """Remove a draw function that has been added to this menu
529
750
 
530
751
  :param draw_func:
531
752
  """
532
753
  ...
533
754
 
534
755
  def type_recast(self):
535
- """ """
756
+ """Return a new instance, this is needed because types
757
+ such as textures can be changed at runtime.
758
+
759
+ :return: a new instance of this object with the type initialized again.
760
+ """
536
761
  ...
537
762
 
538
763
  def values(self):
539
- """ """
764
+ """Returns the values of this objects custom properties (matches Python's
765
+ dictionary function of the same name).
766
+
767
+ :return: custom property values.
768
+ """
540
769
  ...
541
770
 
542
771
  class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
543
- """ """
544
-
545
772
  COMPAT_ENGINES: typing.Any
546
- """ """
547
-
548
773
  bl_context: typing.Any
549
- """ """
550
-
551
774
  bl_label: typing.Any
552
- """ """
553
-
554
775
  bl_options: typing.Any
555
- """ """
556
-
557
776
  bl_region_type: typing.Any
558
- """ """
559
-
560
777
  bl_rna: typing.Any
561
- """ """
562
-
563
778
  bl_space_type: typing.Any
564
- """ """
565
-
566
779
  id_data: typing.Any
567
- """ """
568
780
 
569
781
  def append(self, draw_func):
570
- """
782
+ """Append a draw function to this menu,
783
+ takes the same arguments as the menus draw function
571
784
 
572
- :param draw_func:
785
+ :param draw_func:
573
786
  """
574
787
  ...
575
788
 
576
- def as_pointer(self):
577
- """ """
789
+ def as_pointer(self) -> int:
790
+ """Returns the memory address which holds a pointer to Blender's internal data
791
+
792
+ :return: int (memory address).
793
+ :rtype: int
794
+ """
578
795
  ...
579
796
 
580
- def bl_rna_get_subclass(self):
581
- """ """
797
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
798
+ """
799
+
800
+ :return: The RNA type or default when not found.
801
+ :rtype: bpy.types.Struct
802
+ """
582
803
  ...
583
804
 
584
- def bl_rna_get_subclass_py(self):
585
- """ """
805
+ def bl_rna_get_subclass_py(self) -> typing.Any:
806
+ """
807
+
808
+ :return: The class or default when not found.
809
+ :rtype: typing.Any
810
+ """
586
811
  ...
587
812
 
588
813
  def draw(self, context):
@@ -592,72 +817,126 @@ class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
592
817
  """
593
818
  ...
594
819
 
595
- def driver_add(self):
596
- """ """
820
+ def driver_add(self) -> bpy.types.FCurve:
821
+ """Adds driver(s) to the given property
822
+
823
+ :return: The driver(s) added.
824
+ :rtype: bpy.types.FCurve
825
+ """
597
826
  ...
598
827
 
599
- def driver_remove(self):
600
- """ """
828
+ def driver_remove(self) -> bool:
829
+ """Remove driver(s) from the given property
830
+
831
+ :return: Success of driver removal.
832
+ :rtype: bool
833
+ """
601
834
  ...
602
835
 
603
836
  def get(self):
604
- """ """
837
+ """Returns the value of the custom property assigned to key or default
838
+ when not found (matches Python's dictionary function of the same name).
839
+
840
+ """
605
841
  ...
606
842
 
607
843
  def id_properties_clear(self):
608
- """ """
844
+ """
845
+
846
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
847
+ """
609
848
  ...
610
849
 
611
850
  def id_properties_ensure(self):
612
- """ """
851
+ """
852
+
853
+ :return: the parent group for an RNA struct's custom IDProperties.
854
+ """
613
855
  ...
614
856
 
615
857
  def id_properties_ui(self):
616
- """ """
617
- ...
858
+ """
618
859
 
619
- def is_extended(self):
620
- """ """
860
+ :return: Return an object used to manage an IDProperty's UI data.
861
+ """
621
862
  ...
622
863
 
623
- def is_property_hidden(self):
624
- """ """
864
+ def is_extended(self): ...
865
+ def is_property_hidden(self) -> bool:
866
+ """Check if a property is hidden.
867
+
868
+ :return: True when the property is hidden.
869
+ :rtype: bool
870
+ """
625
871
  ...
626
872
 
627
- def is_property_overridable_library(self):
628
- """ """
873
+ def is_property_overridable_library(self) -> bool:
874
+ """Check if a property is overridable.
875
+
876
+ :return: True when the property is overridable.
877
+ :rtype: bool
878
+ """
629
879
  ...
630
880
 
631
- def is_property_readonly(self):
632
- """ """
881
+ def is_property_readonly(self) -> bool:
882
+ """Check if a property is readonly.
883
+
884
+ :return: True when the property is readonly (not writable).
885
+ :rtype: bool
886
+ """
633
887
  ...
634
888
 
635
- def is_property_set(self):
636
- """ """
889
+ def is_property_set(self) -> bool:
890
+ """Check if a property is set, use for testing operator properties.
891
+
892
+ :return: True when the property has been set.
893
+ :rtype: bool
894
+ """
637
895
  ...
638
896
 
639
897
  def items(self):
640
- """ """
898
+ """Returns the items of this objects custom properties (matches Python's
899
+ dictionary function of the same name).
900
+
901
+ :return: custom property key, value pairs.
902
+ """
641
903
  ...
642
904
 
643
- def keyframe_delete(self):
644
- """ """
905
+ def keyframe_delete(self) -> bool:
906
+ """Remove a keyframe from this properties fcurve.
907
+
908
+ :return: Success of keyframe deletion.
909
+ :rtype: bool
910
+ """
645
911
  ...
646
912
 
647
- def keyframe_insert(self):
648
- """ """
913
+ def keyframe_insert(self) -> bool:
914
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
915
+
916
+ :return: Success of keyframe insertion.
917
+ :rtype: bool
918
+ """
649
919
  ...
650
920
 
651
921
  def keys(self):
652
- """ """
922
+ """Returns the keys of this objects custom properties (matches Python's
923
+ dictionary function of the same name).
924
+
925
+ :return: custom property keys.
926
+ """
653
927
  ...
654
928
 
655
- def path_from_id(self):
656
- """ """
929
+ def path_from_id(self) -> str:
930
+ """Returns the data path from the ID to this object (string).
931
+
932
+ :return: The path from `bpy.types.bpy_struct.id_data`
933
+ to this struct and property (when given).
934
+ :rtype: str
935
+ """
657
936
  ...
658
937
 
659
938
  def path_resolve(self):
660
- """ """
939
+ """Returns the property from the path, raise an exception when not found."""
661
940
  ...
662
941
 
663
942
  def poll(self, context):
@@ -668,80 +947,94 @@ class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
668
947
  ...
669
948
 
670
949
  def pop(self):
671
- """ """
950
+ """Remove and return the value of the custom property assigned to key or default
951
+ when not found (matches Python's dictionary function of the same name).
952
+
953
+ """
672
954
  ...
673
955
 
674
956
  def prepend(self, draw_func):
675
- """
957
+ """Prepend a draw function to this menu, takes the same arguments as
958
+ the menus draw function
676
959
 
677
- :param draw_func:
960
+ :param draw_func:
678
961
  """
679
962
  ...
680
963
 
681
- def property_overridable_library_set(self):
682
- """ """
964
+ def property_overridable_library_set(self) -> bool:
965
+ """Define a property as overridable or not (only for custom properties!).
966
+
967
+ :return: True when the overridable status of the property was successfully set.
968
+ :rtype: bool
969
+ """
683
970
  ...
684
971
 
685
972
  def property_unset(self):
686
- """ """
973
+ """Unset a property, will use default value afterward."""
687
974
  ...
688
975
 
689
976
  def remove(self, draw_func):
690
- """
977
+ """Remove a draw function that has been added to this menu
691
978
 
692
979
  :param draw_func:
693
980
  """
694
981
  ...
695
982
 
696
983
  def type_recast(self):
697
- """ """
984
+ """Return a new instance, this is needed because types
985
+ such as textures can be changed at runtime.
986
+
987
+ :return: a new instance of this object with the type initialized again.
988
+ """
698
989
  ...
699
990
 
700
991
  def values(self):
701
- """ """
992
+ """Returns the values of this objects custom properties (matches Python's
993
+ dictionary function of the same name).
994
+
995
+ :return: custom property values.
996
+ """
702
997
  ...
703
998
 
704
999
  class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
705
- """ """
706
-
707
1000
  COMPAT_ENGINES: typing.Any
708
- """ """
709
-
710
1001
  bl_context: typing.Any
711
- """ """
712
-
713
1002
  bl_label: typing.Any
714
- """ """
715
-
716
1003
  bl_region_type: typing.Any
717
- """ """
718
-
719
1004
  bl_rna: typing.Any
720
- """ """
721
-
722
1005
  bl_space_type: typing.Any
723
- """ """
724
-
725
1006
  id_data: typing.Any
726
- """ """
727
1007
 
728
1008
  def append(self, draw_func):
729
- """
1009
+ """Append a draw function to this menu,
1010
+ takes the same arguments as the menus draw function
730
1011
 
731
- :param draw_func:
1012
+ :param draw_func:
732
1013
  """
733
1014
  ...
734
1015
 
735
- def as_pointer(self):
736
- """ """
1016
+ def as_pointer(self) -> int:
1017
+ """Returns the memory address which holds a pointer to Blender's internal data
1018
+
1019
+ :return: int (memory address).
1020
+ :rtype: int
1021
+ """
737
1022
  ...
738
1023
 
739
- def bl_rna_get_subclass(self):
740
- """ """
1024
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1025
+ """
1026
+
1027
+ :return: The RNA type or default when not found.
1028
+ :rtype: bpy.types.Struct
1029
+ """
741
1030
  ...
742
1031
 
743
- def bl_rna_get_subclass_py(self):
744
- """ """
1032
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1033
+ """
1034
+
1035
+ :return: The class or default when not found.
1036
+ :rtype: typing.Any
1037
+ """
745
1038
  ...
746
1039
 
747
1040
  def draw(self, context):
@@ -751,72 +1044,126 @@ class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
751
1044
  """
752
1045
  ...
753
1046
 
754
- def driver_add(self):
755
- """ """
1047
+ def driver_add(self) -> bpy.types.FCurve:
1048
+ """Adds driver(s) to the given property
1049
+
1050
+ :return: The driver(s) added.
1051
+ :rtype: bpy.types.FCurve
1052
+ """
756
1053
  ...
757
1054
 
758
- def driver_remove(self):
759
- """ """
1055
+ def driver_remove(self) -> bool:
1056
+ """Remove driver(s) from the given property
1057
+
1058
+ :return: Success of driver removal.
1059
+ :rtype: bool
1060
+ """
760
1061
  ...
761
1062
 
762
1063
  def get(self):
763
- """ """
1064
+ """Returns the value of the custom property assigned to key or default
1065
+ when not found (matches Python's dictionary function of the same name).
1066
+
1067
+ """
764
1068
  ...
765
1069
 
766
1070
  def id_properties_clear(self):
767
- """ """
1071
+ """
1072
+
1073
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1074
+ """
768
1075
  ...
769
1076
 
770
1077
  def id_properties_ensure(self):
771
- """ """
1078
+ """
1079
+
1080
+ :return: the parent group for an RNA struct's custom IDProperties.
1081
+ """
772
1082
  ...
773
1083
 
774
1084
  def id_properties_ui(self):
775
- """ """
776
- ...
1085
+ """
777
1086
 
778
- def is_extended(self):
779
- """ """
1087
+ :return: Return an object used to manage an IDProperty's UI data.
1088
+ """
780
1089
  ...
781
1090
 
782
- def is_property_hidden(self):
783
- """ """
1091
+ def is_extended(self): ...
1092
+ def is_property_hidden(self) -> bool:
1093
+ """Check if a property is hidden.
1094
+
1095
+ :return: True when the property is hidden.
1096
+ :rtype: bool
1097
+ """
784
1098
  ...
785
1099
 
786
- def is_property_overridable_library(self):
787
- """ """
1100
+ def is_property_overridable_library(self) -> bool:
1101
+ """Check if a property is overridable.
1102
+
1103
+ :return: True when the property is overridable.
1104
+ :rtype: bool
1105
+ """
788
1106
  ...
789
1107
 
790
- def is_property_readonly(self):
791
- """ """
1108
+ def is_property_readonly(self) -> bool:
1109
+ """Check if a property is readonly.
1110
+
1111
+ :return: True when the property is readonly (not writable).
1112
+ :rtype: bool
1113
+ """
792
1114
  ...
793
1115
 
794
- def is_property_set(self):
795
- """ """
1116
+ def is_property_set(self) -> bool:
1117
+ """Check if a property is set, use for testing operator properties.
1118
+
1119
+ :return: True when the property has been set.
1120
+ :rtype: bool
1121
+ """
796
1122
  ...
797
1123
 
798
1124
  def items(self):
799
- """ """
1125
+ """Returns the items of this objects custom properties (matches Python's
1126
+ dictionary function of the same name).
1127
+
1128
+ :return: custom property key, value pairs.
1129
+ """
800
1130
  ...
801
1131
 
802
- def keyframe_delete(self):
803
- """ """
1132
+ def keyframe_delete(self) -> bool:
1133
+ """Remove a keyframe from this properties fcurve.
1134
+
1135
+ :return: Success of keyframe deletion.
1136
+ :rtype: bool
1137
+ """
804
1138
  ...
805
1139
 
806
- def keyframe_insert(self):
807
- """ """
1140
+ def keyframe_insert(self) -> bool:
1141
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1142
+
1143
+ :return: Success of keyframe insertion.
1144
+ :rtype: bool
1145
+ """
808
1146
  ...
809
1147
 
810
1148
  def keys(self):
811
- """ """
1149
+ """Returns the keys of this objects custom properties (matches Python's
1150
+ dictionary function of the same name).
1151
+
1152
+ :return: custom property keys.
1153
+ """
812
1154
  ...
813
1155
 
814
- def path_from_id(self):
815
- """ """
1156
+ def path_from_id(self) -> str:
1157
+ """Returns the data path from the ID to this object (string).
1158
+
1159
+ :return: The path from `bpy.types.bpy_struct.id_data`
1160
+ to this struct and property (when given).
1161
+ :rtype: str
1162
+ """
816
1163
  ...
817
1164
 
818
1165
  def path_resolve(self):
819
- """ """
1166
+ """Returns the property from the path, raise an exception when not found."""
820
1167
  ...
821
1168
 
822
1169
  def poll(self, context):
@@ -827,88 +1174,102 @@ class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
827
1174
  ...
828
1175
 
829
1176
  def pop(self):
830
- """ """
1177
+ """Remove and return the value of the custom property assigned to key or default
1178
+ when not found (matches Python's dictionary function of the same name).
1179
+
1180
+ """
831
1181
  ...
832
1182
 
833
1183
  def prepend(self, draw_func):
834
- """
1184
+ """Prepend a draw function to this menu, takes the same arguments as
1185
+ the menus draw function
835
1186
 
836
- :param draw_func:
1187
+ :param draw_func:
837
1188
  """
838
1189
  ...
839
1190
 
840
- def property_overridable_library_set(self):
841
- """ """
1191
+ def property_overridable_library_set(self) -> bool:
1192
+ """Define a property as overridable or not (only for custom properties!).
1193
+
1194
+ :return: True when the overridable status of the property was successfully set.
1195
+ :rtype: bool
1196
+ """
842
1197
  ...
843
1198
 
844
1199
  def property_unset(self):
845
- """ """
1200
+ """Unset a property, will use default value afterward."""
846
1201
  ...
847
1202
 
848
1203
  def remove(self, draw_func):
849
- """
1204
+ """Remove a draw function that has been added to this menu
850
1205
 
851
1206
  :param draw_func:
852
1207
  """
853
1208
  ...
854
1209
 
855
1210
  def type_recast(self):
856
- """ """
1211
+ """Return a new instance, this is needed because types
1212
+ such as textures can be changed at runtime.
1213
+
1214
+ :return: a new instance of this object with the type initialized again.
1215
+ """
857
1216
  ...
858
1217
 
859
1218
  def values(self):
860
- """ """
1219
+ """Returns the values of this objects custom properties (matches Python's
1220
+ dictionary function of the same name).
1221
+
1222
+ :return: custom property values.
1223
+ """
861
1224
  ...
862
1225
 
863
1226
  class DATA_PT_custom_props_curves(
864
1227
  bpy_types.Panel, DataButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
865
1228
  ):
866
- """ """
1229
+ """The subclass should have its own poll function
1230
+ and the variable '_context_path' MUST be set.
1231
+ """
867
1232
 
868
1233
  COMPAT_ENGINES: typing.Any
869
- """ """
870
-
871
1234
  bl_context: typing.Any
872
- """ """
873
-
874
1235
  bl_label: typing.Any
875
- """ """
876
-
877
1236
  bl_options: typing.Any
878
- """ """
879
-
880
1237
  bl_order: typing.Any
881
- """ """
882
-
883
1238
  bl_region_type: typing.Any
884
- """ """
885
-
886
1239
  bl_rna: typing.Any
887
- """ """
888
-
889
1240
  bl_space_type: typing.Any
890
- """ """
891
-
892
1241
  id_data: typing.Any
893
- """ """
894
1242
 
895
1243
  def append(self, draw_func):
896
- """
1244
+ """Append a draw function to this menu,
1245
+ takes the same arguments as the menus draw function
897
1246
 
898
- :param draw_func:
1247
+ :param draw_func:
899
1248
  """
900
1249
  ...
901
1250
 
902
- def as_pointer(self):
903
- """ """
1251
+ def as_pointer(self) -> int:
1252
+ """Returns the memory address which holds a pointer to Blender's internal data
1253
+
1254
+ :return: int (memory address).
1255
+ :rtype: int
1256
+ """
904
1257
  ...
905
1258
 
906
- def bl_rna_get_subclass(self):
907
- """ """
1259
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1260
+ """
1261
+
1262
+ :return: The RNA type or default when not found.
1263
+ :rtype: bpy.types.Struct
1264
+ """
908
1265
  ...
909
1266
 
910
- def bl_rna_get_subclass_py(self):
911
- """ """
1267
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1268
+ """
1269
+
1270
+ :return: The class or default when not found.
1271
+ :rtype: typing.Any
1272
+ """
912
1273
  ...
913
1274
 
914
1275
  def draw(self, context):
@@ -918,72 +1279,126 @@ class DATA_PT_custom_props_curves(
918
1279
  """
919
1280
  ...
920
1281
 
921
- def driver_add(self):
922
- """ """
1282
+ def driver_add(self) -> bpy.types.FCurve:
1283
+ """Adds driver(s) to the given property
1284
+
1285
+ :return: The driver(s) added.
1286
+ :rtype: bpy.types.FCurve
1287
+ """
923
1288
  ...
924
1289
 
925
- def driver_remove(self):
926
- """ """
1290
+ def driver_remove(self) -> bool:
1291
+ """Remove driver(s) from the given property
1292
+
1293
+ :return: Success of driver removal.
1294
+ :rtype: bool
1295
+ """
927
1296
  ...
928
1297
 
929
1298
  def get(self):
930
- """ """
1299
+ """Returns the value of the custom property assigned to key or default
1300
+ when not found (matches Python's dictionary function of the same name).
1301
+
1302
+ """
931
1303
  ...
932
1304
 
933
1305
  def id_properties_clear(self):
934
- """ """
1306
+ """
1307
+
1308
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1309
+ """
935
1310
  ...
936
1311
 
937
1312
  def id_properties_ensure(self):
938
- """ """
1313
+ """
1314
+
1315
+ :return: the parent group for an RNA struct's custom IDProperties.
1316
+ """
939
1317
  ...
940
1318
 
941
1319
  def id_properties_ui(self):
942
- """ """
943
- ...
1320
+ """
944
1321
 
945
- def is_extended(self):
946
- """ """
1322
+ :return: Return an object used to manage an IDProperty's UI data.
1323
+ """
947
1324
  ...
948
1325
 
949
- def is_property_hidden(self):
950
- """ """
1326
+ def is_extended(self): ...
1327
+ def is_property_hidden(self) -> bool:
1328
+ """Check if a property is hidden.
1329
+
1330
+ :return: True when the property is hidden.
1331
+ :rtype: bool
1332
+ """
951
1333
  ...
952
1334
 
953
- def is_property_overridable_library(self):
954
- """ """
1335
+ def is_property_overridable_library(self) -> bool:
1336
+ """Check if a property is overridable.
1337
+
1338
+ :return: True when the property is overridable.
1339
+ :rtype: bool
1340
+ """
955
1341
  ...
956
1342
 
957
- def is_property_readonly(self):
958
- """ """
1343
+ def is_property_readonly(self) -> bool:
1344
+ """Check if a property is readonly.
1345
+
1346
+ :return: True when the property is readonly (not writable).
1347
+ :rtype: bool
1348
+ """
959
1349
  ...
960
1350
 
961
- def is_property_set(self):
962
- """ """
1351
+ def is_property_set(self) -> bool:
1352
+ """Check if a property is set, use for testing operator properties.
1353
+
1354
+ :return: True when the property has been set.
1355
+ :rtype: bool
1356
+ """
963
1357
  ...
964
1358
 
965
1359
  def items(self):
966
- """ """
1360
+ """Returns the items of this objects custom properties (matches Python's
1361
+ dictionary function of the same name).
1362
+
1363
+ :return: custom property key, value pairs.
1364
+ """
967
1365
  ...
968
1366
 
969
- def keyframe_delete(self):
970
- """ """
1367
+ def keyframe_delete(self) -> bool:
1368
+ """Remove a keyframe from this properties fcurve.
1369
+
1370
+ :return: Success of keyframe deletion.
1371
+ :rtype: bool
1372
+ """
971
1373
  ...
972
1374
 
973
- def keyframe_insert(self):
974
- """ """
1375
+ def keyframe_insert(self) -> bool:
1376
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1377
+
1378
+ :return: Success of keyframe insertion.
1379
+ :rtype: bool
1380
+ """
975
1381
  ...
976
1382
 
977
1383
  def keys(self):
978
- """ """
1384
+ """Returns the keys of this objects custom properties (matches Python's
1385
+ dictionary function of the same name).
1386
+
1387
+ :return: custom property keys.
1388
+ """
979
1389
  ...
980
1390
 
981
- def path_from_id(self):
982
- """ """
1391
+ def path_from_id(self) -> str:
1392
+ """Returns the data path from the ID to this object (string).
1393
+
1394
+ :return: The path from `bpy.types.bpy_struct.id_data`
1395
+ to this struct and property (when given).
1396
+ :rtype: str
1397
+ """
983
1398
  ...
984
1399
 
985
1400
  def path_resolve(self):
986
- """ """
1401
+ """Returns the property from the path, raise an exception when not found."""
987
1402
  ...
988
1403
 
989
1404
  def poll(self, context):
@@ -994,35 +1409,51 @@ class DATA_PT_custom_props_curves(
994
1409
  ...
995
1410
 
996
1411
  def pop(self):
997
- """ """
1412
+ """Remove and return the value of the custom property assigned to key or default
1413
+ when not found (matches Python's dictionary function of the same name).
1414
+
1415
+ """
998
1416
  ...
999
1417
 
1000
1418
  def prepend(self, draw_func):
1001
- """
1419
+ """Prepend a draw function to this menu, takes the same arguments as
1420
+ the menus draw function
1002
1421
 
1003
- :param draw_func:
1422
+ :param draw_func:
1004
1423
  """
1005
1424
  ...
1006
1425
 
1007
- def property_overridable_library_set(self):
1008
- """ """
1426
+ def property_overridable_library_set(self) -> bool:
1427
+ """Define a property as overridable or not (only for custom properties!).
1428
+
1429
+ :return: True when the overridable status of the property was successfully set.
1430
+ :rtype: bool
1431
+ """
1009
1432
  ...
1010
1433
 
1011
1434
  def property_unset(self):
1012
- """ """
1435
+ """Unset a property, will use default value afterward."""
1013
1436
  ...
1014
1437
 
1015
1438
  def remove(self, draw_func):
1016
- """
1439
+ """Remove a draw function that has been added to this menu
1017
1440
 
1018
1441
  :param draw_func:
1019
1442
  """
1020
1443
  ...
1021
1444
 
1022
1445
  def type_recast(self):
1023
- """ """
1446
+ """Return a new instance, this is needed because types
1447
+ such as textures can be changed at runtime.
1448
+
1449
+ :return: a new instance of this object with the type initialized again.
1450
+ """
1024
1451
  ...
1025
1452
 
1026
1453
  def values(self):
1027
- """ """
1454
+ """Returns the values of this objects custom properties (matches Python's
1455
+ dictionary function of the same name).
1456
+
1457
+ :return: custom property values.
1458
+ """
1028
1459
  ...