fake-bge-module 20250103__py3-none-any.whl → 20250201__py3-none-any.whl

bpy/{typing → _typing/rna_enums}/__init__.pyi

@@ -441,7 +441,7 @@ type CurvesHandleTypeItems = typing.Literal[
     "FREE",  # Free.The handle can be moved anywhere, and doesn't influence the point's other handle.
     "AUTO",  # Auto.The location is automatically calculated to be smooth.
     "VECTOR",  # Vector.The location is calculated to point to the next/previous control point.
-    "ALIGN",  # Align.The location is constrained to point in the opposite direction as the other handleW.
+    "ALIGN",  # Align.The location is constrained to point in the opposite direction as the other handle.
 ]
 type CurvesTypeItems = typing.Literal[
     "CATMULL_ROM",  # Catmull Rom.
@@ -592,7 +592,7 @@ type EventTypeItems = typing.Literal[
     "ESC",  # Esc.
     "TAB",  # Tab.
     "RET",  # Return.Enter.
-    "SPACE",  # Spacebar.Space.
+    "SPACE",  # Space Bar.Spacebar.
     "LINE_FEED",  # Line Feed.
     "BACK_SPACE",  # Backspace.BkSpace.
     "DEL",  # Delete.Del.
@@ -1582,15 +1582,15 @@ type IconItems = typing.Literal[
     "COLLECTION_COLOR_06",  # COLLECTION_COLOR_06.
     "COLLECTION_COLOR_07",  # COLLECTION_COLOR_07.
     "COLLECTION_COLOR_08",  # COLLECTION_COLOR_08.
-    "SEQUENCE_COLOR_01",  # SEQUENCE_COLOR_01.
-    "SEQUENCE_COLOR_02",  # SEQUENCE_COLOR_02.
-    "SEQUENCE_COLOR_03",  # SEQUENCE_COLOR_03.
-    "SEQUENCE_COLOR_04",  # SEQUENCE_COLOR_04.
-    "SEQUENCE_COLOR_05",  # SEQUENCE_COLOR_05.
-    "SEQUENCE_COLOR_06",  # SEQUENCE_COLOR_06.
-    "SEQUENCE_COLOR_07",  # SEQUENCE_COLOR_07.
-    "SEQUENCE_COLOR_08",  # SEQUENCE_COLOR_08.
-    "SEQUENCE_COLOR_09",  # SEQUENCE_COLOR_09.
+    "STRIP_COLOR_01",  # STRIP_COLOR_01.
+    "STRIP_COLOR_02",  # STRIP_COLOR_02.
+    "STRIP_COLOR_03",  # STRIP_COLOR_03.
+    "STRIP_COLOR_04",  # STRIP_COLOR_04.
+    "STRIP_COLOR_05",  # STRIP_COLOR_05.
+    "STRIP_COLOR_06",  # STRIP_COLOR_06.
+    "STRIP_COLOR_07",  # STRIP_COLOR_07.
+    "STRIP_COLOR_08",  # STRIP_COLOR_08.
+    "STRIP_COLOR_09",  # STRIP_COLOR_09.
     "LIBRARY_DATA_INDIRECT",  # LIBRARY_DATA_INDIRECT.
     "LIBRARY_DATA_OVERRIDE_NONEDITABLE",  # LIBRARY_DATA_OVERRIDE_NONEDITABLE.
     "LAYERGROUP_COLOR_01",  # LAYERGROUP_COLOR_01.
@@ -2042,9 +2042,9 @@ type NodeClampItems = typing.Literal[
     "RANGE",  # Range.Constrain value between min and max, swapping arguments when min > max.
 ]
 type NodeCombsepColorItems = typing.Literal[
-    "RGB",  # RGB.Use RGB color processing.
-    "HSV",  # HSV.Use HSV color processing.
-    "HSL",  # HSL.Use HSL color processing.
+    "RGB",  # RGB.Use RGB (Red, Green, Blue) color processing.
+    "HSV",  # HSV.Use HSV (Hue, Saturation, Value) color processing.
+    "HSL",  # HSL.Use HSL (Hue, Saturation, Lightness) color processing.
 ]
 type NodeCompareOperationItems = typing.Literal[
     "LESS_THAN",  # Less Than.True when the first input is smaller than second input.
@@ -2739,28 +2739,6 @@ type RigidbodyObjectTypeItems = typing.Literal[
     "ACTIVE",  # Active.Object is directly controlled by simulation results.
     "PASSIVE",  # Passive.Object is directly controlled by animation system.
 ]
-type SequenceModifierTypeItems = typing.Literal[
-    "BRIGHT_CONTRAST",  # Brightness/Contrast.
-    "COLOR_BALANCE",  # Color Balance.
-    "CURVES",  # Curves.
-    "HUE_CORRECT",  # Hue Correct.
-    "MASK",  # Mask.
-    "TONEMAP",  # Tone Map.
-    "WHITE_BALANCE",  # White Balance.
-    "SOUND_EQUALIZER",  # Sound Equalizer.
-]
-type SequenceSoundModifierTypeItems = typing.Literal[
-    "SOUND_EQUALIZER",  # Sound Equalizer.
-]
-type SequenceVideoModifierTypeItems = typing.Literal[
-    "BRIGHT_CONTRAST",  # Brightness/Contrast.
-    "COLOR_BALANCE",  # Color Balance.
-    "CURVES",  # Curves.
-    "HUE_CORRECT",  # Hue Correct.
-    "MASK",  # Mask.
-    "TONEMAP",  # Tone Map.
-    "WHITE_BALANCE",  # White Balance.
-]
 type ShadingTypeItems = typing.Literal[
     "WIREFRAME",  # Wireframe.Display the object as wire edges.
     "SOLID",  # Solid.Display in solid mode.
@@ -2879,6 +2857,28 @@ type StripColorItems = typing.Literal[
     "COLOR_08",  # Color 08.
     "COLOR_09",  # Color 09.
 ]
+type StripModifierTypeItems = typing.Literal[
+    "BRIGHT_CONTRAST",  # Brightness/Contrast.
+    "COLOR_BALANCE",  # Color Balance.
+    "CURVES",  # Curves.
+    "HUE_CORRECT",  # Hue Correct.
+    "MASK",  # Mask.
+    "TONEMAP",  # Tone Map.
+    "WHITE_BALANCE",  # White Balance.
+    "SOUND_EQUALIZER",  # Sound Equalizer.
+]
+type StripSoundModifierTypeItems = typing.Literal[
+    "SOUND_EQUALIZER",  # Sound Equalizer.
+]
+type StripVideoModifierTypeItems = typing.Literal[
+    "BRIGHT_CONTRAST",  # Brightness/Contrast.
+    "COLOR_BALANCE",  # Color Balance.
+    "CURVES",  # Curves.
+    "HUE_CORRECT",  # Hue Correct.
+    "MASK",  # Mask.
+    "TONEMAP",  # Tone Map.
+    "WHITE_BALANCE",  # White Balance.
+]
 type SubdivisionBoundarySmoothItems = typing.Literal[
     "PRESERVE_CORNERS",  # Keep Corners.Smooth boundaries, but corners are kept sharp.
     "ALL",  # All.Smooth boundaries, including corners.

bpy/app/__init__.pyi

@@ -14,7 +14,7 @@ bpy.app.timers.rst
 import typing
 import collections.abc
 import typing_extensions
-import bpy.typing
+import bpy._typing.rna_enums
 
 from . import handlers as handlers
 from . import icons as icons
@@ -28,11 +28,11 @@ def help_text(all: bool | None = False):
     :type all: bool | None
     """
 
-def is_job_running(job_type: bpy.typing.WmJobTypeItems):
+def is_job_running(job_type: bpy._typing.rna_enums.WmJobTypeItems):
     """Check whether a job of the given type is running.
 
     :param job_type: job type in `rna_enum_wm_job_type_items`.
-    :type job_type: bpy.typing.WmJobTypeItems
+    :type job_type: bpy._typing.rna_enums.WmJobTypeItems
     :return: Whether a job of the given type is currently running.
     """
 
@@ -192,6 +192,10 @@ ffmpeg: typing.Any
 """ Constant value bpy.app.ffmpeg(supported=True, avcodec_version=(60, 31, 102), avcodec_version_string='60, 31, 102', avdevice_version=(60, 3, 100), avdevice_version_string='60,  3, 100', avformat_version=(60, 16, 100), avformat_version_string='60, 16, 100', avutil_version=(58, 29, 100), avutil_version_string='58, 29, 100', swscale_version=(7, 5, 100), swscale_version_string=' 7,  5, 100')
 """
 
+module: typing.Any
+""" Boolean, True when running Blender as a python module
+"""
+
 ocio: typing.Any
 """ Constant value bpy.app.ocio(supported=True, version=(2, 3, 2), version_string=' 2,  3,  2')
 """
@@ -216,6 +220,10 @@ openvdb: typing.Any
 """ Constant value bpy.app.openvdb(supported=True, version=(11, 0, 0), version_string='11,  0,  0')
 """
 
+portable: typing.Any
+""" Boolean, True unless blender was built to reference absolute paths (on UNIX).
+"""
+
 python_args: typing.Any
 """ Leading arguments to use when calling Python directly (via sys.executable). These arguments match settings Blender uses to ensure Python runs with a compatible environment (read-only).
 """
@@ -249,7 +257,7 @@ use_userpref_skip_save_on_exit: typing.Any
 """
 
 version: tuple[int, int, int]
-""" The Blender version as a tuple of 3 numbers. eg. (2, 83, 1)
+""" The Blender version as a tuple of 3 numbers (major, minor, micro). eg. (4, 3, 1)
 """
 
 version_cycle: typing.Any
@@ -257,7 +265,7 @@ version_cycle: typing.Any
 """
 
 version_file: typing.Any
-""" The Blender version, as a tuple, last used to save a .blend file, compatible with bpy.data.version. This value should be used for handling compatibility changes between Blender versions
+""" The Blender File version, as a tuple of 3 numbers (major, minor, file sub-version), that will be used to save a .blend file. The last item in this tuple indicates the file sub-version, which is different from the release micro version (the last item of the bpy.app.version tuple). The file sub-version can be incremented multiple times while a Blender version is under development. This value is, and should be, used for handling compatibility changes between Blender versions
 """
 
 version_string: typing.Any

bpy/app/handlers/__init__.pyi

@@ -80,11 +80,13 @@ composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """ on a compositing background job (before)
 """
 
-depsgraph_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
+depsgraph_update_post: list[
+    collections.abc.Callable[[bpy.types.Scene, bpy.types.Depsgraph], None]
+]
 """ on depsgraph update (post)
 """
 
-depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
+depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene, None], None]]
 """ on depsgraph update (pre)
 """
 

bpy/app/icons/__init__.pyi

@@ -2,10 +2,13 @@ import typing
 import collections.abc
 import typing_extensions
 
-def new_triangles(range, coords: bytes | None, colors: bytes | None) -> int:
+def new_triangles(
+    range: tuple[int, int] | None, coords: bytes | None, colors: bytes | None
+) -> int:
     """Create a new icon from triangle geometry.
 
     :param range: Pair of ints.
+    :type range: tuple[int, int] | None
     :param coords: Sequence of bytes (6 floats for one triangle) for (X, Y) coordinates.
     :type coords: bytes | None
     :param colors: Sequence of bytes (12 for one triangles) for RGBA.
@@ -14,10 +17,11 @@ def new_triangles(range, coords: bytes | None, colors: bytes | None) -> int:
     :rtype: int
     """
 
-def new_triangles_from_file(filepath) -> int:
+def new_triangles_from_file(filepath: str | None) -> int:
     """Create a new icon from triangle geometry.
 
     :param filepath: File path.
+    :type filepath: str | None
     :return: Unique icon value (pass to interface icon_value argument).
     :rtype: int
     """

bpy/app/translations/__init__.pyi

@@ -67,67 +67,76 @@ def locale_explode(locale):
     :return: A tuple (language, country, variant, language_country, language@variant).
     """
 
-def pgettext(msgid: str | None, msgctxt=None):
+def pgettext(msgid: str | None, msgctxt: None | str | None = None):
     """Try to translate the given msgid (with optional msgctxt).
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_data(msgid: str | None, msgctxt=None):
+def pgettext_data(msgid: str | None, msgctxt: None | str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_iface(msgid: str | None, msgctxt=None):
+def pgettext_iface(msgid: str | None, msgctxt: None | str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_n(msgid: str | None, msgctxt=None):
+def pgettext_n(msgid: str | None, msgctxt: None | str | None = None):
     """Extract the given msgid to translation files. This is a no-op function that will only mark the string to extract, but not perform the actual translation.
 
     :param msgid: The string to extract.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The original string.
     """
 
-def pgettext_rpt(msgid: str | None, msgctxt=None):
+def pgettext_rpt(msgid: str | None, msgctxt: None | str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if reports' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def pgettext_tip(msgid: str | None, msgctxt=None):
+def pgettext_tip(msgid: str | None, msgctxt: None | str | None = None):
     """Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.
 
     :param msgid: The string to translate.
     :type msgid: str | None
     :param msgctxt: The translation context (defaults to BLT_I18NCONTEXT_DEFAULT).
+    :type msgctxt: None | str | None
     :return: The translated string (or msgid if no translation was found).
     """
 
-def register(module_name: str | None, translations_dict):
+def register(
+    module_name: str | None, translations_dict: dict[str, dict[str, str]] | None
+):
     """Registers an addon's UI translations.
 
         :param module_name: The name identifying the addon.
         :type module_name: str | None
         :param translations_dict: A dictionary built like that:
     {locale: {msg_key: msg_translation, ...}, ...}
+        :type translations_dict: dict[str, dict[str, str]] | None
     """
 
 def unregister(module_name: str | None):
@@ -138,7 +147,7 @@ def unregister(module_name: str | None):
     """
 
 contexts: typing.Any
-""" Constant value bpy.app.translations.contexts(default_real=None, default='*', operator_default='Operator', ui_events_keymaps='UI_Events_KeyMaps', plural='Plural', id_action='Action', id_armature='Armature', id_brush='Brush', id_cachefile='CacheFile', id_camera='Camera', id_collection='Collection', id_curves='Curves', id_curve='Curve', id_fs_linestyle='FreestyleLineStyle', id_gpencil='GPencil', id_id='ID', id_image='Image', id_lattice='Lattice', id_library='Library', id_light='Light', id_lightprobe='LightProbe', id_mask='Mask', id_material='Material', id_mesh='Mesh', id_metaball='Metaball', id_movieclip='MovieClip', id_nodetree='NodeTree', id_object='Object', id_paintcurve='PaintCurve', id_palette='Palette', id_particlesettings='ParticleSettings', id_pointcloud='PointCloud', id_scene='Scene', id_screen='Screen', id_sequence='Sequence', id_shapekey='Key', id_simulation='Simulation', id_sound='Sound', id_speaker='Speaker', id_text='Text', id_texture='Texture', id_vfont='VFont', id_volume='Volume', id_windowmanager='WindowManager', id_workspace='WorkSpace', id_world='World', editor_filebrowser='File browser', editor_python_console='Python console', editor_preferences='Preferences', editor_view3d='View3D', amount='Amount', color='Color', constraint='Constraint', time='Time', unit='Unit')
+""" Constant value bpy.app.translations.contexts(default_real=None, default='*', operator_default='Operator', ui_events_keymaps='UI_Events_KeyMaps', plural='Plural', id_action='Action', id_armature='Armature', id_brush='Brush', id_cachefile='CacheFile', id_camera='Camera', id_collection='Collection', id_curves='Curves', id_curve='Curve', id_fs_linestyle='FreestyleLineStyle', id_gpencil='GPencil', id_id='ID', id_image='Image', id_lattice='Lattice', id_library='Library', id_light='Light', id_lightprobe='LightProbe', id_mask='Mask', id_material='Material', id_mesh='Mesh', id_metaball='Metaball', id_movieclip='MovieClip', id_nodetree='NodeTree', id_object='Object', id_paintcurve='PaintCurve', id_palette='Palette', id_particlesettings='ParticleSettings', id_pointcloud='PointCloud', id_scene='Scene', id_screen='Screen', id_sequence='Sequence', id_shapekey='Key', id_simulation='Simulation', id_sound='Sound', id_speaker='Speaker', id_text='Text', id_texture='Texture', id_vfont='VFont', id_volume='Volume', id_windowmanager='WindowManager', id_workspace='WorkSpace', id_world='World', editor_filebrowser='File browser', editor_python_console='Python console', editor_preferences='Preferences', editor_view3d='View3D', amount='Amount', color='Color', constraint='Constraint', modifier='Modifier', navigation='Navigation', render_layer='Render Layer', time='Time', unit='Unit')
 """
 
 contexts_C_to_py: typing.Any

bpy/msgbus/__init__.pyi

@@ -47,11 +47,14 @@ see bpy.app.handlers.load_post.
 import typing
 import collections.abc
 import typing_extensions
+import bpy.types
 
 def clear_by_owner(owner):
     """Clear all subscribers using this owner."""
 
-def publish_rna(key):
+def publish_rna(
+    key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None,
+):
     """Notify subscribers of changes to this property
     (this typically doesn't need to be called explicitly since changes will automatically publish updates).
     In some cases it may be useful to publish changes explicitly using more general keys.
@@ -62,9 +65,16 @@ def publish_rna(key):
     - A property instance.
     - A struct type.
     - A tuple representing a (struct, property name) pair.
+        :type key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None
     """
 
-def subscribe_rna(key, owner, args, notify, options=set()):
+def subscribe_rna(
+    key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None,
+    owner: typing.Any | None,
+    args,
+    notify,
+    options=set(),
+):
     """Register a message bus subscription. It will be cleared when another blend file is
     loaded, or can be cleared explicitly via `bpy.msgbus.clear_by_owner`.
 
@@ -74,7 +84,9 @@ def subscribe_rna(key, owner, args, notify, options=set()):
     - A property instance.
     - A struct type.
     - A tuple representing a (struct, property name) pair.
+        :type key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None
         :param owner: Handle for this subscription (compared by identity).
+        :type owner: typing.Any | None
         :param options: Change the behavior of the subscriber.
 
     PERSISTENT when set, the subscriber will be kept when remapping ID data.