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
 
@@ -28,22 +29,35 @@ class CURVES_MT_add_attribute(bpy_types.Menu, bpy_types._GenericUI):
28
29
  ...
29
30
 
30
31
  def append(self, draw_func):
31
- """
32
+ """Append a draw function to this menu,
33
+ takes the same arguments as the menus draw function
32
34
 
33
- :param draw_func:
35
+ :param draw_func:
34
36
  """
35
37
  ...
36
38
 
37
- def as_pointer(self):
38
- """ """
39
+ def as_pointer(self) -> int:
40
+ """Returns the memory address which holds a pointer to Blender's internal data
41
+
42
+ :return: int (memory address).
43
+ :rtype: int
44
+ """
39
45
  ...
40
46
 
41
- def bl_rna_get_subclass(self):
42
- """ """
47
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
48
+ """
49
+
50
+ :return: The RNA type or default when not found.
51
+ :rtype: bpy.types.Struct
52
+ """
43
53
  ...
44
54
 
45
- def bl_rna_get_subclass_py(self):
46
- """ """
55
+ def bl_rna_get_subclass_py(self) -> typing.Any:
56
+ """
57
+
58
+ :return: The class or default when not found.
59
+ :rtype: typing.Any
60
+ """
47
61
  ...
48
62
 
49
63
  def draw(self, context):
@@ -62,138 +76,224 @@ class CURVES_MT_add_attribute(bpy_types.Menu, bpy_types._GenericUI):
62
76
  ...
63
77
 
64
78
  def draw_preset(self, _context):
65
- """
79
+ """Define these on the subclass:
80
+ - preset_operator (string)
81
+ - preset_subdir (string)Optionally:
82
+ - preset_add_operator (string)
83
+ - preset_extensions (set of strings)
84
+ - preset_operator_defaults (dict of keyword args)
66
85
 
67
- :param _context:
86
+ :param _context:
68
87
  """
69
88
  ...
70
89
 
71
- def driver_add(self):
72
- """ """
90
+ def driver_add(self) -> bpy.types.FCurve:
91
+ """Adds driver(s) to the given property
92
+
93
+ :return: The driver(s) added.
94
+ :rtype: bpy.types.FCurve
95
+ """
73
96
  ...
74
97
 
75
- def driver_remove(self):
76
- """ """
98
+ def driver_remove(self) -> bool:
99
+ """Remove driver(s) from the given property
100
+
101
+ :return: Success of driver removal.
102
+ :rtype: bool
103
+ """
77
104
  ...
78
105
 
79
106
  def get(self):
80
- """ """
107
+ """Returns the value of the custom property assigned to key or default
108
+ when not found (matches Python's dictionary function of the same name).
109
+
110
+ """
81
111
  ...
82
112
 
83
113
  def id_properties_clear(self):
84
- """ """
114
+ """
115
+
116
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
117
+ """
85
118
  ...
86
119
 
87
120
  def id_properties_ensure(self):
88
- """ """
121
+ """
122
+
123
+ :return: the parent group for an RNA struct's custom IDProperties.
124
+ """
89
125
  ...
90
126
 
91
127
  def id_properties_ui(self):
92
- """ """
128
+ """
129
+
130
+ :return: Return an object used to manage an IDProperty's UI data.
131
+ """
93
132
  ...
94
133
 
95
134
  def is_extended(self):
96
135
  """ """
97
136
  ...
98
137
 
99
- def is_property_hidden(self):
100
- """ """
138
+ def is_property_hidden(self) -> bool:
139
+ """Check if a property is hidden.
140
+
141
+ :return: True when the property is hidden.
142
+ :rtype: bool
143
+ """
101
144
  ...
102
145
 
103
- def is_property_overridable_library(self):
104
- """ """
146
+ def is_property_overridable_library(self) -> bool:
147
+ """Check if a property is overridable.
148
+
149
+ :return: True when the property is overridable.
150
+ :rtype: bool
151
+ """
105
152
  ...
106
153
 
107
- def is_property_readonly(self):
108
- """ """
154
+ def is_property_readonly(self) -> bool:
155
+ """Check if a property is readonly.
156
+
157
+ :return: True when the property is readonly (not writable).
158
+ :rtype: bool
159
+ """
109
160
  ...
110
161
 
111
- def is_property_set(self):
112
- """ """
162
+ def is_property_set(self) -> bool:
163
+ """Check if a property is set, use for testing operator properties.
164
+
165
+ :return: True when the property has been set.
166
+ :rtype: bool
167
+ """
113
168
  ...
114
169
 
115
170
  def items(self):
116
- """ """
171
+ """Returns the items of this objects custom properties (matches Python's
172
+ dictionary function of the same name).
173
+
174
+ :return: custom property key, value pairs.
175
+ """
117
176
  ...
118
177
 
119
- def keyframe_delete(self):
120
- """ """
178
+ def keyframe_delete(self) -> bool:
179
+ """Remove a keyframe from this properties fcurve.
180
+
181
+ :return: Success of keyframe deletion.
182
+ :rtype: bool
183
+ """
121
184
  ...
122
185
 
123
- def keyframe_insert(self):
124
- """ """
186
+ def keyframe_insert(self) -> bool:
187
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
188
+
189
+ :return: Success of keyframe insertion.
190
+ :rtype: bool
191
+ """
125
192
  ...
126
193
 
127
194
  def keys(self):
128
- """ """
195
+ """Returns the keys of this objects custom properties (matches Python's
196
+ dictionary function of the same name).
197
+
198
+ :return: custom property keys.
199
+ """
129
200
  ...
130
201
 
131
- def path_from_id(self):
132
- """ """
202
+ def path_from_id(self) -> str:
203
+ """Returns the data path from the ID to this object (string).
204
+
205
+ :return: The path from `bpy.types.bpy_struct.id_data`
206
+ to this struct and property (when given).
207
+ :rtype: str
208
+ """
133
209
  ...
134
210
 
135
211
  def path_menu(
136
212
  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,
213
+ searchpaths: list[str],
214
+ operator: str,
215
+ props_default: dict = None,
216
+ prop_filepath: str = "filepath",
217
+ filter_ext: typing.Callable = None,
218
+ filter_path=None,
219
+ display_name: typing.Callable = None,
220
+ add_operator=None,
221
+ add_operator_props=None,
146
222
  ):
147
- """
223
+ """Populate a menu from a list of paths.
148
224
 
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:
225
+ :param searchpaths: Paths to scan.
226
+ :type searchpaths: list[str]
227
+ :param operator: The operator id to use with each file.
228
+ :type operator: str
229
+ :param props_default: Properties to assign to each operator.
230
+ :type props_default: dict
231
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
232
+ :type prop_filepath: str
233
+ :param filter_ext: Optional callback that takes the file extensions.
234
+
235
+ Returning false excludes the file from the list.
236
+ :type filter_ext: typing.Callable
237
+ :param filter_path:
238
+ :param display_name: Optional callback that takes the full path, returns the name to display.
239
+ :type display_name: typing.Callable
240
+ :param add_operator:
241
+ :param add_operator_props:
158
242
  """
159
243
  ...
160
244
 
161
245
  def path_resolve(self):
162
- """ """
246
+ """Returns the property from the path, raise an exception when not found."""
163
247
  ...
164
248
 
165
249
  def pop(self):
166
- """ """
250
+ """Remove and return the value of the custom property assigned to key or default
251
+ when not found (matches Python's dictionary function of the same name).
252
+
253
+ """
167
254
  ...
168
255
 
169
256
  def prepend(self, draw_func):
170
- """
257
+ """Prepend a draw function to this menu, takes the same arguments as
258
+ the menus draw function
171
259
 
172
- :param draw_func:
260
+ :param draw_func:
173
261
  """
174
262
  ...
175
263
 
176
- def property_overridable_library_set(self):
177
- """ """
264
+ def property_overridable_library_set(self) -> bool:
265
+ """Define a property as overridable or not (only for custom properties!).
266
+
267
+ :return: True when the overridable status of the property was successfully set.
268
+ :rtype: bool
269
+ """
178
270
  ...
179
271
 
180
272
  def property_unset(self):
181
- """ """
273
+ """Unset a property, will use default value afterward."""
182
274
  ...
183
275
 
184
276
  def remove(self, draw_func):
185
- """
277
+ """Remove a draw function that has been added to this menu
186
278
 
187
279
  :param draw_func:
188
280
  """
189
281
  ...
190
282
 
191
283
  def type_recast(self):
192
- """ """
284
+ """Return a new instance, this is needed because types
285
+ such as textures can be changed at runtime.
286
+
287
+ :return: a new instance of this object with the type initialized again.
288
+ """
193
289
  ...
194
290
 
195
291
  def values(self):
196
- """ """
292
+ """Returns the values of this objects custom properties (matches Python's
293
+ dictionary function of the same name).
294
+
295
+ :return: custom property values.
296
+ """
197
297
  ...
198
298
 
199
299
  class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
@@ -206,22 +306,35 @@ class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
206
306
  """ """
207
307
 
208
308
  def append(self, draw_func):
209
- """
309
+ """Append a draw function to this menu,
310
+ takes the same arguments as the menus draw function
210
311
 
211
- :param draw_func:
312
+ :param draw_func:
212
313
  """
213
314
  ...
214
315
 
215
- def as_pointer(self):
216
- """ """
316
+ def as_pointer(self) -> int:
317
+ """Returns the memory address which holds a pointer to Blender's internal data
318
+
319
+ :return: int (memory address).
320
+ :rtype: int
321
+ """
217
322
  ...
218
323
 
219
- def bl_rna_get_subclass(self):
220
- """ """
324
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
325
+ """
326
+
327
+ :return: The RNA type or default when not found.
328
+ :rtype: bpy.types.Struct
329
+ """
221
330
  ...
222
331
 
223
- def bl_rna_get_subclass_py(self):
224
- """ """
332
+ def bl_rna_get_subclass_py(self) -> typing.Any:
333
+ """
334
+
335
+ :return: The class or default when not found.
336
+ :rtype: typing.Any
337
+ """
225
338
  ...
226
339
 
227
340
  def draw_item(
@@ -248,12 +361,20 @@ class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
248
361
  """
249
362
  ...
250
363
 
251
- def driver_add(self):
252
- """ """
364
+ def driver_add(self) -> bpy.types.FCurve:
365
+ """Adds driver(s) to the given property
366
+
367
+ :return: The driver(s) added.
368
+ :rtype: bpy.types.FCurve
369
+ """
253
370
  ...
254
371
 
255
- def driver_remove(self):
256
- """ """
372
+ def driver_remove(self) -> bool:
373
+ """Remove driver(s) from the given property
374
+
375
+ :return: Success of driver removal.
376
+ :rtype: bool
377
+ """
257
378
  ...
258
379
 
259
380
  def filter_items(self, _context, data, property):
@@ -266,97 +387,162 @@ class CURVES_UL_attributes(bpy_types.UIList, bpy_types._GenericUI):
266
387
  ...
267
388
 
268
389
  def get(self):
269
- """ """
390
+ """Returns the value of the custom property assigned to key or default
391
+ when not found (matches Python's dictionary function of the same name).
392
+
393
+ """
270
394
  ...
271
395
 
272
396
  def id_properties_clear(self):
273
- """ """
397
+ """
398
+
399
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
400
+ """
274
401
  ...
275
402
 
276
403
  def id_properties_ensure(self):
277
- """ """
404
+ """
405
+
406
+ :return: the parent group for an RNA struct's custom IDProperties.
407
+ """
278
408
  ...
279
409
 
280
410
  def id_properties_ui(self):
281
- """ """
411
+ """
412
+
413
+ :return: Return an object used to manage an IDProperty's UI data.
414
+ """
282
415
  ...
283
416
 
284
417
  def is_extended(self):
285
418
  """ """
286
419
  ...
287
420
 
288
- def is_property_hidden(self):
289
- """ """
421
+ def is_property_hidden(self) -> bool:
422
+ """Check if a property is hidden.
423
+
424
+ :return: True when the property is hidden.
425
+ :rtype: bool
426
+ """
290
427
  ...
291
428
 
292
- def is_property_overridable_library(self):
293
- """ """
429
+ def is_property_overridable_library(self) -> bool:
430
+ """Check if a property is overridable.
431
+
432
+ :return: True when the property is overridable.
433
+ :rtype: bool
434
+ """
294
435
  ...
295
436
 
296
- def is_property_readonly(self):
297
- """ """
437
+ def is_property_readonly(self) -> bool:
438
+ """Check if a property is readonly.
439
+
440
+ :return: True when the property is readonly (not writable).
441
+ :rtype: bool
442
+ """
298
443
  ...
299
444
 
300
- def is_property_set(self):
301
- """ """
445
+ def is_property_set(self) -> bool:
446
+ """Check if a property is set, use for testing operator properties.
447
+
448
+ :return: True when the property has been set.
449
+ :rtype: bool
450
+ """
302
451
  ...
303
452
 
304
453
  def items(self):
305
- """ """
454
+ """Returns the items of this objects custom properties (matches Python's
455
+ dictionary function of the same name).
456
+
457
+ :return: custom property key, value pairs.
458
+ """
306
459
  ...
307
460
 
308
- def keyframe_delete(self):
309
- """ """
461
+ def keyframe_delete(self) -> bool:
462
+ """Remove a keyframe from this properties fcurve.
463
+
464
+ :return: Success of keyframe deletion.
465
+ :rtype: bool
466
+ """
310
467
  ...
311
468
 
312
- def keyframe_insert(self):
313
- """ """
469
+ def keyframe_insert(self) -> bool:
470
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
471
+
472
+ :return: Success of keyframe insertion.
473
+ :rtype: bool
474
+ """
314
475
  ...
315
476
 
316
477
  def keys(self):
317
- """ """
478
+ """Returns the keys of this objects custom properties (matches Python's
479
+ dictionary function of the same name).
480
+
481
+ :return: custom property keys.
482
+ """
318
483
  ...
319
484
 
320
- def path_from_id(self):
321
- """ """
485
+ def path_from_id(self) -> str:
486
+ """Returns the data path from the ID to this object (string).
487
+
488
+ :return: The path from `bpy.types.bpy_struct.id_data`
489
+ to this struct and property (when given).
490
+ :rtype: str
491
+ """
322
492
  ...
323
493
 
324
494
  def path_resolve(self):
325
- """ """
495
+ """Returns the property from the path, raise an exception when not found."""
326
496
  ...
327
497
 
328
498
  def pop(self):
329
- """ """
499
+ """Remove and return the value of the custom property assigned to key or default
500
+ when not found (matches Python's dictionary function of the same name).
501
+
502
+ """
330
503
  ...
331
504
 
332
505
  def prepend(self, draw_func):
333
- """
506
+ """Prepend a draw function to this menu, takes the same arguments as
507
+ the menus draw function
334
508
 
335
- :param draw_func:
509
+ :param draw_func:
336
510
  """
337
511
  ...
338
512
 
339
- def property_overridable_library_set(self):
340
- """ """
513
+ def property_overridable_library_set(self) -> bool:
514
+ """Define a property as overridable or not (only for custom properties!).
515
+
516
+ :return: True when the overridable status of the property was successfully set.
517
+ :rtype: bool
518
+ """
341
519
  ...
342
520
 
343
521
  def property_unset(self):
344
- """ """
522
+ """Unset a property, will use default value afterward."""
345
523
  ...
346
524
 
347
525
  def remove(self, draw_func):
348
- """
526
+ """Remove a draw function that has been added to this menu
349
527
 
350
528
  :param draw_func:
351
529
  """
352
530
  ...
353
531
 
354
532
  def type_recast(self):
355
- """ """
533
+ """Return a new instance, this is needed because types
534
+ such as textures can be changed at runtime.
535
+
536
+ :return: a new instance of this object with the type initialized again.
537
+ """
356
538
  ...
357
539
 
358
540
  def values(self):
359
- """ """
541
+ """Returns the values of this objects custom properties (matches Python's
542
+ dictionary function of the same name).
543
+
544
+ :return: custom property values.
545
+ """
360
546
  ...
361
547
 
362
548
  class DataButtonsPanel:
@@ -405,22 +591,35 @@ class DATA_PT_CURVES_attributes(
405
591
  """ """
406
592
 
407
593
  def append(self, draw_func):
408
- """
594
+ """Append a draw function to this menu,
595
+ takes the same arguments as the menus draw function
409
596
 
410
- :param draw_func:
597
+ :param draw_func:
411
598
  """
412
599
  ...
413
600
 
414
- def as_pointer(self):
415
- """ """
601
+ def as_pointer(self) -> int:
602
+ """Returns the memory address which holds a pointer to Blender's internal data
603
+
604
+ :return: int (memory address).
605
+ :rtype: int
606
+ """
416
607
  ...
417
608
 
418
- def bl_rna_get_subclass(self):
419
- """ """
609
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
610
+ """
611
+
612
+ :return: The RNA type or default when not found.
613
+ :rtype: bpy.types.Struct
614
+ """
420
615
  ...
421
616
 
422
- def bl_rna_get_subclass_py(self):
423
- """ """
617
+ def bl_rna_get_subclass_py(self) -> typing.Any:
618
+ """
619
+
620
+ :return: The class or default when not found.
621
+ :rtype: typing.Any
622
+ """
424
623
  ...
425
624
 
426
625
  def draw(self, context):
@@ -430,72 +629,129 @@ class DATA_PT_CURVES_attributes(
430
629
  """
431
630
  ...
432
631
 
433
- def driver_add(self):
434
- """ """
632
+ def driver_add(self) -> bpy.types.FCurve:
633
+ """Adds driver(s) to the given property
634
+
635
+ :return: The driver(s) added.
636
+ :rtype: bpy.types.FCurve
637
+ """
435
638
  ...
436
639
 
437
- def driver_remove(self):
438
- """ """
640
+ def driver_remove(self) -> bool:
641
+ """Remove driver(s) from the given property
642
+
643
+ :return: Success of driver removal.
644
+ :rtype: bool
645
+ """
439
646
  ...
440
647
 
441
648
  def get(self):
442
- """ """
649
+ """Returns the value of the custom property assigned to key or default
650
+ when not found (matches Python's dictionary function of the same name).
651
+
652
+ """
443
653
  ...
444
654
 
445
655
  def id_properties_clear(self):
446
- """ """
656
+ """
657
+
658
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
659
+ """
447
660
  ...
448
661
 
449
662
  def id_properties_ensure(self):
450
- """ """
663
+ """
664
+
665
+ :return: the parent group for an RNA struct's custom IDProperties.
666
+ """
451
667
  ...
452
668
 
453
669
  def id_properties_ui(self):
454
- """ """
670
+ """
671
+
672
+ :return: Return an object used to manage an IDProperty's UI data.
673
+ """
455
674
  ...
456
675
 
457
676
  def is_extended(self):
458
677
  """ """
459
678
  ...
460
679
 
461
- def is_property_hidden(self):
462
- """ """
680
+ def is_property_hidden(self) -> bool:
681
+ """Check if a property is hidden.
682
+
683
+ :return: True when the property is hidden.
684
+ :rtype: bool
685
+ """
463
686
  ...
464
687
 
465
- def is_property_overridable_library(self):
466
- """ """
688
+ def is_property_overridable_library(self) -> bool:
689
+ """Check if a property is overridable.
690
+
691
+ :return: True when the property is overridable.
692
+ :rtype: bool
693
+ """
467
694
  ...
468
695
 
469
- def is_property_readonly(self):
470
- """ """
696
+ def is_property_readonly(self) -> bool:
697
+ """Check if a property is readonly.
698
+
699
+ :return: True when the property is readonly (not writable).
700
+ :rtype: bool
701
+ """
471
702
  ...
472
703
 
473
- def is_property_set(self):
474
- """ """
704
+ def is_property_set(self) -> bool:
705
+ """Check if a property is set, use for testing operator properties.
706
+
707
+ :return: True when the property has been set.
708
+ :rtype: bool
709
+ """
475
710
  ...
476
711
 
477
712
  def items(self):
478
- """ """
713
+ """Returns the items of this objects custom properties (matches Python's
714
+ dictionary function of the same name).
715
+
716
+ :return: custom property key, value pairs.
717
+ """
479
718
  ...
480
719
 
481
- def keyframe_delete(self):
482
- """ """
720
+ def keyframe_delete(self) -> bool:
721
+ """Remove a keyframe from this properties fcurve.
722
+
723
+ :return: Success of keyframe deletion.
724
+ :rtype: bool
725
+ """
483
726
  ...
484
727
 
485
- def keyframe_insert(self):
486
- """ """
728
+ def keyframe_insert(self) -> bool:
729
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
730
+
731
+ :return: Success of keyframe insertion.
732
+ :rtype: bool
733
+ """
487
734
  ...
488
735
 
489
736
  def keys(self):
490
- """ """
737
+ """Returns the keys of this objects custom properties (matches Python's
738
+ dictionary function of the same name).
739
+
740
+ :return: custom property keys.
741
+ """
491
742
  ...
492
743
 
493
- def path_from_id(self):
494
- """ """
744
+ def path_from_id(self) -> str:
745
+ """Returns the data path from the ID to this object (string).
746
+
747
+ :return: The path from `bpy.types.bpy_struct.id_data`
748
+ to this struct and property (when given).
749
+ :rtype: str
750
+ """
495
751
  ...
496
752
 
497
753
  def path_resolve(self):
498
- """ """
754
+ """Returns the property from the path, raise an exception when not found."""
499
755
  ...
500
756
 
501
757
  def poll(self, context):
@@ -506,37 +762,53 @@ class DATA_PT_CURVES_attributes(
506
762
  ...
507
763
 
508
764
  def pop(self):
509
- """ """
765
+ """Remove and return the value of the custom property assigned to key or default
766
+ when not found (matches Python's dictionary function of the same name).
767
+
768
+ """
510
769
  ...
511
770
 
512
771
  def prepend(self, draw_func):
513
- """
772
+ """Prepend a draw function to this menu, takes the same arguments as
773
+ the menus draw function
514
774
 
515
- :param draw_func:
775
+ :param draw_func:
516
776
  """
517
777
  ...
518
778
 
519
- def property_overridable_library_set(self):
520
- """ """
779
+ def property_overridable_library_set(self) -> bool:
780
+ """Define a property as overridable or not (only for custom properties!).
781
+
782
+ :return: True when the overridable status of the property was successfully set.
783
+ :rtype: bool
784
+ """
521
785
  ...
522
786
 
523
787
  def property_unset(self):
524
- """ """
788
+ """Unset a property, will use default value afterward."""
525
789
  ...
526
790
 
527
791
  def remove(self, draw_func):
528
- """
792
+ """Remove a draw function that has been added to this menu
529
793
 
530
794
  :param draw_func:
531
795
  """
532
796
  ...
533
797
 
534
798
  def type_recast(self):
535
- """ """
799
+ """Return a new instance, this is needed because types
800
+ such as textures can be changed at runtime.
801
+
802
+ :return: a new instance of this object with the type initialized again.
803
+ """
536
804
  ...
537
805
 
538
806
  def values(self):
539
- """ """
807
+ """Returns the values of this objects custom properties (matches Python's
808
+ dictionary function of the same name).
809
+
810
+ :return: custom property values.
811
+ """
540
812
  ...
541
813
 
542
814
  class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -567,22 +839,35 @@ class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
567
839
  """ """
568
840
 
569
841
  def append(self, draw_func):
570
- """
842
+ """Append a draw function to this menu,
843
+ takes the same arguments as the menus draw function
571
844
 
572
- :param draw_func:
845
+ :param draw_func:
573
846
  """
574
847
  ...
575
848
 
576
- def as_pointer(self):
577
- """ """
849
+ def as_pointer(self) -> int:
850
+ """Returns the memory address which holds a pointer to Blender's internal data
851
+
852
+ :return: int (memory address).
853
+ :rtype: int
854
+ """
578
855
  ...
579
856
 
580
- def bl_rna_get_subclass(self):
581
- """ """
857
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
858
+ """
859
+
860
+ :return: The RNA type or default when not found.
861
+ :rtype: bpy.types.Struct
862
+ """
582
863
  ...
583
864
 
584
- def bl_rna_get_subclass_py(self):
585
- """ """
865
+ def bl_rna_get_subclass_py(self) -> typing.Any:
866
+ """
867
+
868
+ :return: The class or default when not found.
869
+ :rtype: typing.Any
870
+ """
586
871
  ...
587
872
 
588
873
  def draw(self, context):
@@ -592,72 +877,129 @@ class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
592
877
  """
593
878
  ...
594
879
 
595
- def driver_add(self):
596
- """ """
880
+ def driver_add(self) -> bpy.types.FCurve:
881
+ """Adds driver(s) to the given property
882
+
883
+ :return: The driver(s) added.
884
+ :rtype: bpy.types.FCurve
885
+ """
597
886
  ...
598
887
 
599
- def driver_remove(self):
600
- """ """
888
+ def driver_remove(self) -> bool:
889
+ """Remove driver(s) from the given property
890
+
891
+ :return: Success of driver removal.
892
+ :rtype: bool
893
+ """
601
894
  ...
602
895
 
603
896
  def get(self):
604
- """ """
897
+ """Returns the value of the custom property assigned to key or default
898
+ when not found (matches Python's dictionary function of the same name).
899
+
900
+ """
605
901
  ...
606
902
 
607
903
  def id_properties_clear(self):
608
- """ """
904
+ """
905
+
906
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
907
+ """
609
908
  ...
610
909
 
611
910
  def id_properties_ensure(self):
612
- """ """
911
+ """
912
+
913
+ :return: the parent group for an RNA struct's custom IDProperties.
914
+ """
613
915
  ...
614
916
 
615
917
  def id_properties_ui(self):
616
- """ """
918
+ """
919
+
920
+ :return: Return an object used to manage an IDProperty's UI data.
921
+ """
617
922
  ...
618
923
 
619
924
  def is_extended(self):
620
925
  """ """
621
926
  ...
622
927
 
623
- def is_property_hidden(self):
624
- """ """
928
+ def is_property_hidden(self) -> bool:
929
+ """Check if a property is hidden.
930
+
931
+ :return: True when the property is hidden.
932
+ :rtype: bool
933
+ """
625
934
  ...
626
935
 
627
- def is_property_overridable_library(self):
628
- """ """
936
+ def is_property_overridable_library(self) -> bool:
937
+ """Check if a property is overridable.
938
+
939
+ :return: True when the property is overridable.
940
+ :rtype: bool
941
+ """
629
942
  ...
630
943
 
631
- def is_property_readonly(self):
632
- """ """
944
+ def is_property_readonly(self) -> bool:
945
+ """Check if a property is readonly.
946
+
947
+ :return: True when the property is readonly (not writable).
948
+ :rtype: bool
949
+ """
633
950
  ...
634
951
 
635
- def is_property_set(self):
636
- """ """
952
+ def is_property_set(self) -> bool:
953
+ """Check if a property is set, use for testing operator properties.
954
+
955
+ :return: True when the property has been set.
956
+ :rtype: bool
957
+ """
637
958
  ...
638
959
 
639
960
  def items(self):
640
- """ """
961
+ """Returns the items of this objects custom properties (matches Python's
962
+ dictionary function of the same name).
963
+
964
+ :return: custom property key, value pairs.
965
+ """
641
966
  ...
642
967
 
643
- def keyframe_delete(self):
644
- """ """
968
+ def keyframe_delete(self) -> bool:
969
+ """Remove a keyframe from this properties fcurve.
970
+
971
+ :return: Success of keyframe deletion.
972
+ :rtype: bool
973
+ """
645
974
  ...
646
975
 
647
- def keyframe_insert(self):
648
- """ """
976
+ def keyframe_insert(self) -> bool:
977
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
978
+
979
+ :return: Success of keyframe insertion.
980
+ :rtype: bool
981
+ """
649
982
  ...
650
983
 
651
984
  def keys(self):
652
- """ """
985
+ """Returns the keys of this objects custom properties (matches Python's
986
+ dictionary function of the same name).
987
+
988
+ :return: custom property keys.
989
+ """
653
990
  ...
654
991
 
655
- def path_from_id(self):
656
- """ """
992
+ def path_from_id(self) -> str:
993
+ """Returns the data path from the ID to this object (string).
994
+
995
+ :return: The path from `bpy.types.bpy_struct.id_data`
996
+ to this struct and property (when given).
997
+ :rtype: str
998
+ """
657
999
  ...
658
1000
 
659
1001
  def path_resolve(self):
660
- """ """
1002
+ """Returns the property from the path, raise an exception when not found."""
661
1003
  ...
662
1004
 
663
1005
  def poll(self, context):
@@ -668,37 +1010,53 @@ class DATA_PT_context_curves(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
668
1010
  ...
669
1011
 
670
1012
  def pop(self):
671
- """ """
1013
+ """Remove and return the value of the custom property assigned to key or default
1014
+ when not found (matches Python's dictionary function of the same name).
1015
+
1016
+ """
672
1017
  ...
673
1018
 
674
1019
  def prepend(self, draw_func):
675
- """
1020
+ """Prepend a draw function to this menu, takes the same arguments as
1021
+ the menus draw function
676
1022
 
677
- :param draw_func:
1023
+ :param draw_func:
678
1024
  """
679
1025
  ...
680
1026
 
681
- def property_overridable_library_set(self):
682
- """ """
1027
+ def property_overridable_library_set(self) -> bool:
1028
+ """Define a property as overridable or not (only for custom properties!).
1029
+
1030
+ :return: True when the overridable status of the property was successfully set.
1031
+ :rtype: bool
1032
+ """
683
1033
  ...
684
1034
 
685
1035
  def property_unset(self):
686
- """ """
1036
+ """Unset a property, will use default value afterward."""
687
1037
  ...
688
1038
 
689
1039
  def remove(self, draw_func):
690
- """
1040
+ """Remove a draw function that has been added to this menu
691
1041
 
692
1042
  :param draw_func:
693
1043
  """
694
1044
  ...
695
1045
 
696
1046
  def type_recast(self):
697
- """ """
1047
+ """Return a new instance, this is needed because types
1048
+ such as textures can be changed at runtime.
1049
+
1050
+ :return: a new instance of this object with the type initialized again.
1051
+ """
698
1052
  ...
699
1053
 
700
1054
  def values(self):
701
- """ """
1055
+ """Returns the values of this objects custom properties (matches Python's
1056
+ dictionary function of the same name).
1057
+
1058
+ :return: custom property values.
1059
+ """
702
1060
  ...
703
1061
 
704
1062
  class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -726,22 +1084,35 @@ class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
726
1084
  """ """
727
1085
 
728
1086
  def append(self, draw_func):
729
- """
1087
+ """Append a draw function to this menu,
1088
+ takes the same arguments as the menus draw function
730
1089
 
731
- :param draw_func:
1090
+ :param draw_func:
732
1091
  """
733
1092
  ...
734
1093
 
735
- def as_pointer(self):
736
- """ """
1094
+ def as_pointer(self) -> int:
1095
+ """Returns the memory address which holds a pointer to Blender's internal data
1096
+
1097
+ :return: int (memory address).
1098
+ :rtype: int
1099
+ """
737
1100
  ...
738
1101
 
739
- def bl_rna_get_subclass(self):
740
- """ """
1102
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1103
+ """
1104
+
1105
+ :return: The RNA type or default when not found.
1106
+ :rtype: bpy.types.Struct
1107
+ """
741
1108
  ...
742
1109
 
743
- def bl_rna_get_subclass_py(self):
744
- """ """
1110
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1111
+ """
1112
+
1113
+ :return: The class or default when not found.
1114
+ :rtype: typing.Any
1115
+ """
745
1116
  ...
746
1117
 
747
1118
  def draw(self, context):
@@ -751,72 +1122,129 @@ class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
751
1122
  """
752
1123
  ...
753
1124
 
754
- def driver_add(self):
755
- """ """
1125
+ def driver_add(self) -> bpy.types.FCurve:
1126
+ """Adds driver(s) to the given property
1127
+
1128
+ :return: The driver(s) added.
1129
+ :rtype: bpy.types.FCurve
1130
+ """
756
1131
  ...
757
1132
 
758
- def driver_remove(self):
759
- """ """
1133
+ def driver_remove(self) -> bool:
1134
+ """Remove driver(s) from the given property
1135
+
1136
+ :return: Success of driver removal.
1137
+ :rtype: bool
1138
+ """
760
1139
  ...
761
1140
 
762
1141
  def get(self):
763
- """ """
1142
+ """Returns the value of the custom property assigned to key or default
1143
+ when not found (matches Python's dictionary function of the same name).
1144
+
1145
+ """
764
1146
  ...
765
1147
 
766
1148
  def id_properties_clear(self):
767
- """ """
1149
+ """
1150
+
1151
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1152
+ """
768
1153
  ...
769
1154
 
770
1155
  def id_properties_ensure(self):
771
- """ """
1156
+ """
1157
+
1158
+ :return: the parent group for an RNA struct's custom IDProperties.
1159
+ """
772
1160
  ...
773
1161
 
774
1162
  def id_properties_ui(self):
775
- """ """
1163
+ """
1164
+
1165
+ :return: Return an object used to manage an IDProperty's UI data.
1166
+ """
776
1167
  ...
777
1168
 
778
1169
  def is_extended(self):
779
1170
  """ """
780
1171
  ...
781
1172
 
782
- def is_property_hidden(self):
783
- """ """
1173
+ def is_property_hidden(self) -> bool:
1174
+ """Check if a property is hidden.
1175
+
1176
+ :return: True when the property is hidden.
1177
+ :rtype: bool
1178
+ """
784
1179
  ...
785
1180
 
786
- def is_property_overridable_library(self):
787
- """ """
1181
+ def is_property_overridable_library(self) -> bool:
1182
+ """Check if a property is overridable.
1183
+
1184
+ :return: True when the property is overridable.
1185
+ :rtype: bool
1186
+ """
788
1187
  ...
789
1188
 
790
- def is_property_readonly(self):
791
- """ """
1189
+ def is_property_readonly(self) -> bool:
1190
+ """Check if a property is readonly.
1191
+
1192
+ :return: True when the property is readonly (not writable).
1193
+ :rtype: bool
1194
+ """
792
1195
  ...
793
1196
 
794
- def is_property_set(self):
795
- """ """
1197
+ def is_property_set(self) -> bool:
1198
+ """Check if a property is set, use for testing operator properties.
1199
+
1200
+ :return: True when the property has been set.
1201
+ :rtype: bool
1202
+ """
796
1203
  ...
797
1204
 
798
1205
  def items(self):
799
- """ """
1206
+ """Returns the items of this objects custom properties (matches Python's
1207
+ dictionary function of the same name).
1208
+
1209
+ :return: custom property key, value pairs.
1210
+ """
800
1211
  ...
801
1212
 
802
- def keyframe_delete(self):
803
- """ """
1213
+ def keyframe_delete(self) -> bool:
1214
+ """Remove a keyframe from this properties fcurve.
1215
+
1216
+ :return: Success of keyframe deletion.
1217
+ :rtype: bool
1218
+ """
804
1219
  ...
805
1220
 
806
- def keyframe_insert(self):
807
- """ """
1221
+ def keyframe_insert(self) -> bool:
1222
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1223
+
1224
+ :return: Success of keyframe insertion.
1225
+ :rtype: bool
1226
+ """
808
1227
  ...
809
1228
 
810
1229
  def keys(self):
811
- """ """
1230
+ """Returns the keys of this objects custom properties (matches Python's
1231
+ dictionary function of the same name).
1232
+
1233
+ :return: custom property keys.
1234
+ """
812
1235
  ...
813
1236
 
814
- def path_from_id(self):
815
- """ """
1237
+ def path_from_id(self) -> str:
1238
+ """Returns the data path from the ID to this object (string).
1239
+
1240
+ :return: The path from `bpy.types.bpy_struct.id_data`
1241
+ to this struct and property (when given).
1242
+ :rtype: str
1243
+ """
816
1244
  ...
817
1245
 
818
1246
  def path_resolve(self):
819
- """ """
1247
+ """Returns the property from the path, raise an exception when not found."""
820
1248
  ...
821
1249
 
822
1250
  def poll(self, context):
@@ -827,43 +1255,61 @@ class DATA_PT_curves_surface(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
827
1255
  ...
828
1256
 
829
1257
  def pop(self):
830
- """ """
1258
+ """Remove and return the value of the custom property assigned to key or default
1259
+ when not found (matches Python's dictionary function of the same name).
1260
+
1261
+ """
831
1262
  ...
832
1263
 
833
1264
  def prepend(self, draw_func):
834
- """
1265
+ """Prepend a draw function to this menu, takes the same arguments as
1266
+ the menus draw function
835
1267
 
836
- :param draw_func:
1268
+ :param draw_func:
837
1269
  """
838
1270
  ...
839
1271
 
840
- def property_overridable_library_set(self):
841
- """ """
1272
+ def property_overridable_library_set(self) -> bool:
1273
+ """Define a property as overridable or not (only for custom properties!).
1274
+
1275
+ :return: True when the overridable status of the property was successfully set.
1276
+ :rtype: bool
1277
+ """
842
1278
  ...
843
1279
 
844
1280
  def property_unset(self):
845
- """ """
1281
+ """Unset a property, will use default value afterward."""
846
1282
  ...
847
1283
 
848
1284
  def remove(self, draw_func):
849
- """
1285
+ """Remove a draw function that has been added to this menu
850
1286
 
851
1287
  :param draw_func:
852
1288
  """
853
1289
  ...
854
1290
 
855
1291
  def type_recast(self):
856
- """ """
1292
+ """Return a new instance, this is needed because types
1293
+ such as textures can be changed at runtime.
1294
+
1295
+ :return: a new instance of this object with the type initialized again.
1296
+ """
857
1297
  ...
858
1298
 
859
1299
  def values(self):
860
- """ """
1300
+ """Returns the values of this objects custom properties (matches Python's
1301
+ dictionary function of the same name).
1302
+
1303
+ :return: custom property values.
1304
+ """
861
1305
  ...
862
1306
 
863
1307
  class DATA_PT_custom_props_curves(
864
1308
  bpy_types.Panel, DataButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
865
1309
  ):
866
- """ """
1310
+ """The subclass should have its own poll function
1311
+ and the variable '_context_path' MUST be set.
1312
+ """
867
1313
 
868
1314
  COMPAT_ENGINES: typing.Any
869
1315
  """ """
@@ -893,22 +1339,35 @@ class DATA_PT_custom_props_curves(
893
1339
  """ """
894
1340
 
895
1341
  def append(self, draw_func):
896
- """
1342
+ """Append a draw function to this menu,
1343
+ takes the same arguments as the menus draw function
897
1344
 
898
- :param draw_func:
1345
+ :param draw_func:
899
1346
  """
900
1347
  ...
901
1348
 
902
- def as_pointer(self):
903
- """ """
1349
+ def as_pointer(self) -> int:
1350
+ """Returns the memory address which holds a pointer to Blender's internal data
1351
+
1352
+ :return: int (memory address).
1353
+ :rtype: int
1354
+ """
904
1355
  ...
905
1356
 
906
- def bl_rna_get_subclass(self):
907
- """ """
1357
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1358
+ """
1359
+
1360
+ :return: The RNA type or default when not found.
1361
+ :rtype: bpy.types.Struct
1362
+ """
908
1363
  ...
909
1364
 
910
- def bl_rna_get_subclass_py(self):
911
- """ """
1365
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1366
+ """
1367
+
1368
+ :return: The class or default when not found.
1369
+ :rtype: typing.Any
1370
+ """
912
1371
  ...
913
1372
 
914
1373
  def draw(self, context):
@@ -918,72 +1377,129 @@ class DATA_PT_custom_props_curves(
918
1377
  """
919
1378
  ...
920
1379
 
921
- def driver_add(self):
922
- """ """
1380
+ def driver_add(self) -> bpy.types.FCurve:
1381
+ """Adds driver(s) to the given property
1382
+
1383
+ :return: The driver(s) added.
1384
+ :rtype: bpy.types.FCurve
1385
+ """
923
1386
  ...
924
1387
 
925
- def driver_remove(self):
926
- """ """
1388
+ def driver_remove(self) -> bool:
1389
+ """Remove driver(s) from the given property
1390
+
1391
+ :return: Success of driver removal.
1392
+ :rtype: bool
1393
+ """
927
1394
  ...
928
1395
 
929
1396
  def get(self):
930
- """ """
1397
+ """Returns the value of the custom property assigned to key or default
1398
+ when not found (matches Python's dictionary function of the same name).
1399
+
1400
+ """
931
1401
  ...
932
1402
 
933
1403
  def id_properties_clear(self):
934
- """ """
1404
+ """
1405
+
1406
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1407
+ """
935
1408
  ...
936
1409
 
937
1410
  def id_properties_ensure(self):
938
- """ """
1411
+ """
1412
+
1413
+ :return: the parent group for an RNA struct's custom IDProperties.
1414
+ """
939
1415
  ...
940
1416
 
941
1417
  def id_properties_ui(self):
942
- """ """
1418
+ """
1419
+
1420
+ :return: Return an object used to manage an IDProperty's UI data.
1421
+ """
943
1422
  ...
944
1423
 
945
1424
  def is_extended(self):
946
1425
  """ """
947
1426
  ...
948
1427
 
949
- def is_property_hidden(self):
950
- """ """
1428
+ def is_property_hidden(self) -> bool:
1429
+ """Check if a property is hidden.
1430
+
1431
+ :return: True when the property is hidden.
1432
+ :rtype: bool
1433
+ """
951
1434
  ...
952
1435
 
953
- def is_property_overridable_library(self):
954
- """ """
1436
+ def is_property_overridable_library(self) -> bool:
1437
+ """Check if a property is overridable.
1438
+
1439
+ :return: True when the property is overridable.
1440
+ :rtype: bool
1441
+ """
955
1442
  ...
956
1443
 
957
- def is_property_readonly(self):
958
- """ """
1444
+ def is_property_readonly(self) -> bool:
1445
+ """Check if a property is readonly.
1446
+
1447
+ :return: True when the property is readonly (not writable).
1448
+ :rtype: bool
1449
+ """
959
1450
  ...
960
1451
 
961
- def is_property_set(self):
962
- """ """
1452
+ def is_property_set(self) -> bool:
1453
+ """Check if a property is set, use for testing operator properties.
1454
+
1455
+ :return: True when the property has been set.
1456
+ :rtype: bool
1457
+ """
963
1458
  ...
964
1459
 
965
1460
  def items(self):
966
- """ """
1461
+ """Returns the items of this objects custom properties (matches Python's
1462
+ dictionary function of the same name).
1463
+
1464
+ :return: custom property key, value pairs.
1465
+ """
967
1466
  ...
968
1467
 
969
- def keyframe_delete(self):
970
- """ """
1468
+ def keyframe_delete(self) -> bool:
1469
+ """Remove a keyframe from this properties fcurve.
1470
+
1471
+ :return: Success of keyframe deletion.
1472
+ :rtype: bool
1473
+ """
971
1474
  ...
972
1475
 
973
- def keyframe_insert(self):
974
- """ """
1476
+ def keyframe_insert(self) -> bool:
1477
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1478
+
1479
+ :return: Success of keyframe insertion.
1480
+ :rtype: bool
1481
+ """
975
1482
  ...
976
1483
 
977
1484
  def keys(self):
978
- """ """
1485
+ """Returns the keys of this objects custom properties (matches Python's
1486
+ dictionary function of the same name).
1487
+
1488
+ :return: custom property keys.
1489
+ """
979
1490
  ...
980
1491
 
981
- def path_from_id(self):
982
- """ """
1492
+ def path_from_id(self) -> str:
1493
+ """Returns the data path from the ID to this object (string).
1494
+
1495
+ :return: The path from `bpy.types.bpy_struct.id_data`
1496
+ to this struct and property (when given).
1497
+ :rtype: str
1498
+ """
983
1499
  ...
984
1500
 
985
1501
  def path_resolve(self):
986
- """ """
1502
+ """Returns the property from the path, raise an exception when not found."""
987
1503
  ...
988
1504
 
989
1505
  def poll(self, context):
@@ -994,35 +1510,51 @@ class DATA_PT_custom_props_curves(
994
1510
  ...
995
1511
 
996
1512
  def pop(self):
997
- """ """
1513
+ """Remove and return the value of the custom property assigned to key or default
1514
+ when not found (matches Python's dictionary function of the same name).
1515
+
1516
+ """
998
1517
  ...
999
1518
 
1000
1519
  def prepend(self, draw_func):
1001
- """
1520
+ """Prepend a draw function to this menu, takes the same arguments as
1521
+ the menus draw function
1002
1522
 
1003
- :param draw_func:
1523
+ :param draw_func:
1004
1524
  """
1005
1525
  ...
1006
1526
 
1007
- def property_overridable_library_set(self):
1008
- """ """
1527
+ def property_overridable_library_set(self) -> bool:
1528
+ """Define a property as overridable or not (only for custom properties!).
1529
+
1530
+ :return: True when the overridable status of the property was successfully set.
1531
+ :rtype: bool
1532
+ """
1009
1533
  ...
1010
1534
 
1011
1535
  def property_unset(self):
1012
- """ """
1536
+ """Unset a property, will use default value afterward."""
1013
1537
  ...
1014
1538
 
1015
1539
  def remove(self, draw_func):
1016
- """
1540
+ """Remove a draw function that has been added to this menu
1017
1541
 
1018
1542
  :param draw_func:
1019
1543
  """
1020
1544
  ...
1021
1545
 
1022
1546
  def type_recast(self):
1023
- """ """
1547
+ """Return a new instance, this is needed because types
1548
+ such as textures can be changed at runtime.
1549
+
1550
+ :return: a new instance of this object with the type initialized again.
1551
+ """
1024
1552
  ...
1025
1553
 
1026
1554
  def values(self):
1027
- """ """
1555
+ """Returns the values of this objects custom properties (matches Python's
1556
+ dictionary function of the same name).
1557
+
1558
+ :return: custom property values.
1559
+ """
1028
1560
  ...