fake-bge-module 20250312__py3-none-any.whl → 20260203__py3-none-any.whl

bpy/app/handlers/__init__.pyi

@@ -42,60 +42,65 @@ Below is an example of a mesh that is altered from a handler:
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 import bpy.types
 
 animation_playback_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on ending animation playback
+""" on ending animation playback. Accepts two arguments: The scene data-block and the dependency graph being updated
 """
 
 animation_playback_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on starting animation playback
+""" on starting animation playback. Accepts two arguments: The scene data-block and the dependency graph being updated
 """
 
 annotation_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on drawing an annotation (after)
+""" on drawing an annotation (after). Accepts two arguments: the annotation data-block and dependency graph
 """
 
 annotation_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on drawing an annotation (before)
+""" on drawing an annotation (before). Accepts two arguments: the annotation data-block and dependency graph
 """
 
 blend_import_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on linking or appending data (after), get a single BlendImportContext parameter
+""" on linking or appending data (after). Accepts one argument: a BlendImportContext
 """
 
 blend_import_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on linking or appending data (before), get a single BlendImportContext parameter
+""" on linking or appending data (before). Accepts one argument: a BlendImportContext
 """
 
 composite_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on a compositing background job (cancel)
+""" on a compositing background job (cancel). Accepts one argument: the scene data-block
 """
 
 composite_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on a compositing background job (after)
+""" on a compositing background job (after). Accepts one argument: the scene data-block
 """
 
 composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on a compositing background job (before)
+""" on a compositing background job (before). Accepts one argument: the scene data-block
 """
 
 depsgraph_update_post: list[
     collections.abc.Callable[[bpy.types.Scene, bpy.types.Depsgraph], None]
 ]
-""" on depsgraph update (post)
+""" on depsgraph update (post). Accepts two arguments: The scene data-block and the dependency graph being updated
 """
 
 depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene, None], None]]
-""" on depsgraph update (pre)
+""" on depsgraph update (pre). Accepts two arguments: The scene data-block and the dependency graph being updated
+"""
+
+exit_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
+""" just before Blender shuts down, while all data is still valid. Accepts one boolean argument. True indicates either that a user has been using Blender and exited, or that Blender is exiting in a circumstance that should be treated as if that were the case. False indicates that Blender is running in background mode, or is exiting due to failed command line arguments, etc.
 """
 
 frame_change_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" Called after frame change for playback and rendering, after the data has been evaluated for the new frame.
+""" Called after frame change for playback and rendering, after the data has been evaluated for the new frame. Accepts two arguments: The scene data-block and the dependency graph being updated
 """
 
 frame_change_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" Called after frame change for playback and rendering, before any data is evaluated for the new frame. This makes it possible to change data and relations (for example swap an object to another mesh) for the new frame. Note that this handler is not to be used as 'before the frame changes' event. The dependency graph is not available in this handler, as data and relations may have been altered and the dependency graph has not yet been updated for that.
+""" Called after frame change for playback and rendering, before any data is evaluated for the new frame. This makes it possible to change data and relations (for example swap an object to another mesh) for the new frame. Note that this handler is not to be used as before the frame changes event. The dependency graph is not available in this handler, as data and relations may have been altered and the dependency graph has not yet been updated for that. Accepts two arguments: The scene data-block and the dependency graph being updated
 """
 
 game_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
@@ -127,15 +132,15 @@ load_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """
 
 object_bake_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on canceling a bake job; will be called in the main thread
+""" on canceling a bake job; will be called in the main thread. Accepts one argument: the object data-block being baked
 """
 
 object_bake_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on completing a bake job; will be called in the main thread
+""" on completing a bake job; will be called in the main thread. Accepts one argument: the object data-block being baked
 """
 
 object_bake_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" before starting a bake job
+""" before starting a bake job. Accepts one argument: the object data-block being baked
 """
 
 persistent: typing.Any
@@ -151,15 +156,15 @@ redo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
 """
 
 render_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on canceling a render job
+""" on canceling a render job. Accepts one argument: the scene data-block being rendered
 """
 
 render_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on completion of render job
+""" on completion of render job. Accepts one argument: the scene data-block being rendered
 """
 
 render_init: list[collections.abc.Callable[[bpy.types.Scene], None]]
-""" on initialization of a render job
+""" on initialization of a render job. Accepts one argument: the scene data-block being rendered
 """
 
 render_post: list[collections.abc.Callable[[bpy.types.Scene], None]]

bpy/app/icons/__init__.pyi

@@ -1,6 +1,7 @@
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
 def new_triangles(
     range: tuple[int, int] | None, coords: bytes | None, colors: bytes | None
@@ -8,23 +9,17 @@ def new_triangles(
     """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.
-    :type colors: bytes | None
     :return: Unique icon value (pass to interface icon_value argument).
-    :rtype: 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
     """
 
-def release(icon_id):
+def release(icon_id) -> None:
     """Release the icon."""

bpy/app/timers/__init__.pyi

@@ -19,35 +19,26 @@
 
 ```../examples/bpy.app.timers.4.py```
 
-
---------------------
-
-You should never modify Blender data at arbitrary points in time in separate threads.
-However you can use a queue to collect all the actions that should be executed when Blender is in the right state again.
-Pythons queue.Queue can be used here, because it implements the required locking semantics.
-
-```../examples/bpy.app.timers.5.py```
-
 """
 
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
 def is_registered(function: collections.abc.Callable[[], float | None]) -> bool:
     """Check if this function is registered as a timer.
 
     :param function: Function to check.
-    :type function: collections.abc.Callable[[], float | None]
     :return: True when this function is registered, otherwise False.
-    :rtype: bool
     """
 
 def register(
     function: collections.abc.Callable[[], float | None],
+    *,
     first_interval: float | None = 0,
     persistent: bool | None = False,
-):
+) -> None:
     """Add a new function that will be called after the specified amount of seconds.
     The function gets no arguments and is expected to return either None or a float.
     If None is returned, the timer will be unregistered.
@@ -55,16 +46,12 @@ def register(
     functools.partial can be used to assign some parameters.
 
         :param function: The function that should called.
-        :type function: collections.abc.Callable[[], float | None]
         :param first_interval: Seconds until the callback should be called the first time.
-        :type first_interval: float | None
-        :param persistent: Don't remove timer when a new file is loaded.
-        :type persistent: bool | None
+        :param persistent: Dont remove timer when a new file is loaded.
     """
 
-def unregister(function: collections.abc.Callable[[], float | None]):
+def unregister(function: collections.abc.Callable[[], float | None]) -> None:
     """Unregister timer.
 
     :param function: Function to unregister.
-    :type function: collections.abc.Callable[[], float | None]
     """

bpy/app/translations/__init__.pyi

@@ -11,12 +11,12 @@ If you are a regular add-on, you should only bother about contexts member,
 and the register/unregister functions! The pgettext family of functions
 should only be used in rare, specific cases (like e.g. complex "composited" UI strings...).
 
-To add translations to your python script, you must define a dictionary formatted like that:
+To add translations to your Python script, you must define a dictionary formatted like that:
 {locale: {msg_key: msg_translation, ...}, ...}
 
  where:
 
-* locale is either a lang iso code (e.g. fr
+* locale is either a lang ISO code (e.g. fr
 
 ), a lang+country code (e.g. pt_BR
 
@@ -43,7 +43,7 @@ bpy.app.translations.unregister(__name__)
 The Manage UI translations
 
  add-on has several functions to help you collect strings to translate, and
-generate the needed python code (the translation dictionary), as well as optional intermediary po files
+generate the needed Python code (the translation dictionary), as well as optional intermediary po files
 if you want some... See
 How to Translate Blender and
 Using i18n in Blender Code
@@ -59,99 +59,85 @@ for more info.
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 
-def locale_explode(locale):
+def locale_explode(locale) -> None:
     """Return all components and their combinations of the given ISO locale string.For non-complete locales, missing elements will be None.
 
     :param locale: The ISO locale string to explode.
     :return: A tuple (language, country, variant, language_country, language@variant).
     """
 
-def pgettext(msgid: str | None, msgctxt: None | str | None = None):
+def pgettext(msgid: str | None, msgctxt: None | str | None = 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 | str | None = None):
-    """Try to translate the given msgid (with optional msgctxt), if new data name's translation is enabled.
+def pgettext_data(msgid: str | None, msgctxt: None | str | None = None) -> None:
+    """Try to translate the given msgid (with optional msgctxt), if new data names 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 | str | None = None):
-    """Try to translate the given msgid (with optional msgctxt), if labels' translation is enabled.
+def pgettext_iface(msgid: str | None, msgctxt: None | str | None = 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 | str | None = None):
+def pgettext_n(msgid: str | None, msgctxt: None | str | None = 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 | str | None = None):
-    """Try to translate the given msgid (with optional msgctxt), if reports' translation is enabled.
+def pgettext_rpt(msgid: str | None, msgctxt: None | str | None = 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 | str | None = None):
-    """Try to translate the given msgid (with optional msgctxt), if tooltips' translation is enabled.
+def pgettext_tip(msgid: str | None, msgctxt: None | str | None = 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: dict[str, dict[str, str]] | None
-):
-    """Registers an addon's UI translations.
+) -> None:
+    """Registers an addons 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):
-    """Unregisters an addon's UI translations.
+def unregister(module_name: str | None) -> None:
+    """Unregisters an addons UI translations.
 
     :param module_name: The name identifying the addon.
-    :type 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', modifier='Modifier', navigation='Navigation', render_layer='Render Layer', 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, countable=Countable, id_action=Action, id_armature=Armature, no_translation=Do not translate, 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
-""" A readonly dict mapping contexts' C-identifiers to their py-identifiers.
+""" A readonly dict mapping contexts C-identifiers to their py-identifiers.
 """
 
 locale: typing.Any

bpy/msgbus/__init__.pyi

@@ -1,6 +1,6 @@
 """
 The message bus system can be used to receive notifications when properties of
-Blender datablocks are changed via the data API.
+Blender data-blocks are changed via the data API.
 
 
 --------------------
@@ -18,6 +18,18 @@ The following updates do not trigger message bus notifications:
 * Moving objects in the 3D Viewport.
 * Changes performed by the animation system.
 
+Changes done from msgbus
+
+ callbacks are not included in related undo steps,
+so users can easily skip their effects by using Undo followed by Redo.
+
+Unlike properties update
+
+ callbacks, message bus update callbacks are postponed
+until all operators have finished executing.
+Additionally, for each property the callback is only triggered once per update cycle,
+even if the property was changed multiple times during that period.
+
 
 --------------------
 
@@ -47,16 +59,17 @@ see bpy.app.handlers.load_post.
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 import bpy.types
 
-def clear_by_owner(owner):
+def clear_by_owner(owner) -> None:
     """Clear all subscribers using this owner."""
 
 def publish_rna(
     key: bpy.types.Property | bpy.types.Struct | tuple[bpy.types.Struct, str] | None,
-):
+) -> None:
     """Notify subscribers of changes to this property
-    (this typically doesn't need to be called explicitly since changes will automatically publish updates).
+    (this typically doesnt 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.
 
         :param key: Represents the type of data being subscribed to
@@ -65,7 +78,6 @@ def publish_rna(
     - 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(
@@ -73,8 +85,9 @@ def subscribe_rna(
     owner: typing.Any | None,
     args,
     notify,
-    options=set(),
-):
+    *,
+    options: set[str] | None = set(),
+) -> None:
     """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`.
 
@@ -84,9 +97,7 @@ def subscribe_rna(
     - 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.

bpy/ops/__init__.pyi

@@ -2,8 +2,8 @@
 
 --------------------
 
-Provides python access to calling operators, this includes operators written in
-C, Python or macros.
+Provides Python access to calling operators, this includes operators written in
+C++, Python or macros.
 
 Only keyword arguments can be used to pass operator properties.
 
@@ -20,6 +20,20 @@ Common return values are {'FINISHED'}
 meaning that the operator execution was aborted without making any changes or
 saving an undo history entry.
 
+If operator was cancelled but there wasn't any reports from it with {'ERROR'}
+
+ type,
+it will just return {'CANCELLED'}
+
+ without raising any exceptions.
+However, if there are error reports, a RuntimeError
+
+ will be raised
+after the operator finishes execution, including all error report messages,
+regardless of the return status (even if it was {'FINISHED'}
+
+).
+
 Calling an operator in the wrong context will raise a RuntimeError
 
 ,
@@ -30,7 +44,7 @@ Note that the operator ID (bl_idname) in this example is mesh.subdivide
 ,
 bpy.ops
 
- is just the access path for python.
+ is just the access path for Python.
 
 
 --------------------
@@ -158,11 +172,14 @@ bpy.ops.*
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 from . import action as action
 from . import anim as anim
 from . import armature as armature
 from . import asset as asset
+from . import bge_bricknodes as bge_bricknodes
 from . import boid as boid
+from . import bricknodes as bricknodes
 from . import brush as brush
 from . import buttons as buttons
 from . import cachefile as cachefile
@@ -195,6 +212,7 @@ from . import import_scene as import_scene
 from . import info as info
 from . import lattice as lattice
 from . import logic as logic
+from . import logic_nodes as logic_nodes
 from . import marker as marker
 from . import mask as mask
 from . import material as material