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,10 +1,11 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
5
6
 
6
7
  class ANIM_OT_keying_set_export(bpy_types.Operator):
7
- """ """
8
+ """Export Keying Set to a Python script"""
8
9
 
9
10
  bl_idname: typing.Any
10
11
  """ """
@@ -18,31 +19,51 @@ class ANIM_OT_keying_set_export(bpy_types.Operator):
18
19
  id_data: typing.Any
19
20
  """ """
20
21
 
21
- def as_keywords(self, ignore):
22
- """
22
+ def as_keywords(self, ignore=()):
23
+ """Return a copy of the properties as a dictionary
23
24
 
24
25
  :param ignore:
25
26
  """
26
27
  ...
27
28
 
28
- def as_pointer(self):
29
- """ """
29
+ def as_pointer(self) -> int:
30
+ """Returns the memory address which holds a pointer to Blender's internal data
31
+
32
+ :return: int (memory address).
33
+ :rtype: int
34
+ """
30
35
  ...
31
36
 
32
- def bl_rna_get_subclass(self):
33
- """ """
37
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
38
+ """
39
+
40
+ :return: The RNA type or default when not found.
41
+ :rtype: bpy.types.Struct
42
+ """
34
43
  ...
35
44
 
36
- def bl_rna_get_subclass_py(self):
37
- """ """
45
+ def bl_rna_get_subclass_py(self) -> typing.Any:
46
+ """
47
+
48
+ :return: The class or default when not found.
49
+ :rtype: typing.Any
50
+ """
38
51
  ...
39
52
 
40
- def driver_add(self):
41
- """ """
53
+ def driver_add(self) -> bpy.types.FCurve:
54
+ """Adds driver(s) to the given property
55
+
56
+ :return: The driver(s) added.
57
+ :rtype: bpy.types.FCurve
58
+ """
42
59
  ...
43
60
 
44
- def driver_remove(self):
45
- """ """
61
+ def driver_remove(self) -> bool:
62
+ """Remove driver(s) from the given property
63
+
64
+ :return: Success of driver removal.
65
+ :rtype: bool
66
+ """
46
67
  ...
47
68
 
48
69
  def execute(self, context):
@@ -53,19 +74,31 @@ class ANIM_OT_keying_set_export(bpy_types.Operator):
53
74
  ...
54
75
 
55
76
  def get(self):
56
- """ """
77
+ """Returns the value of the custom property assigned to key or default
78
+ when not found (matches Python's dictionary function of the same name).
79
+
80
+ """
57
81
  ...
58
82
 
59
83
  def id_properties_clear(self):
60
- """ """
84
+ """
85
+
86
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
87
+ """
61
88
  ...
62
89
 
63
90
  def id_properties_ensure(self):
64
- """ """
91
+ """
92
+
93
+ :return: the parent group for an RNA struct's custom IDProperties.
94
+ """
65
95
  ...
66
96
 
67
97
  def id_properties_ui(self):
68
- """ """
98
+ """
99
+
100
+ :return: Return an object used to manage an IDProperty's UI data.
101
+ """
69
102
  ...
70
103
 
71
104
  def invoke(self, context, _event):
@@ -76,72 +109,124 @@ class ANIM_OT_keying_set_export(bpy_types.Operator):
76
109
  """
77
110
  ...
78
111
 
79
- def is_property_hidden(self):
80
- """ """
112
+ def is_property_hidden(self) -> bool:
113
+ """Check if a property is hidden.
114
+
115
+ :return: True when the property is hidden.
116
+ :rtype: bool
117
+ """
81
118
  ...
82
119
 
83
- def is_property_overridable_library(self):
84
- """ """
120
+ def is_property_overridable_library(self) -> bool:
121
+ """Check if a property is overridable.
122
+
123
+ :return: True when the property is overridable.
124
+ :rtype: bool
125
+ """
85
126
  ...
86
127
 
87
- def is_property_readonly(self):
88
- """ """
128
+ def is_property_readonly(self) -> bool:
129
+ """Check if a property is readonly.
130
+
131
+ :return: True when the property is readonly (not writable).
132
+ :rtype: bool
133
+ """
89
134
  ...
90
135
 
91
- def is_property_set(self):
92
- """ """
136
+ def is_property_set(self) -> bool:
137
+ """Check if a property is set, use for testing operator properties.
138
+
139
+ :return: True when the property has been set.
140
+ :rtype: bool
141
+ """
93
142
  ...
94
143
 
95
144
  def items(self):
96
- """ """
145
+ """Returns the items of this objects custom properties (matches Python's
146
+ dictionary function of the same name).
147
+
148
+ :return: custom property key, value pairs.
149
+ """
97
150
  ...
98
151
 
99
- def keyframe_delete(self):
100
- """ """
152
+ def keyframe_delete(self) -> bool:
153
+ """Remove a keyframe from this properties fcurve.
154
+
155
+ :return: Success of keyframe deletion.
156
+ :rtype: bool
157
+ """
101
158
  ...
102
159
 
103
- def keyframe_insert(self):
104
- """ """
160
+ def keyframe_insert(self) -> bool:
161
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
162
+
163
+ :return: Success of keyframe insertion.
164
+ :rtype: bool
165
+ """
105
166
  ...
106
167
 
107
168
  def keys(self):
108
- """ """
169
+ """Returns the keys of this objects custom properties (matches Python's
170
+ dictionary function of the same name).
171
+
172
+ :return: custom property keys.
173
+ """
109
174
  ...
110
175
 
111
- def path_from_id(self):
112
- """ """
176
+ def path_from_id(self) -> str:
177
+ """Returns the data path from the ID to this object (string).
178
+
179
+ :return: The path from `bpy.types.bpy_struct.id_data`
180
+ to this struct and property (when given).
181
+ :rtype: str
182
+ """
113
183
  ...
114
184
 
115
185
  def path_resolve(self):
116
- """ """
186
+ """Returns the property from the path, raise an exception when not found."""
117
187
  ...
118
188
 
119
189
  def poll_message_set(self):
120
- """ """
190
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
121
191
  ...
122
192
 
123
193
  def pop(self):
124
- """ """
194
+ """Remove and return the value of the custom property assigned to key or default
195
+ when not found (matches Python's dictionary function of the same name).
196
+
197
+ """
125
198
  ...
126
199
 
127
- def property_overridable_library_set(self):
128
- """ """
200
+ def property_overridable_library_set(self) -> bool:
201
+ """Define a property as overridable or not (only for custom properties!).
202
+
203
+ :return: True when the overridable status of the property was successfully set.
204
+ :rtype: bool
205
+ """
129
206
  ...
130
207
 
131
208
  def property_unset(self):
132
- """ """
209
+ """Unset a property, will use default value afterward."""
133
210
  ...
134
211
 
135
212
  def type_recast(self):
136
- """ """
213
+ """Return a new instance, this is needed because types
214
+ such as textures can be changed at runtime.
215
+
216
+ :return: a new instance of this object with the type initialized again.
217
+ """
137
218
  ...
138
219
 
139
220
  def values(self):
140
- """ """
221
+ """Returns the values of this objects custom properties (matches Python's
222
+ dictionary function of the same name).
223
+
224
+ :return: custom property values.
225
+ """
141
226
  ...
142
227
 
143
228
  class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
144
- """ """
229
+ """Remove all bone collections that have neither bones nor children. This is done recursively, so bone collections that only have unused children are also removed"""
145
230
 
146
231
  bl_idname: typing.Any
147
232
  """ """
@@ -158,31 +243,51 @@ class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
158
243
  id_data: typing.Any
159
244
  """ """
160
245
 
161
- def as_keywords(self, ignore):
162
- """
246
+ def as_keywords(self, ignore=()):
247
+ """Return a copy of the properties as a dictionary
163
248
 
164
249
  :param ignore:
165
250
  """
166
251
  ...
167
252
 
168
- def as_pointer(self):
169
- """ """
253
+ def as_pointer(self) -> int:
254
+ """Returns the memory address which holds a pointer to Blender's internal data
255
+
256
+ :return: int (memory address).
257
+ :rtype: int
258
+ """
170
259
  ...
171
260
 
172
- def bl_rna_get_subclass(self):
173
- """ """
261
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
262
+ """
263
+
264
+ :return: The RNA type or default when not found.
265
+ :rtype: bpy.types.Struct
266
+ """
174
267
  ...
175
268
 
176
- def bl_rna_get_subclass_py(self):
177
- """ """
269
+ def bl_rna_get_subclass_py(self) -> typing.Any:
270
+ """
271
+
272
+ :return: The class or default when not found.
273
+ :rtype: typing.Any
274
+ """
178
275
  ...
179
276
 
180
- def driver_add(self):
181
- """ """
277
+ def driver_add(self) -> bpy.types.FCurve:
278
+ """Adds driver(s) to the given property
279
+
280
+ :return: The driver(s) added.
281
+ :rtype: bpy.types.FCurve
282
+ """
182
283
  ...
183
284
 
184
- def driver_remove(self):
185
- """ """
285
+ def driver_remove(self) -> bool:
286
+ """Remove driver(s) from the given property
287
+
288
+ :return: Success of driver removal.
289
+ :rtype: bool
290
+ """
186
291
  ...
187
292
 
188
293
  def execute(self, context):
@@ -200,59 +305,108 @@ class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
200
305
  ...
201
306
 
202
307
  def get(self):
203
- """ """
308
+ """Returns the value of the custom property assigned to key or default
309
+ when not found (matches Python's dictionary function of the same name).
310
+
311
+ """
204
312
  ...
205
313
 
206
314
  def id_properties_clear(self):
207
- """ """
315
+ """
316
+
317
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
318
+ """
208
319
  ...
209
320
 
210
321
  def id_properties_ensure(self):
211
- """ """
322
+ """
323
+
324
+ :return: the parent group for an RNA struct's custom IDProperties.
325
+ """
212
326
  ...
213
327
 
214
328
  def id_properties_ui(self):
215
- """ """
329
+ """
330
+
331
+ :return: Return an object used to manage an IDProperty's UI data.
332
+ """
216
333
  ...
217
334
 
218
- def is_property_hidden(self):
219
- """ """
335
+ def is_property_hidden(self) -> bool:
336
+ """Check if a property is hidden.
337
+
338
+ :return: True when the property is hidden.
339
+ :rtype: bool
340
+ """
220
341
  ...
221
342
 
222
- def is_property_overridable_library(self):
223
- """ """
343
+ def is_property_overridable_library(self) -> bool:
344
+ """Check if a property is overridable.
345
+
346
+ :return: True when the property is overridable.
347
+ :rtype: bool
348
+ """
224
349
  ...
225
350
 
226
- def is_property_readonly(self):
227
- """ """
351
+ def is_property_readonly(self) -> bool:
352
+ """Check if a property is readonly.
353
+
354
+ :return: True when the property is readonly (not writable).
355
+ :rtype: bool
356
+ """
228
357
  ...
229
358
 
230
- def is_property_set(self):
231
- """ """
359
+ def is_property_set(self) -> bool:
360
+ """Check if a property is set, use for testing operator properties.
361
+
362
+ :return: True when the property has been set.
363
+ :rtype: bool
364
+ """
232
365
  ...
233
366
 
234
367
  def items(self):
235
- """ """
368
+ """Returns the items of this objects custom properties (matches Python's
369
+ dictionary function of the same name).
370
+
371
+ :return: custom property key, value pairs.
372
+ """
236
373
  ...
237
374
 
238
- def keyframe_delete(self):
239
- """ """
375
+ def keyframe_delete(self) -> bool:
376
+ """Remove a keyframe from this properties fcurve.
377
+
378
+ :return: Success of keyframe deletion.
379
+ :rtype: bool
380
+ """
240
381
  ...
241
382
 
242
- def keyframe_insert(self):
243
- """ """
383
+ def keyframe_insert(self) -> bool:
384
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
385
+
386
+ :return: Success of keyframe insertion.
387
+ :rtype: bool
388
+ """
244
389
  ...
245
390
 
246
391
  def keys(self):
247
- """ """
392
+ """Returns the keys of this objects custom properties (matches Python's
393
+ dictionary function of the same name).
394
+
395
+ :return: custom property keys.
396
+ """
248
397
  ...
249
398
 
250
- def path_from_id(self):
251
- """ """
399
+ def path_from_id(self) -> str:
400
+ """Returns the data path from the ID to this object (string).
401
+
402
+ :return: The path from `bpy.types.bpy_struct.id_data`
403
+ to this struct and property (when given).
404
+ :rtype: str
405
+ """
252
406
  ...
253
407
 
254
408
  def path_resolve(self):
255
- """ """
409
+ """Returns the property from the path, raise an exception when not found."""
256
410
  ...
257
411
 
258
412
  def poll(self, context):
@@ -263,19 +417,26 @@ class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
263
417
  ...
264
418
 
265
419
  def poll_message_set(self):
266
- """ """
420
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
267
421
  ...
268
422
 
269
423
  def pop(self):
270
- """ """
424
+ """Remove and return the value of the custom property assigned to key or default
425
+ when not found (matches Python's dictionary function of the same name).
426
+
427
+ """
271
428
  ...
272
429
 
273
- def property_overridable_library_set(self):
274
- """ """
430
+ def property_overridable_library_set(self) -> bool:
431
+ """Define a property as overridable or not (only for custom properties!).
432
+
433
+ :return: True when the overridable status of the property was successfully set.
434
+ :rtype: bool
435
+ """
275
436
  ...
276
437
 
277
438
  def property_unset(self):
278
- """ """
439
+ """Unset a property, will use default value afterward."""
279
440
  ...
280
441
 
281
442
  def remove_bcolls(self, armature, bcolls_to_remove):
@@ -287,11 +448,19 @@ class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
287
448
  ...
288
449
 
289
450
  def type_recast(self):
290
- """ """
451
+ """Return a new instance, this is needed because types
452
+ such as textures can be changed at runtime.
453
+
454
+ :return: a new instance of this object with the type initialized again.
455
+ """
291
456
  ...
292
457
 
293
458
  def values(self):
294
- """ """
459
+ """Returns the values of this objects custom properties (matches Python's
460
+ dictionary function of the same name).
461
+
462
+ :return: custom property values.
463
+ """
295
464
  ...
296
465
 
297
466
  def visit(self, bcoll, bcolls_with_bones, bcolls_to_remove):
@@ -304,7 +473,7 @@ class ARMATURE_OT_collection_remove_unused(bpy_types.Operator):
304
473
  ...
305
474
 
306
475
  class ARMATURE_OT_collection_show_all(bpy_types.Operator):
307
- """ """
476
+ """Show all bone collections"""
308
477
 
309
478
  bl_idname: typing.Any
310
479
  """ """
@@ -321,31 +490,51 @@ class ARMATURE_OT_collection_show_all(bpy_types.Operator):
321
490
  id_data: typing.Any
322
491
  """ """
323
492
 
324
- def as_keywords(self, ignore):
325
- """
493
+ def as_keywords(self, ignore=()):
494
+ """Return a copy of the properties as a dictionary
326
495
 
327
496
  :param ignore:
328
497
  """
329
498
  ...
330
499
 
331
- def as_pointer(self):
332
- """ """
500
+ def as_pointer(self) -> int:
501
+ """Returns the memory address which holds a pointer to Blender's internal data
502
+
503
+ :return: int (memory address).
504
+ :rtype: int
505
+ """
333
506
  ...
334
507
 
335
- def bl_rna_get_subclass(self):
336
- """ """
508
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
509
+ """
510
+
511
+ :return: The RNA type or default when not found.
512
+ :rtype: bpy.types.Struct
513
+ """
337
514
  ...
338
515
 
339
- def bl_rna_get_subclass_py(self):
340
- """ """
516
+ def bl_rna_get_subclass_py(self) -> typing.Any:
517
+ """
518
+
519
+ :return: The class or default when not found.
520
+ :rtype: typing.Any
521
+ """
341
522
  ...
342
523
 
343
- def driver_add(self):
344
- """ """
524
+ def driver_add(self) -> bpy.types.FCurve:
525
+ """Adds driver(s) to the given property
526
+
527
+ :return: The driver(s) added.
528
+ :rtype: bpy.types.FCurve
529
+ """
345
530
  ...
346
531
 
347
- def driver_remove(self):
348
- """ """
532
+ def driver_remove(self) -> bool:
533
+ """Remove driver(s) from the given property
534
+
535
+ :return: Success of driver removal.
536
+ :rtype: bool
537
+ """
349
538
  ...
350
539
 
351
540
  def execute(self, context):
@@ -356,59 +545,108 @@ class ARMATURE_OT_collection_show_all(bpy_types.Operator):
356
545
  ...
357
546
 
358
547
  def get(self):
359
- """ """
548
+ """Returns the value of the custom property assigned to key or default
549
+ when not found (matches Python's dictionary function of the same name).
550
+
551
+ """
360
552
  ...
361
553
 
362
554
  def id_properties_clear(self):
363
- """ """
555
+ """
556
+
557
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
558
+ """
364
559
  ...
365
560
 
366
561
  def id_properties_ensure(self):
367
- """ """
562
+ """
563
+
564
+ :return: the parent group for an RNA struct's custom IDProperties.
565
+ """
368
566
  ...
369
567
 
370
568
  def id_properties_ui(self):
371
- """ """
569
+ """
570
+
571
+ :return: Return an object used to manage an IDProperty's UI data.
572
+ """
372
573
  ...
373
574
 
374
- def is_property_hidden(self):
375
- """ """
575
+ def is_property_hidden(self) -> bool:
576
+ """Check if a property is hidden.
577
+
578
+ :return: True when the property is hidden.
579
+ :rtype: bool
580
+ """
376
581
  ...
377
582
 
378
- def is_property_overridable_library(self):
379
- """ """
583
+ def is_property_overridable_library(self) -> bool:
584
+ """Check if a property is overridable.
585
+
586
+ :return: True when the property is overridable.
587
+ :rtype: bool
588
+ """
380
589
  ...
381
590
 
382
- def is_property_readonly(self):
383
- """ """
591
+ def is_property_readonly(self) -> bool:
592
+ """Check if a property is readonly.
593
+
594
+ :return: True when the property is readonly (not writable).
595
+ :rtype: bool
596
+ """
384
597
  ...
385
598
 
386
- def is_property_set(self):
387
- """ """
599
+ def is_property_set(self) -> bool:
600
+ """Check if a property is set, use for testing operator properties.
601
+
602
+ :return: True when the property has been set.
603
+ :rtype: bool
604
+ """
388
605
  ...
389
606
 
390
607
  def items(self):
391
- """ """
608
+ """Returns the items of this objects custom properties (matches Python's
609
+ dictionary function of the same name).
610
+
611
+ :return: custom property key, value pairs.
612
+ """
392
613
  ...
393
614
 
394
- def keyframe_delete(self):
395
- """ """
615
+ def keyframe_delete(self) -> bool:
616
+ """Remove a keyframe from this properties fcurve.
617
+
618
+ :return: Success of keyframe deletion.
619
+ :rtype: bool
620
+ """
396
621
  ...
397
622
 
398
- def keyframe_insert(self):
399
- """ """
623
+ def keyframe_insert(self) -> bool:
624
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
625
+
626
+ :return: Success of keyframe insertion.
627
+ :rtype: bool
628
+ """
400
629
  ...
401
630
 
402
631
  def keys(self):
403
- """ """
632
+ """Returns the keys of this objects custom properties (matches Python's
633
+ dictionary function of the same name).
634
+
635
+ :return: custom property keys.
636
+ """
404
637
  ...
405
638
 
406
- def path_from_id(self):
407
- """ """
639
+ def path_from_id(self) -> str:
640
+ """Returns the data path from the ID to this object (string).
641
+
642
+ :return: The path from `bpy.types.bpy_struct.id_data`
643
+ to this struct and property (when given).
644
+ :rtype: str
645
+ """
408
646
  ...
409
647
 
410
648
  def path_resolve(self):
411
- """ """
649
+ """Returns the property from the path, raise an exception when not found."""
412
650
  ...
413
651
 
414
652
  def poll(self, context):
@@ -419,31 +657,46 @@ class ARMATURE_OT_collection_show_all(bpy_types.Operator):
419
657
  ...
420
658
 
421
659
  def poll_message_set(self):
422
- """ """
660
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
423
661
  ...
424
662
 
425
663
  def pop(self):
426
- """ """
664
+ """Remove and return the value of the custom property assigned to key or default
665
+ when not found (matches Python's dictionary function of the same name).
666
+
667
+ """
427
668
  ...
428
669
 
429
- def property_overridable_library_set(self):
430
- """ """
670
+ def property_overridable_library_set(self) -> bool:
671
+ """Define a property as overridable or not (only for custom properties!).
672
+
673
+ :return: True when the overridable status of the property was successfully set.
674
+ :rtype: bool
675
+ """
431
676
  ...
432
677
 
433
678
  def property_unset(self):
434
- """ """
679
+ """Unset a property, will use default value afterward."""
435
680
  ...
436
681
 
437
682
  def type_recast(self):
438
- """ """
683
+ """Return a new instance, this is needed because types
684
+ such as textures can be changed at runtime.
685
+
686
+ :return: a new instance of this object with the type initialized again.
687
+ """
439
688
  ...
440
689
 
441
690
  def values(self):
442
- """ """
691
+ """Returns the values of this objects custom properties (matches Python's
692
+ dictionary function of the same name).
693
+
694
+ :return: custom property values.
695
+ """
443
696
  ...
444
697
 
445
698
  class ARMATURE_OT_collection_unsolo_all(bpy_types.Operator):
446
- """ """
699
+ """Clear the 'solo' setting on all bone collections"""
447
700
 
448
701
  bl_idname: typing.Any
449
702
  """ """
@@ -460,31 +713,51 @@ class ARMATURE_OT_collection_unsolo_all(bpy_types.Operator):
460
713
  id_data: typing.Any
461
714
  """ """
462
715
 
463
- def as_keywords(self, ignore):
464
- """
716
+ def as_keywords(self, ignore=()):
717
+ """Return a copy of the properties as a dictionary
465
718
 
466
719
  :param ignore:
467
720
  """
468
721
  ...
469
722
 
470
- def as_pointer(self):
471
- """ """
723
+ def as_pointer(self) -> int:
724
+ """Returns the memory address which holds a pointer to Blender's internal data
725
+
726
+ :return: int (memory address).
727
+ :rtype: int
728
+ """
472
729
  ...
473
730
 
474
- def bl_rna_get_subclass(self):
475
- """ """
731
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
732
+ """
733
+
734
+ :return: The RNA type or default when not found.
735
+ :rtype: bpy.types.Struct
736
+ """
476
737
  ...
477
738
 
478
- def bl_rna_get_subclass_py(self):
479
- """ """
739
+ def bl_rna_get_subclass_py(self) -> typing.Any:
740
+ """
741
+
742
+ :return: The class or default when not found.
743
+ :rtype: typing.Any
744
+ """
480
745
  ...
481
746
 
482
- def driver_add(self):
483
- """ """
747
+ def driver_add(self) -> bpy.types.FCurve:
748
+ """Adds driver(s) to the given property
749
+
750
+ :return: The driver(s) added.
751
+ :rtype: bpy.types.FCurve
752
+ """
484
753
  ...
485
754
 
486
- def driver_remove(self):
487
- """ """
755
+ def driver_remove(self) -> bool:
756
+ """Remove driver(s) from the given property
757
+
758
+ :return: Success of driver removal.
759
+ :rtype: bool
760
+ """
488
761
  ...
489
762
 
490
763
  def execute(self, context):
@@ -495,59 +768,108 @@ class ARMATURE_OT_collection_unsolo_all(bpy_types.Operator):
495
768
  ...
496
769
 
497
770
  def get(self):
498
- """ """
771
+ """Returns the value of the custom property assigned to key or default
772
+ when not found (matches Python's dictionary function of the same name).
773
+
774
+ """
499
775
  ...
500
776
 
501
777
  def id_properties_clear(self):
502
- """ """
778
+ """
779
+
780
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
781
+ """
503
782
  ...
504
783
 
505
784
  def id_properties_ensure(self):
506
- """ """
785
+ """
786
+
787
+ :return: the parent group for an RNA struct's custom IDProperties.
788
+ """
507
789
  ...
508
790
 
509
791
  def id_properties_ui(self):
510
- """ """
792
+ """
793
+
794
+ :return: Return an object used to manage an IDProperty's UI data.
795
+ """
511
796
  ...
512
797
 
513
- def is_property_hidden(self):
514
- """ """
798
+ def is_property_hidden(self) -> bool:
799
+ """Check if a property is hidden.
800
+
801
+ :return: True when the property is hidden.
802
+ :rtype: bool
803
+ """
515
804
  ...
516
805
 
517
- def is_property_overridable_library(self):
518
- """ """
806
+ def is_property_overridable_library(self) -> bool:
807
+ """Check if a property is overridable.
808
+
809
+ :return: True when the property is overridable.
810
+ :rtype: bool
811
+ """
519
812
  ...
520
813
 
521
- def is_property_readonly(self):
522
- """ """
814
+ def is_property_readonly(self) -> bool:
815
+ """Check if a property is readonly.
816
+
817
+ :return: True when the property is readonly (not writable).
818
+ :rtype: bool
819
+ """
523
820
  ...
524
821
 
525
- def is_property_set(self):
526
- """ """
822
+ def is_property_set(self) -> bool:
823
+ """Check if a property is set, use for testing operator properties.
824
+
825
+ :return: True when the property has been set.
826
+ :rtype: bool
827
+ """
527
828
  ...
528
829
 
529
830
  def items(self):
530
- """ """
831
+ """Returns the items of this objects custom properties (matches Python's
832
+ dictionary function of the same name).
833
+
834
+ :return: custom property key, value pairs.
835
+ """
531
836
  ...
532
837
 
533
- def keyframe_delete(self):
534
- """ """
838
+ def keyframe_delete(self) -> bool:
839
+ """Remove a keyframe from this properties fcurve.
840
+
841
+ :return: Success of keyframe deletion.
842
+ :rtype: bool
843
+ """
535
844
  ...
536
845
 
537
- def keyframe_insert(self):
538
- """ """
846
+ def keyframe_insert(self) -> bool:
847
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
848
+
849
+ :return: Success of keyframe insertion.
850
+ :rtype: bool
851
+ """
539
852
  ...
540
853
 
541
854
  def keys(self):
542
- """ """
855
+ """Returns the keys of this objects custom properties (matches Python's
856
+ dictionary function of the same name).
857
+
858
+ :return: custom property keys.
859
+ """
543
860
  ...
544
861
 
545
- def path_from_id(self):
546
- """ """
862
+ def path_from_id(self) -> str:
863
+ """Returns the data path from the ID to this object (string).
864
+
865
+ :return: The path from `bpy.types.bpy_struct.id_data`
866
+ to this struct and property (when given).
867
+ :rtype: str
868
+ """
547
869
  ...
548
870
 
549
871
  def path_resolve(self):
550
- """ """
872
+ """Returns the property from the path, raise an exception when not found."""
551
873
  ...
552
874
 
553
875
  def poll(self, context):
@@ -558,31 +880,46 @@ class ARMATURE_OT_collection_unsolo_all(bpy_types.Operator):
558
880
  ...
559
881
 
560
882
  def poll_message_set(self):
561
- """ """
883
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
562
884
  ...
563
885
 
564
886
  def pop(self):
565
- """ """
887
+ """Remove and return the value of the custom property assigned to key or default
888
+ when not found (matches Python's dictionary function of the same name).
889
+
890
+ """
566
891
  ...
567
892
 
568
- def property_overridable_library_set(self):
569
- """ """
893
+ def property_overridable_library_set(self) -> bool:
894
+ """Define a property as overridable or not (only for custom properties!).
895
+
896
+ :return: True when the overridable status of the property was successfully set.
897
+ :rtype: bool
898
+ """
570
899
  ...
571
900
 
572
901
  def property_unset(self):
573
- """ """
902
+ """Unset a property, will use default value afterward."""
574
903
  ...
575
904
 
576
905
  def type_recast(self):
577
- """ """
906
+ """Return a new instance, this is needed because types
907
+ such as textures can be changed at runtime.
908
+
909
+ :return: a new instance of this object with the type initialized again.
910
+ """
578
911
  ...
579
912
 
580
913
  def values(self):
581
- """ """
914
+ """Returns the values of this objects custom properties (matches Python's
915
+ dictionary function of the same name).
916
+
917
+ :return: custom property values.
918
+ """
582
919
  ...
583
920
 
584
921
  class ARMATURE_OT_copy_bone_color_to_selected(bpy_types.Operator):
585
- """ """
922
+ """Copy the bone color of the active bone to all selected bones"""
586
923
 
587
924
  bl_idname: typing.Any
588
925
  """ """
@@ -599,31 +936,51 @@ class ARMATURE_OT_copy_bone_color_to_selected(bpy_types.Operator):
599
936
  id_data: typing.Any
600
937
  """ """
601
938
 
602
- def as_keywords(self, ignore):
603
- """
939
+ def as_keywords(self, ignore=()):
940
+ """Return a copy of the properties as a dictionary
604
941
 
605
942
  :param ignore:
606
943
  """
607
944
  ...
608
945
 
609
- def as_pointer(self):
610
- """ """
946
+ def as_pointer(self) -> int:
947
+ """Returns the memory address which holds a pointer to Blender's internal data
948
+
949
+ :return: int (memory address).
950
+ :rtype: int
951
+ """
611
952
  ...
612
953
 
613
- def bl_rna_get_subclass(self):
614
- """ """
954
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
955
+ """
956
+
957
+ :return: The RNA type or default when not found.
958
+ :rtype: bpy.types.Struct
959
+ """
615
960
  ...
616
961
 
617
- def bl_rna_get_subclass_py(self):
618
- """ """
962
+ def bl_rna_get_subclass_py(self) -> typing.Any:
963
+ """
964
+
965
+ :return: The class or default when not found.
966
+ :rtype: typing.Any
967
+ """
619
968
  ...
620
969
 
621
- def driver_add(self):
622
- """ """
970
+ def driver_add(self) -> bpy.types.FCurve:
971
+ """Adds driver(s) to the given property
972
+
973
+ :return: The driver(s) added.
974
+ :rtype: bpy.types.FCurve
975
+ """
623
976
  ...
624
977
 
625
- def driver_remove(self):
626
- """ """
978
+ def driver_remove(self) -> bool:
979
+ """Remove driver(s) from the given property
980
+
981
+ :return: Success of driver removal.
982
+ :rtype: bool
983
+ """
627
984
  ...
628
985
 
629
986
  def execute(self, context):
@@ -634,59 +991,108 @@ class ARMATURE_OT_copy_bone_color_to_selected(bpy_types.Operator):
634
991
  ...
635
992
 
636
993
  def get(self):
637
- """ """
994
+ """Returns the value of the custom property assigned to key or default
995
+ when not found (matches Python's dictionary function of the same name).
996
+
997
+ """
638
998
  ...
639
999
 
640
1000
  def id_properties_clear(self):
641
- """ """
1001
+ """
1002
+
1003
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1004
+ """
642
1005
  ...
643
1006
 
644
1007
  def id_properties_ensure(self):
645
- """ """
1008
+ """
1009
+
1010
+ :return: the parent group for an RNA struct's custom IDProperties.
1011
+ """
646
1012
  ...
647
1013
 
648
1014
  def id_properties_ui(self):
649
- """ """
1015
+ """
1016
+
1017
+ :return: Return an object used to manage an IDProperty's UI data.
1018
+ """
650
1019
  ...
651
1020
 
652
- def is_property_hidden(self):
653
- """ """
1021
+ def is_property_hidden(self) -> bool:
1022
+ """Check if a property is hidden.
1023
+
1024
+ :return: True when the property is hidden.
1025
+ :rtype: bool
1026
+ """
654
1027
  ...
655
1028
 
656
- def is_property_overridable_library(self):
657
- """ """
1029
+ def is_property_overridable_library(self) -> bool:
1030
+ """Check if a property is overridable.
1031
+
1032
+ :return: True when the property is overridable.
1033
+ :rtype: bool
1034
+ """
658
1035
  ...
659
1036
 
660
- def is_property_readonly(self):
661
- """ """
1037
+ def is_property_readonly(self) -> bool:
1038
+ """Check if a property is readonly.
1039
+
1040
+ :return: True when the property is readonly (not writable).
1041
+ :rtype: bool
1042
+ """
662
1043
  ...
663
1044
 
664
- def is_property_set(self):
665
- """ """
1045
+ def is_property_set(self) -> bool:
1046
+ """Check if a property is set, use for testing operator properties.
1047
+
1048
+ :return: True when the property has been set.
1049
+ :rtype: bool
1050
+ """
666
1051
  ...
667
1052
 
668
1053
  def items(self):
669
- """ """
1054
+ """Returns the items of this objects custom properties (matches Python's
1055
+ dictionary function of the same name).
1056
+
1057
+ :return: custom property key, value pairs.
1058
+ """
670
1059
  ...
671
1060
 
672
- def keyframe_delete(self):
673
- """ """
1061
+ def keyframe_delete(self) -> bool:
1062
+ """Remove a keyframe from this properties fcurve.
1063
+
1064
+ :return: Success of keyframe deletion.
1065
+ :rtype: bool
1066
+ """
674
1067
  ...
675
1068
 
676
- def keyframe_insert(self):
677
- """ """
1069
+ def keyframe_insert(self) -> bool:
1070
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1071
+
1072
+ :return: Success of keyframe insertion.
1073
+ :rtype: bool
1074
+ """
678
1075
  ...
679
1076
 
680
1077
  def keys(self):
681
- """ """
1078
+ """Returns the keys of this objects custom properties (matches Python's
1079
+ dictionary function of the same name).
1080
+
1081
+ :return: custom property keys.
1082
+ """
682
1083
  ...
683
1084
 
684
- def path_from_id(self):
685
- """ """
1085
+ def path_from_id(self) -> str:
1086
+ """Returns the data path from the ID to this object (string).
1087
+
1088
+ :return: The path from `bpy.types.bpy_struct.id_data`
1089
+ to this struct and property (when given).
1090
+ :rtype: str
1091
+ """
686
1092
  ...
687
1093
 
688
1094
  def path_resolve(self):
689
- """ """
1095
+ """Returns the property from the path, raise an exception when not found."""
690
1096
  ...
691
1097
 
692
1098
  def poll(self, context):
@@ -697,31 +1103,46 @@ class ARMATURE_OT_copy_bone_color_to_selected(bpy_types.Operator):
697
1103
  ...
698
1104
 
699
1105
  def poll_message_set(self):
700
- """ """
1106
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
701
1107
  ...
702
1108
 
703
1109
  def pop(self):
704
- """ """
1110
+ """Remove and return the value of the custom property assigned to key or default
1111
+ when not found (matches Python's dictionary function of the same name).
1112
+
1113
+ """
705
1114
  ...
706
1115
 
707
- def property_overridable_library_set(self):
708
- """ """
1116
+ def property_overridable_library_set(self) -> bool:
1117
+ """Define a property as overridable or not (only for custom properties!).
1118
+
1119
+ :return: True when the overridable status of the property was successfully set.
1120
+ :rtype: bool
1121
+ """
709
1122
  ...
710
1123
 
711
1124
  def property_unset(self):
712
- """ """
1125
+ """Unset a property, will use default value afterward."""
713
1126
  ...
714
1127
 
715
1128
  def type_recast(self):
716
- """ """
1129
+ """Return a new instance, this is needed because types
1130
+ such as textures can be changed at runtime.
1131
+
1132
+ :return: a new instance of this object with the type initialized again.
1133
+ """
717
1134
  ...
718
1135
 
719
1136
  def values(self):
720
- """ """
1137
+ """Returns the values of this objects custom properties (matches Python's
1138
+ dictionary function of the same name).
1139
+
1140
+ :return: custom property values.
1141
+ """
721
1142
  ...
722
1143
 
723
1144
  class ClearUselessActions(bpy_types.Operator):
724
- """ """
1145
+ """Mark actions with no F-Curves for deletion after save and reload of file preserving "action libraries" """
725
1146
 
726
1147
  bl_idname: typing.Any
727
1148
  """ """
@@ -738,31 +1159,51 @@ class ClearUselessActions(bpy_types.Operator):
738
1159
  id_data: typing.Any
739
1160
  """ """
740
1161
 
741
- def as_keywords(self, ignore):
742
- """
1162
+ def as_keywords(self, ignore=()):
1163
+ """Return a copy of the properties as a dictionary
743
1164
 
744
1165
  :param ignore:
745
1166
  """
746
1167
  ...
747
1168
 
748
- def as_pointer(self):
749
- """ """
1169
+ def as_pointer(self) -> int:
1170
+ """Returns the memory address which holds a pointer to Blender's internal data
1171
+
1172
+ :return: int (memory address).
1173
+ :rtype: int
1174
+ """
750
1175
  ...
751
1176
 
752
- def bl_rna_get_subclass(self):
753
- """ """
1177
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1178
+ """
1179
+
1180
+ :return: The RNA type or default when not found.
1181
+ :rtype: bpy.types.Struct
1182
+ """
754
1183
  ...
755
1184
 
756
- def bl_rna_get_subclass_py(self):
757
- """ """
1185
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1186
+ """
1187
+
1188
+ :return: The class or default when not found.
1189
+ :rtype: typing.Any
1190
+ """
758
1191
  ...
759
1192
 
760
- def driver_add(self):
761
- """ """
1193
+ def driver_add(self) -> bpy.types.FCurve:
1194
+ """Adds driver(s) to the given property
1195
+
1196
+ :return: The driver(s) added.
1197
+ :rtype: bpy.types.FCurve
1198
+ """
762
1199
  ...
763
1200
 
764
- def driver_remove(self):
765
- """ """
1201
+ def driver_remove(self) -> bool:
1202
+ """Remove driver(s) from the given property
1203
+
1204
+ :return: Success of driver removal.
1205
+ :rtype: bool
1206
+ """
766
1207
  ...
767
1208
 
768
1209
  def execute(self, _context):
@@ -773,59 +1214,108 @@ class ClearUselessActions(bpy_types.Operator):
773
1214
  ...
774
1215
 
775
1216
  def get(self):
776
- """ """
1217
+ """Returns the value of the custom property assigned to key or default
1218
+ when not found (matches Python's dictionary function of the same name).
1219
+
1220
+ """
777
1221
  ...
778
1222
 
779
1223
  def id_properties_clear(self):
780
- """ """
1224
+ """
1225
+
1226
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1227
+ """
781
1228
  ...
782
1229
 
783
1230
  def id_properties_ensure(self):
784
- """ """
1231
+ """
1232
+
1233
+ :return: the parent group for an RNA struct's custom IDProperties.
1234
+ """
785
1235
  ...
786
1236
 
787
1237
  def id_properties_ui(self):
788
- """ """
1238
+ """
1239
+
1240
+ :return: Return an object used to manage an IDProperty's UI data.
1241
+ """
789
1242
  ...
790
1243
 
791
- def is_property_hidden(self):
792
- """ """
1244
+ def is_property_hidden(self) -> bool:
1245
+ """Check if a property is hidden.
1246
+
1247
+ :return: True when the property is hidden.
1248
+ :rtype: bool
1249
+ """
793
1250
  ...
794
1251
 
795
- def is_property_overridable_library(self):
796
- """ """
1252
+ def is_property_overridable_library(self) -> bool:
1253
+ """Check if a property is overridable.
1254
+
1255
+ :return: True when the property is overridable.
1256
+ :rtype: bool
1257
+ """
797
1258
  ...
798
1259
 
799
- def is_property_readonly(self):
800
- """ """
1260
+ def is_property_readonly(self) -> bool:
1261
+ """Check if a property is readonly.
1262
+
1263
+ :return: True when the property is readonly (not writable).
1264
+ :rtype: bool
1265
+ """
801
1266
  ...
802
1267
 
803
- def is_property_set(self):
804
- """ """
1268
+ def is_property_set(self) -> bool:
1269
+ """Check if a property is set, use for testing operator properties.
1270
+
1271
+ :return: True when the property has been set.
1272
+ :rtype: bool
1273
+ """
805
1274
  ...
806
1275
 
807
1276
  def items(self):
808
- """ """
1277
+ """Returns the items of this objects custom properties (matches Python's
1278
+ dictionary function of the same name).
1279
+
1280
+ :return: custom property key, value pairs.
1281
+ """
809
1282
  ...
810
1283
 
811
- def keyframe_delete(self):
812
- """ """
1284
+ def keyframe_delete(self) -> bool:
1285
+ """Remove a keyframe from this properties fcurve.
1286
+
1287
+ :return: Success of keyframe deletion.
1288
+ :rtype: bool
1289
+ """
813
1290
  ...
814
1291
 
815
- def keyframe_insert(self):
816
- """ """
1292
+ def keyframe_insert(self) -> bool:
1293
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1294
+
1295
+ :return: Success of keyframe insertion.
1296
+ :rtype: bool
1297
+ """
817
1298
  ...
818
1299
 
819
1300
  def keys(self):
820
- """ """
1301
+ """Returns the keys of this objects custom properties (matches Python's
1302
+ dictionary function of the same name).
1303
+
1304
+ :return: custom property keys.
1305
+ """
821
1306
  ...
822
1307
 
823
- def path_from_id(self):
824
- """ """
1308
+ def path_from_id(self) -> str:
1309
+ """Returns the data path from the ID to this object (string).
1310
+
1311
+ :return: The path from `bpy.types.bpy_struct.id_data`
1312
+ to this struct and property (when given).
1313
+ :rtype: str
1314
+ """
825
1315
  ...
826
1316
 
827
1317
  def path_resolve(self):
828
- """ """
1318
+ """Returns the property from the path, raise an exception when not found."""
829
1319
  ...
830
1320
 
831
1321
  def poll(self, _context):
@@ -836,31 +1326,46 @@ class ClearUselessActions(bpy_types.Operator):
836
1326
  ...
837
1327
 
838
1328
  def poll_message_set(self):
839
- """ """
1329
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
840
1330
  ...
841
1331
 
842
1332
  def pop(self):
843
- """ """
1333
+ """Remove and return the value of the custom property assigned to key or default
1334
+ when not found (matches Python's dictionary function of the same name).
1335
+
1336
+ """
844
1337
  ...
845
1338
 
846
- def property_overridable_library_set(self):
847
- """ """
1339
+ def property_overridable_library_set(self) -> bool:
1340
+ """Define a property as overridable or not (only for custom properties!).
1341
+
1342
+ :return: True when the overridable status of the property was successfully set.
1343
+ :rtype: bool
1344
+ """
848
1345
  ...
849
1346
 
850
1347
  def property_unset(self):
851
- """ """
1348
+ """Unset a property, will use default value afterward."""
852
1349
  ...
853
1350
 
854
1351
  def type_recast(self):
855
- """ """
1352
+ """Return a new instance, this is needed because types
1353
+ such as textures can be changed at runtime.
1354
+
1355
+ :return: a new instance of this object with the type initialized again.
1356
+ """
856
1357
  ...
857
1358
 
858
1359
  def values(self):
859
- """ """
1360
+ """Returns the values of this objects custom properties (matches Python's
1361
+ dictionary function of the same name).
1362
+
1363
+ :return: custom property values.
1364
+ """
860
1365
  ...
861
1366
 
862
1367
  class NLA_OT_bake(bpy_types.Operator):
863
- """ """
1368
+ """Bake all selected objects location/scale/rotation animation to an action"""
864
1369
 
865
1370
  bl_idname: typing.Any
866
1371
  """ """
@@ -877,31 +1382,51 @@ class NLA_OT_bake(bpy_types.Operator):
877
1382
  id_data: typing.Any
878
1383
  """ """
879
1384
 
880
- def as_keywords(self, ignore):
881
- """
1385
+ def as_keywords(self, ignore=()):
1386
+ """Return a copy of the properties as a dictionary
882
1387
 
883
1388
  :param ignore:
884
1389
  """
885
1390
  ...
886
1391
 
887
- def as_pointer(self):
888
- """ """
1392
+ def as_pointer(self) -> int:
1393
+ """Returns the memory address which holds a pointer to Blender's internal data
1394
+
1395
+ :return: int (memory address).
1396
+ :rtype: int
1397
+ """
889
1398
  ...
890
1399
 
891
- def bl_rna_get_subclass(self):
892
- """ """
1400
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1401
+ """
1402
+
1403
+ :return: The RNA type or default when not found.
1404
+ :rtype: bpy.types.Struct
1405
+ """
893
1406
  ...
894
1407
 
895
- def bl_rna_get_subclass_py(self):
896
- """ """
1408
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1409
+ """
1410
+
1411
+ :return: The class or default when not found.
1412
+ :rtype: typing.Any
1413
+ """
897
1414
  ...
898
1415
 
899
- def driver_add(self):
900
- """ """
1416
+ def driver_add(self) -> bpy.types.FCurve:
1417
+ """Adds driver(s) to the given property
1418
+
1419
+ :return: The driver(s) added.
1420
+ :rtype: bpy.types.FCurve
1421
+ """
901
1422
  ...
902
1423
 
903
- def driver_remove(self):
904
- """ """
1424
+ def driver_remove(self) -> bool:
1425
+ """Remove driver(s) from the given property
1426
+
1427
+ :return: Success of driver removal.
1428
+ :rtype: bool
1429
+ """
905
1430
  ...
906
1431
 
907
1432
  def execute(self, context):
@@ -912,19 +1437,31 @@ class NLA_OT_bake(bpy_types.Operator):
912
1437
  ...
913
1438
 
914
1439
  def get(self):
915
- """ """
1440
+ """Returns the value of the custom property assigned to key or default
1441
+ when not found (matches Python's dictionary function of the same name).
1442
+
1443
+ """
916
1444
  ...
917
1445
 
918
1446
  def id_properties_clear(self):
919
- """ """
1447
+ """
1448
+
1449
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1450
+ """
920
1451
  ...
921
1452
 
922
1453
  def id_properties_ensure(self):
923
- """ """
1454
+ """
1455
+
1456
+ :return: the parent group for an RNA struct's custom IDProperties.
1457
+ """
924
1458
  ...
925
1459
 
926
1460
  def id_properties_ui(self):
927
- """ """
1461
+ """
1462
+
1463
+ :return: Return an object used to manage an IDProperty's UI data.
1464
+ """
928
1465
  ...
929
1466
 
930
1467
  def invoke(self, context, _event):
@@ -935,72 +1472,124 @@ class NLA_OT_bake(bpy_types.Operator):
935
1472
  """
936
1473
  ...
937
1474
 
938
- def is_property_hidden(self):
939
- """ """
1475
+ def is_property_hidden(self) -> bool:
1476
+ """Check if a property is hidden.
1477
+
1478
+ :return: True when the property is hidden.
1479
+ :rtype: bool
1480
+ """
940
1481
  ...
941
1482
 
942
- def is_property_overridable_library(self):
943
- """ """
1483
+ def is_property_overridable_library(self) -> bool:
1484
+ """Check if a property is overridable.
1485
+
1486
+ :return: True when the property is overridable.
1487
+ :rtype: bool
1488
+ """
944
1489
  ...
945
1490
 
946
- def is_property_readonly(self):
947
- """ """
1491
+ def is_property_readonly(self) -> bool:
1492
+ """Check if a property is readonly.
1493
+
1494
+ :return: True when the property is readonly (not writable).
1495
+ :rtype: bool
1496
+ """
948
1497
  ...
949
1498
 
950
- def is_property_set(self):
951
- """ """
1499
+ def is_property_set(self) -> bool:
1500
+ """Check if a property is set, use for testing operator properties.
1501
+
1502
+ :return: True when the property has been set.
1503
+ :rtype: bool
1504
+ """
952
1505
  ...
953
1506
 
954
1507
  def items(self):
955
- """ """
1508
+ """Returns the items of this objects custom properties (matches Python's
1509
+ dictionary function of the same name).
1510
+
1511
+ :return: custom property key, value pairs.
1512
+ """
956
1513
  ...
957
1514
 
958
- def keyframe_delete(self):
959
- """ """
1515
+ def keyframe_delete(self) -> bool:
1516
+ """Remove a keyframe from this properties fcurve.
1517
+
1518
+ :return: Success of keyframe deletion.
1519
+ :rtype: bool
1520
+ """
960
1521
  ...
961
1522
 
962
- def keyframe_insert(self):
963
- """ """
1523
+ def keyframe_insert(self) -> bool:
1524
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1525
+
1526
+ :return: Success of keyframe insertion.
1527
+ :rtype: bool
1528
+ """
964
1529
  ...
965
1530
 
966
1531
  def keys(self):
967
- """ """
1532
+ """Returns the keys of this objects custom properties (matches Python's
1533
+ dictionary function of the same name).
1534
+
1535
+ :return: custom property keys.
1536
+ """
968
1537
  ...
969
1538
 
970
- def path_from_id(self):
971
- """ """
1539
+ def path_from_id(self) -> str:
1540
+ """Returns the data path from the ID to this object (string).
1541
+
1542
+ :return: The path from `bpy.types.bpy_struct.id_data`
1543
+ to this struct and property (when given).
1544
+ :rtype: str
1545
+ """
972
1546
  ...
973
1547
 
974
1548
  def path_resolve(self):
975
- """ """
1549
+ """Returns the property from the path, raise an exception when not found."""
976
1550
  ...
977
1551
 
978
1552
  def poll_message_set(self):
979
- """ """
1553
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
980
1554
  ...
981
1555
 
982
1556
  def pop(self):
983
- """ """
1557
+ """Remove and return the value of the custom property assigned to key or default
1558
+ when not found (matches Python's dictionary function of the same name).
1559
+
1560
+ """
984
1561
  ...
985
1562
 
986
- def property_overridable_library_set(self):
987
- """ """
1563
+ def property_overridable_library_set(self) -> bool:
1564
+ """Define a property as overridable or not (only for custom properties!).
1565
+
1566
+ :return: True when the overridable status of the property was successfully set.
1567
+ :rtype: bool
1568
+ """
988
1569
  ...
989
1570
 
990
1571
  def property_unset(self):
991
- """ """
1572
+ """Unset a property, will use default value afterward."""
992
1573
  ...
993
1574
 
994
1575
  def type_recast(self):
995
- """ """
1576
+ """Return a new instance, this is needed because types
1577
+ such as textures can be changed at runtime.
1578
+
1579
+ :return: a new instance of this object with the type initialized again.
1580
+ """
996
1581
  ...
997
1582
 
998
1583
  def values(self):
999
- """ """
1584
+ """Returns the values of this objects custom properties (matches Python's
1585
+ dictionary function of the same name).
1586
+
1587
+ :return: custom property values.
1588
+ """
1000
1589
  ...
1001
1590
 
1002
1591
  class UpdateAnimatedTransformConstraint(bpy_types.Operator):
1003
- """ """
1592
+ """Update f-curves/drivers affecting Transform constraints (use it with files from 2.70 and earlier)"""
1004
1593
 
1005
1594
  bl_idname: typing.Any
1006
1595
  """ """
@@ -1017,31 +1606,51 @@ class UpdateAnimatedTransformConstraint(bpy_types.Operator):
1017
1606
  id_data: typing.Any
1018
1607
  """ """
1019
1608
 
1020
- def as_keywords(self, ignore):
1021
- """
1609
+ def as_keywords(self, ignore=()):
1610
+ """Return a copy of the properties as a dictionary
1022
1611
 
1023
1612
  :param ignore:
1024
1613
  """
1025
1614
  ...
1026
1615
 
1027
- def as_pointer(self):
1028
- """ """
1616
+ def as_pointer(self) -> int:
1617
+ """Returns the memory address which holds a pointer to Blender's internal data
1618
+
1619
+ :return: int (memory address).
1620
+ :rtype: int
1621
+ """
1029
1622
  ...
1030
1623
 
1031
- def bl_rna_get_subclass(self):
1032
- """ """
1624
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1625
+ """
1626
+
1627
+ :return: The RNA type or default when not found.
1628
+ :rtype: bpy.types.Struct
1629
+ """
1033
1630
  ...
1034
1631
 
1035
- def bl_rna_get_subclass_py(self):
1036
- """ """
1632
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1633
+ """
1634
+
1635
+ :return: The class or default when not found.
1636
+ :rtype: typing.Any
1637
+ """
1037
1638
  ...
1038
1639
 
1039
- def driver_add(self):
1040
- """ """
1640
+ def driver_add(self) -> bpy.types.FCurve:
1641
+ """Adds driver(s) to the given property
1642
+
1643
+ :return: The driver(s) added.
1644
+ :rtype: bpy.types.FCurve
1645
+ """
1041
1646
  ...
1042
1647
 
1043
- def driver_remove(self):
1044
- """ """
1648
+ def driver_remove(self) -> bool:
1649
+ """Remove driver(s) from the given property
1650
+
1651
+ :return: Success of driver removal.
1652
+ :rtype: bool
1653
+ """
1045
1654
  ...
1046
1655
 
1047
1656
  def execute(self, context):
@@ -1052,81 +1661,145 @@ class UpdateAnimatedTransformConstraint(bpy_types.Operator):
1052
1661
  ...
1053
1662
 
1054
1663
  def get(self):
1055
- """ """
1664
+ """Returns the value of the custom property assigned to key or default
1665
+ when not found (matches Python's dictionary function of the same name).
1666
+
1667
+ """
1056
1668
  ...
1057
1669
 
1058
1670
  def id_properties_clear(self):
1059
- """ """
1671
+ """
1672
+
1673
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1674
+ """
1060
1675
  ...
1061
1676
 
1062
1677
  def id_properties_ensure(self):
1063
- """ """
1678
+ """
1679
+
1680
+ :return: the parent group for an RNA struct's custom IDProperties.
1681
+ """
1064
1682
  ...
1065
1683
 
1066
1684
  def id_properties_ui(self):
1067
- """ """
1685
+ """
1686
+
1687
+ :return: Return an object used to manage an IDProperty's UI data.
1688
+ """
1068
1689
  ...
1069
1690
 
1070
- def is_property_hidden(self):
1071
- """ """
1691
+ def is_property_hidden(self) -> bool:
1692
+ """Check if a property is hidden.
1693
+
1694
+ :return: True when the property is hidden.
1695
+ :rtype: bool
1696
+ """
1072
1697
  ...
1073
1698
 
1074
- def is_property_overridable_library(self):
1075
- """ """
1699
+ def is_property_overridable_library(self) -> bool:
1700
+ """Check if a property is overridable.
1701
+
1702
+ :return: True when the property is overridable.
1703
+ :rtype: bool
1704
+ """
1076
1705
  ...
1077
1706
 
1078
- def is_property_readonly(self):
1079
- """ """
1707
+ def is_property_readonly(self) -> bool:
1708
+ """Check if a property is readonly.
1709
+
1710
+ :return: True when the property is readonly (not writable).
1711
+ :rtype: bool
1712
+ """
1080
1713
  ...
1081
1714
 
1082
- def is_property_set(self):
1083
- """ """
1715
+ def is_property_set(self) -> bool:
1716
+ """Check if a property is set, use for testing operator properties.
1717
+
1718
+ :return: True when the property has been set.
1719
+ :rtype: bool
1720
+ """
1084
1721
  ...
1085
1722
 
1086
1723
  def items(self):
1087
- """ """
1724
+ """Returns the items of this objects custom properties (matches Python's
1725
+ dictionary function of the same name).
1726
+
1727
+ :return: custom property key, value pairs.
1728
+ """
1088
1729
  ...
1089
1730
 
1090
- def keyframe_delete(self):
1091
- """ """
1731
+ def keyframe_delete(self) -> bool:
1732
+ """Remove a keyframe from this properties fcurve.
1733
+
1734
+ :return: Success of keyframe deletion.
1735
+ :rtype: bool
1736
+ """
1092
1737
  ...
1093
1738
 
1094
- def keyframe_insert(self):
1095
- """ """
1739
+ def keyframe_insert(self) -> bool:
1740
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1741
+
1742
+ :return: Success of keyframe insertion.
1743
+ :rtype: bool
1744
+ """
1096
1745
  ...
1097
1746
 
1098
1747
  def keys(self):
1099
- """ """
1748
+ """Returns the keys of this objects custom properties (matches Python's
1749
+ dictionary function of the same name).
1750
+
1751
+ :return: custom property keys.
1752
+ """
1100
1753
  ...
1101
1754
 
1102
- def path_from_id(self):
1103
- """ """
1755
+ def path_from_id(self) -> str:
1756
+ """Returns the data path from the ID to this object (string).
1757
+
1758
+ :return: The path from `bpy.types.bpy_struct.id_data`
1759
+ to this struct and property (when given).
1760
+ :rtype: str
1761
+ """
1104
1762
  ...
1105
1763
 
1106
1764
  def path_resolve(self):
1107
- """ """
1765
+ """Returns the property from the path, raise an exception when not found."""
1108
1766
  ...
1109
1767
 
1110
1768
  def poll_message_set(self):
1111
- """ """
1769
+ """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
1112
1770
  ...
1113
1771
 
1114
1772
  def pop(self):
1115
- """ """
1773
+ """Remove and return the value of the custom property assigned to key or default
1774
+ when not found (matches Python's dictionary function of the same name).
1775
+
1776
+ """
1116
1777
  ...
1117
1778
 
1118
- def property_overridable_library_set(self):
1119
- """ """
1779
+ def property_overridable_library_set(self) -> bool:
1780
+ """Define a property as overridable or not (only for custom properties!).
1781
+
1782
+ :return: True when the overridable status of the property was successfully set.
1783
+ :rtype: bool
1784
+ """
1120
1785
  ...
1121
1786
 
1122
1787
  def property_unset(self):
1123
- """ """
1788
+ """Unset a property, will use default value afterward."""
1124
1789
  ...
1125
1790
 
1126
1791
  def type_recast(self):
1127
- """ """
1792
+ """Return a new instance, this is needed because types
1793
+ such as textures can be changed at runtime.
1794
+
1795
+ :return: a new instance of this object with the type initialized again.
1796
+ """
1128
1797
  ...
1129
1798
 
1130
1799
  def values(self):
1131
- """ """
1800
+ """Returns the values of this objects custom properties (matches Python's
1801
+ dictionary function of the same name).
1802
+
1803
+ :return: custom property values.
1804
+ """
1132
1805
  ...