fake-bge-module 20250317__py3-none-any.whl → 20260201__py3-none-any.whl

bpy/ops/screen/__init__.pyi

@@ -1,7 +1,8 @@
 import typing
 import collections.abc
 import typing_extensions
-import bpy._typing.rna_enums
+import numpy.typing as npt
+import bpy.stub_internal.rna_enums
 
 def actionzone(
     execution_context: int | str | None = None,
@@ -9,13 +10,10 @@ def actionzone(
     /,
     *,
     modifier: int | None = 0,
-):
+) -> None:
     """Handle area action zones for mouse actions/gestures
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param modifier: Modifier, Modifier state
-    :type modifier: int | None
     """
 
 def animation_cancel(
@@ -24,13 +22,10 @@ def animation_cancel(
     /,
     *,
     restore_frame: bool | None = True,
-):
+) -> None:
     """Cancel animation, returning to the original frame
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param restore_frame: Restore Frame, Restore the frame when animation was initialized
-    :type restore_frame: bool | None
     """
 
 def animation_play(
@@ -40,39 +35,33 @@ def animation_play(
     *,
     reverse: bool | None = False,
     sync: bool | None = False,
-):
+) -> None:
     """Play animation
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param reverse: Play in Reverse, Animation is played backwards
-    :type reverse: bool | None
     :param sync: Sync, Drop frames to maintain framerate
-    :type sync: bool | None
     """
 
 def animation_step(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Step through animation by position
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def area_close(execution_context: int | str | None = None, undo: bool | None = None):
-    """Close selected area
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Step through animation by position"""
 
-def area_dupli(execution_context: int | str | None = None, undo: bool | None = None):
-    """Duplicate selected area into new window
+def area_close(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Close selected area"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def area_dupli(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Duplicate selected area into new window"""
 
 def area_join(
     execution_context: int | str | None = None,
@@ -81,15 +70,11 @@ def area_join(
     *,
     source_xy: collections.abc.Iterable[int] | None = (0, 0),
     target_xy: collections.abc.Iterable[int] | None = (0, 0),
-):
+) -> None:
     """Join selected areas into new window
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param source_xy: Source location
-    :type source_xy: collections.abc.Iterable[int] | None
     :param target_xy: Target location
-    :type target_xy: collections.abc.Iterable[int] | None
     """
 
 def area_move(
@@ -100,25 +85,22 @@ def area_move(
     x: int | None = 0,
     y: int | None = 0,
     delta: int | None = 0,
-):
+    snap: bool | None = False,
+) -> None:
     """Move selected area edges
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param x: X
-    :type x: int | None
     :param y: Y
-    :type y: int | None
     :param delta: Delta
-    :type delta: int | None
+    :param snap: Snapping, Enable snapping
     """
 
-def area_options(execution_context: int | str | None = None, undo: bool | None = None):
-    """Operations for splitting and merging
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def area_options(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Operations for splitting and merging"""
 
 def area_split(
     execution_context: int | str | None = None,
@@ -128,17 +110,12 @@ def area_split(
     direction: typing.Literal["HORIZONTAL", "VERTICAL"] | None = "HORIZONTAL",
     factor: float | None = 0.5,
     cursor: collections.abc.Iterable[int] | None = (0, 0),
-):
+) -> None:
     """Split selected area into new windows
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param direction: Direction
-    :type direction: typing.Literal['HORIZONTAL','VERTICAL'] | None
     :param factor: Factor
-    :type factor: float | None
     :param cursor: Cursor
-    :type cursor: collections.abc.Iterable[int] | None
     """
 
 def area_swap(
@@ -147,39 +124,32 @@ def area_swap(
     /,
     *,
     cursor: collections.abc.Iterable[int] | None = (0, 0),
-):
+) -> None:
     """Swap selected areas screen positions
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param cursor: Cursor
-    :type cursor: collections.abc.Iterable[int] | None
     """
 
 def back_to_previous(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Revert back to the original screen layout, before fullscreen area overlay
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def delete(execution_context: int | str | None = None, undo: bool | None = None):
-    """Delete active screen
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Revert back to the original screen layout, before fullscreen area overlay"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def delete(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Delete active screen"""
 
 def drivers_editor_show(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Show drivers editor in a separate window
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Show drivers editor in a separate window"""
 
 def frame_jump(
     execution_context: int | str | None = None,
@@ -187,13 +157,10 @@ def frame_jump(
     /,
     *,
     end: bool | None = False,
-):
+) -> None:
     """Jump to first/last frame in frame range
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param end: Last Frame, Jump to the last frame of the frame range
-    :type end: bool | None
     """
 
 def frame_offset(
@@ -202,30 +169,25 @@ def frame_offset(
     /,
     *,
     delta: int | None = 0,
-):
+) -> None:
     """Move current frame forward/backward by a given number
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param delta: Delta
-    :type delta: int | None
     """
 
 def header_toggle_menus(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Expand or collapse the header pulldown menus
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def info_log_show(execution_context: int | str | None = None, undo: bool | None = None):
-    """Show info log in a separate window
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Expand or collapse the header pull-down menus"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def info_log_show(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Show info log in a separate window"""
 
 def keyframe_jump(
     execution_context: int | str | None = None,
@@ -233,13 +195,10 @@ def keyframe_jump(
     /,
     *,
     next: bool | None = True,
-):
+) -> None:
     """Jump to previous/next keyframe
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param next: Next Keyframe
-    :type next: bool | None
     """
 
 def marker_jump(
@@ -248,81 +207,78 @@ def marker_jump(
     /,
     *,
     next: bool | None = True,
-):
+) -> None:
     """Jump to previous/next marker
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param next: Next Marker
-    :type next: bool | None
-    """
-
-def new(execution_context: int | str | None = None, undo: bool | None = None):
-    """Add a new screen
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
     """
 
-def redo_last(execution_context: int | str | None = None, undo: bool | None = None):
-    """Display parameters for last action performed
+def new(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Add a new screen"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def quadview_size(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Resize Quad View areas"""
 
-def region_blend(execution_context: int | str | None = None, undo: bool | None = None):
-    """Blend in and out overlapping region
+def redo_last(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Display parameters for last action performed"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def region_blend(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Blend in and out overlapping region"""
 
 def region_context_menu(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Display region context menu
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def region_flip(execution_context: int | str | None = None, undo: bool | None = None):
-    """Toggle the region's alignment (left/right or top/bottom)
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Display region context menu"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def region_flip(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Toggle the regions alignment (left/right or top/bottom)"""
 
 def region_quadview(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Split selected area into camera, front, right, and top views
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def region_scale(execution_context: int | str | None = None, undo: bool | None = None):
-    """Scale selected area
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Split selected area into camera, front, right, and top views"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def region_scale(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Scale selected area"""
 
 def region_toggle(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     /,
     *,
-    region_type: bpy._typing.rna_enums.RegionTypeItems | None = "WINDOW",
-):
+    region_type: bpy.stub_internal.rna_enums.RegionTypeItems | None = "WINDOW",
+) -> None:
     """Hide or unhide the region
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param region_type: Region Type, Type of the region to toggle
-    :type region_type: bpy._typing.rna_enums.RegionTypeItems | None
     """
 
 def repeat_history(
@@ -331,21 +287,18 @@ def repeat_history(
     /,
     *,
     index: int | None = 0,
-):
+) -> None:
     """Display menu for previous actions performed
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param index: Index
-    :type index: int | None
     """
 
-def repeat_last(execution_context: int | str | None = None, undo: bool | None = None):
-    """Repeat last action
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def repeat_last(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Repeat last action"""
 
 def screen_full_area(
     execution_context: int | str | None = None,
@@ -353,13 +306,10 @@ def screen_full_area(
     /,
     *,
     use_hide_panels: bool | None = False,
-):
+) -> None:
     """Toggle display selected area as fullscreen/maximized
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param use_hide_panels: Hide Panels, Hide all the panels
-    :type use_hide_panels: bool | None
+    :param use_hide_panels: Hide Panels, Hide all the panels (Focus Mode)
     """
 
 def screen_set(
@@ -368,13 +318,10 @@ def screen_set(
     /,
     *,
     delta: int | None = 1,
-):
+) -> None:
     """Cycle through available screens
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param delta: Delta
-    :type delta: int | None
     """
 
 def screenshot(
@@ -395,7 +342,6 @@ def screenshot(
     filter_text: bool | None = False,
     filter_archive: bool | None = False,
     filter_btx: bool | None = False,
-    filter_collada: bool | None = False,
     filter_alembic: bool | None = False,
     filter_usd: bool | None = False,
     filter_obj: bool | None = False,
@@ -410,57 +356,31 @@ def screenshot(
     ]
     | None = "DEFAULT",
     sort_method: str | None = "",
-):
+) -> None:
     """Capture a picture of the whole Blender window
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param filepath: File Path, Path to file
-        :type filepath: str
         :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
-        :type hide_props_region: bool | None
         :param check_existing: Check Existing, Check and warn on overwriting existing files
-        :type check_existing: bool | None
         :param filter_blender: Filter .blend files
-        :type filter_blender: bool | None
         :param filter_backup: Filter .blend files
-        :type filter_backup: bool | None
         :param filter_image: Filter image files
-        :type filter_image: bool | None
         :param filter_movie: Filter movie files
-        :type filter_movie: bool | None
         :param filter_python: Filter Python files
-        :type filter_python: bool | None
         :param filter_font: Filter font files
-        :type filter_font: bool | None
         :param filter_sound: Filter sound files
-        :type filter_sound: bool | None
         :param filter_text: Filter text files
-        :type filter_text: bool | None
         :param filter_archive: Filter archive files
-        :type filter_archive: bool | None
         :param filter_btx: Filter btx files
-        :type filter_btx: bool | None
-        :param filter_collada: Filter COLLADA files
-        :type filter_collada: bool | None
         :param filter_alembic: Filter Alembic files
-        :type filter_alembic: bool | None
         :param filter_usd: Filter USD files
-        :type filter_usd: bool | None
         :param filter_obj: Filter OBJ files
-        :type filter_obj: bool | None
         :param filter_volume: Filter OpenVDB volume files
-        :type filter_volume: bool | None
         :param filter_folder: Filter folders
-        :type filter_folder: bool | None
         :param filter_blenlib: Filter Blender IDs
-        :type filter_blenlib: bool | None
         :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
-        :type filemode: int | None
         :param show_multiview: Enable Multi-View
-        :type show_multiview: bool | None
         :param use_multiview: Use Multi-View
-        :type use_multiview: bool | None
         :param display_type: Display Type
 
     DEFAULT
@@ -474,9 +394,7 @@ def screenshot(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
-        :type sort_method: str | None
     """
 
 def screenshot_area(
@@ -497,7 +415,6 @@ def screenshot_area(
     filter_text: bool | None = False,
     filter_archive: bool | None = False,
     filter_btx: bool | None = False,
-    filter_collada: bool | None = False,
     filter_alembic: bool | None = False,
     filter_usd: bool | None = False,
     filter_obj: bool | None = False,
@@ -512,57 +429,31 @@ def screenshot_area(
     ]
     | None = "DEFAULT",
     sort_method: str | None = "",
-):
+) -> None:
     """Capture a picture of an editor
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param filepath: File Path, Path to file
-        :type filepath: str
         :param hide_props_region: Hide Operator Properties, Collapse the region displaying the operator settings
-        :type hide_props_region: bool | None
         :param check_existing: Check Existing, Check and warn on overwriting existing files
-        :type check_existing: bool | None
         :param filter_blender: Filter .blend files
-        :type filter_blender: bool | None
         :param filter_backup: Filter .blend files
-        :type filter_backup: bool | None
         :param filter_image: Filter image files
-        :type filter_image: bool | None
         :param filter_movie: Filter movie files
-        :type filter_movie: bool | None
         :param filter_python: Filter Python files
-        :type filter_python: bool | None
         :param filter_font: Filter font files
-        :type filter_font: bool | None
         :param filter_sound: Filter sound files
-        :type filter_sound: bool | None
         :param filter_text: Filter text files
-        :type filter_text: bool | None
         :param filter_archive: Filter archive files
-        :type filter_archive: bool | None
         :param filter_btx: Filter btx files
-        :type filter_btx: bool | None
-        :param filter_collada: Filter COLLADA files
-        :type filter_collada: bool | None
         :param filter_alembic: Filter Alembic files
-        :type filter_alembic: bool | None
         :param filter_usd: Filter USD files
-        :type filter_usd: bool | None
         :param filter_obj: Filter OBJ files
-        :type filter_obj: bool | None
         :param filter_volume: Filter OpenVDB volume files
-        :type filter_volume: bool | None
         :param filter_folder: Filter folders
-        :type filter_folder: bool | None
         :param filter_blenlib: Filter Blender IDs
-        :type filter_blenlib: bool | None
         :param filemode: File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
-        :type filemode: int | None
         :param show_multiview: Enable Multi-View
-        :type show_multiview: bool | None
         :param use_multiview: Use Multi-View
-        :type use_multiview: bool | None
         :param display_type: Display Type
 
     DEFAULT
@@ -576,9 +467,7 @@ def screenshot_area(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
-        :type sort_method: str | None
     """
 
 def space_context_cycle(
@@ -587,13 +476,10 @@ def space_context_cycle(
     /,
     *,
     direction: typing.Literal["PREV", "NEXT"] | None = "NEXT",
-):
+) -> None:
     """Cycle through the editor context by activating the next/previous one
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param direction: Direction, Direction to cycle through
-    :type direction: typing.Literal['PREV','NEXT'] | None
     """
 
 def space_type_set_or_cycle(
@@ -601,23 +487,30 @@ def space_type_set_or_cycle(
     undo: bool | None = None,
     /,
     *,
-    space_type: bpy._typing.rna_enums.SpaceTypeItems | None = "EMPTY",
-):
+    space_type: bpy.stub_internal.rna_enums.SpaceTypeItems | None = "EMPTY",
+) -> None:
     """Set the space type or cycle subtype
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param space_type: Type
-    :type space_type: bpy._typing.rna_enums.SpaceTypeItems | None
     """
 
 def spacedata_cleanup(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Remove unused settings for invisible editors
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Remove unused settings for invisible editors"""
+
+def time_jump(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    backward: bool | None = False,
+) -> None:
+    """Jump forward/backward by a given number of frames or seconds
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
+    :param backward: Backwards, Jump backwards in time
     """
 
 def userpref_show(
@@ -625,14 +518,11 @@ def userpref_show(
     undo: bool | None = None,
     /,
     *,
-    section: bpy._typing.rna_enums.PreferenceSectionItems | None = "INTERFACE",
-):
+    section: bpy.stub_internal.rna_enums.PreferenceSectionItems | None = "INTERFACE",
+) -> None:
     """Edit user preferences and system settings
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param section: Section to activate in the Preferences
-    :type section: bpy._typing.rna_enums.PreferenceSectionItems | None
     """
 
 def workspace_cycle(
@@ -641,11 +531,8 @@ def workspace_cycle(
     /,
     *,
     direction: typing.Literal["PREV", "NEXT"] | None = "NEXT",
-):
+) -> None:
     """Cycle through workspaces
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param direction: Direction, Direction to cycle through
-    :type direction: typing.Literal['PREV','NEXT'] | None
     """