fake-bge-module 20250317__py3-none-any.whl → 20260201__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.
Files changed (395) hide show
  1. {animsys_refactor → _animsys_refactor}/__init__.pyi +7 -6
  2. {bl_console_utils → _bl_console_utils}/__init__.pyi +1 -0
  3. {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +1 -0
  4. {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +1 -13
  5. {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +1 -5
  6. {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +3 -13
  7. {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +1 -10
  8. {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +2 -0
  9. _bl_i18n_utils/bl_extract_messages/__init__.pyi +28 -0
  10. {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +2 -1
  11. {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +10 -7
  12. {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +53 -50
  13. _bl_i18n_utils/utils_cli/__init__.pyi +11 -0
  14. _bl_i18n_utils/utils_languages_menu/__init__.pyi +6 -0
  15. {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +3 -2
  16. _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
  17. {bl_previews_utils → _bl_previews_utils}/__init__.pyi +1 -0
  18. _bl_previews_utils/bl_previews_render/__init__.pyi +14 -0
  19. {bl_rna_utils → _bl_rna_utils}/__init__.pyi +1 -0
  20. {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +3 -2
  21. {bl_text_utils → _bl_text_utils}/__init__.pyi +1 -0
  22. _bl_text_utils/external_editor/__init__.pyi +6 -0
  23. {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
  24. {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +2 -1
  25. _blendfile_header/__init__.pyi +48 -0
  26. _bpy_internal/__init__.pyi +5 -1
  27. _bpy_internal/addons/__init__.pyi +1 -0
  28. _bpy_internal/addons/cli/__init__.pyi +2 -1
  29. _bpy_internal/assets/__init__.pyi +5 -0
  30. _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
  31. _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
  32. _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
  33. _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
  34. _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
  35. _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
  36. _bpy_internal/extensions/__init__.pyi +1 -0
  37. _bpy_internal/extensions/junction_module/__init__.pyi +8 -7
  38. _bpy_internal/extensions/stale_file_manager/__init__.pyi +9 -8
  39. _bpy_internal/extensions/wheel_manager/__init__.pyi +6 -5
  40. {bl_i18n_utils/utils_languages_menu → _bpy_internal/filesystem}/__init__.pyi +2 -2
  41. _bpy_internal/filesystem/locking/__init__.pyi +28 -0
  42. _bpy_internal/grease_pencil/__init__.pyi +1 -0
  43. _bpy_internal/grease_pencil/stroke/__init__.pyi +22 -6
  44. _bpy_internal/platform/__init__.pyi +5 -0
  45. _bpy_internal/platform/freedesktop/__init__.pyi +21 -0
  46. _bpy_internal/system_info/__init__.pyi +1 -0
  47. _bpy_internal/system_info/text_generate_runtime/__init__.pyi +2 -1
  48. _bpy_internal/system_info/url_prefill_runtime/__init__.pyi +2 -1
  49. _bpy_internal/system_info/url_prefill_startup/__init__.pyi +3 -2
  50. {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +1 -0
  51. _bpy_types/__init__.pyi +1635 -0
  52. {console_python → _console_python}/__init__.pyi +8 -7
  53. _console_shell/__init__.pyi +10 -0
  54. {graphviz_export → _graphviz_export}/__init__.pyi +3 -2
  55. _keyingsets_utils/__init__.pyi +21 -0
  56. {rna_info → _rna_info}/__init__.pyi +32 -27
  57. {rna_xml → _rna_xml}/__init__.pyi +7 -6
  58. addon_utils/__init__.pyi +13 -25
  59. aud/__init__.pyi +133 -155
  60. bge/__init__.pyi +1 -0
  61. bge/app/__init__.pyi +1 -0
  62. bge/constraints/__init__.pyi +22 -51
  63. bge/types/__init__.pyi +618 -1913
  64. bge_extras/__init__.pyi +1 -0
  65. bge_extras/logger/__init__.pyi +4 -3
  66. bgui/__init__.pyi +1 -0
  67. bgui/frame/__init__.pyi +1 -0
  68. bgui/frame_button/__init__.pyi +1 -0
  69. bgui/image/__init__.pyi +1 -1
  70. bgui/image_button/__init__.pyi +1 -0
  71. bgui/label/__init__.pyi +1 -0
  72. bgui/list_box/__init__.pyi +1 -1
  73. bgui/progress_bar/__init__.pyi +2 -1
  74. bgui/system/__init__.pyi +3 -5
  75. bgui/text_block/__init__.pyi +1 -0
  76. bgui/text_input/__init__.pyi +9 -8
  77. bgui/theme/__init__.pyi +4 -3
  78. bgui/widget/__init__.pyi +5 -4
  79. bl_app_override/__init__.pyi +4 -3
  80. bl_app_override/helpers/__init__.pyi +3 -2
  81. bl_app_template_utils/__init__.pyi +5 -4
  82. bl_app_templates_system/Game_Engine/__init__.pyi +5 -4
  83. bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
  84. bl_app_templates_system/__init__.pyi +2 -0
  85. bl_keymap_utils/__init__.pyi +1 -0
  86. bl_keymap_utils/io/__init__.pyi +10 -9
  87. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -1
  88. bl_keymap_utils/keymap_hierarchy/__init__.pyi +2 -1
  89. bl_keymap_utils/platform_helpers/__init__.pyi +3 -2
  90. bl_keymap_utils/versioning/__init__.pyi +2 -1
  91. bl_math/__init__.pyi +4 -13
  92. bl_operators/__init__.pyi +4 -2
  93. bl_operators/add_mesh_torus/__init__.pyi +9 -9
  94. bl_operators/anim/__init__.pyi +90 -62
  95. bl_operators/assets/__init__.pyi +14 -18
  96. bl_operators/bmesh/__init__.pyi +1 -0
  97. bl_operators/bmesh/find_adjacent/__init__.pyi +12 -9
  98. bl_operators/bone_selection_sets/__init__.pyi +34 -60
  99. bl_operators/clip/__init__.pyi +39 -57
  100. bl_operators/connect_to_output/__init__.pyi +20 -18
  101. bl_operators/console/__init__.pyi +17 -25
  102. bl_operators/constraint/__init__.pyi +15 -21
  103. bl_operators/copy_global_transform/__init__.pyi +261 -0
  104. bl_operators/file/__init__.pyi +13 -17
  105. bl_operators/freestyle/__init__.pyi +15 -21
  106. bl_operators/geometry_nodes/__init__.pyi +30 -36
  107. bl_operators/grease_pencil/__init__.pyi +5 -5
  108. bl_operators/image/__init__.pyi +14 -22
  109. bl_operators/image_as_planes/__init__.pyi +36 -42
  110. bl_operators/mesh/__init__.pyi +8 -53
  111. bl_operators/node/__init__.pyi +375 -92
  112. bl_operators/node_editor/__init__.pyi +1 -0
  113. bl_operators/node_editor/node_functions/__init__.pyi +10 -9
  114. bl_operators/object/__init__.pyi +57 -98
  115. bl_operators/object_align/__init__.pyi +8 -8
  116. bl_operators/object_quick_effects/__init__.pyi +15 -21
  117. bl_operators/object_randomize_transform/__init__.pyi +6 -6
  118. bl_operators/presets/__init__.pyi +46 -94
  119. bl_operators/rigidbody/__init__.pyi +12 -16
  120. bl_operators/screen_play_rendered_anim/__init__.pyi +5 -5
  121. bl_operators/sequencer/__init__.pyi +40 -54
  122. bl_operators/spreadsheet/__init__.pyi +7 -7
  123. bl_operators/userpref/__init__.pyi +69 -117
  124. bl_operators/uvcalc_follow_active/__init__.pyi +8 -8
  125. bl_operators/uvcalc_lightmap/__init__.pyi +12 -12
  126. bl_operators/uvcalc_transform/__init__.pyi +39 -28
  127. bl_operators/vertexpaint_dirt/__init__.pyi +7 -7
  128. bl_operators/view3d/__init__.pyi +31 -43
  129. bl_operators/wm/__init__.pyi +139 -231
  130. bl_operators/world/__init__.pyi +6 -6
  131. bl_ui/__init__.pyi +18 -17
  132. bl_ui/anim/__init__.pyi +5 -5
  133. bl_ui/asset_shelf/__init__.pyi +5 -5
  134. bl_ui/generic_ui_list/__init__.pyi +11 -25
  135. bl_ui/node_add_menu/__init__.pyi +281 -12
  136. bl_ui/node_add_menu_compositor/__init__.pyi +135 -91
  137. bl_ui/node_add_menu_geometry/__init__.pyi +407 -263
  138. bl_ui/node_add_menu_shader/__init__.pyi +67 -67
  139. bl_ui/node_add_menu_texture/__init__.pyi +25 -69
  140. bl_ui/properties_animviz/__init__.pyi +3 -2
  141. bl_ui/properties_collection/__init__.pyi +20 -30
  142. bl_ui/properties_constraint/__init__.pyi +228 -450
  143. bl_ui/properties_data_armature/__init__.pyi +45 -79
  144. bl_ui/properties_data_bone/__init__.pyi +33 -51
  145. bl_ui/properties_data_camera/__init__.pyi +43 -75
  146. bl_ui/properties_data_curve/__init__.pyi +42 -101
  147. bl_ui/properties_data_curves/__init__.pyi +21 -35
  148. bl_ui/properties_data_empty/__init__.pyi +8 -10
  149. bl_ui/properties_data_grease_pencil/__init__.pyi +49 -87
  150. bl_ui/properties_data_lattice/__init__.pyi +12 -18
  151. bl_ui/properties_data_light/__init__.pyi +28 -46
  152. bl_ui/properties_data_lightprobe/__init__.pyi +35 -61
  153. bl_ui/properties_data_mesh/__init__.pyi +73 -120
  154. bl_ui/properties_data_metaball/__init__.pyi +16 -26
  155. bl_ui/properties_data_modifier/__init__.pyi +34 -39
  156. bl_ui/properties_data_pointcloud/__init__.pyi +17 -27
  157. bl_ui/properties_data_shaderfx/__init__.pyi +4 -4
  158. bl_ui/properties_data_speaker/__init__.pyi +15 -25
  159. bl_ui/properties_data_volume/__init__.pyi +22 -38
  160. bl_ui/properties_freestyle/__init__.pyi +79 -127
  161. bl_ui/properties_game/__init__.pyi +88 -84
  162. bl_ui/properties_grease_pencil_common/__init__.pyi +33 -190
  163. bl_ui/properties_mask_common/__init__.pyi +33 -45
  164. bl_ui/properties_material/__init__.pyi +52 -111
  165. bl_ui/properties_material_gpencil/__init__.pyi +48 -68
  166. bl_ui/properties_object/__init__.pyi +123 -93
  167. bl_ui/properties_output/__init__.pyi +103 -81
  168. bl_ui/properties_paint_common/__init__.pyi +78 -59
  169. bl_ui/properties_particle/__init__.pyi +160 -262
  170. bl_ui/properties_physics_cloth/__init__.pyi +36 -62
  171. bl_ui/properties_physics_common/__init__.pyi +11 -11
  172. bl_ui/properties_physics_dynamicpaint/__init__.pyi +81 -123
  173. bl_ui/properties_physics_field/__init__.pyi +35 -53
  174. bl_ui/properties_physics_fluid/__init__.pyi +106 -160
  175. bl_ui/properties_physics_geometry_nodes/__init__.pyi +6 -6
  176. bl_ui/properties_physics_rigidbody/__init__.pyi +28 -42
  177. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +44 -68
  178. bl_ui/properties_physics_softbody/__init__.pyi +38 -66
  179. bl_ui/properties_render/__init__.pyi +267 -259
  180. bl_ui/properties_scene/__init__.pyi +69 -72
  181. bl_ui/properties_strip/__init__.pyi +744 -0
  182. bl_ui/properties_strip_modifier/__init__.pyi +45 -0
  183. bl_ui/properties_texture/__init__.pyi +69 -122
  184. bl_ui/properties_view_layer/__init__.pyi +97 -51
  185. bl_ui/properties_workspace/__init__.pyi +12 -18
  186. bl_ui/properties_world/__init__.pyi +33 -53
  187. bl_ui/space_clip/__init__.pyi +231 -311
  188. bl_ui/space_console/__init__.pyi +14 -24
  189. bl_ui/space_dopesheet/__init__.pyi +193 -125
  190. bl_ui/space_filebrowser/__init__.pyi +107 -131
  191. bl_ui/space_graph/__init__.pyi +93 -80
  192. bl_ui/space_image/__init__.pyi +207 -291
  193. bl_ui/space_info/__init__.pyi +14 -24
  194. bl_ui/space_logic/__init__.pyi +14 -22
  195. bl_ui/space_nla/__init__.pyi +63 -69
  196. bl_ui/space_node/__init__.pyi +215 -154
  197. bl_ui/space_outliner/__init__.pyi +65 -61
  198. bl_ui/space_properties/__init__.pyi +41 -16
  199. bl_ui/space_sequencer/__init__.pyi +276 -980
  200. bl_ui/space_spreadsheet/__init__.pyi +27 -23
  201. bl_ui/space_statusbar/__init__.pyi +4 -4
  202. bl_ui/space_text/__init__.pyi +39 -73
  203. bl_ui/space_time/__init__.pyi +33 -78
  204. bl_ui/space_toolsystem_common/__init__.pyi +31 -28
  205. bl_ui/space_toolsystem_toolbar/__init__.pyi +67 -43
  206. bl_ui/space_topbar/__init__.pyi +68 -111
  207. bl_ui/space_userpref/__init__.pyi +310 -445
  208. bl_ui/space_view3d/__init__.pyi +667 -1122
  209. bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
  210. bl_ui/space_view3d_toolbar/__init__.pyi +237 -966
  211. bl_ui/utils/__init__.pyi +4 -3
  212. blend_render_info/__init__.pyi +4 -2
  213. blf/__init__.pyi +92 -59
  214. bmesh/__init__.pyi +4 -10
  215. bmesh/geometry/__init__.pyi +2 -4
  216. bmesh/ops/__init__.pyi +442 -815
  217. bmesh/types/__init__.pyi +377 -720
  218. bmesh/utils/__init__.pyi +20 -45
  219. bpy/__init__.pyi +2 -1
  220. bpy/app/__init__.pyi +96 -90
  221. bpy/app/handlers/__init__.pyi +24 -19
  222. bpy/app/icons/__init__.pyi +2 -7
  223. bpy/app/timers/__init__.pyi +5 -18
  224. bpy/app/translations/__init__.pyi +21 -35
  225. bpy/msgbus/__init__.pyi +20 -9
  226. bpy/ops/__init__.pyi +21 -3
  227. bpy/ops/action/__init__.pyi +121 -226
  228. bpy/ops/anim/__init__.pyi +204 -358
  229. bpy/ops/armature/__init__.pyi +129 -249
  230. bpy/ops/asset/__init__.pyi +82 -111
  231. bpy/ops/bge_bricknodes/__init__.pyi +61 -0
  232. bpy/ops/boid/__init__.pyi +44 -50
  233. bpy/ops/bricknodes/__init__.pyi +37 -0
  234. bpy/ops/brush/__init__.pyi +33 -120
  235. bpy/ops/buttons/__init__.pyi +27 -83
  236. bpy/ops/cachefile/__init__.pyi +16 -74
  237. bpy/ops/camera/__init__.pyi +3 -13
  238. bpy/ops/clip/__init__.pyi +278 -558
  239. bpy/ops/cloth/__init__.pyi +2 -6
  240. bpy/ops/collection/__init__.pyi +34 -44
  241. bpy/ops/console/__init__.pyi +70 -111
  242. bpy/ops/constraint/__init__.pyi +34 -102
  243. bpy/ops/curve/__init__.pyi +163 -315
  244. bpy/ops/curves/__init__.pyi +163 -189
  245. bpy/ops/cycles/__init__.pyi +8 -18
  246. bpy/ops/dpaint/__init__.pyi +21 -30
  247. bpy/ops/ed/__init__.pyi +59 -103
  248. bpy/ops/export_anim/__init__.pyi +4 -11
  249. bpy/ops/export_scene/__init__.pyi +29 -174
  250. bpy/ops/extensions/__init__.pyi +102 -194
  251. bpy/ops/file/__init__.pyi +166 -272
  252. bpy/ops/fluid/__init__.pyi +78 -86
  253. bpy/ops/font/__init__.pyi +73 -164
  254. bpy/ops/geometry/__init__.pyi +33 -144
  255. bpy/ops/gizmogroup/__init__.pyi +8 -14
  256. bpy/ops/gpencil/__init__.pyi +31 -58
  257. bpy/ops/graph/__init__.pyi +176 -411
  258. bpy/ops/grease_pencil/__init__.pyi +416 -639
  259. bpy/ops/image/__init__.pyi +148 -492
  260. bpy/ops/import_anim/__init__.pyi +5 -18
  261. bpy/ops/import_curve/__init__.pyi +4 -6
  262. bpy/ops/import_scene/__init__.pyi +22 -49
  263. bpy/ops/info/__init__.pyi +27 -43
  264. bpy/ops/lattice/__init__.pyi +26 -43
  265. bpy/ops/logic/__init__.pyi +49 -122
  266. bpy/ops/logic_nodes/__init__.pyi +461 -0
  267. bpy/ops/marker/__init__.pyi +24 -60
  268. bpy/ops/mask/__init__.pyi +118 -222
  269. bpy/ops/material/__init__.pyi +19 -18
  270. bpy/ops/mball/__init__.pyi +13 -39
  271. bpy/ops/mesh/__init__.pyi +409 -1264
  272. bpy/ops/nla/__init__.pyi +140 -232
  273. bpy/ops/node/__init__.pyi +1189 -807
  274. bpy/ops/object/__init__.pyi +806 -1659
  275. bpy/ops/outliner/__init__.pyi +284 -432
  276. bpy/ops/paint/__init__.pyi +189 -381
  277. bpy/ops/paintcurve/__init__.pyi +29 -44
  278. bpy/ops/palette/__init__.pyi +23 -34
  279. bpy/ops/particle/__init__.pyi +135 -201
  280. bpy/ops/pointcloud/__init__.pyi +23 -42
  281. bpy/ops/pose/__init__.pyi +195 -310
  282. bpy/ops/poselib/__init__.pyi +45 -73
  283. bpy/ops/preferences/__init__.pyi +89 -221
  284. bpy/ops/ptcache/__init__.pyi +32 -39
  285. bpy/ops/render/__init__.pyi +36 -83
  286. bpy/ops/rigidbody/__init__.pyi +47 -78
  287. bpy/ops/scene/__init__.pyi +169 -222
  288. bpy/ops/screen/__init__.pyi +146 -259
  289. bpy/ops/script/__init__.pyi +9 -15
  290. bpy/ops/sculpt/__init__.pyi +194 -354
  291. bpy/ops/sculpt_curves/__init__.pyi +21 -29
  292. bpy/ops/sequencer/__init__.pyi +586 -836
  293. bpy/ops/sound/__init__.pyi +25 -131
  294. bpy/ops/spreadsheet/__init__.pyi +34 -21
  295. bpy/ops/surface/__init__.pyi +7 -54
  296. bpy/ops/text/__init__.pyi +166 -281
  297. bpy/ops/text_editor/__init__.pyi +2 -6
  298. bpy/ops/texture/__init__.pyi +20 -22
  299. bpy/ops/transform/__init__.pyi +108 -445
  300. bpy/ops/ui/__init__.pyi +157 -219
  301. bpy/ops/uilist/__init__.pyi +4 -16
  302. bpy/ops/uv/__init__.pyi +291 -347
  303. bpy/ops/view2d/__init__.pyi +29 -88
  304. bpy/ops/view3d/__init__.pyi +238 -438
  305. bpy/ops/wm/__init__.pyi +651 -1510
  306. bpy/ops/workspace/__init__.pyi +42 -44
  307. bpy/ops/world/__init__.pyi +12 -13
  308. bpy/path/__init__.pyi +5 -36
  309. bpy/props/__init__.pyi +395 -259
  310. bpy/{_typing → stub_internal}/__init__.pyi +1 -0
  311. bpy/{_typing → stub_internal}/rna_enums/__init__.pyi +214 -114
  312. bpy/types/__init__.pyi +93285 -103831
  313. bpy/utils/__init__.pyi +46 -104
  314. bpy/utils/previews/__init__.pyi +7 -15
  315. bpy/utils/units/__init__.pyi +6 -15
  316. bpy_extras/__init__.pyi +1 -0
  317. bpy_extras/anim_utils/__init__.pyi +32 -23
  318. bpy_extras/asset_utils/__init__.pyi +1 -0
  319. bpy_extras/bmesh_utils/__init__.pyi +2 -2
  320. bpy_extras/id_map_utils/__init__.pyi +15 -6
  321. bpy_extras/image_utils/__init__.pyi +3 -11
  322. bpy_extras/io_utils/__init__.pyi +22 -38
  323. bpy_extras/keyconfig_utils/__init__.pyi +5 -4
  324. bpy_extras/mesh_utils/__init__.pyi +3 -14
  325. bpy_extras/node_shader_utils/__init__.pyi +63 -70
  326. bpy_extras/node_utils/__init__.pyi +4 -3
  327. bpy_extras/object_utils/__init__.pyi +6 -19
  328. bpy_extras/view3d_utils/__init__.pyi +1 -18
  329. bpy_extras/wm_utils/__init__.pyi +1 -0
  330. bpy_extras/wm_utils/progress_report/__init__.pyi +12 -11
  331. {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/METADATA +9 -3
  332. fake_bge_module-20260201.dist-info/RECORD +414 -0
  333. {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/WHEEL +1 -1
  334. {fake_bge_module-20250317.dist-info → fake_bge_module-20260201.dist-info}/top_level.txt +16 -16
  335. freestyle/__init__.pyi +1 -0
  336. freestyle/chainingiterators/__init__.pyi +41 -60
  337. freestyle/functions/__init__.pyi +56 -194
  338. freestyle/predicates/__init__.pyi +11 -61
  339. freestyle/shaders/__init__.pyi +95 -156
  340. freestyle/types/__init__.pyi +306 -941
  341. freestyle/utils/ContextFunctions/__init__.pyi +4 -24
  342. freestyle/utils/__init__.pyi +46 -36
  343. gpu/__init__.pyi +84 -5
  344. gpu/capabilities/__init__.pyi +1 -21
  345. gpu/matrix/__init__.pyi +16 -24
  346. gpu/platform/__init__.pyi +3 -7
  347. gpu/select/__init__.pyi +2 -1
  348. gpu/shader/__init__.pyi +43 -9
  349. gpu/state/__init__.pyi +66 -44
  350. gpu/texture/__init__.pyi +4 -5
  351. gpu/types/__init__.pyi +216 -216
  352. gpu_extras/__init__.pyi +1 -0
  353. gpu_extras/batch/__init__.pyi +2 -5
  354. gpu_extras/presets/__init__.pyi +9 -10
  355. idprop/__init__.pyi +17 -0
  356. idprop/types/__init__.pyi +18 -17
  357. imbuf/__init__.pyi +13 -9
  358. imbuf/types/__init__.pyi +10 -23
  359. keyingsets_builtins/__init__.pyi +51 -93
  360. mathutils/__init__.pyi +296 -2255
  361. mathutils/bvhtree/__init__.pyi +22 -29
  362. mathutils/geometry/__init__.pyi +83 -132
  363. mathutils/interpolate/__init__.pyi +7 -5
  364. mathutils/kdtree/__init__.pyi +5 -14
  365. mathutils/noise/__init__.pyi +62 -106
  366. nodeitems_builtins/__init__.pyi +5 -4
  367. nodeitems_utils/__init__.pyi +10 -9
  368. rna_keymap_ui/__init__.pyi +7 -6
  369. rna_prop_ui/__init__.pyi +14 -13
  370. _bpy_internal/freedesktop/__init__.pyi +0 -20
  371. bgl/__init__.pyi +0 -4235
  372. bl_i18n_utils/bl_extract_messages/__init__.pyi +0 -24
  373. bl_i18n_utils/utils_cli/__init__.pyi +0 -10
  374. bl_previews_utils/bl_previews_render/__init__.pyi +0 -11
  375. bl_text_utils/external_editor/__init__.pyi +0 -5
  376. bpy_types/__init__.pyi +0 -29
  377. console_shell/__init__.pyi +0 -9
  378. fake_bge_module-20250317.dist-info/RECORD +0 -395
  379. keyingsets_utils/__init__.pyi +0 -18
  380. {animsys_refactor → _animsys_refactor}/py.typed +0 -0
  381. {bgl → _bl_console_utils}/py.typed +0 -0
  382. {bl_console_utils → _bl_i18n_utils}/py.typed +0 -0
  383. {bl_i18n_utils → _bl_previews_utils}/py.typed +0 -0
  384. {bl_previews_utils → _bl_rna_utils}/py.typed +0 -0
  385. {bl_rna_utils → _bl_text_utils}/py.typed +0 -0
  386. {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
  387. {bl_ui_utils → _blendfile_header}/py.typed +0 -0
  388. {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
  389. {bpy_types → _bpy_types}/py.typed +0 -0
  390. {console_python → _console_python}/py.typed +0 -0
  391. {console_shell → _console_shell}/py.typed +0 -0
  392. {graphviz_export → _graphviz_export}/py.typed +0 -0
  393. {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
  394. {rna_info → _rna_info}/py.typed +0 -0
  395. {rna_xml → _rna_xml}/py.typed +0 -0
bpy/ops/wm/__init__.pyi CHANGED
@@ -1,8 +1,9 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
+ import numpy.typing as npt
4
5
  import bl_operators.wm
5
- import bpy._typing.rna_enums
6
+ import bpy.stub_internal.rna_enums
6
7
  import bpy.types
7
8
  import mathutils
8
9
 
@@ -23,7 +24,6 @@ def alembic_export(
23
24
  filter_text: bool | None = False,
24
25
  filter_archive: bool | None = False,
25
26
  filter_btx: bool | None = False,
26
- filter_collada: bool | None = False,
27
27
  filter_alembic: bool | None = True,
28
28
  filter_usd: bool | None = False,
29
29
  filter_obj: bool | None = False,
@@ -44,7 +44,6 @@ def alembic_export(
44
44
  sh_open: float | None = 0.0,
45
45
  sh_close: float | None = 1.0,
46
46
  selected: bool | None = False,
47
- visible_objects_only: bool | None = False,
48
47
  flatten: bool | None = False,
49
48
  collection: str = "",
50
49
  uvs: bool | None = True,
@@ -59,9 +58,9 @@ def alembic_export(
59
58
  use_instancing: bool | None = True,
60
59
  global_scale: float | None = 1.0,
61
60
  triangulate: bool | None = False,
62
- quad_method: bpy._typing.rna_enums.ModifierTriangulateQuadMethodItems
61
+ quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems
63
62
  | None = "SHORTEST_DIAGONAL",
64
- ngon_method: bpy._typing.rna_enums.ModifierTriangulateNgonMethodItems
63
+ ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems
65
64
  | None = "BEAUTY",
66
65
  export_hair: bool | None = True,
67
66
  export_particles: bool | None = True,
@@ -69,51 +68,28 @@ def alembic_export(
69
68
  as_background_job: bool | None = False,
70
69
  evaluation_mode: typing.Literal["RENDER", "VIEWPORT"] | None = "RENDER",
71
70
  init_scene_frame_range: bool | None = True,
72
- ):
71
+ ) -> None:
73
72
  """Export current scene in an Alembic archive
74
73
 
75
- :type execution_context: int | str | None
76
- :type undo: bool | None
77
74
  :param filepath: File Path, Path to file
78
- :type filepath: str
79
75
  :param check_existing: Check Existing, Check and warn on overwriting existing files
80
- :type check_existing: bool | None
81
76
  :param filter_blender: Filter .blend files
82
- :type filter_blender: bool | None
83
77
  :param filter_backup: Filter .blend files
84
- :type filter_backup: bool | None
85
78
  :param filter_image: Filter image files
86
- :type filter_image: bool | None
87
79
  :param filter_movie: Filter movie files
88
- :type filter_movie: bool | None
89
80
  :param filter_python: Filter Python files
90
- :type filter_python: bool | None
91
81
  :param filter_font: Filter font files
92
- :type filter_font: bool | None
93
82
  :param filter_sound: Filter sound files
94
- :type filter_sound: bool | None
95
83
  :param filter_text: Filter text files
96
- :type filter_text: bool | None
97
84
  :param filter_archive: Filter archive files
98
- :type filter_archive: bool | None
99
85
  :param filter_btx: Filter btx files
100
- :type filter_btx: bool | None
101
- :param filter_collada: Filter COLLADA files
102
- :type filter_collada: bool | None
103
86
  :param filter_alembic: Filter Alembic files
104
- :type filter_alembic: bool | None
105
87
  :param filter_usd: Filter USD files
106
- :type filter_usd: bool | None
107
88
  :param filter_obj: Filter OBJ files
108
- :type filter_obj: bool | None
109
89
  :param filter_volume: Filter OpenVDB volume files
110
- :type filter_volume: bool | None
111
90
  :param filter_folder: Filter folders
112
- :type filter_folder: bool | None
113
91
  :param filter_blenlib: Filter Blender IDs
114
- :type filter_blenlib: bool | None
115
92
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
116
- :type filemode: int | None
117
93
  :param display_type: Display Type
118
94
 
119
95
  DEFAULT
@@ -127,66 +103,34 @@ def alembic_export(
127
103
 
128
104
  THUMBNAIL
129
105
  Thumbnails -- Display files as thumbnails.
130
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
131
106
  :param sort_method: File sorting mode
132
- :type sort_method: str | None
133
- :type filter_glob: str
134
107
  :param start: Start Frame, Start frame of the export, use the default value to take the start frame of the current scene
135
- :type start: int | None
136
108
  :param end: End Frame, End frame of the export, use the default value to take the end frame of the current scene
137
- :type end: int | None
138
109
  :param xsamples: Transform Samples, Number of times per frame transformations are sampled
139
- :type xsamples: int | None
140
110
  :param gsamples: Geometry Samples, Number of times per frame object data are sampled
141
- :type gsamples: int | None
142
111
  :param sh_open: Shutter Open, Time at which the shutter is open
143
- :type sh_open: float | None
144
112
  :param sh_close: Shutter Close, Time at which the shutter is closed
145
- :type sh_close: float | None
146
113
  :param selected: Selected Objects Only, Export only selected objects
147
- :type selected: bool | None
148
- :param visible_objects_only: Visible Objects Only, Export only objects that are visible
149
- :type visible_objects_only: bool | None
150
- :param flatten: Flatten Hierarchy, Do not preserve objects' parent/children relationship
151
- :type flatten: bool | None
114
+ :param flatten: Flatten Hierarchy, Do not preserve objects parent/children relationship
152
115
  :param collection: Collection
153
- :type collection: str
154
116
  :param uvs: UV Coordinates, Export UV coordinates
155
- :type uvs: bool | None
156
117
  :param packuv: Merge UVs
157
- :type packuv: bool | None
158
118
  :param normals: Normals, Export normals
159
- :type normals: bool | None
160
119
  :param vcolors: Color Attributes, Export color attributes
161
- :type vcolors: bool | None
162
120
  :param orcos: Generated Coordinates, Export undeformed mesh vertex coordinates
163
- :type orcos: bool | None
164
121
  :param face_sets: Face Sets, Export per face shading group assignments
165
- :type face_sets: bool | None
166
- :param subdiv_schema: Use Subdivision Schema, Export meshes using Alembic's subdivision schema
167
- :type subdiv_schema: bool | None
122
+ :param subdiv_schema: Use Subdivision Schema, Export meshes using Alembics subdivision schema
168
123
  :param apply_subdiv: Apply Subdivision Surface, Export subdivision surfaces as meshes
169
- :type apply_subdiv: bool | None
170
124
  :param curves_as_mesh: Curves as Mesh, Export curves and NURBS surfaces as meshes
171
- :type curves_as_mesh: bool | None
172
125
  :param use_instancing: Use Instancing, Export data of duplicated objects as Alembic instances; speeds up the export and can be disabled for compatibility with other software
173
- :type use_instancing: bool | None
174
- :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
175
- :type global_scale: float | None
126
+ :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
176
127
  :param triangulate: Triangulate, Export polygons (quads and n-gons) as triangles
177
- :type triangulate: bool | None
178
128
  :param quad_method: Quad Method, Method for splitting the quads into triangles
179
- :type quad_method: bpy._typing.rna_enums.ModifierTriangulateQuadMethodItems | None
180
129
  :param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
181
- :type ngon_method: bpy._typing.rna_enums.ModifierTriangulateNgonMethodItems | None
182
130
  :param export_hair: Export Hair, Exports hair particle systems as animated curves
183
- :type export_hair: bool | None
184
131
  :param export_particles: Export Particles, Exports non-hair particle systems
185
- :type export_particles: bool | None
186
132
  :param export_custom_properties: Export Custom Properties, Export custom properties to Alembic .userProperties
187
- :type export_custom_properties: bool | None
188
133
  :param as_background_job: Run as Background Job, Enable this to run the import in the background, disable to block Blender while importing. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job
189
- :type as_background_job: bool | None
190
134
  :param evaluation_mode: Settings, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering
191
135
 
192
136
  RENDER
@@ -194,8 +138,6 @@ def alembic_export(
194
138
 
195
139
  VIEWPORT
196
140
  Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
197
- :type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
198
- :type init_scene_frame_range: bool | None
199
141
  """
200
142
 
201
143
  def alembic_import(
@@ -218,7 +160,6 @@ def alembic_import(
218
160
  filter_text: bool | None = False,
219
161
  filter_archive: bool | None = False,
220
162
  filter_btx: bool | None = False,
221
- filter_collada: bool | None = False,
222
163
  filter_alembic: bool | None = True,
223
164
  filter_usd: bool | None = False,
224
165
  filter_obj: bool | None = False,
@@ -239,57 +180,31 @@ def alembic_import(
239
180
  always_add_cache_reader: bool | None = False,
240
181
  is_sequence: bool | None = False,
241
182
  as_background_job: bool | None = False,
242
- ):
183
+ ) -> None:
243
184
  """Load an Alembic archive
244
185
 
245
- :type execution_context: int | str | None
246
- :type undo: bool | None
247
186
  :param filepath: File Path, Path to file
248
- :type filepath: str
249
187
  :param directory: Directory, Directory of the file
250
- :type directory: str
251
188
  :param files: Files
252
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
253
189
  :param check_existing: Check Existing, Check and warn on overwriting existing files
254
- :type check_existing: bool | None
255
190
  :param filter_blender: Filter .blend files
256
- :type filter_blender: bool | None
257
191
  :param filter_backup: Filter .blend files
258
- :type filter_backup: bool | None
259
192
  :param filter_image: Filter image files
260
- :type filter_image: bool | None
261
193
  :param filter_movie: Filter movie files
262
- :type filter_movie: bool | None
263
194
  :param filter_python: Filter Python files
264
- :type filter_python: bool | None
265
195
  :param filter_font: Filter font files
266
- :type filter_font: bool | None
267
196
  :param filter_sound: Filter sound files
268
- :type filter_sound: bool | None
269
197
  :param filter_text: Filter text files
270
- :type filter_text: bool | None
271
198
  :param filter_archive: Filter archive files
272
- :type filter_archive: bool | None
273
199
  :param filter_btx: Filter btx files
274
- :type filter_btx: bool | None
275
- :param filter_collada: Filter COLLADA files
276
- :type filter_collada: bool | None
277
200
  :param filter_alembic: Filter Alembic files
278
- :type filter_alembic: bool | None
279
201
  :param filter_usd: Filter USD files
280
- :type filter_usd: bool | None
281
202
  :param filter_obj: Filter OBJ files
282
- :type filter_obj: bool | None
283
203
  :param filter_volume: Filter OpenVDB volume files
284
- :type filter_volume: bool | None
285
204
  :param filter_folder: Filter folders
286
- :type filter_folder: bool | None
287
205
  :param filter_blenlib: Filter Blender IDs
288
- :type filter_blenlib: bool | None
289
206
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
290
- :type filemode: int | None
291
207
  :param relative_path: Relative Path, Select the file relative to the blend file
292
- :type relative_path: bool | None
293
208
  :param display_type: Display Type
294
209
 
295
210
  DEFAULT
@@ -303,22 +218,13 @@ def alembic_import(
303
218
 
304
219
  THUMBNAIL
305
220
  Thumbnails -- Display files as thumbnails.
306
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
307
221
  :param sort_method: File sorting mode
308
- :type sort_method: str | None
309
- :type filter_glob: str
310
- :param scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
311
- :type scale: float | None
312
- :param set_frame_range: Set Frame Range, If checked, update scene's start and end frame to match those of the Alembic archive
313
- :type set_frame_range: bool | None
222
+ :param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
223
+ :param set_frame_range: Set Frame Range, If checked, update scenes start and end frame to match those of the Alembic archive
314
224
  :param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
315
- :type validate_meshes: bool | None
316
225
  :param always_add_cache_reader: Always Add Cache Reader, Add cache modifiers and constraints to imported objects even if they are not animated so that they can be updated when reloading the Alembic archive
317
- :type always_add_cache_reader: bool | None
318
226
  :param is_sequence: Is Sequence, Set to true if the cache is split into separate files
319
- :type is_sequence: bool | None
320
227
  :param as_background_job: Run as Background Job, Enable this to run the export in the background, disable to block Blender while exporting. This option is deprecated; EXECUTE this operator to run in the foreground, and INVOKE it to run as a background job
321
- :type as_background_job: bool | None
322
228
  """
323
229
 
324
230
  def append(
@@ -342,7 +248,6 @@ def append(
342
248
  filter_text: bool | None = False,
343
249
  filter_archive: bool | None = False,
344
250
  filter_btx: bool | None = False,
345
- filter_collada: bool | None = False,
346
251
  filter_alembic: bool | None = False,
347
252
  filter_usd: bool | None = False,
348
253
  filter_obj: bool | None = False,
@@ -364,57 +269,31 @@ def append(
364
269
  instance_object_data: bool | None = True,
365
270
  set_fake: bool | None = False,
366
271
  use_recursive: bool | None = True,
367
- ):
272
+ ) -> None:
368
273
  """Append from a Library .blend file
369
274
 
370
- :type execution_context: int | str | None
371
- :type undo: bool | None
372
275
  :param filepath: File Path, Path to file
373
- :type filepath: str
374
276
  :param directory: Directory, Directory of the file
375
- :type directory: str
376
277
  :param filename: File Name, Name of the file
377
- :type filename: str
378
278
  :param files: Files
379
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
380
279
  :param check_existing: Check Existing, Check and warn on overwriting existing files
381
- :type check_existing: bool | None
382
280
  :param filter_blender: Filter .blend files
383
- :type filter_blender: bool | None
384
281
  :param filter_backup: Filter .blend files
385
- :type filter_backup: bool | None
386
282
  :param filter_image: Filter image files
387
- :type filter_image: bool | None
388
283
  :param filter_movie: Filter movie files
389
- :type filter_movie: bool | None
390
284
  :param filter_python: Filter Python files
391
- :type filter_python: bool | None
392
285
  :param filter_font: Filter font files
393
- :type filter_font: bool | None
394
286
  :param filter_sound: Filter sound files
395
- :type filter_sound: bool | None
396
287
  :param filter_text: Filter text files
397
- :type filter_text: bool | None
398
288
  :param filter_archive: Filter archive files
399
- :type filter_archive: bool | None
400
289
  :param filter_btx: Filter btx files
401
- :type filter_btx: bool | None
402
- :param filter_collada: Filter COLLADA files
403
- :type filter_collada: bool | None
404
290
  :param filter_alembic: Filter Alembic files
405
- :type filter_alembic: bool | None
406
291
  :param filter_usd: Filter USD files
407
- :type filter_usd: bool | None
408
292
  :param filter_obj: Filter OBJ files
409
- :type filter_obj: bool | None
410
293
  :param filter_volume: Filter OpenVDB volume files
411
- :type filter_volume: bool | None
412
294
  :param filter_folder: Filter folders
413
- :type filter_folder: bool | None
414
295
  :param filter_blenlib: Filter Blender IDs
415
- :type filter_blenlib: bool | None
416
296
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
417
- :type filemode: int | None
418
297
  :param display_type: Display Type
419
298
 
420
299
  DEFAULT
@@ -428,27 +307,16 @@ def append(
428
307
 
429
308
  THUMBNAIL
430
309
  Thumbnails -- Display files as thumbnails.
431
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
432
310
  :param sort_method: File sorting mode
433
- :type sort_method: str | None
434
311
  :param link: Link, Link the objects or data-blocks rather than appending
435
- :type link: bool | None
436
312
  :param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
437
- :type do_reuse_local_id: bool | None
438
- :param clear_asset_data: Clear Asset Data, Don't add asset meta-data or tags from the original data-block
439
- :type clear_asset_data: bool | None
313
+ :param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
440
314
  :param autoselect: Select, Select new objects
441
- :type autoselect: bool | None
442
315
  :param active_collection: Active Collection, Put new objects on the active collection
443
- :type active_collection: bool | None
444
316
  :param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
445
- :type instance_collections: bool | None
446
317
  :param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
447
- :type instance_object_data: bool | None
448
318
  :param set_fake: Fake User, Set "Fake User" for appended items (except objects and collections)
449
- :type set_fake: bool | None
450
319
  :param use_recursive: Localize All, Localize all appended data, including those indirectly linked from other libraries
451
- :type use_recursive: bool | None
452
320
  """
453
321
 
454
322
  def batch_rename(
@@ -464,7 +332,7 @@ def batch_rename(
464
332
  "CURVE",
465
333
  "META",
466
334
  "VOLUME",
467
- "GPENCIL",
335
+ "GREASEPENCIL",
468
336
  "ARMATURE",
469
337
  "LATTICE",
470
338
  "LIGHT",
@@ -482,36 +350,27 @@ def batch_rename(
482
350
  data_source: typing.Literal["SELECT", "ALL"] | None = "SELECT",
483
351
  actions: bpy.types.bpy_prop_collection[bl_operators.wm.BatchRenameAction]
484
352
  | None = None,
485
- ):
353
+ ) -> None:
486
354
  """Rename multiple items at once
487
355
 
488
- :type execution_context: int | str | None
489
- :type undo: bool | None
490
356
  :param data_type: Type, Type of data to rename
491
- :type data_type: typing.Literal['OBJECT','COLLECTION','MATERIAL','MESH','CURVE','META','VOLUME','GPENCIL','ARMATURE','LATTICE','LIGHT','LIGHT_PROBE','CAMERA','SPEAKER','BONE','NODE','SEQUENCE_STRIP','ACTION_CLIP','SCENE','BRUSH'] | None
492
357
  :param data_source: Source
493
- :type data_source: typing.Literal['SELECT','ALL'] | None
494
358
  :param actions: actions
495
- :type actions: bpy.types.bpy_prop_collection[bl_operators.wm.BatchRenameAction] | None
496
359
  """
497
360
 
498
361
  def blend_strings_utf8_validate(
499
- execution_context: int | str | None = None, undo: bool | None = None
500
- ):
501
- """Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)
502
-
503
- :type execution_context: int | str | None
504
- :type undo: bool | None
505
- """
362
+ execution_context: int | str | None = None,
363
+ undo: bool | None = None,
364
+ /,
365
+ ) -> None:
366
+ """Check and fix all strings in current .blend file to be valid UTF-8 Unicode (needed for some old, 2.4x area files)"""
506
367
 
507
368
  def blenderplayer_start(
508
- execution_context: int | str | None = None, undo: bool | None = None
509
- ):
510
- """Launch the blender-player with the current blend-file
511
-
512
- :type execution_context: int | str | None
513
- :type undo: bool | None
514
- """
369
+ execution_context: int | str | None = None,
370
+ undo: bool | None = None,
371
+ /,
372
+ ) -> None:
373
+ """Launch the blender-player with the current blend-file"""
515
374
 
516
375
  def call_asset_shelf_popover(
517
376
  execution_context: int | str | None = None,
@@ -519,13 +378,10 @@ def call_asset_shelf_popover(
519
378
  /,
520
379
  *,
521
380
  name: str = "",
522
- ):
381
+ ) -> None:
523
382
  """Open a predefined asset shelf in a popup
524
383
 
525
- :type execution_context: int | str | None
526
- :type undo: bool | None
527
384
  :param name: Asset Shelf Name, Identifier of the asset shelf to display
528
- :type name: str
529
385
  """
530
386
 
531
387
  def call_menu(
@@ -534,13 +390,10 @@ def call_menu(
534
390
  /,
535
391
  *,
536
392
  name: str = "",
537
- ):
393
+ ) -> None:
538
394
  """Open a predefined menu
539
395
 
540
- :type execution_context: int | str | None
541
- :type undo: bool | None
542
396
  :param name: Name, Name of the menu
543
- :type name: str
544
397
  """
545
398
 
546
399
  def call_menu_pie(
@@ -549,13 +402,10 @@ def call_menu_pie(
549
402
  /,
550
403
  *,
551
404
  name: str = "",
552
- ):
405
+ ) -> None:
553
406
  """Open a predefined pie menu
554
407
 
555
- :type execution_context: int | str | None
556
- :type undo: bool | None
557
408
  :param name: Name, Name of the pie menu
558
- :type name: str
559
409
  """
560
410
 
561
411
  def call_panel(
@@ -565,15 +415,11 @@ def call_panel(
565
415
  *,
566
416
  name: str = "",
567
417
  keep_open: bool | None = True,
568
- ):
418
+ ) -> None:
569
419
  """Open a predefined panel
570
420
 
571
- :type execution_context: int | str | None
572
- :type undo: bool | None
573
421
  :param name: Name, Name of the menu
574
- :type name: str
575
422
  :param keep_open: Keep Open
576
- :type keep_open: bool | None
577
423
  """
578
424
 
579
425
  def clear_recent_files(
@@ -582,23 +428,18 @@ def clear_recent_files(
582
428
  /,
583
429
  *,
584
430
  remove: typing.Literal["ALL", "MISSING"] | None = "ALL",
585
- ):
431
+ ) -> None:
586
432
  """Clear the recent files list
587
433
 
588
- :type execution_context: int | str | None
589
- :type undo: bool | None
590
434
  :param remove: Remove
591
- :type remove: typing.Literal['ALL','MISSING'] | None
592
435
  """
593
436
 
594
437
  def collection_export_all(
595
- execution_context: int | str | None = None, undo: bool | None = None
596
- ):
597
- """Invoke all configured exporters for all collections
598
-
599
- :type execution_context: int | str | None
600
- :type undo: bool | None
601
- """
438
+ execution_context: int | str | None = None,
439
+ undo: bool | None = None,
440
+ /,
441
+ ) -> None:
442
+ """Invoke all configured exporters for all collections"""
602
443
 
603
444
  def context_collection_boolean_set(
604
445
  execution_context: int | str | None = None,
@@ -608,17 +449,12 @@ def context_collection_boolean_set(
608
449
  data_path_iter: str = "",
609
450
  data_path_item: str = "",
610
451
  type: typing.Literal["TOGGLE", "ENABLE", "DISABLE"] | None = "TOGGLE",
611
- ):
452
+ ) -> None:
612
453
  """Set boolean values for a collection of items
613
454
 
614
- :type execution_context: int | str | None
615
- :type undo: bool | None
616
455
  :param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
617
- :type data_path_iter: str
618
456
  :param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
619
- :type data_path_item: str
620
457
  :param type: Type
621
- :type type: typing.Literal['TOGGLE','ENABLE','DISABLE'] | None
622
458
  """
623
459
 
624
460
  def context_cycle_array(
@@ -628,15 +464,11 @@ def context_cycle_array(
628
464
  *,
629
465
  data_path: str = "",
630
466
  reverse: bool | None = False,
631
- ):
467
+ ) -> None:
632
468
  """Set a context array value (useful for cycling the active mesh edit mode)
633
469
 
634
- :type execution_context: int | str | None
635
- :type undo: bool | None
636
470
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
637
- :type data_path: str
638
471
  :param reverse: Reverse, Cycle backwards
639
- :type reverse: bool | None
640
472
  """
641
473
 
642
474
  def context_cycle_enum(
@@ -647,17 +479,12 @@ def context_cycle_enum(
647
479
  data_path: str = "",
648
480
  reverse: bool | None = False,
649
481
  wrap: bool | None = False,
650
- ):
482
+ ) -> None:
651
483
  """Toggle a context value
652
484
 
653
- :type execution_context: int | str | None
654
- :type undo: bool | None
655
485
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
656
- :type data_path: str
657
486
  :param reverse: Reverse, Cycle backwards
658
- :type reverse: bool | None
659
487
  :param wrap: Wrap, Wrap back to the first/last values
660
- :type wrap: bool | None
661
488
  """
662
489
 
663
490
  def context_cycle_int(
@@ -668,17 +495,12 @@ def context_cycle_int(
668
495
  data_path: str = "",
669
496
  reverse: bool | None = False,
670
497
  wrap: bool | None = False,
671
- ):
498
+ ) -> None:
672
499
  """Set a context value (useful for cycling active material, shape keys, groups, etc.)
673
500
 
674
- :type execution_context: int | str | None
675
- :type undo: bool | None
676
501
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
677
- :type data_path: str
678
502
  :param reverse: Reverse, Cycle backwards
679
- :type reverse: bool | None
680
503
  :param wrap: Wrap, Wrap back to the first/last values
681
- :type wrap: bool | None
682
504
  """
683
505
 
684
506
  def context_menu_enum(
@@ -687,13 +509,10 @@ def context_menu_enum(
687
509
  /,
688
510
  *,
689
511
  data_path: str = "",
690
- ):
512
+ ) -> None:
691
513
  """Undocumented, consider contributing.
692
514
 
693
- :type execution_context: int | str | None
694
- :type undo: bool | None
695
515
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
696
- :type data_path: str
697
516
  """
698
517
 
699
518
  def context_modal_mouse(
@@ -707,23 +526,15 @@ def context_modal_mouse(
707
526
  input_scale: float | None = 0.01,
708
527
  invert: bool | None = False,
709
528
  initial_x: int | None = 0,
710
- ):
529
+ ) -> None:
711
530
  """Adjust arbitrary values with mouse input
712
531
 
713
- :type execution_context: int | str | None
714
- :type undo: bool | None
715
532
  :param data_path_iter: data_path_iter, The data path relative to the context, must point to an iterable
716
- :type data_path_iter: str
717
533
  :param data_path_item: data_path_item, The data path from each iterable to the value (int or float)
718
- :type data_path_item: str
719
534
  :param header_text: Header Text, Text to display in header during scale
720
- :type header_text: str
721
535
  :param input_scale: input_scale, Scale the mouse movement by this value before applying the delta
722
- :type input_scale: float | None
723
536
  :param invert: invert, Invert the mouse input
724
- :type invert: bool | None
725
537
  :param initial_x: initial_x
726
- :type initial_x: int | None
727
538
  """
728
539
 
729
540
  def context_pie_enum(
@@ -732,13 +543,10 @@ def context_pie_enum(
732
543
  /,
733
544
  *,
734
545
  data_path: str = "",
735
- ):
546
+ ) -> None:
736
547
  """Undocumented, consider contributing.
737
548
 
738
- :type execution_context: int | str | None
739
- :type undo: bool | None
740
549
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
741
- :type data_path: str
742
550
  """
743
551
 
744
552
  def context_scale_float(
@@ -748,15 +556,11 @@ def context_scale_float(
748
556
  *,
749
557
  data_path: str = "",
750
558
  value: float | None = 1.0,
751
- ):
559
+ ) -> None:
752
560
  """Scale a float context value
753
561
 
754
- :type execution_context: int | str | None
755
- :type undo: bool | None
756
562
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
757
- :type data_path: str
758
563
  :param value: Value, Assign value
759
- :type value: float | None
760
564
  """
761
565
 
762
566
  def context_scale_int(
@@ -767,17 +571,12 @@ def context_scale_int(
767
571
  data_path: str = "",
768
572
  value: float | None = 1.0,
769
573
  always_step: bool | None = True,
770
- ):
574
+ ) -> None:
771
575
  """Scale an int context value
772
576
 
773
- :type execution_context: int | str | None
774
- :type undo: bool | None
775
577
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
776
- :type data_path: str
777
578
  :param value: Value, Assign value
778
- :type value: float | None
779
- :param always_step: Always Step, Always adjust the value by a minimum of 1 when 'value' is not 1.0
780
- :type always_step: bool | None
579
+ :param always_step: Always Step, Always adjust the value by a minimum of 1 when value is not 1.0
781
580
  """
782
581
 
783
582
  def context_set_boolean(
@@ -787,15 +586,11 @@ def context_set_boolean(
787
586
  *,
788
587
  data_path: str = "",
789
588
  value: bool | None = True,
790
- ):
589
+ ) -> None:
791
590
  """Set a context value
792
591
 
793
- :type execution_context: int | str | None
794
- :type undo: bool | None
795
592
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
796
- :type data_path: str
797
593
  :param value: Value, Assignment value
798
- :type value: bool | None
799
594
  """
800
595
 
801
596
  def context_set_enum(
@@ -805,15 +600,11 @@ def context_set_enum(
805
600
  *,
806
601
  data_path: str = "",
807
602
  value: str = "",
808
- ):
603
+ ) -> None:
809
604
  """Set a context value
810
605
 
811
- :type execution_context: int | str | None
812
- :type undo: bool | None
813
606
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
814
- :type data_path: str
815
607
  :param value: Value, Assignment value (as a string)
816
- :type value: str
817
608
  """
818
609
 
819
610
  def context_set_float(
@@ -824,17 +615,12 @@ def context_set_float(
824
615
  data_path: str = "",
825
616
  value: float | None = 0.0,
826
617
  relative: bool | None = False,
827
- ):
618
+ ) -> None:
828
619
  """Set a context value
829
620
 
830
- :type execution_context: int | str | None
831
- :type undo: bool | None
832
621
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
833
- :type data_path: str
834
622
  :param value: Value, Assignment value
835
- :type value: float | None
836
623
  :param relative: Relative, Apply relative to the current value (delta)
837
- :type relative: bool | None
838
624
  """
839
625
 
840
626
  def context_set_id(
@@ -844,15 +630,11 @@ def context_set_id(
844
630
  *,
845
631
  data_path: str = "",
846
632
  value: str = "",
847
- ):
633
+ ) -> None:
848
634
  """Set a context value to an ID data-block
849
635
 
850
- :type execution_context: int | str | None
851
- :type undo: bool | None
852
636
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
853
- :type data_path: str
854
637
  :param value: Value, Assign value
855
- :type value: str
856
638
  """
857
639
 
858
640
  def context_set_int(
@@ -863,17 +645,12 @@ def context_set_int(
863
645
  data_path: str = "",
864
646
  value: int | None = 0,
865
647
  relative: bool | None = False,
866
- ):
648
+ ) -> None:
867
649
  """Set a context value
868
650
 
869
- :type execution_context: int | str | None
870
- :type undo: bool | None
871
651
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
872
- :type data_path: str
873
652
  :param value: Value, Assign value
874
- :type value: int | None
875
653
  :param relative: Relative, Apply relative to the current value (delta)
876
- :type relative: bool | None
877
654
  """
878
655
 
879
656
  def context_set_string(
@@ -883,15 +660,11 @@ def context_set_string(
883
660
  *,
884
661
  data_path: str = "",
885
662
  value: str = "",
886
- ):
663
+ ) -> None:
887
664
  """Set a context value
888
665
 
889
- :type execution_context: int | str | None
890
- :type undo: bool | None
891
666
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
892
- :type data_path: str
893
667
  :param value: Value, Assign value
894
- :type value: str
895
668
  """
896
669
 
897
670
  def context_set_value(
@@ -901,15 +674,11 @@ def context_set_value(
901
674
  *,
902
675
  data_path: str = "",
903
676
  value: str = "",
904
- ):
677
+ ) -> None:
905
678
  """Set a context value
906
679
 
907
- :type execution_context: int | str | None
908
- :type undo: bool | None
909
680
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
910
- :type data_path: str
911
681
  :param value: Value, Assignment value (as a string)
912
- :type value: str
913
682
  """
914
683
 
915
684
  def context_toggle(
@@ -919,15 +688,11 @@ def context_toggle(
919
688
  *,
920
689
  data_path: str = "",
921
690
  module: str = "",
922
- ):
691
+ ) -> None:
923
692
  """Toggle a context value
924
693
 
925
- :type execution_context: int | str | None
926
- :type undo: bool | None
927
694
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
928
- :type data_path: str
929
695
  :param module: Module, Optionally override the context with a module
930
- :type module: str
931
696
  """
932
697
 
933
698
  def context_toggle_enum(
@@ -938,17 +703,12 @@ def context_toggle_enum(
938
703
  data_path: str = "",
939
704
  value_1: str = "",
940
705
  value_2: str = "",
941
- ):
706
+ ) -> None:
942
707
  """Toggle a context value
943
708
 
944
- :type execution_context: int | str | None
945
- :type undo: bool | None
946
709
  :param data_path: Context Attributes, Context data-path (expanded using visible windows in the current .blend file)
947
- :type data_path: str
948
710
  :param value_1: Value, Toggle enum
949
- :type value_1: str
950
711
  :param value_2: Value, Toggle enum
951
- :type value_2: str
952
712
  """
953
713
 
954
714
  def debug_menu(
@@ -957,13 +717,10 @@ def debug_menu(
957
717
  /,
958
718
  *,
959
719
  debug_value: int | None = 0,
960
- ):
720
+ ) -> None:
961
721
  """Open a popup to set the debug level
962
722
 
963
- :type execution_context: int | str | None
964
- :type undo: bool | None
965
723
  :param debug_value: Debug Value
966
- :type debug_value: int | None
967
724
  """
968
725
 
969
726
  def doc_view(
@@ -972,13 +729,10 @@ def doc_view(
972
729
  /,
973
730
  *,
974
731
  doc_id: str = "",
975
- ):
732
+ ) -> None:
976
733
  """Open online reference docs in a web browser
977
734
 
978
- :type execution_context: int | str | None
979
- :type undo: bool | None
980
735
  :param doc_id: Doc ID
981
- :type doc_id: str
982
736
  """
983
737
 
984
738
  def doc_view_manual(
@@ -987,23 +741,18 @@ def doc_view_manual(
987
741
  /,
988
742
  *,
989
743
  doc_id: str = "",
990
- ):
744
+ ) -> None:
991
745
  """Load online manual
992
746
 
993
- :type execution_context: int | str | None
994
- :type undo: bool | None
995
747
  :param doc_id: Doc ID
996
- :type doc_id: str
997
748
  """
998
749
 
999
750
  def doc_view_manual_ui_context(
1000
- execution_context: int | str | None = None, undo: bool | None = None
1001
- ):
1002
- """View a context based online manual in a web browser
1003
-
1004
- :type execution_context: int | str | None
1005
- :type undo: bool | None
1006
- """
751
+ execution_context: int | str | None = None,
752
+ undo: bool | None = None,
753
+ /,
754
+ ) -> None:
755
+ """View a context based online manual in a web browser"""
1007
756
 
1008
757
  def drop_blend_file(
1009
758
  execution_context: int | str | None = None,
@@ -1011,13 +760,10 @@ def drop_blend_file(
1011
760
  /,
1012
761
  *,
1013
762
  filepath: str = "",
1014
- ):
763
+ ) -> None:
1015
764
  """Undocumented, consider contributing.
1016
765
 
1017
- :type execution_context: int | str | None
1018
- :type undo: bool | None
1019
766
  :param filepath: filepath
1020
- :type filepath: str
1021
767
  """
1022
768
 
1023
769
  def drop_import_file(
@@ -1028,15 +774,123 @@ def drop_import_file(
1028
774
  directory: str = "",
1029
775
  files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
1030
776
  | None = None,
1031
- ):
777
+ ) -> None:
1032
778
  """Operator that allows file handlers to receive file drops
1033
779
 
1034
- :type execution_context: int | str | None
1035
- :type undo: bool | None
1036
780
  :param directory: Directory, Directory of the file
1037
- :type directory: str
1038
781
  :param files: Files
1039
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
782
+ """
783
+
784
+ def fbx_import(
785
+ execution_context: int | str | None = None,
786
+ undo: bool | None = None,
787
+ /,
788
+ *,
789
+ filepath: str = "",
790
+ directory: str = "",
791
+ files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
792
+ | None = None,
793
+ check_existing: bool | None = False,
794
+ filter_blender: bool | None = False,
795
+ filter_backup: bool | None = False,
796
+ filter_image: bool | None = False,
797
+ filter_movie: bool | None = False,
798
+ filter_python: bool | None = False,
799
+ filter_font: bool | None = False,
800
+ filter_sound: bool | None = False,
801
+ filter_text: bool | None = False,
802
+ filter_archive: bool | None = False,
803
+ filter_btx: bool | None = False,
804
+ filter_alembic: bool | None = False,
805
+ filter_usd: bool | None = False,
806
+ filter_obj: bool | None = False,
807
+ filter_volume: bool | None = False,
808
+ filter_folder: bool | None = True,
809
+ filter_blenlib: bool | None = False,
810
+ filemode: int | None = 8,
811
+ display_type: typing.Literal[
812
+ "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
813
+ ]
814
+ | None = "DEFAULT",
815
+ sort_method: str | None = "",
816
+ global_scale: float | None = 1.0,
817
+ mtl_name_collision_mode: typing.Literal["MAKE_UNIQUE", "REFERENCE_EXISTING"]
818
+ | None = "MAKE_UNIQUE",
819
+ import_colors: typing.Literal["NONE", "SRGB", "LINEAR"] | None = "SRGB",
820
+ use_custom_normals: bool | None = True,
821
+ use_custom_props: bool | None = True,
822
+ use_custom_props_enum_as_string: bool | None = True,
823
+ import_subdivision: bool | None = False,
824
+ ignore_leaf_bones: bool | None = False,
825
+ validate_meshes: bool | None = True,
826
+ use_anim: bool | None = True,
827
+ anim_offset: float | None = 1.0,
828
+ filter_glob: str = "*.fbx",
829
+ ) -> None:
830
+ """Import FBX file into current scene
831
+
832
+ :param filepath: File Path, Path to file
833
+ :param directory: Directory, Directory of the file
834
+ :param files: Files
835
+ :param check_existing: Check Existing, Check and warn on overwriting existing files
836
+ :param filter_blender: Filter .blend files
837
+ :param filter_backup: Filter .blend files
838
+ :param filter_image: Filter image files
839
+ :param filter_movie: Filter movie files
840
+ :param filter_python: Filter Python files
841
+ :param filter_font: Filter font files
842
+ :param filter_sound: Filter sound files
843
+ :param filter_text: Filter text files
844
+ :param filter_archive: Filter archive files
845
+ :param filter_btx: Filter btx files
846
+ :param filter_alembic: Filter Alembic files
847
+ :param filter_usd: Filter USD files
848
+ :param filter_obj: Filter OBJ files
849
+ :param filter_volume: Filter OpenVDB volume files
850
+ :param filter_folder: Filter folders
851
+ :param filter_blenlib: Filter Blender IDs
852
+ :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
853
+ :param display_type: Display Type
854
+
855
+ DEFAULT
856
+ Default -- Automatically determine display type for files.
857
+
858
+ LIST_VERTICAL
859
+ Short List -- Display files as short list.
860
+
861
+ LIST_HORIZONTAL
862
+ Long List -- Display files as a detailed list.
863
+
864
+ THUMBNAIL
865
+ Thumbnails -- Display files as thumbnails.
866
+ :param sort_method: File sorting mode
867
+ :param global_scale: Scale
868
+ :param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
869
+
870
+ MAKE_UNIQUE
871
+ Make Unique -- Import each FBX material as a unique Blender material.
872
+
873
+ REFERENCE_EXISTING
874
+ Reference Existing -- If a material with the same name already exists, reference that instead of importing.
875
+ :param import_colors: Vertex Colors, Import vertex color attributes
876
+
877
+ NONE
878
+ None -- Do not import color attributes.
879
+
880
+ SRGB
881
+ sRGB -- Vertex colors in the file are in sRGB color space.
882
+
883
+ LINEAR
884
+ Linear -- Vertex colors in the file are in linear color space.
885
+ :param use_custom_normals: Custom Normals, Import custom normals, if available (otherwise Blender will compute them)
886
+ :param use_custom_props: Custom Properties, Import user properties as custom properties
887
+ :param use_custom_props_enum_as_string: Enums As Strings, Store custom property enumeration values as strings
888
+ :param import_subdivision: Subdivision Data, Import FBX subdivision information as subdivision surface modifiers
889
+ :param ignore_leaf_bones: Ignore Leaf Bones, Ignore the last bone at the end of each chain (used to mark the length of the previous bone)
890
+ :param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
891
+ :param use_anim: Import Animation, Import FBX animation
892
+ :param anim_offset: Offset, Offset to apply to animation timestamps, in frames
893
+ :param filter_glob: Extension Filter
1040
894
  """
1041
895
 
1042
896
  def grease_pencil_export_pdf(
@@ -1056,7 +910,6 @@ def grease_pencil_export_pdf(
1056
910
  filter_text: bool | None = False,
1057
911
  filter_archive: bool | None = False,
1058
912
  filter_btx: bool | None = False,
1059
- filter_collada: bool | None = False,
1060
913
  filter_alembic: bool | None = False,
1061
914
  filter_usd: bool | None = False,
1062
915
  filter_obj: bool | None = True,
@@ -1072,54 +925,31 @@ def grease_pencil_export_pdf(
1072
925
  use_fill: bool | None = True,
1073
926
  selected_object_type: typing.Literal["ACTIVE", "SELECTED", "VISIBLE"]
1074
927
  | None = "ACTIVE",
928
+ frame_mode: typing.Literal["ACTIVE", "SELECTED", "SCENE"] | None = "ACTIVE",
1075
929
  stroke_sample: float | None = 0.0,
1076
930
  use_uniform_width: bool | None = False,
1077
- frame_mode: typing.Literal["ACTIVE", "SELECTED", "SCENE"] | None = "ACTIVE",
1078
- ):
931
+ ) -> None:
1079
932
  """Export Grease Pencil to PDF
1080
933
 
1081
- :type execution_context: int | str | None
1082
- :type undo: bool | None
1083
934
  :param filepath: File Path, Path to file
1084
- :type filepath: str
1085
935
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1086
- :type check_existing: bool | None
1087
936
  :param filter_blender: Filter .blend files
1088
- :type filter_blender: bool | None
1089
937
  :param filter_backup: Filter .blend files
1090
- :type filter_backup: bool | None
1091
938
  :param filter_image: Filter image files
1092
- :type filter_image: bool | None
1093
939
  :param filter_movie: Filter movie files
1094
- :type filter_movie: bool | None
1095
940
  :param filter_python: Filter Python files
1096
- :type filter_python: bool | None
1097
941
  :param filter_font: Filter font files
1098
- :type filter_font: bool | None
1099
942
  :param filter_sound: Filter sound files
1100
- :type filter_sound: bool | None
1101
943
  :param filter_text: Filter text files
1102
- :type filter_text: bool | None
1103
944
  :param filter_archive: Filter archive files
1104
- :type filter_archive: bool | None
1105
945
  :param filter_btx: Filter btx files
1106
- :type filter_btx: bool | None
1107
- :param filter_collada: Filter COLLADA files
1108
- :type filter_collada: bool | None
1109
946
  :param filter_alembic: Filter Alembic files
1110
- :type filter_alembic: bool | None
1111
947
  :param filter_usd: Filter USD files
1112
- :type filter_usd: bool | None
1113
948
  :param filter_obj: Filter OBJ files
1114
- :type filter_obj: bool | None
1115
949
  :param filter_volume: Filter OpenVDB volume files
1116
- :type filter_volume: bool | None
1117
950
  :param filter_folder: Filter folders
1118
- :type filter_folder: bool | None
1119
951
  :param filter_blenlib: Filter Blender IDs
1120
- :type filter_blenlib: bool | None
1121
952
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1122
- :type filemode: int | None
1123
953
  :param display_type: Display Type
1124
954
 
1125
955
  DEFAULT
@@ -1133,11 +963,8 @@ def grease_pencil_export_pdf(
1133
963
 
1134
964
  THUMBNAIL
1135
965
  Thumbnails -- Display files as thumbnails.
1136
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1137
966
  :param sort_method: File sorting mode
1138
- :type sort_method: str | None
1139
967
  :param use_fill: Fill, Export strokes with fill enabled
1140
- :type use_fill: bool | None
1141
968
  :param selected_object_type: Object, Which objects to include in the export
1142
969
 
1143
970
  ACTIVE
@@ -1148,11 +975,6 @@ def grease_pencil_export_pdf(
1148
975
 
1149
976
  VISIBLE
1150
977
  Visible -- Include all visible objects.
1151
- :type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
1152
- :param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
1153
- :type stroke_sample: float | None
1154
- :param use_uniform_width: Uniform Width, Export strokes with uniform width
1155
- :type use_uniform_width: bool | None
1156
978
  :param frame_mode: Frames, Which frames to include in the export
1157
979
 
1158
980
  ACTIVE
@@ -1163,7 +985,8 @@ def grease_pencil_export_pdf(
1163
985
 
1164
986
  SCENE
1165
987
  Scene -- Include all scene frames.
1166
- :type frame_mode: typing.Literal['ACTIVE','SELECTED','SCENE'] | None
988
+ :param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
989
+ :param use_uniform_width: Uniform Width, Export strokes with uniform width
1167
990
  """
1168
991
 
1169
992
  def grease_pencil_export_svg(
@@ -1183,7 +1006,6 @@ def grease_pencil_export_svg(
1183
1006
  filter_text: bool | None = False,
1184
1007
  filter_archive: bool | None = False,
1185
1008
  filter_btx: bool | None = False,
1186
- filter_collada: bool | None = False,
1187
1009
  filter_alembic: bool | None = False,
1188
1010
  filter_usd: bool | None = False,
1189
1011
  filter_obj: bool | None = True,
@@ -1199,54 +1021,32 @@ def grease_pencil_export_svg(
1199
1021
  use_fill: bool | None = True,
1200
1022
  selected_object_type: typing.Literal["ACTIVE", "SELECTED", "VISIBLE"]
1201
1023
  | None = "ACTIVE",
1024
+ frame_mode: typing.Literal["ACTIVE", "SELECTED", "SCENE"] | None = "ACTIVE",
1202
1025
  stroke_sample: float | None = 0.0,
1203
1026
  use_uniform_width: bool | None = False,
1204
1027
  use_clip_camera: bool | None = False,
1205
- ):
1028
+ ) -> None:
1206
1029
  """Export Grease Pencil to SVG
1207
1030
 
1208
- :type execution_context: int | str | None
1209
- :type undo: bool | None
1210
1031
  :param filepath: File Path, Path to file
1211
- :type filepath: str
1212
1032
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1213
- :type check_existing: bool | None
1214
1033
  :param filter_blender: Filter .blend files
1215
- :type filter_blender: bool | None
1216
1034
  :param filter_backup: Filter .blend files
1217
- :type filter_backup: bool | None
1218
1035
  :param filter_image: Filter image files
1219
- :type filter_image: bool | None
1220
1036
  :param filter_movie: Filter movie files
1221
- :type filter_movie: bool | None
1222
1037
  :param filter_python: Filter Python files
1223
- :type filter_python: bool | None
1224
1038
  :param filter_font: Filter font files
1225
- :type filter_font: bool | None
1226
1039
  :param filter_sound: Filter sound files
1227
- :type filter_sound: bool | None
1228
1040
  :param filter_text: Filter text files
1229
- :type filter_text: bool | None
1230
1041
  :param filter_archive: Filter archive files
1231
- :type filter_archive: bool | None
1232
1042
  :param filter_btx: Filter btx files
1233
- :type filter_btx: bool | None
1234
- :param filter_collada: Filter COLLADA files
1235
- :type filter_collada: bool | None
1236
1043
  :param filter_alembic: Filter Alembic files
1237
- :type filter_alembic: bool | None
1238
1044
  :param filter_usd: Filter USD files
1239
- :type filter_usd: bool | None
1240
1045
  :param filter_obj: Filter OBJ files
1241
- :type filter_obj: bool | None
1242
1046
  :param filter_volume: Filter OpenVDB volume files
1243
- :type filter_volume: bool | None
1244
1047
  :param filter_folder: Filter folders
1245
- :type filter_folder: bool | None
1246
1048
  :param filter_blenlib: Filter Blender IDs
1247
- :type filter_blenlib: bool | None
1248
1049
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1249
- :type filemode: int | None
1250
1050
  :param display_type: Display Type
1251
1051
 
1252
1052
  DEFAULT
@@ -1260,11 +1060,8 @@ def grease_pencil_export_svg(
1260
1060
 
1261
1061
  THUMBNAIL
1262
1062
  Thumbnails -- Display files as thumbnails.
1263
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1264
1063
  :param sort_method: File sorting mode
1265
- :type sort_method: str | None
1266
1064
  :param use_fill: Fill, Export strokes with fill enabled
1267
- :type use_fill: bool | None
1268
1065
  :param selected_object_type: Object, Which objects to include in the export
1269
1066
 
1270
1067
  ACTIVE
@@ -1275,13 +1072,19 @@ def grease_pencil_export_svg(
1275
1072
 
1276
1073
  VISIBLE
1277
1074
  Visible -- Include all visible objects.
1278
- :type selected_object_type: typing.Literal['ACTIVE','SELECTED','VISIBLE'] | None
1075
+ :param frame_mode: Frames, Which frames to include in the export
1076
+
1077
+ ACTIVE
1078
+ Active -- Include only active frame.
1079
+
1080
+ SELECTED
1081
+ Selected -- Include selected frames.
1082
+
1083
+ SCENE
1084
+ Scene -- Include all scene frames.
1279
1085
  :param stroke_sample: Sampling, Precision of stroke sampling. Low values mean a more precise result, and zero disables sampling
1280
- :type stroke_sample: float | None
1281
1086
  :param use_uniform_width: Uniform Width, Export strokes with uniform width
1282
- :type use_uniform_width: bool | None
1283
1087
  :param use_clip_camera: Clip Camera, Clip drawings to camera size when exporting in camera view
1284
- :type use_clip_camera: bool | None
1285
1088
  """
1286
1089
 
1287
1090
  def grease_pencil_import_svg(
@@ -1304,7 +1107,6 @@ def grease_pencil_import_svg(
1304
1107
  filter_text: bool | None = False,
1305
1108
  filter_archive: bool | None = False,
1306
1109
  filter_btx: bool | None = False,
1307
- filter_collada: bool | None = False,
1308
1110
  filter_alembic: bool | None = False,
1309
1111
  filter_usd: bool | None = False,
1310
1112
  filter_obj: bool | None = True,
@@ -1321,57 +1123,31 @@ def grease_pencil_import_svg(
1321
1123
  resolution: int | None = 10,
1322
1124
  scale: float | None = 10.0,
1323
1125
  use_scene_unit: bool | None = False,
1324
- ):
1126
+ ) -> None:
1325
1127
  """Import SVG into Grease Pencil
1326
1128
 
1327
- :type execution_context: int | str | None
1328
- :type undo: bool | None
1329
1129
  :param filepath: File Path, Path to file
1330
- :type filepath: str
1331
1130
  :param directory: Directory, Directory of the file
1332
- :type directory: str
1333
1131
  :param files: Files
1334
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
1335
1132
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1336
- :type check_existing: bool | None
1337
1133
  :param filter_blender: Filter .blend files
1338
- :type filter_blender: bool | None
1339
1134
  :param filter_backup: Filter .blend files
1340
- :type filter_backup: bool | None
1341
1135
  :param filter_image: Filter image files
1342
- :type filter_image: bool | None
1343
1136
  :param filter_movie: Filter movie files
1344
- :type filter_movie: bool | None
1345
1137
  :param filter_python: Filter Python files
1346
- :type filter_python: bool | None
1347
1138
  :param filter_font: Filter font files
1348
- :type filter_font: bool | None
1349
1139
  :param filter_sound: Filter sound files
1350
- :type filter_sound: bool | None
1351
1140
  :param filter_text: Filter text files
1352
- :type filter_text: bool | None
1353
1141
  :param filter_archive: Filter archive files
1354
- :type filter_archive: bool | None
1355
1142
  :param filter_btx: Filter btx files
1356
- :type filter_btx: bool | None
1357
- :param filter_collada: Filter COLLADA files
1358
- :type filter_collada: bool | None
1359
1143
  :param filter_alembic: Filter Alembic files
1360
- :type filter_alembic: bool | None
1361
1144
  :param filter_usd: Filter USD files
1362
- :type filter_usd: bool | None
1363
1145
  :param filter_obj: Filter OBJ files
1364
- :type filter_obj: bool | None
1365
1146
  :param filter_volume: Filter OpenVDB volume files
1366
- :type filter_volume: bool | None
1367
1147
  :param filter_folder: Filter folders
1368
- :type filter_folder: bool | None
1369
1148
  :param filter_blenlib: Filter Blender IDs
1370
- :type filter_blenlib: bool | None
1371
1149
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1372
- :type filemode: int | None
1373
1150
  :param relative_path: Relative Path, Select the file relative to the blend file
1374
- :type relative_path: bool | None
1375
1151
  :param display_type: Display Type
1376
1152
 
1377
1153
  DEFAULT
@@ -1385,15 +1161,99 @@ def grease_pencil_import_svg(
1385
1161
 
1386
1162
  THUMBNAIL
1387
1163
  Thumbnails -- Display files as thumbnails.
1388
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1389
1164
  :param sort_method: File sorting mode
1390
- :type sort_method: str | None
1391
1165
  :param resolution: Resolution, Resolution of the generated strokes
1392
- :type resolution: int | None
1393
1166
  :param scale: Scale, Scale of the final strokes
1394
- :type scale: float | None
1395
- :param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
1396
- :type use_scene_unit: bool | None
1167
+ :param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
1168
+ """
1169
+
1170
+ def id_linked_relocate(
1171
+ execution_context: int | str | None = None,
1172
+ undo: bool | None = None,
1173
+ /,
1174
+ *,
1175
+ id_session_uid: int | None = 0,
1176
+ filepath: str = "",
1177
+ directory: str = "",
1178
+ filename: str = "",
1179
+ check_existing: bool | None = False,
1180
+ filter_blender: bool | None = True,
1181
+ filter_backup: bool | None = False,
1182
+ filter_image: bool | None = False,
1183
+ filter_movie: bool | None = False,
1184
+ filter_python: bool | None = False,
1185
+ filter_font: bool | None = False,
1186
+ filter_sound: bool | None = False,
1187
+ filter_text: bool | None = False,
1188
+ filter_archive: bool | None = False,
1189
+ filter_btx: bool | None = False,
1190
+ filter_alembic: bool | None = False,
1191
+ filter_usd: bool | None = False,
1192
+ filter_obj: bool | None = False,
1193
+ filter_volume: bool | None = False,
1194
+ filter_folder: bool | None = True,
1195
+ filter_blenlib: bool | None = True,
1196
+ filemode: int | None = 1,
1197
+ relative_path: bool | None = True,
1198
+ display_type: typing.Literal[
1199
+ "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
1200
+ ]
1201
+ | None = "DEFAULT",
1202
+ sort_method: str | None = "",
1203
+ link: bool | None = True,
1204
+ do_reuse_local_id: bool | None = False,
1205
+ clear_asset_data: bool | None = False,
1206
+ autoselect: bool | None = True,
1207
+ active_collection: bool | None = False,
1208
+ instance_collections: bool | None = False,
1209
+ instance_object_data: bool | None = False,
1210
+ ) -> None:
1211
+ """Relocate a linked ID, i.e. select another ID to link, and remap its local usages to that newly linked data-block). Currently only designed as an internal operator, not directly exposed to the user
1212
+
1213
+ :param id_session_uid: Linked ID Session UID, Unique runtime identifier for the linked ID to relocate
1214
+ :param filepath: File Path, Path to file
1215
+ :param directory: Directory, Directory of the file
1216
+ :param filename: File Name, Name of the file
1217
+ :param check_existing: Check Existing, Check and warn on overwriting existing files
1218
+ :param filter_blender: Filter .blend files
1219
+ :param filter_backup: Filter .blend files
1220
+ :param filter_image: Filter image files
1221
+ :param filter_movie: Filter movie files
1222
+ :param filter_python: Filter Python files
1223
+ :param filter_font: Filter font files
1224
+ :param filter_sound: Filter sound files
1225
+ :param filter_text: Filter text files
1226
+ :param filter_archive: Filter archive files
1227
+ :param filter_btx: Filter btx files
1228
+ :param filter_alembic: Filter Alembic files
1229
+ :param filter_usd: Filter USD files
1230
+ :param filter_obj: Filter OBJ files
1231
+ :param filter_volume: Filter OpenVDB volume files
1232
+ :param filter_folder: Filter folders
1233
+ :param filter_blenlib: Filter Blender IDs
1234
+ :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1235
+ :param relative_path: Relative Path, Select the file relative to the blend file
1236
+ :param display_type: Display Type
1237
+
1238
+ DEFAULT
1239
+ Default -- Automatically determine display type for files.
1240
+
1241
+ LIST_VERTICAL
1242
+ Short List -- Display files as short list.
1243
+
1244
+ LIST_HORIZONTAL
1245
+ Long List -- Display files as a detailed list.
1246
+
1247
+ THUMBNAIL
1248
+ Thumbnails -- Display files as thumbnails.
1249
+ :param sort_method: File sorting mode
1250
+ :param link: Link, Link the objects or data-blocks rather than appending
1251
+ :param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
1252
+ :param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
1253
+ :param autoselect: Select, Select new objects
1254
+ :param active_collection: Active Collection, Put new objects on the active collection
1255
+ :param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
1256
+ :param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
1397
1257
  """
1398
1258
 
1399
1259
  def interface_theme_preset_add(
@@ -1404,17 +1264,12 @@ def interface_theme_preset_add(
1404
1264
  name: str = "",
1405
1265
  remove_name: bool | None = False,
1406
1266
  remove_active: bool | None = False,
1407
- ):
1267
+ ) -> None:
1408
1268
  """Add a custom theme to the preset list
1409
1269
 
1410
- :type execution_context: int | str | None
1411
- :type undo: bool | None
1412
1270
  :param name: Name, Name of the preset, used to make the path name
1413
- :type name: str
1414
1271
  :param remove_name: remove_name
1415
- :type remove_name: bool | None
1416
1272
  :param remove_active: remove_active
1417
- :type remove_active: bool | None
1418
1273
  """
1419
1274
 
1420
1275
  def interface_theme_preset_remove(
@@ -1425,17 +1280,12 @@ def interface_theme_preset_remove(
1425
1280
  name: str = "",
1426
1281
  remove_name: bool | None = False,
1427
1282
  remove_active: bool | None = True,
1428
- ):
1283
+ ) -> None:
1429
1284
  """Remove a custom theme from the preset list
1430
1285
 
1431
- :type execution_context: int | str | None
1432
- :type undo: bool | None
1433
1286
  :param name: Name, Name of the preset, used to make the path name
1434
- :type name: str
1435
1287
  :param remove_name: remove_name
1436
- :type remove_name: bool | None
1437
1288
  :param remove_active: remove_active
1438
- :type remove_active: bool | None
1439
1289
  """
1440
1290
 
1441
1291
  def interface_theme_preset_save(
@@ -1446,17 +1296,12 @@ def interface_theme_preset_save(
1446
1296
  name: str = "",
1447
1297
  remove_name: bool | None = False,
1448
1298
  remove_active: bool | None = True,
1449
- ):
1299
+ ) -> None:
1450
1300
  """Save a custom theme in the preset list
1451
1301
 
1452
- :type execution_context: int | str | None
1453
- :type undo: bool | None
1454
1302
  :param name: Name, Name of the preset, used to make the path name
1455
- :type name: str
1456
1303
  :param remove_name: remove_name
1457
- :type remove_name: bool | None
1458
1304
  :param remove_active: remove_active
1459
- :type remove_active: bool | None
1460
1305
  """
1461
1306
 
1462
1307
  def keyconfig_preset_add(
@@ -1467,17 +1312,12 @@ def keyconfig_preset_add(
1467
1312
  name: str = "",
1468
1313
  remove_name: bool | None = False,
1469
1314
  remove_active: bool | None = False,
1470
- ):
1315
+ ) -> None:
1471
1316
  """Add a custom keymap configuration to the preset list
1472
1317
 
1473
- :type execution_context: int | str | None
1474
- :type undo: bool | None
1475
1318
  :param name: Name, Name of the preset, used to make the path name
1476
- :type name: str
1477
1319
  :param remove_name: remove_name
1478
- :type remove_name: bool | None
1479
1320
  :param remove_active: remove_active
1480
- :type remove_active: bool | None
1481
1321
  """
1482
1322
 
1483
1323
  def keyconfig_preset_remove(
@@ -1488,17 +1328,12 @@ def keyconfig_preset_remove(
1488
1328
  name: str = "",
1489
1329
  remove_name: bool | None = False,
1490
1330
  remove_active: bool | None = True,
1491
- ):
1331
+ ) -> None:
1492
1332
  """Remove a custom keymap configuration from the preset list
1493
1333
 
1494
- :type execution_context: int | str | None
1495
- :type undo: bool | None
1496
1334
  :param name: Name, Name of the preset, used to make the path name
1497
- :type name: str
1498
1335
  :param remove_name: remove_name
1499
- :type remove_name: bool | None
1500
1336
  :param remove_active: remove_active
1501
- :type remove_active: bool | None
1502
1337
  """
1503
1338
 
1504
1339
  def lib_reload(
@@ -1522,7 +1357,6 @@ def lib_reload(
1522
1357
  filter_text: bool | None = False,
1523
1358
  filter_archive: bool | None = False,
1524
1359
  filter_btx: bool | None = False,
1525
- filter_collada: bool | None = False,
1526
1360
  filter_alembic: bool | None = False,
1527
1361
  filter_usd: bool | None = False,
1528
1362
  filter_obj: bool | None = False,
@@ -1536,61 +1370,33 @@ def lib_reload(
1536
1370
  ]
1537
1371
  | None = "DEFAULT",
1538
1372
  sort_method: str | None = "",
1539
- ):
1373
+ ) -> None:
1540
1374
  """Reload the given library
1541
1375
 
1542
- :type execution_context: int | str | None
1543
- :type undo: bool | None
1544
1376
  :param library: Library, Library to reload
1545
- :type library: str
1546
1377
  :param filepath: File Path, Path to file
1547
- :type filepath: str
1548
1378
  :param directory: Directory, Directory of the file
1549
- :type directory: str
1550
1379
  :param filename: File Name, Name of the file
1551
- :type filename: str
1552
1380
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
1553
- :type hide_props_region: bool | None
1554
1381
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1555
- :type check_existing: bool | None
1556
1382
  :param filter_blender: Filter .blend files
1557
- :type filter_blender: bool | None
1558
1383
  :param filter_backup: Filter .blend files
1559
- :type filter_backup: bool | None
1560
1384
  :param filter_image: Filter image files
1561
- :type filter_image: bool | None
1562
1385
  :param filter_movie: Filter movie files
1563
- :type filter_movie: bool | None
1564
1386
  :param filter_python: Filter Python files
1565
- :type filter_python: bool | None
1566
1387
  :param filter_font: Filter font files
1567
- :type filter_font: bool | None
1568
1388
  :param filter_sound: Filter sound files
1569
- :type filter_sound: bool | None
1570
1389
  :param filter_text: Filter text files
1571
- :type filter_text: bool | None
1572
1390
  :param filter_archive: Filter archive files
1573
- :type filter_archive: bool | None
1574
1391
  :param filter_btx: Filter btx files
1575
- :type filter_btx: bool | None
1576
- :param filter_collada: Filter COLLADA files
1577
- :type filter_collada: bool | None
1578
1392
  :param filter_alembic: Filter Alembic files
1579
- :type filter_alembic: bool | None
1580
1393
  :param filter_usd: Filter USD files
1581
- :type filter_usd: bool | None
1582
1394
  :param filter_obj: Filter OBJ files
1583
- :type filter_obj: bool | None
1584
1395
  :param filter_volume: Filter OpenVDB volume files
1585
- :type filter_volume: bool | None
1586
1396
  :param filter_folder: Filter folders
1587
- :type filter_folder: bool | None
1588
1397
  :param filter_blenlib: Filter Blender IDs
1589
- :type filter_blenlib: bool | None
1590
1398
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1591
- :type filemode: int | None
1592
1399
  :param relative_path: Relative Path, Select the file relative to the blend file
1593
- :type relative_path: bool | None
1594
1400
  :param display_type: Display Type
1595
1401
 
1596
1402
  DEFAULT
@@ -1604,9 +1410,7 @@ def lib_reload(
1604
1410
 
1605
1411
  THUMBNAIL
1606
1412
  Thumbnails -- Display files as thumbnails.
1607
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1608
1413
  :param sort_method: File sorting mode
1609
- :type sort_method: str | None
1610
1414
  """
1611
1415
 
1612
1416
  def lib_relocate(
@@ -1632,7 +1436,6 @@ def lib_relocate(
1632
1436
  filter_text: bool | None = False,
1633
1437
  filter_archive: bool | None = False,
1634
1438
  filter_btx: bool | None = False,
1635
- filter_collada: bool | None = False,
1636
1439
  filter_alembic: bool | None = False,
1637
1440
  filter_usd: bool | None = False,
1638
1441
  filter_obj: bool | None = False,
@@ -1646,63 +1449,34 @@ def lib_relocate(
1646
1449
  ]
1647
1450
  | None = "DEFAULT",
1648
1451
  sort_method: str | None = "",
1649
- ):
1452
+ ) -> None:
1650
1453
  """Relocate the given library to one or several others
1651
1454
 
1652
- :type execution_context: int | str | None
1653
- :type undo: bool | None
1654
1455
  :param library: Library, Library to relocate
1655
- :type library: str
1656
1456
  :param filepath: File Path, Path to file
1657
- :type filepath: str
1658
1457
  :param directory: Directory, Directory of the file
1659
- :type directory: str
1660
1458
  :param filename: File Name, Name of the file
1661
- :type filename: str
1662
1459
  :param files: Files
1663
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
1664
1460
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
1665
- :type hide_props_region: bool | None
1666
1461
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1667
- :type check_existing: bool | None
1668
1462
  :param filter_blender: Filter .blend files
1669
- :type filter_blender: bool | None
1670
1463
  :param filter_backup: Filter .blend files
1671
- :type filter_backup: bool | None
1672
1464
  :param filter_image: Filter image files
1673
- :type filter_image: bool | None
1674
1465
  :param filter_movie: Filter movie files
1675
- :type filter_movie: bool | None
1676
1466
  :param filter_python: Filter Python files
1677
- :type filter_python: bool | None
1678
1467
  :param filter_font: Filter font files
1679
- :type filter_font: bool | None
1680
1468
  :param filter_sound: Filter sound files
1681
- :type filter_sound: bool | None
1682
1469
  :param filter_text: Filter text files
1683
- :type filter_text: bool | None
1684
1470
  :param filter_archive: Filter archive files
1685
- :type filter_archive: bool | None
1686
1471
  :param filter_btx: Filter btx files
1687
- :type filter_btx: bool | None
1688
- :param filter_collada: Filter COLLADA files
1689
- :type filter_collada: bool | None
1690
1472
  :param filter_alembic: Filter Alembic files
1691
- :type filter_alembic: bool | None
1692
1473
  :param filter_usd: Filter USD files
1693
- :type filter_usd: bool | None
1694
1474
  :param filter_obj: Filter OBJ files
1695
- :type filter_obj: bool | None
1696
1475
  :param filter_volume: Filter OpenVDB volume files
1697
- :type filter_volume: bool | None
1698
1476
  :param filter_folder: Filter folders
1699
- :type filter_folder: bool | None
1700
1477
  :param filter_blenlib: Filter Blender IDs
1701
- :type filter_blenlib: bool | None
1702
1478
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1703
- :type filemode: int | None
1704
1479
  :param relative_path: Relative Path, Select the file relative to the blend file
1705
- :type relative_path: bool | None
1706
1480
  :param display_type: Display Type
1707
1481
 
1708
1482
  DEFAULT
@@ -1716,9 +1490,7 @@ def lib_relocate(
1716
1490
 
1717
1491
  THUMBNAIL
1718
1492
  Thumbnails -- Display files as thumbnails.
1719
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1720
1493
  :param sort_method: File sorting mode
1721
- :type sort_method: str | None
1722
1494
  """
1723
1495
 
1724
1496
  def link(
@@ -1742,7 +1514,6 @@ def link(
1742
1514
  filter_text: bool | None = False,
1743
1515
  filter_archive: bool | None = False,
1744
1516
  filter_btx: bool | None = False,
1745
- filter_collada: bool | None = False,
1746
1517
  filter_alembic: bool | None = False,
1747
1518
  filter_usd: bool | None = False,
1748
1519
  filter_obj: bool | None = False,
@@ -1763,59 +1534,32 @@ def link(
1763
1534
  active_collection: bool | None = True,
1764
1535
  instance_collections: bool | None = True,
1765
1536
  instance_object_data: bool | None = True,
1766
- ):
1537
+ ) -> None:
1767
1538
  """Link from a Library .blend file
1768
1539
 
1769
- :type execution_context: int | str | None
1770
- :type undo: bool | None
1771
1540
  :param filepath: File Path, Path to file
1772
- :type filepath: str
1773
1541
  :param directory: Directory, Directory of the file
1774
- :type directory: str
1775
1542
  :param filename: File Name, Name of the file
1776
- :type filename: str
1777
1543
  :param files: Files
1778
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
1779
1544
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1780
- :type check_existing: bool | None
1781
1545
  :param filter_blender: Filter .blend files
1782
- :type filter_blender: bool | None
1783
1546
  :param filter_backup: Filter .blend files
1784
- :type filter_backup: bool | None
1785
1547
  :param filter_image: Filter image files
1786
- :type filter_image: bool | None
1787
1548
  :param filter_movie: Filter movie files
1788
- :type filter_movie: bool | None
1789
1549
  :param filter_python: Filter Python files
1790
- :type filter_python: bool | None
1791
1550
  :param filter_font: Filter font files
1792
- :type filter_font: bool | None
1793
1551
  :param filter_sound: Filter sound files
1794
- :type filter_sound: bool | None
1795
1552
  :param filter_text: Filter text files
1796
- :type filter_text: bool | None
1797
1553
  :param filter_archive: Filter archive files
1798
- :type filter_archive: bool | None
1799
1554
  :param filter_btx: Filter btx files
1800
- :type filter_btx: bool | None
1801
- :param filter_collada: Filter COLLADA files
1802
- :type filter_collada: bool | None
1803
1555
  :param filter_alembic: Filter Alembic files
1804
- :type filter_alembic: bool | None
1805
1556
  :param filter_usd: Filter USD files
1806
- :type filter_usd: bool | None
1807
1557
  :param filter_obj: Filter OBJ files
1808
- :type filter_obj: bool | None
1809
1558
  :param filter_volume: Filter OpenVDB volume files
1810
- :type filter_volume: bool | None
1811
1559
  :param filter_folder: Filter folders
1812
- :type filter_folder: bool | None
1813
1560
  :param filter_blenlib: Filter Blender IDs
1814
- :type filter_blenlib: bool | None
1815
1561
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1816
- :type filemode: int | None
1817
1562
  :param relative_path: Relative Path, Select the file relative to the blend file
1818
- :type relative_path: bool | None
1819
1563
  :param display_type: Display Type
1820
1564
 
1821
1565
  DEFAULT
@@ -1829,33 +1573,22 @@ def link(
1829
1573
 
1830
1574
  THUMBNAIL
1831
1575
  Thumbnails -- Display files as thumbnails.
1832
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1833
1576
  :param sort_method: File sorting mode
1834
- :type sort_method: str | None
1835
1577
  :param link: Link, Link the objects or data-blocks rather than appending
1836
- :type link: bool | None
1837
1578
  :param do_reuse_local_id: Re-Use Local Data, Try to re-use previously matching appended data-blocks instead of appending a new copy
1838
- :type do_reuse_local_id: bool | None
1839
- :param clear_asset_data: Clear Asset Data, Don't add asset meta-data or tags from the original data-block
1840
- :type clear_asset_data: bool | None
1579
+ :param clear_asset_data: Clear Asset Data, Dont add asset meta-data or tags from the original data-block
1841
1580
  :param autoselect: Select, Select new objects
1842
- :type autoselect: bool | None
1843
1581
  :param active_collection: Active Collection, Put new objects on the active collection
1844
- :type active_collection: bool | None
1845
1582
  :param instance_collections: Instance Collections, Create instances for collections, rather than adding them directly to the scene
1846
- :type instance_collections: bool | None
1847
1583
  :param instance_object_data: Instance Object Data, Create instances for object data which are not referenced by any objects
1848
- :type instance_object_data: bool | None
1849
1584
  """
1850
1585
 
1851
1586
  def memory_statistics(
1852
- execution_context: int | str | None = None, undo: bool | None = None
1853
- ):
1854
- """Print memory statistics to the console
1855
-
1856
- :type execution_context: int | str | None
1857
- :type undo: bool | None
1858
- """
1587
+ execution_context: int | str | None = None,
1588
+ undo: bool | None = None,
1589
+ /,
1590
+ ) -> None:
1591
+ """Print memory statistics to the console"""
1859
1592
 
1860
1593
  def obj_export(
1861
1594
  execution_context: int | str | None = None,
@@ -1874,7 +1607,6 @@ def obj_export(
1874
1607
  filter_text: bool | None = False,
1875
1608
  filter_archive: bool | None = False,
1876
1609
  filter_btx: bool | None = False,
1877
- filter_collada: bool | None = False,
1878
1610
  filter_alembic: bool | None = False,
1879
1611
  filter_usd: bool | None = False,
1880
1612
  filter_obj: bool | None = False,
@@ -1898,6 +1630,7 @@ def obj_export(
1898
1630
  | None = "Y",
1899
1631
  global_scale: float | None = 1.0,
1900
1632
  apply_modifiers: bool | None = True,
1633
+ apply_transform: bool | None = True,
1901
1634
  export_eval_mode: typing.Literal["DAG_EVAL_RENDER", "DAG_EVAL_VIEWPORT"]
1902
1635
  | None = "DAG_EVAL_VIEWPORT",
1903
1636
  export_selected_objects: bool | None = False,
@@ -1917,51 +1650,28 @@ def obj_export(
1917
1650
  smooth_group_bitflags: bool | None = False,
1918
1651
  filter_glob: str = "*.obj;*.mtl",
1919
1652
  collection: str = "",
1920
- ):
1653
+ ) -> None:
1921
1654
  """Save the scene to a Wavefront OBJ file
1922
1655
 
1923
- :type execution_context: int | str | None
1924
- :type undo: bool | None
1925
1656
  :param filepath: File Path, Path to file
1926
- :type filepath: str
1927
1657
  :param check_existing: Check Existing, Check and warn on overwriting existing files
1928
- :type check_existing: bool | None
1929
1658
  :param filter_blender: Filter .blend files
1930
- :type filter_blender: bool | None
1931
1659
  :param filter_backup: Filter .blend files
1932
- :type filter_backup: bool | None
1933
1660
  :param filter_image: Filter image files
1934
- :type filter_image: bool | None
1935
1661
  :param filter_movie: Filter movie files
1936
- :type filter_movie: bool | None
1937
1662
  :param filter_python: Filter Python files
1938
- :type filter_python: bool | None
1939
1663
  :param filter_font: Filter font files
1940
- :type filter_font: bool | None
1941
1664
  :param filter_sound: Filter sound files
1942
- :type filter_sound: bool | None
1943
1665
  :param filter_text: Filter text files
1944
- :type filter_text: bool | None
1945
1666
  :param filter_archive: Filter archive files
1946
- :type filter_archive: bool | None
1947
1667
  :param filter_btx: Filter btx files
1948
- :type filter_btx: bool | None
1949
- :param filter_collada: Filter COLLADA files
1950
- :type filter_collada: bool | None
1951
1668
  :param filter_alembic: Filter Alembic files
1952
- :type filter_alembic: bool | None
1953
1669
  :param filter_usd: Filter USD files
1954
- :type filter_usd: bool | None
1955
1670
  :param filter_obj: Filter OBJ files
1956
- :type filter_obj: bool | None
1957
1671
  :param filter_volume: Filter OpenVDB volume files
1958
- :type filter_volume: bool | None
1959
1672
  :param filter_folder: Filter folders
1960
- :type filter_folder: bool | None
1961
1673
  :param filter_blenlib: Filter Blender IDs
1962
- :type filter_blenlib: bool | None
1963
1674
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
1964
- :type filemode: int | None
1965
1675
  :param display_type: Display Type
1966
1676
 
1967
1677
  DEFAULT
@@ -1975,15 +1685,10 @@ def obj_export(
1975
1685
 
1976
1686
  THUMBNAIL
1977
1687
  Thumbnails -- Display files as thumbnails.
1978
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
1979
1688
  :param sort_method: File sorting mode
1980
- :type sort_method: str | None
1981
1689
  :param export_animation: Export Animation, Export multiple frames instead of the current frame only
1982
- :type export_animation: bool | None
1983
1690
  :param start_frame: Start Frame, The first frame to be exported
1984
- :type start_frame: int | None
1985
1691
  :param end_frame: End Frame, The last frame to be exported
1986
- :type end_frame: int | None
1987
1692
  :param forward_axis: Forward Axis
1988
1693
 
1989
1694
  X
@@ -2003,7 +1708,6 @@ def obj_export(
2003
1708
 
2004
1709
  NEGATIVE_Z
2005
1710
  -Z -- Negative Z axis.
2006
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2007
1711
  :param up_axis: Up Axis
2008
1712
 
2009
1713
  X
@@ -2023,11 +1727,9 @@ def obj_export(
2023
1727
 
2024
1728
  NEGATIVE_Z
2025
1729
  -Z -- Negative Z axis.
2026
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2027
- :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
2028
- :type global_scale: float | None
1730
+ :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
2029
1731
  :param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
2030
- :type apply_modifiers: bool | None
1732
+ :param apply_transform: Apply Transform, Apply object transforms to exported vertices
2031
1733
  :param export_eval_mode: Object Properties, Determines properties like object visibility, modifiers etc., where they differ for Render and Viewport
2032
1734
 
2033
1735
  DAG_EVAL_RENDER
@@ -2035,19 +1737,12 @@ def obj_export(
2035
1737
 
2036
1738
  DAG_EVAL_VIEWPORT
2037
1739
  Viewport -- Export objects as they appear in the viewport.
2038
- :type export_eval_mode: typing.Literal['DAG_EVAL_RENDER','DAG_EVAL_VIEWPORT'] | None
2039
1740
  :param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
2040
- :type export_selected_objects: bool | None
2041
1741
  :param export_uv: Export UVs
2042
- :type export_uv: bool | None
2043
- :param export_normals: Export Normals, Export per-face normals if the face is flat-shaded, per-face-per-loop normals if smooth-shaded
2044
- :type export_normals: bool | None
1742
+ :param export_normals: Export Normals, Export per-face normals if the face is flat-shaded, per-face-corner normals if smooth-shaded
2045
1743
  :param export_colors: Export Colors, Export per-vertex colors
2046
- :type export_colors: bool | None
2047
1744
  :param export_materials: Export Materials, Export MTL library. There must be a Principled-BSDF node for image textures to be exported to the MTL file
2048
- :type export_materials: bool | None
2049
1745
  :param export_pbr_extensions: Export Materials with PBR Extensions, Export MTL library using PBR extensions (roughness, metallic, sheen, coat, anisotropy, transmission)
2050
- :type export_pbr_extensions: bool | None
2051
1746
  :param path_mode: Path Mode, Method used to reference paths
2052
1747
 
2053
1748
  AUTO
@@ -2067,25 +1762,15 @@ def obj_export(
2067
1762
 
2068
1763
  COPY
2069
1764
  Copy -- Copy the file to the destination path.
2070
- :type path_mode: typing.Literal['AUTO','ABSOLUTE','RELATIVE','MATCH','STRIP','COPY'] | None
2071
1765
  :param export_triangulated_mesh: Export Triangulated Mesh, All ngons with four or more vertices will be triangulated. Meshes in the scene will not be affected. Behaves like Triangulate Modifier with ngon-method: "Beauty", quad-method: "Shortest Diagonal", min vertices: 4
2072
- :type export_triangulated_mesh: bool | None
2073
1766
  :param export_curves_as_nurbs: Export Curves as NURBS, Export curves in parametric form instead of exporting as mesh
2074
- :type export_curves_as_nurbs: bool | None
2075
- :param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a '_'
2076
- :type export_object_groups: bool | None
1767
+ :param export_object_groups: Export Object Groups, Append mesh name to object name, separated by a _
2077
1768
  :param export_material_groups: Export Material Groups, Generate an OBJ group for each part of a geometry using a different material
2078
- :type export_material_groups: bool | None
2079
1769
  :param export_vertex_groups: Export Vertex Groups, Export the name of the vertex group of a face. It is approximated by choosing the vertex group with the most members among the vertices of a face
2080
- :type export_vertex_groups: bool | None
2081
- :param export_smooth_groups: Export Smooth Groups, Every smooth-shaded face is assigned group "1" and every flat-shaded face "off"
2082
- :type export_smooth_groups: bool | None
2083
- :param smooth_group_bitflags: Generate Bitflags for Smooth Groups
2084
- :type smooth_group_bitflags: bool | None
1770
+ :param export_smooth_groups: Export Smooth Groups, Generate smooth groups identifiers for each group of smooth faces, as unique integer values by default
1771
+ :param smooth_group_bitflags: Bitflags Smooth Groups, If exporting smoothgroups, generate bitflags values for the groups, instead of unique integer values. The same bitflag value can be re-used for different groups of smooth faces, as long as they have no common sharp edges or vertices
2085
1772
  :param filter_glob: Extension Filter
2086
- :type filter_glob: str
2087
1773
  :param collection: Collection
2088
- :type collection: str
2089
1774
  """
2090
1775
 
2091
1776
  def obj_import(
@@ -2108,7 +1793,6 @@ def obj_import(
2108
1793
  filter_text: bool | None = False,
2109
1794
  filter_archive: bool | None = False,
2110
1795
  filter_btx: bool | None = False,
2111
- filter_collada: bool | None = False,
2112
1796
  filter_alembic: bool | None = False,
2113
1797
  filter_usd: bool | None = False,
2114
1798
  filter_obj: bool | None = False,
@@ -2135,56 +1819,33 @@ def obj_import(
2135
1819
  validate_meshes: bool | None = True,
2136
1820
  close_spline_loops: bool | None = True,
2137
1821
  collection_separator: str = "",
1822
+ mtl_name_collision_mode: typing.Literal["MAKE_UNIQUE", "REFERENCE_EXISTING"]
1823
+ | None = "MAKE_UNIQUE",
2138
1824
  filter_glob: str = "*.obj;*.mtl",
2139
- ):
1825
+ ) -> None:
2140
1826
  """Load a Wavefront OBJ scene
2141
1827
 
2142
- :type execution_context: int | str | None
2143
- :type undo: bool | None
2144
1828
  :param filepath: File Path, Path to file
2145
- :type filepath: str
2146
1829
  :param directory: Directory, Directory of the file
2147
- :type directory: str
2148
1830
  :param files: Files
2149
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
2150
1831
  :param check_existing: Check Existing, Check and warn on overwriting existing files
2151
- :type check_existing: bool | None
2152
1832
  :param filter_blender: Filter .blend files
2153
- :type filter_blender: bool | None
2154
1833
  :param filter_backup: Filter .blend files
2155
- :type filter_backup: bool | None
2156
1834
  :param filter_image: Filter image files
2157
- :type filter_image: bool | None
2158
1835
  :param filter_movie: Filter movie files
2159
- :type filter_movie: bool | None
2160
1836
  :param filter_python: Filter Python files
2161
- :type filter_python: bool | None
2162
1837
  :param filter_font: Filter font files
2163
- :type filter_font: bool | None
2164
1838
  :param filter_sound: Filter sound files
2165
- :type filter_sound: bool | None
2166
1839
  :param filter_text: Filter text files
2167
- :type filter_text: bool | None
2168
1840
  :param filter_archive: Filter archive files
2169
- :type filter_archive: bool | None
2170
1841
  :param filter_btx: Filter btx files
2171
- :type filter_btx: bool | None
2172
- :param filter_collada: Filter COLLADA files
2173
- :type filter_collada: bool | None
2174
1842
  :param filter_alembic: Filter Alembic files
2175
- :type filter_alembic: bool | None
2176
1843
  :param filter_usd: Filter USD files
2177
- :type filter_usd: bool | None
2178
1844
  :param filter_obj: Filter OBJ files
2179
- :type filter_obj: bool | None
2180
1845
  :param filter_volume: Filter OpenVDB volume files
2181
- :type filter_volume: bool | None
2182
1846
  :param filter_folder: Filter folders
2183
- :type filter_folder: bool | None
2184
1847
  :param filter_blenlib: Filter Blender IDs
2185
- :type filter_blenlib: bool | None
2186
1848
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
2187
- :type filemode: int | None
2188
1849
  :param display_type: Display Type
2189
1850
 
2190
1851
  DEFAULT
@@ -2198,13 +1859,9 @@ def obj_import(
2198
1859
 
2199
1860
  THUMBNAIL
2200
1861
  Thumbnails -- Display files as thumbnails.
2201
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
2202
1862
  :param sort_method: File sorting mode
2203
- :type sort_method: str | None
2204
- :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
2205
- :type global_scale: float | None
1863
+ :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
2206
1864
  :param clamp_size: Clamp Bounding Box, Resize the objects to keep bounding box under this value. Value 0 disables clamping
2207
- :type clamp_size: float | None
2208
1865
  :param forward_axis: Forward Axis
2209
1866
 
2210
1867
  X
@@ -2224,7 +1881,6 @@ def obj_import(
2224
1881
 
2225
1882
  NEGATIVE_Z
2226
1883
  -Z -- Negative Z axis.
2227
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2228
1884
  :param up_axis: Up Axis
2229
1885
 
2230
1886
  X
@@ -2244,21 +1900,20 @@ def obj_import(
2244
1900
 
2245
1901
  NEGATIVE_Z
2246
1902
  -Z -- Negative Z axis.
2247
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2248
- :param use_split_objects: Split By Object, Import each OBJ 'o' as a separate object
2249
- :type use_split_objects: bool | None
2250
- :param use_split_groups: Split By Group, Import each OBJ 'g' as a separate object
2251
- :type use_split_groups: bool | None
1903
+ :param use_split_objects: Split By Object, Import each OBJ o as a separate object
1904
+ :param use_split_groups: Split By Group, Import each OBJ g as a separate object
2252
1905
  :param import_vertex_groups: Vertex Groups, Import OBJ groups as vertex groups
2253
- :type import_vertex_groups: bool | None
2254
1906
  :param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
2255
- :type validate_meshes: bool | None
2256
- :param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected(if disabled, no curves will be cyclic)
2257
- :type close_spline_loops: bool | None
1907
+ :param close_spline_loops: Detect Cyclic Curves, Join curve endpoints if overlapping control points are detected (if disabled, no curves will be cyclic)
2258
1908
  :param collection_separator: Path Separator, Character used to separate objects name into hierarchical structure
2259
- :type collection_separator: str
1909
+ :param mtl_name_collision_mode: Material Name Collision, How to handle naming collisions when importing materials
1910
+
1911
+ MAKE_UNIQUE
1912
+ Make Unique -- Create new materials with unique names for each OBJ file.
1913
+
1914
+ REFERENCE_EXISTING
1915
+ Reference Existing -- Use existing materials with same name instead of creating new ones.
2260
1916
  :param filter_glob: Extension Filter
2261
- :type filter_glob: str
2262
1917
  """
2263
1918
 
2264
1919
  def open_mainfile(
@@ -2279,7 +1934,6 @@ def open_mainfile(
2279
1934
  filter_text: bool | None = False,
2280
1935
  filter_archive: bool | None = False,
2281
1936
  filter_btx: bool | None = False,
2282
- filter_collada: bool | None = False,
2283
1937
  filter_alembic: bool | None = False,
2284
1938
  filter_usd: bool | None = False,
2285
1939
  filter_obj: bool | None = False,
@@ -2293,56 +1947,32 @@ def open_mainfile(
2293
1947
  | None = "DEFAULT",
2294
1948
  sort_method: str | None = "",
2295
1949
  load_ui: bool | None = True,
2296
- use_scripts: bool | None = True,
1950
+ use_scripts: bool | None = False,
2297
1951
  display_file_selector: bool | None = True,
2298
1952
  state: int | None = 0,
2299
- ):
1953
+ ) -> None:
2300
1954
  """Open a Blender file
2301
1955
 
2302
- :type execution_context: int | str | None
2303
- :type undo: bool | None
2304
1956
  :param filepath: File Path, Path to file
2305
- :type filepath: str
2306
1957
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
2307
- :type hide_props_region: bool | None
2308
1958
  :param check_existing: Check Existing, Check and warn on overwriting existing files
2309
- :type check_existing: bool | None
2310
1959
  :param filter_blender: Filter .blend files
2311
- :type filter_blender: bool | None
2312
1960
  :param filter_backup: Filter .blend files
2313
- :type filter_backup: bool | None
2314
1961
  :param filter_image: Filter image files
2315
- :type filter_image: bool | None
2316
1962
  :param filter_movie: Filter movie files
2317
- :type filter_movie: bool | None
2318
1963
  :param filter_python: Filter Python files
2319
- :type filter_python: bool | None
2320
1964
  :param filter_font: Filter font files
2321
- :type filter_font: bool | None
2322
1965
  :param filter_sound: Filter sound files
2323
- :type filter_sound: bool | None
2324
1966
  :param filter_text: Filter text files
2325
- :type filter_text: bool | None
2326
1967
  :param filter_archive: Filter archive files
2327
- :type filter_archive: bool | None
2328
1968
  :param filter_btx: Filter btx files
2329
- :type filter_btx: bool | None
2330
- :param filter_collada: Filter COLLADA files
2331
- :type filter_collada: bool | None
2332
1969
  :param filter_alembic: Filter Alembic files
2333
- :type filter_alembic: bool | None
2334
1970
  :param filter_usd: Filter USD files
2335
- :type filter_usd: bool | None
2336
1971
  :param filter_obj: Filter OBJ files
2337
- :type filter_obj: bool | None
2338
1972
  :param filter_volume: Filter OpenVDB volume files
2339
- :type filter_volume: bool | None
2340
1973
  :param filter_folder: Filter folders
2341
- :type filter_folder: bool | None
2342
1974
  :param filter_blenlib: Filter Blender IDs
2343
- :type filter_blenlib: bool | None
2344
1975
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
2345
- :type filemode: int | None
2346
1976
  :param display_type: Display Type
2347
1977
 
2348
1978
  DEFAULT
@@ -2356,36 +1986,26 @@ def open_mainfile(
2356
1986
 
2357
1987
  THUMBNAIL
2358
1988
  Thumbnails -- Display files as thumbnails.
2359
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
2360
1989
  :param sort_method: File sorting mode
2361
- :type sort_method: str | None
2362
1990
  :param load_ui: Load UI, Load user interface setup in the .blend file
2363
- :type load_ui: bool | None
2364
1991
  :param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
2365
- :type use_scripts: bool | None
2366
1992
  :param display_file_selector: Display File Selector
2367
- :type display_file_selector: bool | None
2368
1993
  :param state: State
2369
- :type state: int | None
2370
1994
  """
2371
1995
 
2372
1996
  def operator_cheat_sheet(
2373
- execution_context: int | str | None = None, undo: bool | None = None
2374
- ):
2375
- """List all the operators in a text-block, useful for scripting
2376
-
2377
- :type execution_context: int | str | None
2378
- :type undo: bool | None
2379
- """
1997
+ execution_context: int | str | None = None,
1998
+ undo: bool | None = None,
1999
+ /,
2000
+ ) -> None:
2001
+ """List all the operators in a text-block, useful for scripting"""
2380
2002
 
2381
2003
  def operator_defaults(
2382
- execution_context: int | str | None = None, undo: bool | None = None
2383
- ):
2384
- """Set the active operator to its default values
2385
-
2386
- :type execution_context: int | str | None
2387
- :type undo: bool | None
2388
- """
2004
+ execution_context: int | str | None = None,
2005
+ undo: bool | None = None,
2006
+ /,
2007
+ ) -> None:
2008
+ """Set the active operator to its default values"""
2389
2009
 
2390
2010
  def operator_pie_enum(
2391
2011
  execution_context: int | str | None = None,
@@ -2394,15 +2014,11 @@ def operator_pie_enum(
2394
2014
  *,
2395
2015
  data_path: str = "",
2396
2016
  prop_string: str = "",
2397
- ):
2017
+ ) -> None:
2398
2018
  """Undocumented, consider contributing.
2399
2019
 
2400
- :type execution_context: int | str | None
2401
- :type undo: bool | None
2402
2020
  :param data_path: Operator, Operator name (in Python as string)
2403
- :type data_path: str
2404
2021
  :param prop_string: Property, Property name (as a string)
2405
- :type prop_string: str
2406
2022
  """
2407
2023
 
2408
2024
  def operator_preset_add(
@@ -2414,19 +2030,13 @@ def operator_preset_add(
2414
2030
  remove_name: bool | None = False,
2415
2031
  remove_active: bool | None = False,
2416
2032
  operator: str = "",
2417
- ):
2033
+ ) -> None:
2418
2034
  """Add or remove an Operator Preset
2419
2035
 
2420
- :type execution_context: int | str | None
2421
- :type undo: bool | None
2422
2036
  :param name: Name, Name of the preset, used to make the path name
2423
- :type name: str
2424
2037
  :param remove_name: remove_name
2425
- :type remove_name: bool | None
2426
2038
  :param remove_active: remove_active
2427
- :type remove_active: bool | None
2428
2039
  :param operator: Operator
2429
- :type operator: str
2430
2040
  """
2431
2041
 
2432
2042
  def operator_presets_cleanup(
@@ -2437,15 +2047,11 @@ def operator_presets_cleanup(
2437
2047
  operator: str = "",
2438
2048
  properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement]
2439
2049
  | None = None,
2440
- ):
2050
+ ) -> None:
2441
2051
  """Remove outdated operator properties from presets that may cause problems
2442
2052
 
2443
- :type execution_context: int | str | None
2444
- :type undo: bool | None
2445
2053
  :param operator: operator
2446
- :type operator: str
2447
2054
  :param properties: properties
2448
- :type properties: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
2449
2055
  """
2450
2056
 
2451
2057
  def owner_disable(
@@ -2454,13 +2060,10 @@ def owner_disable(
2454
2060
  /,
2455
2061
  *,
2456
2062
  owner_id: str = "",
2457
- ):
2063
+ ) -> None:
2458
2064
  """Disable add-on for workspace
2459
2065
 
2460
- :type execution_context: int | str | None
2461
- :type undo: bool | None
2462
2066
  :param owner_id: UI Tag
2463
- :type owner_id: str
2464
2067
  """
2465
2068
 
2466
2069
  def owner_enable(
@@ -2469,13 +2072,10 @@ def owner_enable(
2469
2072
  /,
2470
2073
  *,
2471
2074
  owner_id: str = "",
2472
- ):
2075
+ ) -> None:
2473
2076
  """Enable add-on for workspace
2474
2077
 
2475
- :type execution_context: int | str | None
2476
- :type undo: bool | None
2477
2078
  :param owner_id: UI Tag
2478
- :type owner_id: str
2479
2079
  """
2480
2080
 
2481
2081
  def path_open(
@@ -2484,13 +2084,10 @@ def path_open(
2484
2084
  /,
2485
2085
  *,
2486
2086
  filepath: str = "",
2487
- ):
2087
+ ) -> None:
2488
2088
  """Open a path in a file browser
2489
2089
 
2490
- :type execution_context: int | str | None
2491
- :type undo: bool | None
2492
2090
  :param filepath: filepath
2493
- :type filepath: str
2494
2091
  """
2495
2092
 
2496
2093
  def ply_export(
@@ -2510,7 +2107,6 @@ def ply_export(
2510
2107
  filter_text: bool | None = False,
2511
2108
  filter_archive: bool | None = False,
2512
2109
  filter_btx: bool | None = False,
2513
- filter_collada: bool | None = False,
2514
2110
  filter_alembic: bool | None = False,
2515
2111
  filter_usd: bool | None = False,
2516
2112
  filter_obj: bool | None = False,
@@ -2540,51 +2136,28 @@ def ply_export(
2540
2136
  export_triangulated_mesh: bool | None = False,
2541
2137
  ascii_format: bool | None = False,
2542
2138
  filter_glob: str = "*.ply",
2543
- ):
2139
+ ) -> None:
2544
2140
  """Save the scene to a PLY file
2545
2141
 
2546
- :type execution_context: int | str | None
2547
- :type undo: bool | None
2548
2142
  :param filepath: File Path, Path to file
2549
- :type filepath: str
2550
2143
  :param check_existing: Check Existing, Check and warn on overwriting existing files
2551
- :type check_existing: bool | None
2552
2144
  :param filter_blender: Filter .blend files
2553
- :type filter_blender: bool | None
2554
2145
  :param filter_backup: Filter .blend files
2555
- :type filter_backup: bool | None
2556
2146
  :param filter_image: Filter image files
2557
- :type filter_image: bool | None
2558
2147
  :param filter_movie: Filter movie files
2559
- :type filter_movie: bool | None
2560
2148
  :param filter_python: Filter Python files
2561
- :type filter_python: bool | None
2562
2149
  :param filter_font: Filter font files
2563
- :type filter_font: bool | None
2564
2150
  :param filter_sound: Filter sound files
2565
- :type filter_sound: bool | None
2566
2151
  :param filter_text: Filter text files
2567
- :type filter_text: bool | None
2568
2152
  :param filter_archive: Filter archive files
2569
- :type filter_archive: bool | None
2570
2153
  :param filter_btx: Filter btx files
2571
- :type filter_btx: bool | None
2572
- :param filter_collada: Filter COLLADA files
2573
- :type filter_collada: bool | None
2574
2154
  :param filter_alembic: Filter Alembic files
2575
- :type filter_alembic: bool | None
2576
2155
  :param filter_usd: Filter USD files
2577
- :type filter_usd: bool | None
2578
2156
  :param filter_obj: Filter OBJ files
2579
- :type filter_obj: bool | None
2580
2157
  :param filter_volume: Filter OpenVDB volume files
2581
- :type filter_volume: bool | None
2582
2158
  :param filter_folder: Filter folders
2583
- :type filter_folder: bool | None
2584
2159
  :param filter_blenlib: Filter Blender IDs
2585
- :type filter_blenlib: bool | None
2586
2160
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
2587
- :type filemode: int | None
2588
2161
  :param display_type: Display Type
2589
2162
 
2590
2163
  DEFAULT
@@ -2598,9 +2171,7 @@ def ply_export(
2598
2171
 
2599
2172
  THUMBNAIL
2600
2173
  Thumbnails -- Display files as thumbnails.
2601
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
2602
2174
  :param sort_method: File sorting mode
2603
- :type sort_method: str | None
2604
2175
  :param forward_axis: Forward Axis
2605
2176
 
2606
2177
  X
@@ -2620,7 +2191,6 @@ def ply_export(
2620
2191
 
2621
2192
  NEGATIVE_Z
2622
2193
  -Z -- Negative Z axis.
2623
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2624
2194
  :param up_axis: Up Axis
2625
2195
 
2626
2196
  X
@@ -2640,19 +2210,12 @@ def ply_export(
2640
2210
 
2641
2211
  NEGATIVE_Z
2642
2212
  -Z -- Negative Z axis.
2643
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2644
- :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
2645
- :type global_scale: float | None
2213
+ :param global_scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
2646
2214
  :param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
2647
- :type apply_modifiers: bool | None
2648
2215
  :param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
2649
- :type export_selected_objects: bool | None
2650
2216
  :param collection: Source Collection, Export only objects from this collection (and its children)
2651
- :type collection: str
2652
2217
  :param export_uv: Export UVs
2653
- :type export_uv: bool | None
2654
2218
  :param export_normals: Export Vertex Normals, Export specific vertex normals if available, export calculated normals otherwise
2655
- :type export_normals: bool | None
2656
2219
  :param export_colors: Export Vertex Colors, Export vertex color attributes
2657
2220
 
2658
2221
  NONE
@@ -2663,15 +2226,10 @@ def ply_export(
2663
2226
 
2664
2227
  LINEAR
2665
2228
  Linear -- Vertex colors in the file are in linear color space.
2666
- :type export_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
2667
2229
  :param export_attributes: Export Vertex Attributes, Export custom vertex attributes
2668
- :type export_attributes: bool | None
2669
2230
  :param export_triangulated_mesh: Export Triangulated Mesh, All ngons with four or more vertices will be triangulated. Meshes in the scene will not be affected. Behaves like Triangulate Modifier with ngon-method: "Beauty", quad-method: "Shortest Diagonal", min vertices: 4
2670
- :type export_triangulated_mesh: bool | None
2671
2231
  :param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
2672
- :type ascii_format: bool | None
2673
2232
  :param filter_glob: Extension Filter
2674
- :type filter_glob: str
2675
2233
  """
2676
2234
 
2677
2235
  def ply_import(
@@ -2694,7 +2252,6 @@ def ply_import(
2694
2252
  filter_text: bool | None = False,
2695
2253
  filter_archive: bool | None = False,
2696
2254
  filter_btx: bool | None = False,
2697
- filter_collada: bool | None = False,
2698
2255
  filter_alembic: bool | None = False,
2699
2256
  filter_usd: bool | None = False,
2700
2257
  filter_obj: bool | None = False,
@@ -2719,55 +2276,30 @@ def ply_import(
2719
2276
  import_colors: typing.Literal["NONE", "SRGB", "LINEAR"] | None = "SRGB",
2720
2277
  import_attributes: bool | None = True,
2721
2278
  filter_glob: str = "*.ply",
2722
- ):
2279
+ ) -> None:
2723
2280
  """Import an PLY file as an object
2724
2281
 
2725
- :type execution_context: int | str | None
2726
- :type undo: bool | None
2727
2282
  :param filepath: File Path, Path to file
2728
- :type filepath: str
2729
2283
  :param directory: Directory, Directory of the file
2730
- :type directory: str
2731
2284
  :param files: Files
2732
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
2733
2285
  :param check_existing: Check Existing, Check and warn on overwriting existing files
2734
- :type check_existing: bool | None
2735
2286
  :param filter_blender: Filter .blend files
2736
- :type filter_blender: bool | None
2737
2287
  :param filter_backup: Filter .blend files
2738
- :type filter_backup: bool | None
2739
2288
  :param filter_image: Filter image files
2740
- :type filter_image: bool | None
2741
2289
  :param filter_movie: Filter movie files
2742
- :type filter_movie: bool | None
2743
2290
  :param filter_python: Filter Python files
2744
- :type filter_python: bool | None
2745
2291
  :param filter_font: Filter font files
2746
- :type filter_font: bool | None
2747
2292
  :param filter_sound: Filter sound files
2748
- :type filter_sound: bool | None
2749
2293
  :param filter_text: Filter text files
2750
- :type filter_text: bool | None
2751
2294
  :param filter_archive: Filter archive files
2752
- :type filter_archive: bool | None
2753
2295
  :param filter_btx: Filter btx files
2754
- :type filter_btx: bool | None
2755
- :param filter_collada: Filter COLLADA files
2756
- :type filter_collada: bool | None
2757
2296
  :param filter_alembic: Filter Alembic files
2758
- :type filter_alembic: bool | None
2759
2297
  :param filter_usd: Filter USD files
2760
- :type filter_usd: bool | None
2761
2298
  :param filter_obj: Filter OBJ files
2762
- :type filter_obj: bool | None
2763
2299
  :param filter_volume: Filter OpenVDB volume files
2764
- :type filter_volume: bool | None
2765
2300
  :param filter_folder: Filter folders
2766
- :type filter_folder: bool | None
2767
2301
  :param filter_blenlib: Filter Blender IDs
2768
- :type filter_blenlib: bool | None
2769
2302
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
2770
- :type filemode: int | None
2771
2303
  :param display_type: Display Type
2772
2304
 
2773
2305
  DEFAULT
@@ -2781,13 +2313,9 @@ def ply_import(
2781
2313
 
2782
2314
  THUMBNAIL
2783
2315
  Thumbnails -- Display files as thumbnails.
2784
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
2785
2316
  :param sort_method: File sorting mode
2786
- :type sort_method: str | None
2787
2317
  :param global_scale: Scale
2788
- :type global_scale: float | None
2789
- :param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
2790
- :type use_scene_unit: bool | None
2318
+ :param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
2791
2319
  :param forward_axis: Forward Axis
2792
2320
 
2793
2321
  X
@@ -2807,7 +2335,6 @@ def ply_import(
2807
2335
 
2808
2336
  NEGATIVE_Z
2809
2337
  -Z -- Negative Z axis.
2810
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2811
2338
  :param up_axis: Up Axis
2812
2339
 
2813
2340
  X
@@ -2827,9 +2354,7 @@ def ply_import(
2827
2354
 
2828
2355
  NEGATIVE_Z
2829
2356
  -Z -- Negative Z axis.
2830
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
2831
2357
  :param merge_verts: Merge Vertices, Merges vertices by distance
2832
- :type merge_verts: bool | None
2833
2358
  :param import_colors: Vertex Colors, Import vertex color attributes
2834
2359
 
2835
2360
  NONE
@@ -2840,11 +2365,8 @@ def ply_import(
2840
2365
 
2841
2366
  LINEAR
2842
2367
  Linear -- Vertex colors in the file are in linear color space.
2843
- :type import_colors: typing.Literal['NONE','SRGB','LINEAR'] | None
2844
2368
  :param import_attributes: Vertex Attributes, Import custom vertex attributes
2845
- :type import_attributes: bool | None
2846
2369
  :param filter_glob: Extension Filter
2847
- :type filter_glob: str
2848
2370
  """
2849
2371
 
2850
2372
  def previews_batch_clear(
@@ -2863,31 +2385,19 @@ def previews_batch_clear(
2863
2385
  use_intern_data: bool | None = True,
2864
2386
  use_trusted: bool | None = False,
2865
2387
  use_backups: bool | None = True,
2866
- ):
2867
- """Clear selected .blend file's previews
2388
+ ) -> None:
2389
+ """Clear selected .blend files previews
2868
2390
 
2869
- :type execution_context: int | str | None
2870
- :type undo: bool | None
2871
2391
  :param files: files
2872
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
2873
2392
  :param directory: directory
2874
- :type directory: str
2875
2393
  :param filter_blender: filter_blender
2876
- :type filter_blender: bool | None
2877
2394
  :param filter_folder: filter_folder
2878
- :type filter_folder: bool | None
2879
- :param use_scenes: Scenes, Clear scenes' previews
2880
- :type use_scenes: bool | None
2881
- :param use_collections: Collections, Clear collections' previews
2882
- :type use_collections: bool | None
2883
- :param use_objects: Objects, Clear objects' previews
2884
- :type use_objects: bool | None
2885
- :param use_intern_data: Materials & Textures, Clear 'internal' previews (materials, textures, images, etc.)
2886
- :type use_intern_data: bool | None
2395
+ :param use_scenes: Scenes, Clear scenes previews
2396
+ :param use_collections: Collections, Clear collections previews
2397
+ :param use_objects: Objects, Clear objects previews
2398
+ :param use_intern_data: Materials & Textures, Clear internal previews (materials, textures, images, etc.)
2887
2399
  :param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
2888
- :type use_trusted: bool | None
2889
2400
  :param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with cleared previews
2890
- :type use_backups: bool | None
2891
2401
  """
2892
2402
 
2893
2403
  def previews_batch_generate(
@@ -2906,31 +2416,19 @@ def previews_batch_generate(
2906
2416
  use_intern_data: bool | None = True,
2907
2417
  use_trusted: bool | None = False,
2908
2418
  use_backups: bool | None = True,
2909
- ):
2910
- """Generate selected .blend file's previews
2419
+ ) -> None:
2420
+ """Generate selected .blend files previews
2911
2421
 
2912
- :type execution_context: int | str | None
2913
- :type undo: bool | None
2914
2422
  :param files: Collection of file paths with common directory root
2915
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
2916
2423
  :param directory: Root path of all files listed in files collection
2917
- :type directory: str
2918
2424
  :param filter_blender: Show Blender files in the File Browser
2919
- :type filter_blender: bool | None
2920
2425
  :param filter_folder: Show folders in the File Browser
2921
- :type filter_folder: bool | None
2922
- :param use_scenes: Scenes, Generate scenes' previews
2923
- :type use_scenes: bool | None
2924
- :param use_collections: Collections, Generate collections' previews
2925
- :type use_collections: bool | None
2926
- :param use_objects: Objects, Generate objects' previews
2927
- :type use_objects: bool | None
2928
- :param use_intern_data: Materials & Textures, Generate 'internal' previews (materials, textures, images, etc.)
2929
- :type use_intern_data: bool | None
2426
+ :param use_scenes: Scenes, Generate scenes previews
2427
+ :param use_collections: Collections, Generate collections previews
2428
+ :param use_objects: Objects, Generate objects previews
2429
+ :param use_intern_data: Materials & Textures, Generate internal previews (materials, textures, images, etc.)
2930
2430
  :param use_trusted: Trusted Blend Files, Enable Python evaluation for selected files
2931
- :type use_trusted: bool | None
2932
2431
  :param use_backups: Save Backups, Keep a backup (.blend1) version of the files when saving with generated previews
2933
- :type use_backups: bool | None
2934
2432
  """
2935
2433
 
2936
2434
  def previews_clear(
@@ -2954,11 +2452,9 @@ def previews_clear(
2954
2452
  ]
2955
2453
  ]
2956
2454
  | None = {},
2957
- ):
2455
+ ) -> None:
2958
2456
  """Clear data-block previews (only for some types like objects, materials, textures, etc.)
2959
2457
 
2960
- :type execution_context: int | str | None
2961
- :type undo: bool | None
2962
2458
  :param id_type: Data-Block Type, Which data-block previews to clear
2963
2459
 
2964
2460
  ALL
@@ -2993,17 +2489,14 @@ def previews_clear(
2993
2489
 
2994
2490
  IMAGE
2995
2491
  Images.
2996
- :type id_type: set[typing.Literal['ALL','GEOMETRY','SHADING','SCENE','COLLECTION','OBJECT','MATERIAL','LIGHT','WORLD','TEXTURE','IMAGE']] | None
2997
2492
  """
2998
2493
 
2999
2494
  def previews_ensure(
3000
- execution_context: int | str | None = None, undo: bool | None = None
3001
- ):
3002
- """Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)
3003
-
3004
- :type execution_context: int | str | None
3005
- :type undo: bool | None
3006
- """
2495
+ execution_context: int | str | None = None,
2496
+ undo: bool | None = None,
2497
+ /,
2498
+ ) -> None:
2499
+ """Ensure data-block previews are available and up-to-date (to be saved in .blend file, only for some types like materials, textures, etc.)"""
3007
2500
 
3008
2501
  def properties_add(
3009
2502
  execution_context: int | str | None = None,
@@ -3011,13 +2504,10 @@ def properties_add(
3011
2504
  /,
3012
2505
  *,
3013
2506
  data_path: str = "",
3014
- ):
2507
+ ) -> None:
3015
2508
  """Add your own property to the data-block
3016
2509
 
3017
- :type execution_context: int | str | None
3018
- :type undo: bool | None
3019
2510
  :param data_path: Property Edit, Property data_path edit
3020
- :type data_path: str
3021
2511
  """
3022
2512
 
3023
2513
  def properties_context_change(
@@ -3026,13 +2516,10 @@ def properties_context_change(
3026
2516
  /,
3027
2517
  *,
3028
2518
  context: str = "",
3029
- ):
2519
+ ) -> None:
3030
2520
  """Jump to a different tab inside the properties editor
3031
2521
 
3032
- :type execution_context: int | str | None
3033
- :type undo: bool | None
3034
2522
  :param context: Context
3035
- :type context: str
3036
2523
  """
3037
2524
 
3038
2525
  def properties_edit(
@@ -3216,15 +2703,11 @@ def properties_edit(
3216
2703
  ]
3217
2704
  | None = "OBJECT",
3218
2705
  eval_string: str = "",
3219
- ):
3220
- """Change a custom property's type, or adjust how it is displayed in the interface
2706
+ ) -> None:
2707
+ """Change a custom propertys type, or adjust how it is displayed in the interface
3221
2708
 
3222
- :type execution_context: int | str | None
3223
- :type undo: bool | None
3224
2709
  :param data_path: Property Edit, Property data_path edit
3225
- :type data_path: str
3226
2710
  :param property_name: Property Name, Property name edit
3227
- :type property_name: str
3228
2711
  :param property_type: Type
3229
2712
 
3230
2713
  FLOAT
@@ -3253,51 +2736,28 @@ def properties_edit(
3253
2736
 
3254
2737
  PYTHON
3255
2738
  Python -- Edit a Python value directly, for unsupported property types.
3256
- :type property_type: typing.Literal['FLOAT','FLOAT_ARRAY','INT','INT_ARRAY','BOOL','BOOL_ARRAY','STRING','DATA_BLOCK','PYTHON'] | None
3257
2739
  :param is_overridable_library: Library Overridable, Allow the property to be overridden when the data-block is linked
3258
- :type is_overridable_library: bool | None
3259
2740
  :param description: Description
3260
- :type description: str
3261
2741
  :param use_soft_limits: Soft Limits, Limits the Property Value slider to a range, values outside the range must be inputted numerically
3262
- :type use_soft_limits: bool | None
3263
2742
  :param array_length: Array Length
3264
- :type array_length: int | None
3265
2743
  :param default_int: Default Value
3266
- :type default_int: collections.abc.Iterable[int] | None
3267
2744
  :param min_int: Min
3268
- :type min_int: int | None
3269
2745
  :param max_int: Max
3270
- :type max_int: int | None
3271
2746
  :param soft_min_int: Soft Min
3272
- :type soft_min_int: int | None
3273
2747
  :param soft_max_int: Soft Max
3274
- :type soft_max_int: int | None
3275
2748
  :param step_int: Step
3276
- :type step_int: int | None
3277
2749
  :param default_bool: Default Value
3278
- :type default_bool: collections.abc.Iterable[bool] | None
3279
2750
  :param default_float: Default Value
3280
- :type default_float: collections.abc.Iterable[float] | None
3281
2751
  :param min_float: Min
3282
- :type min_float: float | None
3283
2752
  :param max_float: Max
3284
- :type max_float: float | None
3285
2753
  :param soft_min_float: Soft Min
3286
- :type soft_min_float: float | None
3287
2754
  :param soft_max_float: Soft Max
3288
- :type soft_max_float: float | None
3289
2755
  :param precision: Precision
3290
- :type precision: int | None
3291
2756
  :param step_float: Step
3292
- :type step_float: float | None
3293
2757
  :param subtype: Subtype
3294
- :type subtype: str | None
3295
2758
  :param default_string: Default Value
3296
- :type default_string: str
3297
2759
  :param id_type: ID Type
3298
- :type id_type: typing.Literal['ACTION','ARMATURE','BRUSH','CACHEFILE','CAMERA','COLLECTION','CURVE','CURVES','FONT','GREASEPENCIL','GREASEPENCIL_V3','IMAGE','KEY','LATTICE','LIBRARY','LIGHT','LIGHT_PROBE','LINESTYLE','MASK','MATERIAL','MESH','META','MOVIECLIP','NODETREE','OBJECT','PAINTCURVE','PALETTE','PARTICLE','POINTCLOUD','SCENE','SCREEN','SOUND','SPEAKER','TEXT','TEXTURE','VOLUME','WINDOWMANAGER','WORKSPACE','WORLD'] | None
3299
2760
  :param eval_string: Value, Python value for unsupported custom property types
3300
- :type eval_string: str
3301
2761
  """
3302
2762
 
3303
2763
  def properties_edit_value(
@@ -3308,17 +2768,12 @@ def properties_edit_value(
3308
2768
  data_path: str = "",
3309
2769
  property_name: str = "",
3310
2770
  eval_string: str = "",
3311
- ):
2771
+ ) -> None:
3312
2772
  """Edit the value of a custom property
3313
2773
 
3314
- :type execution_context: int | str | None
3315
- :type undo: bool | None
3316
2774
  :param data_path: Property Edit, Property data_path edit
3317
- :type data_path: str
3318
2775
  :param property_name: Property Name, Property name edit
3319
- :type property_name: str
3320
2776
  :param eval_string: Value, Value for custom property types that can only be edited as a Python expression
3321
- :type eval_string: str
3322
2777
  """
3323
2778
 
3324
2779
  def properties_remove(
@@ -3328,23 +2783,19 @@ def properties_remove(
3328
2783
  *,
3329
2784
  data_path: str = "",
3330
2785
  property_name: str = "",
3331
- ):
2786
+ ) -> None:
3332
2787
  """Internal use (edit a property data_path)
3333
2788
 
3334
- :type execution_context: int | str | None
3335
- :type undo: bool | None
3336
2789
  :param data_path: Property Edit, Property data_path edit
3337
- :type data_path: str
3338
2790
  :param property_name: Property Name, Property name edit
3339
- :type property_name: str
3340
2791
  """
3341
2792
 
3342
- def quit_blender(execution_context: int | str | None = None, undo: bool | None = None):
3343
- """Quit Blender
3344
-
3345
- :type execution_context: int | str | None
3346
- :type undo: bool | None
3347
- """
2793
+ def quit_blender(
2794
+ execution_context: int | str | None = None,
2795
+ undo: bool | None = None,
2796
+ /,
2797
+ ) -> None:
2798
+ """Quit Blender"""
3348
2799
 
3349
2800
  def radial_control(
3350
2801
  execution_context: int | str | None = None,
@@ -3363,35 +2814,21 @@ def radial_control(
3363
2814
  image_id: str = "",
3364
2815
  secondary_tex: bool | None = False,
3365
2816
  release_confirm: bool | None = False,
3366
- ):
2817
+ ) -> None:
3367
2818
  """Set some size property (e.g. brush size) with mouse wheel
3368
2819
 
3369
- :type execution_context: int | str | None
3370
- :type undo: bool | None
3371
2820
  :param data_path_primary: Primary Data Path, Primary path of property to be set by the radial control
3372
- :type data_path_primary: str
3373
2821
  :param data_path_secondary: Secondary Data Path, Secondary path of property to be set by the radial control
3374
- :type data_path_secondary: str
3375
2822
  :param use_secondary: Use Secondary, Path of property to select between the primary and secondary data paths
3376
- :type use_secondary: str
3377
2823
  :param rotation_path: Rotation Path, Path of property used to rotate the texture display
3378
- :type rotation_path: str
3379
2824
  :param color_path: Color Path, Path of property used to set the color of the control
3380
- :type color_path: str
3381
2825
  :param fill_color_path: Fill Color Path, Path of property used to set the fill color of the control
3382
- :type fill_color_path: str
3383
2826
  :param fill_color_override_path: Fill Color Override Path
3384
- :type fill_color_override_path: str
3385
2827
  :param fill_color_override_test_path: Fill Color Override Test
3386
- :type fill_color_override_test_path: str
3387
2828
  :param zoom_path: Zoom Path, Path of property used to set the zoom level for the control
3388
- :type zoom_path: str
3389
2829
  :param image_id: Image ID, Path of ID that is used to generate an image for the control
3390
- :type image_id: str
3391
2830
  :param secondary_tex: Secondary Texture, Tweak brush secondary/mask texture
3392
- :type secondary_tex: bool | None
3393
2831
  :param release_confirm: Confirm On Release, Finish operation on key release
3394
- :type release_confirm: bool | None
3395
2832
  """
3396
2833
 
3397
2834
  def read_factory_settings(
@@ -3402,16 +2839,11 @@ def read_factory_settings(
3402
2839
  use_factory_startup_app_template_only: bool | None = False,
3403
2840
  app_template: str = "Template",
3404
2841
  use_empty: bool | None = False,
3405
- ):
2842
+ ) -> None:
3406
2843
  """Load factory default startup file and preferences. To make changes permanent, use "Save Startup File" and "Save Preferences"
3407
2844
 
3408
- :type execution_context: int | str | None
3409
- :type undo: bool | None
3410
2845
  :param use_factory_startup_app_template_only: Factory Startup App-Template Only
3411
- :type use_factory_startup_app_template_only: bool | None
3412
- :type app_template: str
3413
2846
  :param use_empty: Empty, After loading, remove everything except scenes, windows, and workspaces. This makes it possible to load the startup file with its scene configuration and window layout intact, but no objects, materials, animations, ...
3414
- :type use_empty: bool | None
3415
2847
  """
3416
2848
 
3417
2849
  def read_factory_userpref(
@@ -3420,21 +2852,18 @@ def read_factory_userpref(
3420
2852
  /,
3421
2853
  *,
3422
2854
  use_factory_startup_app_template_only: bool | None = False,
3423
- ):
2855
+ ) -> None:
3424
2856
  """Load factory default preferences. To make changes to preferences permanent, use "Save Preferences"
3425
2857
 
3426
- :type execution_context: int | str | None
3427
- :type undo: bool | None
3428
2858
  :param use_factory_startup_app_template_only: Factory Startup App-Template Only
3429
- :type use_factory_startup_app_template_only: bool | None
3430
2859
  """
3431
2860
 
3432
- def read_history(execution_context: int | str | None = None, undo: bool | None = None):
3433
- """Reloads history and bookmarks
3434
-
3435
- :type execution_context: int | str | None
3436
- :type undo: bool | None
3437
- """
2861
+ def read_history(
2862
+ execution_context: int | str | None = None,
2863
+ undo: bool | None = None,
2864
+ /,
2865
+ ) -> None:
2866
+ """Reloads history and bookmarks"""
3438
2867
 
3439
2868
  def read_homefile(
3440
2869
  execution_context: int | str | None = None,
@@ -3448,32 +2877,23 @@ def read_homefile(
3448
2877
  use_factory_startup_app_template_only: bool | None = False,
3449
2878
  app_template: str = "Template",
3450
2879
  use_empty: bool | None = False,
3451
- ):
2880
+ ) -> None:
3452
2881
  """Open the default file
3453
2882
 
3454
- :type execution_context: int | str | None
3455
- :type undo: bool | None
3456
2883
  :param filepath: File Path, Path to an alternative start-up file
3457
- :type filepath: str
3458
2884
  :param load_ui: Load UI, Load user interface setup from the .blend file
3459
- :type load_ui: bool | None
3460
2885
  :param use_splash: Splash
3461
- :type use_splash: bool | None
3462
- :param use_factory_startup: Factory Startup, Load the default ('factory startup') blend file. This is independent of the normal start-up file that the user can save
3463
- :type use_factory_startup: bool | None
2886
+ :param use_factory_startup: Factory Startup, Load the default (factory startup) blend file. This is independent of the normal start-up file that the user can save
3464
2887
  :param use_factory_startup_app_template_only: Factory Startup App-Template Only
3465
- :type use_factory_startup_app_template_only: bool | None
3466
- :type app_template: str
3467
2888
  :param use_empty: Empty, After loading, remove everything except scenes, windows, and workspaces. This makes it possible to load the startup file with its scene configuration and window layout intact, but no objects, materials, animations, ...
3468
- :type use_empty: bool | None
3469
2889
  """
3470
2890
 
3471
- def read_userpref(execution_context: int | str | None = None, undo: bool | None = None):
3472
- """Load last saved preferences
3473
-
3474
- :type execution_context: int | str | None
3475
- :type undo: bool | None
3476
- """
2891
+ def read_userpref(
2892
+ execution_context: int | str | None = None,
2893
+ undo: bool | None = None,
2894
+ /,
2895
+ ) -> None:
2896
+ """Load last saved preferences"""
3477
2897
 
3478
2898
  def recover_auto_save(
3479
2899
  execution_context: int | str | None = None,
@@ -3493,7 +2913,6 @@ def recover_auto_save(
3493
2913
  filter_text: bool | None = False,
3494
2914
  filter_archive: bool | None = False,
3495
2915
  filter_btx: bool | None = False,
3496
- filter_collada: bool | None = False,
3497
2916
  filter_alembic: bool | None = False,
3498
2917
  filter_usd: bool | None = False,
3499
2918
  filter_obj: bool | None = False,
@@ -3506,54 +2925,30 @@ def recover_auto_save(
3506
2925
  ]
3507
2926
  | None = "LIST_VERTICAL",
3508
2927
  sort_method: str | None = "",
3509
- use_scripts: bool | None = True,
3510
- ):
2928
+ use_scripts: bool | None = False,
2929
+ ) -> None:
3511
2930
  """Open an automatically saved file to recover it
3512
2931
 
3513
- :type execution_context: int | str | None
3514
- :type undo: bool | None
3515
2932
  :param filepath: File Path, Path to file
3516
- :type filepath: str
3517
2933
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
3518
- :type hide_props_region: bool | None
3519
2934
  :param check_existing: Check Existing, Check and warn on overwriting existing files
3520
- :type check_existing: bool | None
3521
2935
  :param filter_blender: Filter .blend files
3522
- :type filter_blender: bool | None
3523
2936
  :param filter_backup: Filter .blend files
3524
- :type filter_backup: bool | None
3525
2937
  :param filter_image: Filter image files
3526
- :type filter_image: bool | None
3527
2938
  :param filter_movie: Filter movie files
3528
- :type filter_movie: bool | None
3529
2939
  :param filter_python: Filter Python files
3530
- :type filter_python: bool | None
3531
2940
  :param filter_font: Filter font files
3532
- :type filter_font: bool | None
3533
2941
  :param filter_sound: Filter sound files
3534
- :type filter_sound: bool | None
3535
2942
  :param filter_text: Filter text files
3536
- :type filter_text: bool | None
3537
2943
  :param filter_archive: Filter archive files
3538
- :type filter_archive: bool | None
3539
2944
  :param filter_btx: Filter btx files
3540
- :type filter_btx: bool | None
3541
- :param filter_collada: Filter COLLADA files
3542
- :type filter_collada: bool | None
3543
2945
  :param filter_alembic: Filter Alembic files
3544
- :type filter_alembic: bool | None
3545
2946
  :param filter_usd: Filter USD files
3546
- :type filter_usd: bool | None
3547
2947
  :param filter_obj: Filter OBJ files
3548
- :type filter_obj: bool | None
3549
2948
  :param filter_volume: Filter OpenVDB volume files
3550
- :type filter_volume: bool | None
3551
2949
  :param filter_folder: Filter folders
3552
- :type filter_folder: bool | None
3553
2950
  :param filter_blenlib: Filter Blender IDs
3554
- :type filter_blenlib: bool | None
3555
2951
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
3556
- :type filemode: int | None
3557
2952
  :param display_type: Display Type
3558
2953
 
3559
2954
  DEFAULT
@@ -3567,11 +2962,8 @@ def recover_auto_save(
3567
2962
 
3568
2963
  THUMBNAIL
3569
2964
  Thumbnails -- Display files as thumbnails.
3570
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
3571
2965
  :param sort_method: File sorting mode
3572
- :type sort_method: str | None
3573
2966
  :param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
3574
- :type use_scripts: bool | None
3575
2967
  """
3576
2968
 
3577
2969
  def recover_last_session(
@@ -3579,14 +2971,11 @@ def recover_last_session(
3579
2971
  undo: bool | None = None,
3580
2972
  /,
3581
2973
  *,
3582
- use_scripts: bool | None = True,
3583
- ):
2974
+ use_scripts: bool | None = False,
2975
+ ) -> None:
3584
2976
  """Open the last closed file ("quit.blend")
3585
2977
 
3586
- :type execution_context: int | str | None
3587
- :type undo: bool | None
3588
2978
  :param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
3589
- :type use_scripts: bool | None
3590
2979
  """
3591
2980
 
3592
2981
  def redraw_timer(
@@ -3606,11 +2995,9 @@ def redraw_timer(
3606
2995
  | None = "DRAW",
3607
2996
  iterations: int | None = 10,
3608
2997
  time_limit: float | None = 0.0,
3609
- ):
2998
+ ) -> None:
3610
2999
  """Simple redraw timer to test the speed of updating the interface
3611
3000
 
3612
- :type execution_context: int | str | None
3613
- :type undo: bool | None
3614
3001
  :param type: Type
3615
3002
 
3616
3003
  DRAW
@@ -3633,11 +3020,8 @@ def redraw_timer(
3633
3020
 
3634
3021
  UNDO
3635
3022
  Undo/Redo -- Undo and redo.
3636
- :type type: typing.Literal['DRAW','DRAW_SWAP','DRAW_WIN','DRAW_WIN_SWAP','ANIM_STEP','ANIM_PLAY','UNDO'] | None
3637
3023
  :param iterations: Iterations, Number of times to redraw
3638
- :type iterations: int | None
3639
3024
  :param time_limit: Time Limit, Seconds to run the test for (override iterations)
3640
- :type time_limit: float | None
3641
3025
  """
3642
3026
 
3643
3027
  def revert_mainfile(
@@ -3645,14 +3029,11 @@ def revert_mainfile(
3645
3029
  undo: bool | None = None,
3646
3030
  /,
3647
3031
  *,
3648
- use_scripts: bool | None = True,
3649
- ):
3032
+ use_scripts: bool | None = False,
3033
+ ) -> None:
3650
3034
  """Reload the saved file
3651
3035
 
3652
- :type execution_context: int | str | None
3653
- :type undo: bool | None
3654
3036
  :param use_scripts: Trusted Source, Allow .blend file to execute scripts automatically, default available from system preferences
3655
- :type use_scripts: bool | None
3656
3037
  """
3657
3038
 
3658
3039
  def save_as_mainfile(
@@ -3673,7 +3054,6 @@ def save_as_mainfile(
3673
3054
  filter_text: bool | None = False,
3674
3055
  filter_archive: bool | None = False,
3675
3056
  filter_btx: bool | None = False,
3676
- filter_collada: bool | None = False,
3677
3057
  filter_alembic: bool | None = False,
3678
3058
  filter_usd: bool | None = False,
3679
3059
  filter_obj: bool | None = False,
@@ -3689,53 +3069,29 @@ def save_as_mainfile(
3689
3069
  compress: bool | None = False,
3690
3070
  relative_remap: bool | None = True,
3691
3071
  copy: bool | None = False,
3692
- ):
3072
+ ) -> None:
3693
3073
  """Save the current file in the desired location
3694
3074
 
3695
- :type execution_context: int | str | None
3696
- :type undo: bool | None
3697
3075
  :param filepath: File Path, Path to file
3698
- :type filepath: str
3699
3076
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
3700
- :type hide_props_region: bool | None
3701
3077
  :param check_existing: Check Existing, Check and warn on overwriting existing files
3702
- :type check_existing: bool | None
3703
3078
  :param filter_blender: Filter .blend files
3704
- :type filter_blender: bool | None
3705
3079
  :param filter_backup: Filter .blend files
3706
- :type filter_backup: bool | None
3707
3080
  :param filter_image: Filter image files
3708
- :type filter_image: bool | None
3709
3081
  :param filter_movie: Filter movie files
3710
- :type filter_movie: bool | None
3711
3082
  :param filter_python: Filter Python files
3712
- :type filter_python: bool | None
3713
3083
  :param filter_font: Filter font files
3714
- :type filter_font: bool | None
3715
3084
  :param filter_sound: Filter sound files
3716
- :type filter_sound: bool | None
3717
3085
  :param filter_text: Filter text files
3718
- :type filter_text: bool | None
3719
3086
  :param filter_archive: Filter archive files
3720
- :type filter_archive: bool | None
3721
3087
  :param filter_btx: Filter btx files
3722
- :type filter_btx: bool | None
3723
- :param filter_collada: Filter COLLADA files
3724
- :type filter_collada: bool | None
3725
3088
  :param filter_alembic: Filter Alembic files
3726
- :type filter_alembic: bool | None
3727
3089
  :param filter_usd: Filter USD files
3728
- :type filter_usd: bool | None
3729
3090
  :param filter_obj: Filter OBJ files
3730
- :type filter_obj: bool | None
3731
3091
  :param filter_volume: Filter OpenVDB volume files
3732
- :type filter_volume: bool | None
3733
3092
  :param filter_folder: Filter folders
3734
- :type filter_folder: bool | None
3735
3093
  :param filter_blenlib: Filter Blender IDs
3736
- :type filter_blenlib: bool | None
3737
3094
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
3738
- :type filemode: int | None
3739
3095
  :param display_type: Display Type
3740
3096
 
3741
3097
  DEFAULT
@@ -3749,24 +3105,47 @@ def save_as_mainfile(
3749
3105
 
3750
3106
  THUMBNAIL
3751
3107
  Thumbnails -- Display files as thumbnails.
3752
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
3753
3108
  :param sort_method: File sorting mode
3754
- :type sort_method: str | None
3755
3109
  :param compress: Compress, Write compressed .blend file
3756
- :type compress: bool | None
3757
3110
  :param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
3758
- :type relative_remap: bool | None
3759
3111
  :param copy: Save Copy, Save a copy of the actual working state but does not make saved file active
3760
- :type copy: bool | None
3761
3112
  """
3762
3113
 
3763
- def save_homefile(execution_context: int | str | None = None, undo: bool | None = None):
3764
- """Make the current file the default startup file
3114
+ def save_as_runtime(
3115
+ execution_context: int | str | None = None,
3116
+ undo: bool | None = None,
3117
+ /,
3118
+ *,
3119
+ player_path: str = "/home/runner/work/fake-bge-module/fake-bge-module/upbge-bin/upbge-latest-bin/blenderplayer",
3120
+ filepath: str = "",
3121
+ copy_python: bool | None = True,
3122
+ overwrite_lib: bool | None = False,
3123
+ copy_scripts: bool | None = False,
3124
+ copy_datafiles: bool | None = True,
3125
+ copy_modules: bool | None = True,
3126
+ copy_logic_nodes: bool | None = True,
3127
+ copy_libs: bool | None = True,
3128
+ ) -> None:
3129
+ """Undocumented, consider contributing.
3765
3130
 
3766
- :type execution_context: int | str | None
3767
- :type undo: bool | None
3131
+ :param player_path: Player Path, The path to the player to use
3132
+ :param filepath: filepath
3133
+ :param copy_python: Copy Python, Copy bundle Python with the runtime
3134
+ :param overwrite_lib: Overwrite lib folder, Overwrites the lib folder (if one exists) with the bundled Python lib folder
3135
+ :param copy_scripts: Copy Scripts folder, Copy bundle Scripts folder with the runtime
3136
+ :param copy_datafiles: Copy Datafiles folder, Copy bundle datafiles folder with the runtime
3137
+ :param copy_modules: Copy Script>Modules folder, Copy bundle modules folder with the runtime
3138
+ :param copy_logic_nodes: Copy Logic Nodes game folder, Copy Logic Nodes game with the runtime
3139
+ :param copy_libs: Copy shared libs, Copy all the needed executable shared libs with the runtime
3768
3140
  """
3769
3141
 
3142
+ def save_homefile(
3143
+ execution_context: int | str | None = None,
3144
+ undo: bool | None = None,
3145
+ /,
3146
+ ) -> None:
3147
+ """Make the current file the default startup file"""
3148
+
3770
3149
  def save_mainfile(
3771
3150
  execution_context: int | str | None = None,
3772
3151
  undo: bool | None = None,
@@ -3785,7 +3164,6 @@ def save_mainfile(
3785
3164
  filter_text: bool | None = False,
3786
3165
  filter_archive: bool | None = False,
3787
3166
  filter_btx: bool | None = False,
3788
- filter_collada: bool | None = False,
3789
3167
  filter_alembic: bool | None = False,
3790
3168
  filter_usd: bool | None = False,
3791
3169
  filter_obj: bool | None = False,
@@ -3802,53 +3180,29 @@ def save_mainfile(
3802
3180
  relative_remap: bool | None = False,
3803
3181
  exit: bool | None = False,
3804
3182
  incremental: bool | None = False,
3805
- ):
3183
+ ) -> None:
3806
3184
  """Save the current Blender file
3807
3185
 
3808
- :type execution_context: int | str | None
3809
- :type undo: bool | None
3810
3186
  :param filepath: File Path, Path to file
3811
- :type filepath: str
3812
3187
  :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
3813
- :type hide_props_region: bool | None
3814
3188
  :param check_existing: Check Existing, Check and warn on overwriting existing files
3815
- :type check_existing: bool | None
3816
3189
  :param filter_blender: Filter .blend files
3817
- :type filter_blender: bool | None
3818
3190
  :param filter_backup: Filter .blend files
3819
- :type filter_backup: bool | None
3820
3191
  :param filter_image: Filter image files
3821
- :type filter_image: bool | None
3822
3192
  :param filter_movie: Filter movie files
3823
- :type filter_movie: bool | None
3824
3193
  :param filter_python: Filter Python files
3825
- :type filter_python: bool | None
3826
3194
  :param filter_font: Filter font files
3827
- :type filter_font: bool | None
3828
3195
  :param filter_sound: Filter sound files
3829
- :type filter_sound: bool | None
3830
3196
  :param filter_text: Filter text files
3831
- :type filter_text: bool | None
3832
3197
  :param filter_archive: Filter archive files
3833
- :type filter_archive: bool | None
3834
3198
  :param filter_btx: Filter btx files
3835
- :type filter_btx: bool | None
3836
- :param filter_collada: Filter COLLADA files
3837
- :type filter_collada: bool | None
3838
3199
  :param filter_alembic: Filter Alembic files
3839
- :type filter_alembic: bool | None
3840
3200
  :param filter_usd: Filter USD files
3841
- :type filter_usd: bool | None
3842
3201
  :param filter_obj: Filter OBJ files
3843
- :type filter_obj: bool | None
3844
3202
  :param filter_volume: Filter OpenVDB volume files
3845
- :type filter_volume: bool | None
3846
3203
  :param filter_folder: Filter folders
3847
- :type filter_folder: bool | None
3848
3204
  :param filter_blenlib: Filter Blender IDs
3849
- :type filter_blenlib: bool | None
3850
3205
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
3851
- :type filemode: int | None
3852
3206
  :param display_type: Display Type
3853
3207
 
3854
3208
  DEFAULT
@@ -3862,41 +3216,33 @@ def save_mainfile(
3862
3216
 
3863
3217
  THUMBNAIL
3864
3218
  Thumbnails -- Display files as thumbnails.
3865
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
3866
3219
  :param sort_method: File sorting mode
3867
- :type sort_method: str | None
3868
3220
  :param compress: Compress, Write compressed .blend file
3869
- :type compress: bool | None
3870
3221
  :param relative_remap: Remap Relative, Remap relative paths when saving to a different directory
3871
- :type relative_remap: bool | None
3872
3222
  :param exit: Exit, Exit Blender after saving
3873
- :type exit: bool | None
3874
3223
  :param incremental: Incremental, Save the current Blender file with a numerically incremented name that does not overwrite any existing files
3875
- :type incremental: bool | None
3876
- """
3877
-
3878
- def save_userpref(execution_context: int | str | None = None, undo: bool | None = None):
3879
- """Make the current preferences default
3880
-
3881
- :type execution_context: int | str | None
3882
- :type undo: bool | None
3883
3224
  """
3884
3225
 
3885
- def search_menu(execution_context: int | str | None = None, undo: bool | None = None):
3886
- """Pop-up a search over all menus in the current context
3226
+ def save_userpref(
3227
+ execution_context: int | str | None = None,
3228
+ undo: bool | None = None,
3229
+ /,
3230
+ ) -> None:
3231
+ """Make the current preferences default"""
3887
3232
 
3888
- :type execution_context: int | str | None
3889
- :type undo: bool | None
3890
- """
3233
+ def search_menu(
3234
+ execution_context: int | str | None = None,
3235
+ undo: bool | None = None,
3236
+ /,
3237
+ ) -> None:
3238
+ """Pop-up a search over all menus in the current context"""
3891
3239
 
3892
3240
  def search_operator(
3893
- execution_context: int | str | None = None, undo: bool | None = None
3894
- ):
3895
- """Pop-up a search over all available operators in current context
3896
-
3897
- :type execution_context: int | str | None
3898
- :type undo: bool | None
3899
- """
3241
+ execution_context: int | str | None = None,
3242
+ undo: bool | None = None,
3243
+ /,
3244
+ ) -> None:
3245
+ """Pop-up a search over all available operators in current context"""
3900
3246
 
3901
3247
  def search_single_menu(
3902
3248
  execution_context: int | str | None = None,
@@ -3905,15 +3251,11 @@ def search_single_menu(
3905
3251
  *,
3906
3252
  menu_idname: str = "",
3907
3253
  initial_query: str = "",
3908
- ):
3254
+ ) -> None:
3909
3255
  """Pop-up a search for a menu in current context
3910
3256
 
3911
- :type execution_context: int | str | None
3912
- :type undo: bool | None
3913
3257
  :param menu_idname: Menu Name, Menu to search in
3914
- :type menu_idname: str
3915
3258
  :param initial_query: Initial Query, Query to insert into the search box
3916
- :type initial_query: str
3917
3259
  """
3918
3260
 
3919
3261
  def set_stereo_3d(
@@ -3921,42 +3263,50 @@ def set_stereo_3d(
3921
3263
  undo: bool | None = None,
3922
3264
  /,
3923
3265
  *,
3924
- display_mode: bpy._typing.rna_enums.Stereo3DDisplayItems | None = "ANAGLYPH",
3925
- anaglyph_type: bpy._typing.rna_enums.Stereo3DAnaglyphTypeItems | None = "RED_CYAN",
3926
- interlace_type: bpy._typing.rna_enums.Stereo3DInterlaceTypeItems
3266
+ display_mode: bpy.stub_internal.rna_enums.Stereo3DDisplayItems | None = "ANAGLYPH",
3267
+ anaglyph_type: bpy.stub_internal.rna_enums.Stereo3DAnaglyphTypeItems
3268
+ | None = "RED_CYAN",
3269
+ interlace_type: bpy.stub_internal.rna_enums.Stereo3DInterlaceTypeItems
3927
3270
  | None = "ROW_INTERLEAVED",
3928
3271
  use_interlace_swap: bool | None = False,
3929
3272
  use_sidebyside_crosseyed: bool | None = False,
3930
- ):
3273
+ ) -> None:
3931
3274
  """Toggle 3D stereo support for current window (or change the display mode)
3932
3275
 
3933
- :type execution_context: int | str | None
3934
- :type undo: bool | None
3935
3276
  :param display_mode: Display Mode
3936
- :type display_mode: bpy._typing.rna_enums.Stereo3DDisplayItems | None
3937
3277
  :param anaglyph_type: Anaglyph Type
3938
- :type anaglyph_type: bpy._typing.rna_enums.Stereo3DAnaglyphTypeItems | None
3939
3278
  :param interlace_type: Interlace Type
3940
- :type interlace_type: bpy._typing.rna_enums.Stereo3DInterlaceTypeItems | None
3941
3279
  :param use_interlace_swap: Swap Left/Right, Swap left and right stereo channels
3942
- :type use_interlace_swap: bool | None
3943
3280
  :param use_sidebyside_crosseyed: Cross-Eyed, Right eye should see left image and vice versa
3944
- :type use_sidebyside_crosseyed: bool | None
3945
3281
  """
3946
3282
 
3947
- def splash(execution_context: int | str | None = None, undo: bool | None = None):
3948
- """Open the splash screen with release info
3283
+ def set_working_color_space(
3284
+ execution_context: int | str | None = None,
3285
+ undo: bool | None = None,
3286
+ /,
3287
+ *,
3288
+ convert_colors: bool | None = True,
3289
+ working_space: str | None = "",
3290
+ ) -> None:
3291
+ """Change the working color space of all colors in this blend file
3949
3292
 
3950
- :type execution_context: int | str | None
3951
- :type undo: bool | None
3293
+ :param convert_colors: Convert Colors in All Data-blocks, Change colors in all data-blocks to the new working space
3294
+ :param working_space: Working Space, Color space to set
3952
3295
  """
3953
3296
 
3954
- def splash_about(execution_context: int | str | None = None, undo: bool | None = None):
3955
- """Open a window with information about UPBGE
3297
+ def splash(
3298
+ execution_context: int | str | None = None,
3299
+ undo: bool | None = None,
3300
+ /,
3301
+ ) -> None:
3302
+ """Open the splash screen with release info"""
3956
3303
 
3957
- :type execution_context: int | str | None
3958
- :type undo: bool | None
3959
- """
3304
+ def splash_about(
3305
+ execution_context: int | str | None = None,
3306
+ undo: bool | None = None,
3307
+ /,
3308
+ ) -> None:
3309
+ """Open a window with information about UPBGE"""
3960
3310
 
3961
3311
  def stl_export(
3962
3312
  execution_context: int | str | None = None,
@@ -3975,7 +3325,6 @@ def stl_export(
3975
3325
  filter_text: bool | None = False,
3976
3326
  filter_archive: bool | None = False,
3977
3327
  filter_btx: bool | None = False,
3978
- filter_collada: bool | None = False,
3979
3328
  filter_alembic: bool | None = False,
3980
3329
  filter_usd: bool | None = False,
3981
3330
  filter_obj: bool | None = False,
@@ -4002,51 +3351,28 @@ def stl_export(
4002
3351
  | None = "Z",
4003
3352
  apply_modifiers: bool | None = True,
4004
3353
  filter_glob: str = "*.stl",
4005
- ):
3354
+ ) -> None:
4006
3355
  """Save the scene to an STL file
4007
3356
 
4008
- :type execution_context: int | str | None
4009
- :type undo: bool | None
4010
3357
  :param filepath: File Path, Path to file
4011
- :type filepath: str
4012
3358
  :param check_existing: Check Existing, Check and warn on overwriting existing files
4013
- :type check_existing: bool | None
4014
3359
  :param filter_blender: Filter .blend files
4015
- :type filter_blender: bool | None
4016
3360
  :param filter_backup: Filter .blend files
4017
- :type filter_backup: bool | None
4018
3361
  :param filter_image: Filter image files
4019
- :type filter_image: bool | None
4020
3362
  :param filter_movie: Filter movie files
4021
- :type filter_movie: bool | None
4022
3363
  :param filter_python: Filter Python files
4023
- :type filter_python: bool | None
4024
3364
  :param filter_font: Filter font files
4025
- :type filter_font: bool | None
4026
3365
  :param filter_sound: Filter sound files
4027
- :type filter_sound: bool | None
4028
3366
  :param filter_text: Filter text files
4029
- :type filter_text: bool | None
4030
3367
  :param filter_archive: Filter archive files
4031
- :type filter_archive: bool | None
4032
3368
  :param filter_btx: Filter btx files
4033
- :type filter_btx: bool | None
4034
- :param filter_collada: Filter COLLADA files
4035
- :type filter_collada: bool | None
4036
3369
  :param filter_alembic: Filter Alembic files
4037
- :type filter_alembic: bool | None
4038
3370
  :param filter_usd: Filter USD files
4039
- :type filter_usd: bool | None
4040
3371
  :param filter_obj: Filter OBJ files
4041
- :type filter_obj: bool | None
4042
3372
  :param filter_volume: Filter OpenVDB volume files
4043
- :type filter_volume: bool | None
4044
3373
  :param filter_folder: Filter folders
4045
- :type filter_folder: bool | None
4046
3374
  :param filter_blenlib: Filter Blender IDs
4047
- :type filter_blenlib: bool | None
4048
3375
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
4049
- :type filemode: int | None
4050
3376
  :param display_type: Display Type
4051
3377
 
4052
3378
  DEFAULT
@@ -4060,21 +3386,13 @@ def stl_export(
4060
3386
 
4061
3387
  THUMBNAIL
4062
3388
  Thumbnails -- Display files as thumbnails.
4063
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
4064
3389
  :param sort_method: File sorting mode
4065
- :type sort_method: str | None
4066
3390
  :param ascii_format: ASCII Format, Export file in ASCII format, export as binary otherwise
4067
- :type ascii_format: bool | None
4068
3391
  :param use_batch: Batch Export, Export each object to a separate file
4069
- :type use_batch: bool | None
4070
3392
  :param export_selected_objects: Export Selected Objects, Export only selected objects instead of all supported objects
4071
- :type export_selected_objects: bool | None
4072
3393
  :param collection: Source Collection, Export only objects from this collection (and its children)
4073
- :type collection: str
4074
3394
  :param global_scale: Scale
4075
- :type global_scale: float | None
4076
- :param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to exported data
4077
- :type use_scene_unit: bool | None
3395
+ :param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to exported data
4078
3396
  :param forward_axis: Forward Axis
4079
3397
 
4080
3398
  X
@@ -4094,7 +3412,6 @@ def stl_export(
4094
3412
 
4095
3413
  NEGATIVE_Z
4096
3414
  -Z -- Negative Z axis.
4097
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4098
3415
  :param up_axis: Up Axis
4099
3416
 
4100
3417
  X
@@ -4114,11 +3431,8 @@ def stl_export(
4114
3431
 
4115
3432
  NEGATIVE_Z
4116
3433
  -Z -- Negative Z axis.
4117
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4118
3434
  :param apply_modifiers: Apply Modifiers, Apply modifiers to exported meshes
4119
- :type apply_modifiers: bool | None
4120
3435
  :param filter_glob: Extension Filter
4121
- :type filter_glob: str
4122
3436
  """
4123
3437
 
4124
3438
  def stl_import(
@@ -4141,7 +3455,6 @@ def stl_import(
4141
3455
  filter_text: bool | None = False,
4142
3456
  filter_archive: bool | None = False,
4143
3457
  filter_btx: bool | None = False,
4144
- filter_collada: bool | None = False,
4145
3458
  filter_alembic: bool | None = False,
4146
3459
  filter_usd: bool | None = False,
4147
3460
  filter_obj: bool | None = False,
@@ -4165,55 +3478,30 @@ def stl_import(
4165
3478
  | None = "Z",
4166
3479
  use_mesh_validate: bool | None = True,
4167
3480
  filter_glob: str = "*.stl",
4168
- ):
3481
+ ) -> None:
4169
3482
  """Import an STL file as an object
4170
3483
 
4171
- :type execution_context: int | str | None
4172
- :type undo: bool | None
4173
3484
  :param filepath: File Path, Path to file
4174
- :type filepath: str
4175
3485
  :param directory: Directory, Directory of the file
4176
- :type directory: str
4177
3486
  :param files: Files
4178
- :type files: bpy.types.bpy_prop_collection[bpy.types.OperatorFileListElement] | None
4179
3487
  :param check_existing: Check Existing, Check and warn on overwriting existing files
4180
- :type check_existing: bool | None
4181
3488
  :param filter_blender: Filter .blend files
4182
- :type filter_blender: bool | None
4183
3489
  :param filter_backup: Filter .blend files
4184
- :type filter_backup: bool | None
4185
3490
  :param filter_image: Filter image files
4186
- :type filter_image: bool | None
4187
3491
  :param filter_movie: Filter movie files
4188
- :type filter_movie: bool | None
4189
3492
  :param filter_python: Filter Python files
4190
- :type filter_python: bool | None
4191
3493
  :param filter_font: Filter font files
4192
- :type filter_font: bool | None
4193
3494
  :param filter_sound: Filter sound files
4194
- :type filter_sound: bool | None
4195
3495
  :param filter_text: Filter text files
4196
- :type filter_text: bool | None
4197
3496
  :param filter_archive: Filter archive files
4198
- :type filter_archive: bool | None
4199
3497
  :param filter_btx: Filter btx files
4200
- :type filter_btx: bool | None
4201
- :param filter_collada: Filter COLLADA files
4202
- :type filter_collada: bool | None
4203
3498
  :param filter_alembic: Filter Alembic files
4204
- :type filter_alembic: bool | None
4205
3499
  :param filter_usd: Filter USD files
4206
- :type filter_usd: bool | None
4207
3500
  :param filter_obj: Filter OBJ files
4208
- :type filter_obj: bool | None
4209
3501
  :param filter_volume: Filter OpenVDB volume files
4210
- :type filter_volume: bool | None
4211
3502
  :param filter_folder: Filter folders
4212
- :type filter_folder: bool | None
4213
3503
  :param filter_blenlib: Filter Blender IDs
4214
- :type filter_blenlib: bool | None
4215
3504
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
4216
- :type filemode: int | None
4217
3505
  :param display_type: Display Type
4218
3506
 
4219
3507
  DEFAULT
@@ -4227,15 +3515,10 @@ def stl_import(
4227
3515
 
4228
3516
  THUMBNAIL
4229
3517
  Thumbnails -- Display files as thumbnails.
4230
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
4231
3518
  :param sort_method: File sorting mode
4232
- :type sort_method: str | None
4233
3519
  :param global_scale: Scale
4234
- :type global_scale: float | None
4235
- :param use_scene_unit: Scene Unit, Apply current scene's unit (as defined by unit scale) to imported data
4236
- :type use_scene_unit: bool | None
3520
+ :param use_scene_unit: Scene Unit, Apply current scenes unit (as defined by unit scale) to imported data
4237
3521
  :param use_facet_normal: Facet Normals, Use (import) facet normals (note that this will still give flat shading)
4238
- :type use_facet_normal: bool | None
4239
3522
  :param forward_axis: Forward Axis
4240
3523
 
4241
3524
  X
@@ -4255,7 +3538,6 @@ def stl_import(
4255
3538
 
4256
3539
  NEGATIVE_Z
4257
3540
  -Z -- Negative Z axis.
4258
- :type forward_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4259
3541
  :param up_axis: Up Axis
4260
3542
 
4261
3543
  X
@@ -4275,11 +3557,8 @@ def stl_import(
4275
3557
 
4276
3558
  NEGATIVE_Z
4277
3559
  -Z -- Negative Z axis.
4278
- :type up_axis: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4279
3560
  :param use_mesh_validate: Validate Mesh, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
4280
- :type use_mesh_validate: bool | None
4281
3561
  :param filter_glob: Extension Filter
4282
- :type filter_glob: str
4283
3562
  """
4284
3563
 
4285
3564
  def sysinfo(
@@ -4288,13 +3567,10 @@ def sysinfo(
4288
3567
  /,
4289
3568
  *,
4290
3569
  filepath: str = "",
4291
- ):
3570
+ ) -> None:
4292
3571
  """Generate system information, saved into a text file
4293
3572
 
4294
- :type execution_context: int | str | None
4295
- :type undo: bool | None
4296
3573
  :param filepath: filepath
4297
- :type filepath: str
4298
3574
  """
4299
3575
 
4300
3576
  def tool_set_by_brush_type(
@@ -4326,15 +3602,11 @@ def tool_set_by_brush_type(
4326
3602
  "PREFERENCES",
4327
3603
  ]
4328
3604
  | None = "EMPTY",
4329
- ):
3605
+ ) -> None:
4330
3606
  """Look up the most appropriate tool for the given brush type and activate that
4331
3607
 
4332
- :type execution_context: int | str | None
4333
- :type undo: bool | None
4334
3608
  :param brush_type: Brush Type, Brush type identifier for which the most appropriate tool will be looked up
4335
- :type brush_type: str
4336
3609
  :param space_type: Type
4337
- :type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','LOGIC_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
4338
3610
  """
4339
3611
 
4340
3612
  def tool_set_by_id(
@@ -4368,19 +3640,13 @@ def tool_set_by_id(
4368
3640
  "PREFERENCES",
4369
3641
  ]
4370
3642
  | None = "EMPTY",
4371
- ):
3643
+ ) -> None:
4372
3644
  """Set the tool by name (for key-maps)
4373
3645
 
4374
- :type execution_context: int | str | None
4375
- :type undo: bool | None
4376
3646
  :param name: Identifier, Identifier of the tool
4377
- :type name: str
4378
3647
  :param cycle: Cycle, Cycle through tools in this group
4379
- :type cycle: bool | None
4380
3648
  :param as_fallback: Set Fallback, Set the fallback tool instead of the primary tool
4381
- :type as_fallback: bool | None
4382
3649
  :param space_type: Type
4383
- :type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','LOGIC_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
4384
3650
  """
4385
3651
 
4386
3652
  def tool_set_by_index(
@@ -4415,47 +3681,36 @@ def tool_set_by_index(
4415
3681
  "PREFERENCES",
4416
3682
  ]
4417
3683
  | None = "EMPTY",
4418
- ):
3684
+ ) -> None:
4419
3685
  """Set the tool by index (for key-maps)
4420
3686
 
4421
- :type execution_context: int | str | None
4422
- :type undo: bool | None
4423
3687
  :param index: Index in Toolbar
4424
- :type index: int | None
4425
3688
  :param cycle: Cycle, Cycle through tools in this group
4426
- :type cycle: bool | None
4427
3689
  :param expand: expand, Include tool subgroups
4428
- :type expand: bool | None
4429
3690
  :param as_fallback: Set Fallback, Set the fallback tool instead of the primary
4430
- :type as_fallback: bool | None
4431
3691
  :param space_type: Type
4432
- :type space_type: typing.Literal['EMPTY','VIEW_3D','IMAGE_EDITOR','NODE_EDITOR','SEQUENCE_EDITOR','CLIP_EDITOR','DOPESHEET_EDITOR','GRAPH_EDITOR','NLA_EDITOR','TEXT_EDITOR','LOGIC_EDITOR','CONSOLE','INFO','TOPBAR','STATUSBAR','OUTLINER','PROPERTIES','FILE_BROWSER','SPREADSHEET','PREFERENCES'] | None
4433
3692
  """
4434
3693
 
4435
- def toolbar(execution_context: int | str | None = None, undo: bool | None = None):
4436
- """Undocumented, consider contributing.
4437
-
4438
- :type execution_context: int | str | None
4439
- :type undo: bool | None
4440
- """
3694
+ def toolbar(
3695
+ execution_context: int | str | None = None,
3696
+ undo: bool | None = None,
3697
+ /,
3698
+ ) -> None:
3699
+ """Undocumented, consider contributing."""
4441
3700
 
4442
3701
  def toolbar_fallback_pie(
4443
- execution_context: int | str | None = None, undo: bool | None = None
4444
- ):
4445
- """Undocumented, consider contributing.
4446
-
4447
- :type execution_context: int | str | None
4448
- :type undo: bool | None
4449
- """
3702
+ execution_context: int | str | None = None,
3703
+ undo: bool | None = None,
3704
+ /,
3705
+ ) -> None:
3706
+ """Undocumented, consider contributing."""
4450
3707
 
4451
3708
  def toolbar_prompt(
4452
- execution_context: int | str | None = None, undo: bool | None = None
4453
- ):
4454
- """Leader key like functionality for accessing tools
4455
-
4456
- :type execution_context: int | str | None
4457
- :type undo: bool | None
4458
- """
3709
+ execution_context: int | str | None = None,
3710
+ undo: bool | None = None,
3711
+ /,
3712
+ ) -> None:
3713
+ """Leader key like functionality for accessing tools"""
4459
3714
 
4460
3715
  def url_open(
4461
3716
  execution_context: int | str | None = None,
@@ -4463,13 +3718,10 @@ def url_open(
4463
3718
  /,
4464
3719
  *,
4465
3720
  url: str = "",
4466
- ):
3721
+ ) -> None:
4467
3722
  """Open a website in the web browser
4468
3723
 
4469
- :type execution_context: int | str | None
4470
- :type undo: bool | None
4471
3724
  :param url: URL, URL to open
4472
- :type url: str
4473
3725
  """
4474
3726
 
4475
3727
  def url_open_preset(
@@ -4478,13 +3730,10 @@ def url_open_preset(
4478
3730
  /,
4479
3731
  *,
4480
3732
  type: str | None = "",
4481
- ):
3733
+ ) -> None:
4482
3734
  """Open a preset website in the web browser
4483
3735
 
4484
- :type execution_context: int | str | None
4485
- :type undo: bool | None
4486
3736
  :param type: Site
4487
- :type type: str | None
4488
3737
  """
4489
3738
 
4490
3739
  def usd_export(
@@ -4504,7 +3753,6 @@ def usd_export(
4504
3753
  filter_text: bool | None = False,
4505
3754
  filter_archive: bool | None = False,
4506
3755
  filter_btx: bool | None = False,
4507
- filter_collada: bool | None = False,
4508
3756
  filter_alembic: bool | None = False,
4509
3757
  filter_usd: bool | None = True,
4510
3758
  filter_obj: bool | None = False,
@@ -4519,7 +3767,6 @@ def usd_export(
4519
3767
  sort_method: str | None = "",
4520
3768
  filter_glob: str = "*.usd",
4521
3769
  selected_objects_only: bool | None = False,
4522
- visible_objects_only: bool | None = True,
4523
3770
  collection: str = "",
4524
3771
  export_animation: bool | None = False,
4525
3772
  export_hair: bool | None = False,
@@ -4546,7 +3793,6 @@ def usd_export(
4546
3793
  "X", "Y", "Z", "NEGATIVE_X", "NEGATIVE_Y", "NEGATIVE_Z"
4547
3794
  ]
4548
3795
  | None = "Y",
4549
- export_textures: bool | None = False,
4550
3796
  export_textures_mode: typing.Literal["KEEP", "PRESERVE", "NEW"] | None = "NEW",
4551
3797
  overwrite_textures: bool | None = False,
4552
3798
  relative_paths: bool | None = True,
@@ -4554,9 +3800,11 @@ def usd_export(
4554
3800
  root_prim_path: str = "/root",
4555
3801
  export_custom_properties: bool | None = True,
4556
3802
  custom_properties_namespace: str = "userProperties",
3803
+ accessibility_label: str = "",
3804
+ accessibility_description: str = "",
4557
3805
  author_blender_name: bool | None = True,
4558
3806
  convert_world_material: bool | None = True,
4559
- allow_unicode: bool | None = False,
3807
+ allow_unicode: bool | None = True,
4560
3808
  export_meshes: bool | None = True,
4561
3809
  export_lights: bool | None = True,
4562
3810
  export_cameras: bool | None = True,
@@ -4564,9 +3812,9 @@ def usd_export(
4564
3812
  export_points: bool | None = True,
4565
3813
  export_volumes: bool | None = True,
4566
3814
  triangulate_meshes: bool | None = False,
4567
- quad_method: bpy._typing.rna_enums.ModifierTriangulateQuadMethodItems
3815
+ quad_method: bpy.stub_internal.rna_enums.ModifierTriangulateQuadMethodItems
4568
3816
  | None = "SHORTEST_DIAGONAL",
4569
- ngon_method: bpy._typing.rna_enums.ModifierTriangulateNgonMethodItems
3817
+ ngon_method: bpy.stub_internal.rna_enums.ModifierTriangulateNgonMethodItems
4570
3818
  | None = "BEAUTY",
4571
3819
  usdz_downscale_size: typing.Literal[
4572
3820
  "KEEP", "256", "512", "1024", "2048", "4096", "CUSTOM"
@@ -4586,51 +3834,28 @@ def usd_export(
4586
3834
  ]
4587
3835
  | None = "METERS",
4588
3836
  meters_per_unit: float | None = 1.0,
4589
- ):
3837
+ ) -> None:
4590
3838
  """Export current scene in a USD archive
4591
3839
 
4592
- :type execution_context: int | str | None
4593
- :type undo: bool | None
4594
3840
  :param filepath: File Path, Path to file
4595
- :type filepath: str
4596
3841
  :param check_existing: Check Existing, Check and warn on overwriting existing files
4597
- :type check_existing: bool | None
4598
3842
  :param filter_blender: Filter .blend files
4599
- :type filter_blender: bool | None
4600
3843
  :param filter_backup: Filter .blend files
4601
- :type filter_backup: bool | None
4602
3844
  :param filter_image: Filter image files
4603
- :type filter_image: bool | None
4604
3845
  :param filter_movie: Filter movie files
4605
- :type filter_movie: bool | None
4606
3846
  :param filter_python: Filter Python files
4607
- :type filter_python: bool | None
4608
3847
  :param filter_font: Filter font files
4609
- :type filter_font: bool | None
4610
3848
  :param filter_sound: Filter sound files
4611
- :type filter_sound: bool | None
4612
3849
  :param filter_text: Filter text files
4613
- :type filter_text: bool | None
4614
3850
  :param filter_archive: Filter archive files
4615
- :type filter_archive: bool | None
4616
3851
  :param filter_btx: Filter btx files
4617
- :type filter_btx: bool | None
4618
- :param filter_collada: Filter COLLADA files
4619
- :type filter_collada: bool | None
4620
3852
  :param filter_alembic: Filter Alembic files
4621
- :type filter_alembic: bool | None
4622
3853
  :param filter_usd: Filter USD files
4623
- :type filter_usd: bool | None
4624
3854
  :param filter_obj: Filter OBJ files
4625
- :type filter_obj: bool | None
4626
3855
  :param filter_volume: Filter OpenVDB volume files
4627
- :type filter_volume: bool | None
4628
3856
  :param filter_folder: Filter folders
4629
- :type filter_folder: bool | None
4630
3857
  :param filter_blenlib: Filter Blender IDs
4631
- :type filter_blenlib: bool | None
4632
3858
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
4633
- :type filemode: int | None
4634
3859
  :param display_type: Display Type
4635
3860
 
4636
3861
  DEFAULT
@@ -4644,30 +3869,16 @@ def usd_export(
4644
3869
 
4645
3870
  THUMBNAIL
4646
3871
  Thumbnails -- Display files as thumbnails.
4647
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
4648
3872
  :param sort_method: File sorting mode
4649
- :type sort_method: str | None
4650
- :type filter_glob: str
4651
3873
  :param selected_objects_only: Selection Only, Only export selected objects. Unselected parents of selected objects are exported as empty transform
4652
- :type selected_objects_only: bool | None
4653
- :param visible_objects_only: Visible Only, Only export visible objects. Invisible parents of exported objects are exported as empty transforms
4654
- :type visible_objects_only: bool | None
4655
3874
  :param collection: Collection
4656
- :type collection: str
4657
3875
  :param export_animation: Animation, Export all frames in the render frame range, rather than only the current frame
4658
- :type export_animation: bool | None
4659
3876
  :param export_hair: Hair, Export hair particle systems as USD curves
4660
- :type export_hair: bool | None
4661
3877
  :param export_uvmaps: UV Maps, Include all mesh UV maps in the export
4662
- :type export_uvmaps: bool | None
4663
3878
  :param rename_uvmaps: Rename UV Maps, Rename active render UV map to "st" to match USD conventions
4664
- :type rename_uvmaps: bool | None
4665
3879
  :param export_mesh_colors: Color Attributes, Include mesh color attributes in the export
4666
- :type export_mesh_colors: bool | None
4667
3880
  :param export_normals: Normals, Include normals of exported meshes in the export
4668
- :type export_normals: bool | None
4669
3881
  :param export_materials: Materials, Export viewport settings of materials as USD preview materials, and export material assignments as geometry subsets
4670
- :type export_materials: bool | None
4671
3882
  :param export_subdivision: Subdivision, Choose how subdivision modifiers will be mapped to the USD subdivision scheme during export
4672
3883
 
4673
3884
  IGNORE
@@ -4678,15 +3889,10 @@ def usd_export(
4678
3889
 
4679
3890
  BEST_MATCH
4680
3891
  Best Match -- Scheme = Catmull-Clark, when possible. Reverts to exporting the subdivided mesh for the Simple subdivision type.
4681
- :type export_subdivision: typing.Literal['IGNORE','TESSELLATE','BEST_MATCH'] | None
4682
3892
  :param export_armatures: Armatures, Export armatures and meshes with armature modifiers as USD skeletons and skinned meshes
4683
- :type export_armatures: bool | None
4684
3893
  :param only_deform_bones: Only Deform Bones, Only export deform bones and their parents
4685
- :type only_deform_bones: bool | None
4686
3894
  :param export_shapekeys: Shape Keys, Export shape keys as USD blend shapes
4687
- :type export_shapekeys: bool | None
4688
3895
  :param use_instancing: Instancing, Export instanced objects as references in USD rather than real objects
4689
- :type use_instancing: bool | None
4690
3896
  :param evaluation_mode: Use Settings for, Determines visibility of objects, modifier settings, and other areas where there are different settings for viewport and rendering
4691
3897
 
4692
3898
  RENDER
@@ -4694,13 +3900,9 @@ def usd_export(
4694
3900
 
4695
3901
  VIEWPORT
4696
3902
  Viewport -- Use Viewport settings for object visibility, modifier settings, etc.
4697
- :type evaluation_mode: typing.Literal['RENDER','VIEWPORT'] | None
4698
3903
  :param generate_preview_surface: USD Preview Surface Network, Generate an approximate USD Preview Surface shader representation of a Principled BSDF node network
4699
- :type generate_preview_surface: bool | None
4700
3904
  :param generate_materialx_network: MaterialX Network, Generate a MaterialX network representation of the materials
4701
- :type generate_materialx_network: bool | None
4702
3905
  :param convert_orientation: Convert Orientation, Convert orientation axis to a different convention to match other applications
4703
- :type convert_orientation: bool | None
4704
3906
  :param export_global_forward_selection: Forward Axis
4705
3907
 
4706
3908
  X
@@ -4720,7 +3922,6 @@ def usd_export(
4720
3922
 
4721
3923
  NEGATIVE_Z
4722
3924
  -Z -- Negative Z axis.
4723
- :type export_global_forward_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4724
3925
  :param export_global_up_selection: Up Axis
4725
3926
 
4726
3927
  X
@@ -4740,9 +3941,6 @@ def usd_export(
4740
3941
 
4741
3942
  NEGATIVE_Z
4742
3943
  -Z -- Negative Z axis.
4743
- :type export_global_up_selection: typing.Literal['X','Y','Z','NEGATIVE_X','NEGATIVE_Y','NEGATIVE_Z'] | None
4744
- :param export_textures: Export Textures, If exporting materials, export textures referenced by material nodes to a 'textures' directory in the same directory as the USD file
4745
- :type export_textures: bool | None
4746
3944
  :param export_textures_mode: Export Textures, Texture export method
4747
3945
 
4748
3946
  KEEP
@@ -4750,15 +3948,12 @@ def usd_export(
4750
3948
 
4751
3949
  PRESERVE
4752
3950
  Preserve -- Preserve file paths of textures from already imported USD files.
4753
- Export remaining textures to a 'textures' folder next to the USD file.
3951
+ Export remaining textures to a textures folder next to the USD file.
4754
3952
 
4755
3953
  NEW
4756
- New Path -- Export textures to a 'textures' folder next to the USD file.
4757
- :type export_textures_mode: typing.Literal['KEEP','PRESERVE','NEW'] | None
3954
+ New Path -- Export textures to a textures folder next to the USD file.
4758
3955
  :param overwrite_textures: Overwrite Textures, Overwrite existing files when exporting textures
4759
- :type overwrite_textures: bool | None
4760
3956
  :param relative_paths: Relative Paths, Use relative paths to reference external files (i.e. textures, volumes) in USD, otherwise use absolute paths
4761
- :type relative_paths: bool | None
4762
3957
  :param xform_op_mode: Xform Ops, The type of transform operators to write
4763
3958
 
4764
3959
  TRS
@@ -4769,37 +3964,23 @@ def usd_export(
4769
3964
 
4770
3965
  MAT
4771
3966
  Matrix -- Export matrix operator.
4772
- :type xform_op_mode: typing.Literal['TRS','TOS','MAT'] | None
4773
3967
  :param root_prim_path: Root Prim, If set, add a transform primitive with the given path to the stage as the parent of all exported data
4774
- :type root_prim_path: str
4775
3968
  :param export_custom_properties: Custom Properties, Export custom properties as USD attributes
4776
- :type export_custom_properties: bool | None
4777
- :param custom_properties_namespace: Namespace, If set, add the given namespace as a prefix to exported custom property names. This only applies to property names that do not already have a prefix (e.g., it would apply to name 'bar' but not 'foo:bar') and does not apply to blender object and data names which are always exported in the 'userProperties:blender' namespace
4778
- :type custom_properties_namespace: str
3969
+ :param custom_properties_namespace: Namespace, If set, add the given namespace as a prefix to exported custom property names. This only applies to property names that do not already have a prefix (e.g., it would apply to name bar but not foo:bar) and does not apply to blender object and data names which are always exported in the userProperties:blender namespace
3970
+ :param accessibility_label: Label, Set the accessibility label for the exported stages default prim
3971
+ :param accessibility_description: Description, Set the accessibility description for the exported stages default prim
4779
3972
  :param author_blender_name: Blender Names, Author USD custom attributes containing the original Blender object and object data names
4780
- :type author_blender_name: bool | None
4781
3973
  :param convert_world_material: World Dome Light, Convert the world material to a USD dome light. Currently works for simple materials, consisting of an environment texture connected to a background shader, with an optional vector multiply of the texture color
4782
- :type convert_world_material: bool | None
4783
3974
  :param allow_unicode: Allow Unicode, Preserve UTF-8 encoded characters when writing USD prim and property names (requires software utilizing USD 24.03 or greater when opening the resulting files)
4784
- :type allow_unicode: bool | None
4785
3975
  :param export_meshes: Meshes, Export all meshes
4786
- :type export_meshes: bool | None
4787
3976
  :param export_lights: Lights, Export all lights
4788
- :type export_lights: bool | None
4789
3977
  :param export_cameras: Cameras, Export all cameras
4790
- :type export_cameras: bool | None
4791
3978
  :param export_curves: Curves, Export all curves
4792
- :type export_curves: bool | None
4793
3979
  :param export_points: Point Clouds, Export all point clouds
4794
- :type export_points: bool | None
4795
3980
  :param export_volumes: Volumes, Export all volumes
4796
- :type export_volumes: bool | None
4797
3981
  :param triangulate_meshes: Triangulate Meshes, Triangulate meshes during export
4798
- :type triangulate_meshes: bool | None
4799
3982
  :param quad_method: Quad Method, Method for splitting the quads into triangles
4800
- :type quad_method: bpy._typing.rna_enums.ModifierTriangulateQuadMethodItems | None
4801
3983
  :param ngon_method: N-gon Method, Method for splitting the n-gons into triangles
4802
- :type ngon_method: bpy._typing.rna_enums.ModifierTriangulateNgonMethodItems | None
4803
3984
  :param usdz_downscale_size: USDZ Texture Downsampling, Choose a maximum size for all exported textures
4804
3985
 
4805
3986
  KEEP
@@ -4822,11 +4003,8 @@ def usd_export(
4822
4003
 
4823
4004
  CUSTOM
4824
4005
  Custom -- Specify a custom size.
4825
- :type usdz_downscale_size: typing.Literal['KEEP','256','512','1024','2048','4096','CUSTOM'] | None
4826
4006
  :param usdz_downscale_custom_size: USDZ Custom Downscale Size, Custom size for downscaling exported textures
4827
- :type usdz_downscale_custom_size: int | None
4828
4007
  :param merge_parent_xform: Merge parent Xform, Merge USD primitives with their Xform parent if possible. USD does not allow nested UsdGeomGprims, intermediary Xform prims will be defined to keep the USD file valid when encountering object hierarchies.
4829
- :type merge_parent_xform: bool | None
4830
4008
  :param convert_scene_units: Units, Set the USD Stage meters per unit to the chosen measurement, or a custom value
4831
4009
 
4832
4010
  METERS
@@ -4852,9 +4030,7 @@ def usd_export(
4852
4030
 
4853
4031
  CUSTOM
4854
4032
  Custom -- Specify a custom scene meters per unit value.
4855
- :type convert_scene_units: typing.Literal['METERS','KILOMETERS','CENTIMETERS','MILLIMETERS','INCHES','FEET','YARDS','CUSTOM'] | None
4856
4033
  :param meters_per_unit: Meters Per Unit, Custom value for meters per unit in the USD Stage
4857
- :type meters_per_unit: float | None
4858
4034
  """
4859
4035
 
4860
4036
  def usd_import(
@@ -4874,7 +4050,6 @@ def usd_import(
4874
4050
  filter_text: bool | None = False,
4875
4051
  filter_archive: bool | None = False,
4876
4052
  filter_btx: bool | None = False,
4877
- filter_collada: bool | None = False,
4878
4053
  filter_alembic: bool | None = False,
4879
4054
  filter_usd: bool | None = True,
4880
4055
  filter_obj: bool | None = False,
@@ -4901,7 +4076,7 @@ def usd_import(
4901
4076
  import_skeletons: bool | None = True,
4902
4077
  import_blendshapes: bool | None = True,
4903
4078
  import_points: bool | None = True,
4904
- import_subdiv: bool | None = False,
4079
+ import_subdivision: bool | None = False,
4905
4080
  support_scene_instancing: bool | None = True,
4906
4081
  import_visible_only: bool | None = True,
4907
4082
  create_collection: bool | None = False,
@@ -4925,59 +4100,35 @@ def usd_import(
4925
4100
  import_textures_dir: str = "//textures/",
4926
4101
  tex_name_collision_mode: typing.Literal["USE_EXISTING", "OVERWRITE"]
4927
4102
  | None = "USE_EXISTING",
4928
- attr_import_mode: typing.Literal["NONE", "USER", "ALL"] | None = "ALL",
4103
+ property_import_mode: typing.Literal["NONE", "USER", "ALL"] | None = "ALL",
4929
4104
  validate_meshes: bool | None = False,
4930
4105
  create_world_material: bool | None = True,
4931
4106
  import_defined_only: bool | None = True,
4932
4107
  merge_parent_xform: bool | None = True,
4933
4108
  apply_unit_conversion_scale: bool | None = True,
4934
- ):
4109
+ ) -> None:
4935
4110
  """Import USD stage into current scene
4936
4111
 
4937
- :type execution_context: int | str | None
4938
- :type undo: bool | None
4939
4112
  :param filepath: File Path, Path to file
4940
- :type filepath: str
4941
4113
  :param check_existing: Check Existing, Check and warn on overwriting existing files
4942
- :type check_existing: bool | None
4943
4114
  :param filter_blender: Filter .blend files
4944
- :type filter_blender: bool | None
4945
4115
  :param filter_backup: Filter .blend files
4946
- :type filter_backup: bool | None
4947
4116
  :param filter_image: Filter image files
4948
- :type filter_image: bool | None
4949
4117
  :param filter_movie: Filter movie files
4950
- :type filter_movie: bool | None
4951
4118
  :param filter_python: Filter Python files
4952
- :type filter_python: bool | None
4953
4119
  :param filter_font: Filter font files
4954
- :type filter_font: bool | None
4955
4120
  :param filter_sound: Filter sound files
4956
- :type filter_sound: bool | None
4957
4121
  :param filter_text: Filter text files
4958
- :type filter_text: bool | None
4959
4122
  :param filter_archive: Filter archive files
4960
- :type filter_archive: bool | None
4961
4123
  :param filter_btx: Filter btx files
4962
- :type filter_btx: bool | None
4963
- :param filter_collada: Filter COLLADA files
4964
- :type filter_collada: bool | None
4965
4124
  :param filter_alembic: Filter Alembic files
4966
- :type filter_alembic: bool | None
4967
4125
  :param filter_usd: Filter USD files
4968
- :type filter_usd: bool | None
4969
4126
  :param filter_obj: Filter OBJ files
4970
- :type filter_obj: bool | None
4971
4127
  :param filter_volume: Filter OpenVDB volume files
4972
- :type filter_volume: bool | None
4973
4128
  :param filter_folder: Filter folders
4974
- :type filter_folder: bool | None
4975
4129
  :param filter_blenlib: Filter Blender IDs
4976
- :type filter_blenlib: bool | None
4977
4130
  :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
4978
- :type filemode: int | None
4979
4131
  :param relative_path: Relative Path, Select the file relative to the blend file
4980
- :type relative_path: bool | None
4981
4132
  :param display_type: Display Type
4982
4133
 
4983
4134
  DEFAULT
@@ -4991,75 +4142,44 @@ def usd_import(
4991
4142
 
4992
4143
  THUMBNAIL
4993
4144
  Thumbnails -- Display files as thumbnails.
4994
- :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
4995
4145
  :param sort_method: File sorting mode
4996
- :type sort_method: str | None
4997
- :type filter_glob: str
4998
- :param scale: Scale, Value by which to enlarge or shrink the objects with respect to the world's origin
4999
- :type scale: float | None
5000
- :param set_frame_range: Set Frame Range, Update the scene's start and end frame to match those of the USD archive
5001
- :type set_frame_range: bool | None
4146
+ :param scale: Scale, Value by which to enlarge or shrink the objects with respect to the worlds origin
4147
+ :param set_frame_range: Set Frame Range, Update the scenes start and end frame to match those of the USD archive
5002
4148
  :param import_cameras: Cameras
5003
- :type import_cameras: bool | None
5004
4149
  :param import_curves: Curves
5005
- :type import_curves: bool | None
5006
4150
  :param import_lights: Lights
5007
- :type import_lights: bool | None
5008
4151
  :param import_materials: Materials
5009
- :type import_materials: bool | None
5010
4152
  :param import_meshes: Meshes
5011
- :type import_meshes: bool | None
5012
4153
  :param import_volumes: Volumes
5013
- :type import_volumes: bool | None
5014
4154
  :param import_shapes: USD Shapes
5015
- :type import_shapes: bool | None
5016
4155
  :param import_skeletons: Armatures
5017
- :type import_skeletons: bool | None
5018
4156
  :param import_blendshapes: Shape Keys
5019
- :type import_blendshapes: bool | None
5020
4157
  :param import_points: Point Clouds
5021
- :type import_points: bool | None
5022
- :param import_subdiv: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
5023
- :type import_subdiv: bool | None
4158
+ :param import_subdivision: Import Subdivision Scheme, Create subdivision surface modifiers based on the USD SubdivisionScheme attribute
5024
4159
  :param support_scene_instancing: Scene Instancing, Import USD scene graph instances as collection instances
5025
- :type support_scene_instancing: bool | None
5026
4160
  :param import_visible_only: Visible Primitives Only, Do not import invisible USD primitives. Only applies to primitives with a non-animated visibility attribute. Primitives with animated visibility will always be imported
5027
- :type import_visible_only: bool | None
5028
4161
  :param create_collection: Create Collection, Add all imported objects to a new collection
5029
- :type create_collection: bool | None
5030
4162
  :param read_mesh_uvs: UV Coordinates, Read mesh UV coordinates
5031
- :type read_mesh_uvs: bool | None
5032
4163
  :param read_mesh_colors: Color Attributes, Read mesh color attributes
5033
- :type read_mesh_colors: bool | None
5034
4164
  :param read_mesh_attributes: Mesh Attributes, Read USD Primvars as mesh attributes
5035
- :type read_mesh_attributes: bool | None
5036
4165
  :param prim_path_mask: Path Mask, Import only the primitive at the given path and its descendants. Multiple paths may be specified in a list delimited by commas or semicolons
5037
- :type prim_path_mask: str
5038
4166
  :param import_guide: Guide, Import guide geometry
5039
- :type import_guide: bool | None
5040
4167
  :param import_proxy: Proxy, Import proxy geometry
5041
- :type import_proxy: bool | None
5042
4168
  :param import_render: Render, Import final render geometry
5043
- :type import_render: bool | None
5044
4169
  :param import_all_materials: Import All Materials, Also import materials that are not used by any geometry. Note that when this option is false, materials referenced by geometry will still be imported
5045
- :type import_all_materials: bool | None
5046
4170
  :param import_usd_preview: Import USD Preview, Convert UsdPreviewSurface shaders to Principled BSDF shader networks
5047
- :type import_usd_preview: bool | None
5048
- :param set_material_blend: Set Material Blend, If the Import USD Preview option is enabled, the material blend method will automatically be set based on the shader's opacity and opacityThreshold inputs
5049
- :type set_material_blend: bool | None
4171
+ :param set_material_blend: Set Material Blend, If the Import USD Preview option is enabled, the material blend method will automatically be set based on the shaders opacity and opacityThreshold inputs
5050
4172
  :param light_intensity_scale: Light Intensity Scale, Scale for the intensity of imported lights
5051
- :type light_intensity_scale: float | None
5052
4173
  :param mtl_purpose: Material Purpose, Attempt to import materials with the given purpose. If no material with this purpose is bound to the primitive, fall back on loading any other bound material
5053
4174
 
5054
4175
  MTL_ALL_PURPOSE
5055
- All Purpose -- Attempt to import 'allPurpose' materials..
4176
+ All Purpose -- Attempt to import allPurpose materials..
5056
4177
 
5057
4178
  MTL_PREVIEW
5058
- Preview -- Attempt to import 'preview' materials. Load 'allPurpose' materials as a fallback.
4179
+ Preview -- Attempt to import preview materials. Load allPurpose materials as a fallback.
5059
4180
 
5060
4181
  MTL_FULL
5061
- Full -- Attempt to import 'full' materials. Load 'allPurpose' or 'preview' materials, in that order, as a fallback.
5062
- :type mtl_purpose: typing.Literal['MTL_ALL_PURPOSE','MTL_PREVIEW','MTL_FULL'] | None
4182
+ Full -- Attempt to import full materials. Load allPurpose or preview materials, in that order, as a fallback.
5063
4183
  :param mtl_name_collision_mode: Material Name Collision, Behavior when the name of an imported material conflicts with an existing material
5064
4184
 
5065
4185
  MAKE_UNIQUE
@@ -5067,20 +4187,17 @@ def usd_import(
5067
4187
 
5068
4188
  REFERENCE_EXISTING
5069
4189
  Reference Existing -- If a material with the same name already exists, reference that instead of importing.
5070
- :type mtl_name_collision_mode: typing.Literal['MAKE_UNIQUE','REFERENCE_EXISTING'] | None
5071
4190
  :param import_textures_mode: Import Textures, Behavior when importing textures from a USDZ archive
5072
4191
 
5073
4192
  IMPORT_NONE
5074
- None -- Don't import textures.
4193
+ None -- Dont import textures.
5075
4194
 
5076
4195
  IMPORT_PACK
5077
4196
  Packed -- Import textures as packed data.
5078
4197
 
5079
4198
  IMPORT_COPY
5080
4199
  Copy -- Copy files to textures directory.
5081
- :type import_textures_mode: typing.Literal['IMPORT_NONE','IMPORT_PACK','IMPORT_COPY'] | None
5082
4200
  :param import_textures_dir: Textures Directory, Path to the directory where imported textures will be copied
5083
- :type import_textures_dir: str
5084
4201
  :param tex_name_collision_mode: File Name Collision, Behavior when the name of an imported texture file conflicts with an existing file
5085
4202
 
5086
4203
  USE_EXISTING
@@ -5088,61 +4205,50 @@ def usd_import(
5088
4205
 
5089
4206
  OVERWRITE
5090
4207
  Overwrite -- Overwrite existing files.
5091
- :type tex_name_collision_mode: typing.Literal['USE_EXISTING','OVERWRITE'] | None
5092
- :param attr_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
4208
+ :param property_import_mode: Custom Properties, Behavior when importing USD attributes as Blender custom properties
5093
4209
 
5094
4210
  NONE
5095
4211
  None -- Do not import USD custom attributes.
5096
4212
 
5097
4213
  USER
5098
- User -- Import USD attributes in the 'userProperties' namespace as Blender custom properties. The namespace will be stripped from the property names.
4214
+ User -- Import USD attributes in the userProperties namespace as Blender custom properties. The namespace will be stripped from the property names.
5099
4215
 
5100
4216
  ALL
5101
4217
  All Custom -- Import all USD custom attributes as Blender custom properties. Namespaces will be retained in the property names.
5102
- :type attr_import_mode: typing.Literal['NONE','USER','ALL'] | None
5103
4218
  :param validate_meshes: Validate Meshes, Ensure the data is valid (when disabled, data may be imported which causes crashes displaying or editing)
5104
- :type validate_meshes: bool | None
5105
4219
  :param create_world_material: World Dome Light, Convert the first discovered USD dome light to a world background shader
5106
- :type create_world_material: bool | None
5107
4220
  :param import_defined_only: Defined Primitives Only, Import only defined USD primitives. When disabled this allows importing USD primitives which are not defined, such as those with an override specifier
5108
- :type import_defined_only: bool | None
5109
4221
  :param merge_parent_xform: Merge parent Xform, Allow USD primitives to merge with their Xform parent if they are the only child in the hierarchy
5110
- :type merge_parent_xform: bool | None
5111
- :param apply_unit_conversion_scale: Apply Unit Conversion Scale, Scale the scene objects by the USD stage's meters per unit value. This scaling is applied in addition to the value specified in the Scale option
5112
- :type apply_unit_conversion_scale: bool | None
4222
+ :param apply_unit_conversion_scale: Apply Unit Conversion Scale, Scale the scene objects by the USD stages meters per unit value. This scaling is applied in addition to the value specified in the Scale option
5113
4223
  """
5114
4224
 
5115
- def window_close(execution_context: int | str | None = None, undo: bool | None = None):
5116
- """Close the current window
5117
-
5118
- :type execution_context: int | str | None
5119
- :type undo: bool | None
5120
- """
4225
+ def window_close(
4226
+ execution_context: int | str | None = None,
4227
+ undo: bool | None = None,
4228
+ /,
4229
+ ) -> None:
4230
+ """Close the current window"""
5121
4231
 
5122
4232
  def window_fullscreen_toggle(
5123
- execution_context: int | str | None = None, undo: bool | None = None
5124
- ):
5125
- """Toggle the current window full-screen
5126
-
5127
- :type execution_context: int | str | None
5128
- :type undo: bool | None
5129
- """
5130
-
5131
- def window_new(execution_context: int | str | None = None, undo: bool | None = None):
5132
- """Create a new window
4233
+ execution_context: int | str | None = None,
4234
+ undo: bool | None = None,
4235
+ /,
4236
+ ) -> None:
4237
+ """Toggle the current window full-screen"""
5133
4238
 
5134
- :type execution_context: int | str | None
5135
- :type undo: bool | None
5136
- """
4239
+ def window_new(
4240
+ execution_context: int | str | None = None,
4241
+ undo: bool | None = None,
4242
+ /,
4243
+ ) -> None:
4244
+ """Create a new window"""
5137
4245
 
5138
4246
  def window_new_main(
5139
- execution_context: int | str | None = None, undo: bool | None = None
5140
- ):
5141
- """Create a new main window with its own workspace and scene selection
5142
-
5143
- :type execution_context: int | str | None
5144
- :type undo: bool | None
5145
- """
4247
+ execution_context: int | str | None = None,
4248
+ undo: bool | None = None,
4249
+ /,
4250
+ ) -> None:
4251
+ """Create a new main window with its own workspace and scene selection"""
5146
4252
 
5147
4253
  def xr_navigation_fly(
5148
4254
  execution_context: int | str | None = None,
@@ -5165,11 +4271,12 @@ def xr_navigation_fly(
5165
4271
  "CONTROLLER_FORWARD",
5166
4272
  ]
5167
4273
  | None = "VIEWER_FORWARD",
4274
+ snap_turn_threshold: float | None = 0.95,
5168
4275
  lock_location_z: bool | None = False,
5169
4276
  lock_direction: bool | None = False,
5170
- speed_frame_based: bool | None = True,
5171
- speed_min: float | None = 0.018,
5172
- speed_max: float | None = 0.054,
4277
+ speed_frame_based: bool | None = False,
4278
+ turn_speed_factor: float | None = 0.333333,
4279
+ fly_speed_factor: float | None = 0.333333,
5173
4280
  speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None = (
5174
4281
  0.0,
5175
4282
  0.0,
@@ -5178,11 +4285,27 @@ def xr_navigation_fly(
5178
4285
  1.0,
5179
4286
  1.0,
5180
4287
  ),
5181
- ):
4288
+ alt_mode: typing.Literal[
4289
+ "FORWARD",
4290
+ "BACK",
4291
+ "LEFT",
4292
+ "RIGHT",
4293
+ "UP",
4294
+ "DOWN",
4295
+ "TURNLEFT",
4296
+ "TURNRIGHT",
4297
+ "VIEWER_FORWARD",
4298
+ "VIEWER_BACK",
4299
+ "VIEWER_LEFT",
4300
+ "VIEWER_RIGHT",
4301
+ "CONTROLLER_FORWARD",
4302
+ ]
4303
+ | None = "VIEWER_FORWARD",
4304
+ alt_lock_location_z: bool | None = False,
4305
+ alt_lock_direction: bool | None = False,
4306
+ ) -> None:
5182
4307
  """Move/turn relative to the VR viewer or controller
5183
4308
 
5184
- :type execution_context: int | str | None
5185
- :type undo: bool | None
5186
4309
  :param mode: Mode, Fly mode
5187
4310
 
5188
4311
  FORWARD
@@ -5210,34 +4333,69 @@ def xr_navigation_fly(
5210
4333
  Turn Right -- Turn clockwise around navigation up axis.
5211
4334
 
5212
4335
  VIEWER_FORWARD
5213
- Viewer Forward -- Move along viewer's forward axis.
4336
+ Viewer Forward -- Move along viewers forward axis.
5214
4337
 
5215
4338
  VIEWER_BACK
5216
- Viewer Back -- Move along viewer's back axis.
4339
+ Viewer Back -- Move along viewers back axis.
5217
4340
 
5218
4341
  VIEWER_LEFT
5219
- Viewer Left -- Move along viewer's left axis.
4342
+ Viewer Left -- Move along viewers left axis.
5220
4343
 
5221
4344
  VIEWER_RIGHT
5222
- Viewer Right -- Move along viewer's right axis.
4345
+ Viewer Right -- Move along viewers right axis.
5223
4346
 
5224
4347
  CONTROLLER_FORWARD
5225
- Controller Forward -- Move along controller's forward axis.
5226
- :type mode: typing.Literal['FORWARD','BACK','LEFT','RIGHT','UP','DOWN','TURNLEFT','TURNRIGHT','VIEWER_FORWARD','VIEWER_BACK','VIEWER_LEFT','VIEWER_RIGHT','CONTROLLER_FORWARD'] | None
4348
+ Controller Forward -- Move along controllers forward axis.
4349
+ :param snap_turn_threshold: Snap Turn Threshold, Input state threshold when using snap turn
5227
4350
  :param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
5228
- :type lock_location_z: bool | None
5229
- :param lock_direction: Lock Direction, Limit movement to viewer's initial direction
5230
- :type lock_direction: bool | None
4351
+ :param lock_direction: Lock Direction, Limit movement to viewers initial direction
5231
4352
  :param speed_frame_based: Frame Based Speed, Apply fixed movement deltas every update
5232
- :type speed_frame_based: bool | None
5233
- :param speed_min: Minimum Speed, Minimum move (turn) speed in meters (radians) per second or frame
5234
- :type speed_min: float | None
5235
- :param speed_max: Maximum Speed, Maximum move (turn) speed in meters (radians) per second or frame
5236
- :type speed_max: float | None
4353
+ :param turn_speed_factor: Turn Speed Factor, Ratio between the min and max turn speed
4354
+ :param fly_speed_factor: Fly Speed Factor, Ratio between the min and max fly speed
5237
4355
  :param speed_interpolation0: Speed Interpolation 0, First cubic spline control point between min/max speeds
5238
- :type speed_interpolation0: collections.abc.Sequence[float] | mathutils.Vector | None
5239
4356
  :param speed_interpolation1: Speed Interpolation 1, Second cubic spline control point between min/max speeds
5240
- :type speed_interpolation1: collections.abc.Sequence[float] | mathutils.Vector | None
4357
+ :param alt_mode: Mode (Alt), Fly mode when hands are swapped
4358
+
4359
+ FORWARD
4360
+ Forward -- Move along navigation forward axis.
4361
+
4362
+ BACK
4363
+ Back -- Move along navigation back axis.
4364
+
4365
+ LEFT
4366
+ Left -- Move along navigation left axis.
4367
+
4368
+ RIGHT
4369
+ Right -- Move along navigation right axis.
4370
+
4371
+ UP
4372
+ Up -- Move along navigation up axis.
4373
+
4374
+ DOWN
4375
+ Down -- Move along navigation down axis.
4376
+
4377
+ TURNLEFT
4378
+ Turn Left -- Turn counter-clockwise around navigation up axis.
4379
+
4380
+ TURNRIGHT
4381
+ Turn Right -- Turn clockwise around navigation up axis.
4382
+
4383
+ VIEWER_FORWARD
4384
+ Viewer Forward -- Move along viewers forward axis.
4385
+
4386
+ VIEWER_BACK
4387
+ Viewer Back -- Move along viewers back axis.
4388
+
4389
+ VIEWER_LEFT
4390
+ Viewer Left -- Move along viewers left axis.
4391
+
4392
+ VIEWER_RIGHT
4393
+ Viewer Right -- Move along viewers right axis.
4394
+
4395
+ CONTROLLER_FORWARD
4396
+ Controller Forward -- Move along controllers forward axis.
4397
+ :param alt_lock_location_z: Lock Elevation (Alt), When hands are swapped, prevent changes to viewer elevation
4398
+ :param alt_lock_direction: Lock Direction (Alt), When hands are swapped, limit movement to viewers initial direction
5241
4399
  """
5242
4400
 
5243
4401
  def xr_navigation_grab(
@@ -5250,21 +4408,14 @@ def xr_navigation_grab(
5250
4408
  lock_rotation: bool | None = False,
5251
4409
  lock_rotation_z: bool | None = False,
5252
4410
  lock_scale: bool | None = False,
5253
- ):
4411
+ ) -> None:
5254
4412
  """Navigate the VR scene by grabbing with controllers
5255
4413
 
5256
- :type execution_context: int | str | None
5257
- :type undo: bool | None
5258
4414
  :param lock_location: Lock Location, Prevent changes to viewer location
5259
- :type lock_location: bool | None
5260
4415
  :param lock_location_z: Lock Elevation, Prevent changes to viewer elevation
5261
- :type lock_location_z: bool | None
5262
4416
  :param lock_rotation: Lock Rotation, Prevent changes to viewer rotation
5263
- :type lock_rotation: bool | None
5264
4417
  :param lock_rotation_z: Lock Up Orientation, Prevent changes to viewer up orientation
5265
- :type lock_rotation_z: bool | None
5266
4418
  :param lock_scale: Lock Scale, Prevent changes to viewer scale
5267
- :type lock_scale: bool | None
5268
4419
  """
5269
4420
 
5270
4421
  def xr_navigation_reset(
@@ -5275,60 +4426,50 @@ def xr_navigation_reset(
5275
4426
  location: bool | None = True,
5276
4427
  rotation: bool | None = True,
5277
4428
  scale: bool | None = True,
5278
- ):
4429
+ ) -> None:
5279
4430
  """Reset VR navigation deltas relative to session base pose
5280
4431
 
5281
- :type execution_context: int | str | None
5282
- :type undo: bool | None
5283
4432
  :param location: Location, Reset location deltas
5284
- :type location: bool | None
5285
4433
  :param rotation: Rotation, Reset rotation deltas
5286
- :type rotation: bool | None
5287
4434
  :param scale: Scale, Reset scale deltas
5288
- :type scale: bool | None
5289
4435
  """
5290
4436
 
4437
+ def xr_navigation_swap_hands(
4438
+ execution_context: int | str | None = None,
4439
+ undo: bool | None = None,
4440
+ /,
4441
+ ) -> None:
4442
+ """Swap VR navigation controls between left / right controllers"""
4443
+
5291
4444
  def xr_navigation_teleport(
5292
4445
  execution_context: int | str | None = None,
5293
4446
  undo: bool | None = None,
5294
4447
  /,
5295
4448
  *,
5296
- teleport_axes: collections.abc.Iterable[bool] | None = (True, True, True),
5297
- interpolation: float | None = 1.0,
5298
- offset: float | None = 0.0,
5299
4449
  selectable_only: bool | None = True,
5300
- distance: float | None = 1.70141e38,
5301
- from_viewer: bool | None = False,
5302
- axis: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0, -1.0),
5303
- color: collections.abc.Iterable[float] | None = (0.35, 0.35, 1.0, 1.0),
5304
- ):
4450
+ force: float | None = 8.5,
4451
+ range: float | None = 0.15,
4452
+ ray_line_width: float | None = 6.0,
4453
+ destination_indicator_width: float | None = 0.18,
4454
+ hit_color: collections.abc.Iterable[float] | None = (0.4, 0.6, 0.9, 1.0),
4455
+ miss_color: collections.abc.Iterable[float] | None = (1.0, 0.35, 0.35, 1.0),
4456
+ fallback_color: collections.abc.Iterable[float] | None = (0.5, 0.45, 0.8, 1.0),
4457
+ ) -> None:
5305
4458
  """Set VR viewer location to controller raycast hit location
5306
4459
 
5307
- :type execution_context: int | str | None
5308
- :type undo: bool | None
5309
- :param teleport_axes: Teleport Axes, Enabled teleport axes in navigation space
5310
- :type teleport_axes: collections.abc.Iterable[bool] | None
5311
- :param interpolation: Interpolation, Interpolation factor between viewer and hit locations
5312
- :type interpolation: float | None
5313
- :param offset: Offset, Offset along hit normal to subtract from final location
5314
- :type offset: float | None
5315
4460
  :param selectable_only: Selectable Only, Only allow selectable objects to influence raycast result
5316
- :type selectable_only: bool | None
5317
- :param distance: Maximum raycast distance
5318
- :type distance: float | None
5319
- :param from_viewer: From Viewer, Use viewer pose as raycast origin
5320
- :type from_viewer: bool | None
5321
- :param axis: Axis, Raycast axis in controller/viewer space
5322
- :type axis: collections.abc.Sequence[float] | mathutils.Vector | None
5323
- :param color: Color, Raycast color
5324
- :type color: collections.abc.Iterable[float] | None
4461
+ :param force: Force, Velocity force controlling the teleportation arc parabola in m/s
4462
+ :param range: Range, Time step range controlling the teleportation arc parabola
4463
+ :param ray_line_width: Ray Line Width, Visual width of the teleportation ray line
4464
+ :param destination_indicator_width: Destination Indicator Width, Visual width of the hit destination indicator
4465
+ :param hit_color: Hit Color, Color of raycast when it succeeds
4466
+ :param miss_color: Miss Color, Color of raycast when it misses
4467
+ :param fallback_color: Fallback Color, Color of raycast when a fallback case succeeds
5325
4468
  """
5326
4469
 
5327
4470
  def xr_session_toggle(
5328
- execution_context: int | str | None = None, undo: bool | None = None
5329
- ):
5330
- """Open a view for use with virtual reality headsets, or close it if already opened
5331
-
5332
- :type execution_context: int | str | None
5333
- :type undo: bool | None
5334
- """
4471
+ execution_context: int | str | None = None,
4472
+ undo: bool | None = None,
4473
+ /,
4474
+ ) -> None:
4475
+ """Open a view for use with virtual reality headsets, or close it if already opened"""