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

bpy/ops/particle/__init__.pyi

@@ -1,6 +1,7 @@
 import typing
 import collections.abc
 import typing_extensions
+import numpy.typing as npt
 import bpy.types
 
 def brush_edit(
@@ -11,15 +12,11 @@ def brush_edit(
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
     pen_flip: bool | None = False,
-):
+) -> None:
     """Apply a stroke of brush to the particles
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param stroke: Stroke
-    :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
-    :param pen_flip: Pen Flip, Whether a tablet's eraser mode is being used
-    :type pen_flip: bool | None
+    :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
     """
 
 def connect_hair(
@@ -28,13 +25,10 @@ def connect_hair(
     /,
     *,
     all: bool | None = False,
-):
+) -> None:
     """Connect hair to the emitter mesh
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param all: All Hair, Connect all hair systems to the emitter mesh
-    :type all: bool | None
     """
 
 def copy_particle_systems(
@@ -45,23 +39,18 @@ def copy_particle_systems(
     space: typing.Literal["OBJECT", "WORLD"] | None = "OBJECT",
     remove_target_particles: bool | None = True,
     use_active: bool | None = False,
-):
+) -> None:
     """Copy particle systems from the active object to selected objects
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param space: Space, Space transform for copying from one object to another
 
     OBJECT
-    Object -- Copy inside each object's local space.
+    Object -- Copy inside each objects local space.
 
     WORLD
     World -- Copy in world space.
-        :type space: typing.Literal['OBJECT','WORLD'] | None
         :param remove_target_particles: Remove Target Particles, Remove particle systems on the target objects
-        :type remove_target_particles: bool | None
         :param use_active: Use Active, Use the active particle system from the context
-        :type use_active: bool | None
     """
 
 def delete(
@@ -70,13 +59,10 @@ def delete(
     /,
     *,
     type: typing.Literal["PARTICLE", "KEY"] | None = "PARTICLE",
-):
+) -> None:
     """Delete selected particles or keys
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param type: Type, Delete a full particle or only keys
-    :type type: typing.Literal['PARTICLE','KEY'] | None
     """
 
 def disconnect_hair(
@@ -85,13 +71,10 @@ def disconnect_hair(
     /,
     *,
     all: bool | None = False,
-):
+) -> None:
     """Disconnect hair from the emitter mesh
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param all: All Hair, Disconnect all hair systems from the emitter mesh
-    :type all: bool | None
     """
 
 def duplicate_particle_system(
@@ -100,64 +83,53 @@ def duplicate_particle_system(
     /,
     *,
     use_duplicate_settings: bool | None = False,
-):
+) -> None:
     """Duplicate particle system within the active object
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param use_duplicate_settings: Duplicate Settings, Duplicate settings as well, so the new particle system uses its own settings
-    :type use_duplicate_settings: bool | None
     """
 
-def dupliob_copy(execution_context: int | str | None = None, undo: bool | None = None):
-    """Duplicate the current instance object
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def dupliob_copy(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Duplicate the current instance object"""
 
 def dupliob_move_down(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Move instance object down in the list
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move instance object down in the list"""
 
 def dupliob_move_up(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Move instance object up in the list
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move instance object up in the list"""
 
 def dupliob_refresh(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Refresh list of instance objects and their weights
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Refresh list of instance objects and their weights"""
 
 def dupliob_remove(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Remove the selected instance object
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def edited_clear(execution_context: int | str | None = None, undo: bool | None = None):
-    """Undo all edition performed on the particle system
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Remove the selected instance object"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def edited_clear(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Undo all edition performed on the particle system"""
 
 def hair_dynamics_preset_add(
     execution_context: int | str | None = None,
@@ -167,17 +139,12 @@ def hair_dynamics_preset_add(
     name: str = "",
     remove_name: bool | None = False,
     remove_active: bool | None = False,
-):
+) -> None:
     """Add or remove a Hair Dynamics Preset
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param name: Name, Name of the preset, used to make the path name
-    :type name: str
     :param remove_name: remove_name
-    :type remove_name: bool | None
     :param remove_active: remove_active
-    :type remove_active: bool | None
     """
 
 def hide(
@@ -186,44 +153,46 @@ def hide(
     /,
     *,
     unselected: bool | None = False,
-):
+) -> None:
     """Hide selected particles
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param unselected: Unselected, Hide unselected rather than selected
-    :type unselected: bool | None
-    """
-
-def mirror(execution_context: int | str | None = None, undo: bool | None = None):
-    """Duplicate and mirror the selected particles along the local X axis
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
     """
 
-def new(execution_context: int | str | None = None, undo: bool | None = None):
-    """Add new particle settings
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def mirror(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Duplicate and mirror the selected particles along the local X axis"""
 
-def new_target(execution_context: int | str | None = None, undo: bool | None = None):
-    """Add a new particle target
+def new(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Add new particle settings"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def new_target(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Add a new particle target"""
 
 def particle_edit_toggle(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Toggle particle edit mode
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Toggle particle edit mode"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def particle_system_remove_all(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Remove all particle system within the active object"""
 
 def rekey(
     execution_context: int | str | None = None,
@@ -231,13 +200,10 @@ def rekey(
     /,
     *,
     keys_number: int | None = 2,
-):
+) -> None:
     """Change the number of keys of selected particles (root and tip keys included)
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param keys_number: Number of Keys
-    :type keys_number: int | None
     """
 
 def remove_doubles(
@@ -246,13 +212,10 @@ def remove_doubles(
     /,
     *,
     threshold: float | None = 0.0002,
-):
+) -> None:
     """Remove selected particles close enough of others
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param threshold: Merge Distance, Threshold distance within which particles are removed
-    :type threshold: float | None
     """
 
 def reveal(
@@ -261,13 +224,10 @@ def reveal(
     /,
     *,
     select: bool | None = True,
-):
+) -> None:
     """Show hidden particles
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param select: Select
-    :type select: bool | None
     """
 
 def select_all(
@@ -276,11 +236,9 @@ def select_all(
     /,
     *,
     action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
-):
-    """(De)select all particles' keys
+) -> None:
+    """(De)select all particles keys
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param action: Action, Selection action to execute
 
     TOGGLE
@@ -294,22 +252,21 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
-    """
-
-def select_less(execution_context: int | str | None = None, undo: bool | None = None):
-    """Deselect boundary selected keys of each particle
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
     """
 
-def select_linked(execution_context: int | str | None = None, undo: bool | None = None):
-    """Select all keys linked to already selected ones
+def select_less(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Deselect boundary selected keys of each particle"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def select_linked(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Select all keys linked to already selected ones"""
 
 def select_linked_pick(
     execution_context: int | str | None = None,
@@ -318,23 +275,19 @@ def select_linked_pick(
     *,
     deselect: bool | None = False,
     location: collections.abc.Iterable[int] | None = (0, 0),
-):
+) -> None:
     """Select nearest particle from mouse pointer
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
     :param deselect: Deselect, Deselect linked keys rather than selecting them
-    :type deselect: bool | None
     :param location: Location
-    :type location: collections.abc.Iterable[int] | None
     """
 
-def select_more(execution_context: int | str | None = None, undo: bool | None = None):
-    """Select keys linked to boundary selected keys of each particle
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def select_more(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Select keys linked to boundary selected keys of each particle"""
 
 def select_random(
     execution_context: int | str | None = None,
@@ -345,15 +298,11 @@ def select_random(
     seed: int | None = 0,
     action: typing.Literal["SELECT", "DESELECT"] | None = "SELECT",
     type: typing.Literal["HAIR", "POINTS"] | None = "HAIR",
-):
+) -> None:
     """Select a randomly distributed set of hair or points
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param ratio: Ratio, Portion of items to select randomly
-        :type ratio: float | None
         :param seed: Random Seed, Seed for the random number generator
-        :type seed: int | None
         :param action: Action, Selection action to execute
 
     SELECT
@@ -361,9 +310,7 @@ def select_random(
 
     DESELECT
     Deselect -- Deselect all elements.
-        :type action: typing.Literal['SELECT','DESELECT'] | None
         :param type: Type, Select either hair or points
-        :type type: typing.Literal['HAIR','POINTS'] | None
     """
 
 def select_roots(
@@ -372,11 +319,9 @@ def select_roots(
     /,
     *,
     action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "SELECT",
-):
+) -> None:
     """Select roots of all visible particles
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param action: Action, Selection action to execute
 
     TOGGLE
@@ -390,7 +335,6 @@ def select_roots(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
 def select_tips(
@@ -399,11 +343,9 @@ def select_tips(
     /,
     *,
     action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "SELECT",
-):
+) -> None:
     """Select tips of all visible particles
 
-        :type execution_context: int | str | None
-        :type undo: bool | None
         :param action: Action, Selection action to execute
 
     TOGGLE
@@ -417,54 +359,49 @@ def select_tips(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
-def shape_cut(execution_context: int | str | None = None, undo: bool | None = None):
-    """Cut hair to conform to the set shape object
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def subdivide(execution_context: int | str | None = None, undo: bool | None = None):
-    """Subdivide selected particles segments (adds keys)
+def shape_cut(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Cut hair to conform to the set shape object"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def subdivide(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Subdivide selected particles segments (adds keys)"""
 
 def target_move_down(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Move particle target down in the list
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move particle target down in the list"""
 
 def target_move_up(
-    execution_context: int | str | None = None, undo: bool | None = None
-):
-    """Move particle target up in the list
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
-
-def target_remove(execution_context: int | str | None = None, undo: bool | None = None):
-    """Remove the selected particle target
-
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Move particle target up in the list"""
 
-def unify_length(execution_context: int | str | None = None, undo: bool | None = None):
-    """Make selected hair the same length
+def target_remove(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Remove the selected particle target"""
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    """
+def unify_length(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
+    """Make selected hair the same length"""
 
 def weight_set(
     execution_context: int | str | None = None,
@@ -472,11 +409,8 @@ def weight_set(
     /,
     *,
     factor: float | None = 1.0,
-):
+) -> None:
     """Set the weight of selected keys
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param factor: Factor, Interpolation factor between current brush weight, and keys' weights
-    :type factor: float | None
+    :param factor: Factor, Interpolation factor between current brush weight, and keys weights
     """