fake-bpy-module-latest 20260115__py3-none-any.whl → 20260125__py3-none-any.whl

_bpy_internal/__init__.pyi

@@ -6,6 +6,7 @@ from . import addons as addons
 from . import assets as assets
 from . import disk_file_hash_service as disk_file_hash_service
 from . import extensions as extensions
-from . import freedesktop as freedesktop
+from . import filesystem as filesystem
 from . import grease_pencil as grease_pencil
+from . import platform as platform
 from . import system_info as system_info

_bpy_internal/filesystem/__init__.pyi

@@ -0,0 +1,5 @@
+import typing
+import collections.abc
+import typing_extensions
+import numpy.typing as npt
+from . import locking as locking

_bpy_internal/filesystem/locking/__init__.pyi

@@ -0,0 +1,28 @@
+import typing
+import collections.abc
+import typing_extensions
+import numpy.typing as npt
+
+class MutexAcquisitionError:
+    """Raised when mutex_lock_and_open_with_retry() cannot obtain a lock."""
+
+    args: typing.Any
+
+def mutex_lock_and_open(file_path, mode) -> None:
+    """Obtain an exclusive lock on a file.Create a file on disk, and immediately lock it for exclusive use by this
+    process.
+
+        :return: If the file was opened & locked succesfully, a tuple (file,
+    unlocker) is returned. Otherwise returns None. The caller should call
+    unlocker(file) to unlock the mutex.
+    """
+
+def mutex_lock_and_open_with_retry(
+    file_path, mode, *, max_tries, wait_time_sec
+) -> None:
+    """Obtain an exclusive lock on a file, retrying when that fails.See mutex_lock_and_open() for the lock semantics, and the first two parameters.
+
+        :param max_tries: number of times the code attempts to acquire the lock.
+        :return: A tuple (file, unlocker) is returned. The caller should call
+    unlocker(file) to unlock the mutex.
+    """

_bpy_internal/platform/__init__.pyi

@@ -0,0 +1,5 @@
+import typing
+import collections.abc
+import typing_extensions
+import numpy.typing as npt
+from . import freedesktop as freedesktop

bl_operators/node/__init__.pyi

@@ -564,6 +564,13 @@ class NODE_OT_swap_zone(NodeSwapOperator, ZoneOperator, _bpy_types.Operator):
         :param context:
         """
 
+    @staticmethod
+    def get_child_items(node) -> None:
+        """
+
+        :param node:
+        """
+
     @staticmethod
     def get_zone_pair(tree, node) -> None:
         """
@@ -572,6 +579,13 @@ class NODE_OT_swap_zone(NodeSwapOperator, ZoneOperator, _bpy_types.Operator):
         :param node:
         """
 
+    def transfer_zone_sockets(self, old_node, new_node) -> None:
+        """
+
+        :param old_node:
+        :param new_node:
+        """
+
 class NODE_OT_tree_path_parent(_bpy_types.Operator):
     """Go to parent node tree"""
 

bl_ui/generic_ui_list/__init__.pyi

@@ -114,7 +114,7 @@ class UILIST_OT_entry_remove(GenericUIListOperator, _bpy_types.Operator):
 
 def draw_ui_list(
     layout: bpy.types.UILayout,
-    context: bpy.types.Context,
+    context: _bpy_types.Context,
     class_name: str = "UI_UL_list",
     *,
     unique_id: str,

bpy/app/__init__.pyi

@@ -122,6 +122,10 @@ build_type: bytes
 """ The type of build (Release, Debug)
 """
 
+cachedir: None | str
+""" String, the cache directory used by blender (read-only).If the parent of the cache folder (i.e. the part of the path that is not Blender-specific) does not exist, returns None.
+"""
+
 debug: bool
 """ Boolean, for debug info (started with --debug / --debug-* matching this attribute name).
 """
@@ -199,11 +203,11 @@ module: bool
 """
 
 ocio: typing.Any
-""" Constant value bpy.app.ocio(supported=True, version=(2, 4, 2), version_string= 2,  4,  2)
+""" Constant value bpy.app.ocio(supported=True, version=(2, 5, 0), version_string= 2,  5,  0)
 """
 
 oiio: typing.Any
-""" Constant value bpy.app.oiio(supported=True, version=(3, 0, 9), version_string= 3,  0,  9)
+""" Constant value bpy.app.oiio(supported=True, version=(3, 1, 7), version_string= 3,  1,  7)
 """
 
 online_access: bool
@@ -215,11 +219,11 @@ online_access_override: bool
 """
 
 opensubdiv: typing.Any
-""" Constant value bpy.app.opensubdiv(supported=True, version=(3, 6, 0), version_string= 3,  6,  0)
+""" Constant value bpy.app.opensubdiv(supported=True, version=(3, 7, 0), version_string= 3,  7,  0)
 """
 
 openvdb: typing.Any
-""" Constant value bpy.app.openvdb(supported=True, version=(12, 0, 0), version_string=12,  0,  0)
+""" Constant value bpy.app.openvdb(supported=True, version=(13, 0, 0), version_string=13,  0,  0)
 """
 
 portable: bool

bpy/app/handlers/__init__.pyi

@@ -91,6 +91,10 @@ depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene, None], Non
 """ 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. Accepts two arguments: The scene data-block and the dependency graph being updated
 """

bpy/ops/grease_pencil/__init__.pyi

@@ -66,7 +66,8 @@ def brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Draw a new stroke in the active Grease Pencil object
@@ -79,12 +80,19 @@ def brush_stroke(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 
@@ -1042,7 +1050,8 @@ def sculpt_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Sculpt strokes in the active Grease Pencil object
@@ -1055,12 +1064,19 @@ def sculpt_paint(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 
@@ -1600,7 +1616,8 @@ def vertex_brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Draw on vertex colors in the active Grease Pencil object
@@ -1613,12 +1630,19 @@ def vertex_brush_stroke(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 
@@ -1750,7 +1774,8 @@ def weight_brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Draw weight on stroke points in the active Grease Pencil object
@@ -1763,12 +1788,19 @@ def weight_brush_stroke(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 

bpy/ops/mesh/__init__.pyi

@@ -593,17 +593,22 @@ def edgering_select(
     undo: bool | None = None,
     /,
     *,
+    delimit_edge_ring: set[bpy.stub_internal.rna_enums.MeshWalkDelimitEdgeRingItems]
+    | None = {"NGONS"},
     extend: bool | None = False,
     deselect: bool | None = False,
     toggle: bool | None = False,
-    ring: bool | None = True,
+    object_index: int | None = -1,
+    edge_index: int | None = -1,
+    vert_index: int | None = -1,
+    face_index: int | None = -1,
 ) -> None:
     """Select an edge ring
 
-    :param extend: Extend, Extend the selection
+    :param delimit_edge_ring: Edge Ring Delimit, Delimit edge ring selection
+    :param extend: Extend Select, Extend the selection
     :param deselect: Deselect, Remove from the selection
     :param toggle: Toggle Select, Toggle the selection
-    :param ring: Select Ring, Select ring
     """
 
 def edges_select_sharp(
@@ -1075,34 +1080,30 @@ def knife_tool(
         :param wait_for_input: Wait for Input
     """
 
-def loop_multi_select(
-    execution_context: int | str | None = None,
-    undo: bool | None = None,
-    /,
-    *,
-    ring: bool | None = False,
-) -> None:
-    """Select a loop of connected edges by connection type
-
-    :param ring: Ring
-    """
-
 def loop_select(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     /,
     *,
+    delimit_edge_loop: set[bpy.stub_internal.rna_enums.MeshWalkDelimitEdgeLoopItems]
+    | None = {"NGONS", "OUTER_CORNERS"},
+    delimit_face_loop: set[bpy.stub_internal.rna_enums.MeshWalkDelimitFaceLoopItems]
+    | None = {},
     extend: bool | None = False,
     deselect: bool | None = False,
     toggle: bool | None = False,
-    ring: bool | None = False,
+    object_index: int | None = -1,
+    edge_index: int | None = -1,
+    vert_index: int | None = -1,
+    face_index: int | None = -1,
 ) -> None:
     """Select a loop of connected edges
 
+    :param delimit_edge_loop: Boundary Delimit, Delimit edge loop selection
+    :param delimit_face_loop: Face Loop Delimit, Delimit face loop selection
     :param extend: Extend Select, Extend the selection
     :param deselect: Deselect, Remove from the selection
     :param toggle: Toggle Select, Toggle the selection
-    :param ring: Select Ring, Select ring
     """
 
 def loop_to_region(
@@ -2299,6 +2300,32 @@ def select_by_pole_count(
     :param exclude_nonmanifold: Exclude Non Manifold, Exclude non-manifold poles
     """
 
+def select_edge_loop_multi(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    delimit_edge_loop: set[bpy.stub_internal.rna_enums.MeshWalkDelimitEdgeLoopItems]
+    | None = {"NGONS", "OUTER_CORNERS"},
+) -> None:
+    """Select loops of connected edges from each selected edge
+
+    :param delimit_edge_loop: Boundary Delimit, Delimit edge loop selection
+    """
+
+def select_edge_ring_multi(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    delimit_edge_ring: set[bpy.stub_internal.rna_enums.MeshWalkDelimitEdgeRingItems]
+    | None = {"NGONS"},
+) -> None:
+    """Select rings of connected edges from each selected edge
+
+    :param delimit_edge_ring: Edge Ring Delimit, Delimit edge ring selection
+    """
+
 def select_face_by_sides(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/node/__init__.pyi

@@ -960,6 +960,44 @@ def field_to_grid_item_remove(
     :param node_identifier: Node Identifier, Optional identifier of the node to operate on
     """
 
+def field_to_list_item_add(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    node_identifier: int | None = 0,
+) -> None:
+    """Add item below active item
+
+    :param node_identifier: Node Identifier, Optional identifier of the node to operate on
+    """
+
+def field_to_list_item_move(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
+    node_identifier: int | None = 0,
+) -> None:
+    """Move active item
+
+    :param direction: Direction, Move direction
+    :param node_identifier: Node Identifier, Optional identifier of the node to operate on
+    """
+
+def field_to_list_item_remove(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    node_identifier: int | None = 0,
+) -> None:
+    """Remove active item
+
+    :param node_identifier: Node Identifier, Optional identifier of the node to operate on
+    """
+
 def file_output_item_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/outliner/__init__.pyi

@@ -413,14 +413,14 @@ def id_remap(
     /,
     *,
     id_type: bpy.stub_internal.rna_enums.IdTypeItems | None = "OBJECT",
-    old_id: str | None = "",
-    new_id: str | None = "",
+    old_id: int | None = 0,
+    new_id: int | None = 0,
 ) -> None:
     """Undocumented, consider contributing.
 
     :param id_type: ID Type
-    :param old_id: Old ID, Old ID to replace
-    :param new_id: New ID, New ID to remap all selected IDs users to
+    :param old_id: Old ID, Old IDs session uid to remap data from
+    :param new_id: New ID, New IDs session uid to remap all selected IDs users to
     """
 
 def item_activate(

bpy/ops/paint/__init__.pyi

@@ -381,7 +381,8 @@ def image_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Paint a stroke into the image
@@ -394,12 +395,19 @@ def image_paint(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 
@@ -662,6 +670,20 @@ def vert_select_linked_pick(
     :param select: Select, Whether to select or deselect linked vertices under the cursor
     """
 
+def vert_select_loop(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    select: bool | None = True,
+    extend: bool | None = False,
+) -> None:
+    """Select vertex loop under the cursor
+
+    :param select: Select, If false, vertices will be deselected
+    :param extend: Extend, Extend the selection
+    """
+
 def vert_select_more(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -792,7 +814,8 @@ def vertex_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
     override_location: bool | None = False,
 ) -> None:
@@ -806,12 +829,19 @@ def vertex_paint(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :param override_location: Override Location, Override the given "location" array by recalculating object space positions from the provided "mouse_event" positions
     """
@@ -901,7 +931,8 @@ def weight_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
     override_location: bool | None = False,
 ) -> None:
@@ -915,12 +946,19 @@ def weight_paint(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :param override_location: Override Location, Override the given "location" array by recalculating object space positions from the provided "mouse_event" positions
     """

bpy/ops/preferences/__init__.pyi

@@ -220,6 +220,13 @@ def autoexec_path_remove(
     :param index: Index
     """
 
+def clear_filter(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Clear the search filter"""
+
 def copy_prev(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -427,6 +434,13 @@ def script_directory_remove(
     :param index: Index, Index of the script directory to remove
     """
 
+def start_filter(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Start entering filter text"""
+
 def studiolight_copy_settings(
     execution_context: int | str | None = None,
     undo: bool | None = None,

bpy/ops/sculpt/__init__.pyi

@@ -12,7 +12,8 @@ def brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
     override_location: bool | None = False,
     ignore_background_click: bool | None = False,
@@ -27,12 +28,19 @@ def brush_stroke(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :param override_location: Override Location, Override the given "location" array by recalculating object space positions from the provided "mouse_event" positions
         :param ignore_background_click: Ignore Background Click, Clicks on the background do not start the stroke

bpy/ops/sculpt_curves/__init__.pyi

@@ -11,7 +11,8 @@ def brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT"] | None = "NORMAL",
+    brush_toggle: typing.Literal["None", "SMOOTH", "ERASE", "MASK"] | None = "None",
     pen_flip: bool | None = False,
 ) -> None:
     """Sculpt curves using a brush
@@ -24,12 +25,19 @@ def brush_stroke(
 
     INVERT
     Invert -- Invert action of brush for duration of stroke.
+        :param brush_toggle: Temporary Brush Toggle Type, Brush to use for duration of stroke
+
+    None
+    None -- Apply brush normally.
 
     SMOOTH
-    Smooth -- Switch brush to smooth mode for duration of stroke.
+    Smooth -- Switch to smooth brush for duration of stroke.
 
     ERASE
-    Erase -- Switch brush to erase mode for duration of stroke.
+    Erase -- Switch to erase brush for duration of stroke.
+
+    MASK
+    Mask -- Switch to mask brush for duration of stroke.
         :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """