fake-bpy-module 20240803__py3-none-any.whl → 20240804__py3-none-any.whl

bpy/ops/scene/__init__.pyi

@@ -53,7 +53,17 @@ def freestyle_alpha_modifier_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ALONG_STROKE",
+    type: typing.Literal[
+        "ALONG_STROKE",
+        "CREASE_ANGLE",
+        "CURVATURE_3D",
+        "DISTANCE_FROM_CAMERA",
+        "DISTANCE_FROM_OBJECT",
+        "MATERIAL",
+        "NOISE",
+        "TANGENT",
+    ]
+    | None = "ALONG_STROKE",
 ):
     """Add an alpha transparency modifier to the line style associated with the active lineset
 
@@ -61,7 +71,7 @@ def freestyle_alpha_modifier_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['ALONG_STROKE', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'] | None
     """
 
     ...
@@ -71,7 +81,17 @@ def freestyle_color_modifier_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ALONG_STROKE",
+    type: typing.Literal[
+        "ALONG_STROKE",
+        "CREASE_ANGLE",
+        "CURVATURE_3D",
+        "DISTANCE_FROM_CAMERA",
+        "DISTANCE_FROM_OBJECT",
+        "MATERIAL",
+        "NOISE",
+        "TANGENT",
+    ]
+    | None = "ALONG_STROKE",
 ):
     """Add a line color modifier to the line style associated with the active lineset
 
@@ -79,7 +99,7 @@ def freestyle_color_modifier_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['ALONG_STROKE', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'] | None
     """
 
     ...
@@ -89,7 +109,7 @@ def freestyle_fill_range_by_selection(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "COLOR",
+    type: typing.Literal["COLOR", "ALPHA", "THICKNESS"] | None = "COLOR",
     name: str = "",
 ):
     """Fill the Range Min/Max entries by the min/max distance between selected mesh objects and the source object (either a user-specified object or the active camera)
@@ -107,7 +127,7 @@ def freestyle_fill_range_by_selection(
 
     THICKNESS
     Thickness -- Thickness modifier type.
-        :type type: str | None
+        :type type: typing.Literal['COLOR','ALPHA','THICKNESS'] | None
         :param name: Name, Name of the modifier to work on
         :type name: str
     """
@@ -119,7 +139,23 @@ def freestyle_geometry_modifier_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "2D_OFFSET",
+    type: typing.Literal[
+        "2D_OFFSET",
+        "2D_TRANSFORM",
+        "BACKBONE_STRETCHER",
+        "BEZIER_CURVE",
+        "BLUEPRINT",
+        "GUIDING_LINES",
+        "PERLIN_NOISE_1D",
+        "PERLIN_NOISE_2D",
+        "POLYGONIZATION",
+        "SAMPLING",
+        "SIMPLIFICATION",
+        "SINUS_DISPLACEMENT",
+        "SPATIAL_NOISE",
+        "TIP_REMOVER",
+    ]
+    | None = "2D_OFFSET",
 ):
     """Add a stroke geometry modifier to the line style associated with the active lineset
 
@@ -127,7 +163,7 @@ def freestyle_geometry_modifier_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['2D_OFFSET', '2D_TRANSFORM', 'BACKBONE_STRETCHER', 'BEZIER_CURVE', 'BLUEPRINT', 'GUIDING_LINES', 'PERLIN_NOISE_1D', 'PERLIN_NOISE_2D', 'POLYGONIZATION', 'SAMPLING', 'SIMPLIFICATION', 'SINUS_DISPLACEMENT', 'SPATIAL_NOISE', 'TIP_REMOVER'] | None
     """
 
     ...
@@ -165,7 +201,7 @@ def freestyle_lineset_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Change the position of the active line set within the list of line sets
 
@@ -173,7 +209,7 @@ def freestyle_lineset_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to move the active line set towards
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -239,7 +275,7 @@ def freestyle_modifier_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move the modifier within the list of modifiers
 
@@ -247,7 +283,7 @@ def freestyle_modifier_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to move the chosen modifier towards
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -285,7 +321,7 @@ def freestyle_module_move(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Change the position of the style module within in the list of style modules
 
@@ -293,7 +329,7 @@ def freestyle_module_move(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to move the chosen style module towards
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -352,7 +388,18 @@ def freestyle_thickness_modifier_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ALONG_STROKE",
+    type: typing.Literal[
+        "ALONG_STROKE",
+        "CALLIGRAPHY",
+        "CREASE_ANGLE",
+        "CURVATURE_3D",
+        "DISTANCE_FROM_CAMERA",
+        "DISTANCE_FROM_OBJECT",
+        "MATERIAL",
+        "NOISE",
+        "TANGENT",
+    ]
+    | None = "ALONG_STROKE",
 ):
     """Add a line thickness modifier to the line style associated with the active lineset
 
@@ -360,7 +407,7 @@ def freestyle_thickness_modifier_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['ALONG_STROKE', 'CALLIGRAPHY', 'CREASE_ANGLE', 'CURVATURE_3D', 'DISTANCE_FROM_CAMERA', 'DISTANCE_FROM_OBJECT', 'MATERIAL', 'NOISE', 'TANGENT'] | None
     """
 
     ...
@@ -432,7 +479,7 @@ def new(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "NEW",
+    type: typing.Literal["NEW", "EMPTY", "LINK_COPY", "FULL_COPY"] | None = "NEW",
 ):
     """Add new scene by type
 
@@ -452,7 +499,7 @@ def new(
 
     FULL_COPY
     Full Copy -- Make a full copy of the current scene.
-        :type type: str | None
+        :type type: typing.Literal['NEW','EMPTY','LINK_COPY','FULL_COPY'] | None
     """
 
     ...
@@ -462,7 +509,7 @@ def new_sequencer(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "NEW",
+    type: typing.Literal["NEW", "EMPTY", "LINK_COPY", "FULL_COPY"] | None = "NEW",
 ):
     """Add new scene by type in the sequence editor and assign to active strip
 
@@ -482,7 +529,7 @@ def new_sequencer(
 
     FULL_COPY
     Full Copy -- Make a full copy of the current scene.
-        :type type: str | None
+        :type type: typing.Literal['NEW','EMPTY','LINK_COPY','FULL_COPY'] | None
     """
 
     ...
@@ -520,7 +567,7 @@ def view_layer_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "NEW",
+    type: typing.Literal["NEW", "COPY", "EMPTY"] | None = "NEW",
 ):
     """Add a view layer
 
@@ -537,7 +584,7 @@ def view_layer_add(
 
     EMPTY
     Blank -- Add a new view layer with all collections disabled.
-        :type type: str | None
+        :type type: typing.Literal['NEW','COPY','EMPTY'] | None
     """
 
     ...

bpy/ops/screen/__init__.pyi

@@ -169,7 +169,7 @@ def area_split(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "HORIZONTAL",
+    direction: typing.Literal["HORIZONTAL", "VERTICAL"] | None = "HORIZONTAL",
     factor: float | None = 0.5,
     cursor: collections.abc.Iterable[int] | None = (0, 0),
 ):
@@ -179,7 +179,7 @@ def area_split(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction
-    :type direction: str | None
+    :type direction: typing.Literal['HORIZONTAL','VERTICAL'] | None
     :param factor: Factor
     :type factor: float | None
     :param cursor: Cursor
@@ -451,7 +451,25 @@ def region_toggle(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    region_type: str | None = "WINDOW",
+    region_type: typing.Literal[
+        "WINDOW",
+        "HEADER",
+        "CHANNELS",
+        "TEMPORARY",
+        "UI",
+        "TOOLS",
+        "TOOL_PROPS",
+        "ASSET_SHELF",
+        "ASSET_SHELF_HEADER",
+        "PREVIEW",
+        "HUD",
+        "NAVIGATION_BAR",
+        "EXECUTE",
+        "FOOTER",
+        "TOOL_HEADER",
+        "XR",
+    ]
+    | None = "WINDOW",
 ):
     """Hide or unhide the region
 
@@ -459,7 +477,7 @@ def region_toggle(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param region_type: Region Type, Type of the region to toggle
-    :type region_type: str | None
+    :type region_type: typing.Literal['WINDOW', 'HEADER', 'CHANNELS', 'TEMPORARY', 'UI', 'TOOLS', 'TOOL_PROPS', 'ASSET_SHELF', 'ASSET_SHELF_HEADER', 'PREVIEW', 'HUD', 'NAVIGATION_BAR', 'EXECUTE', 'FOOTER', 'TOOL_HEADER', 'XR'] | None
     """
 
     ...
@@ -560,7 +578,10 @@ def screenshot(
     filemode: int | None = 9,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Capture a picture of the whole Blender window
@@ -627,7 +648,7 @@ def screenshot(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -662,7 +683,10 @@ def screenshot_area(
     filemode: int | None = 9,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
 ):
     """Capture a picture of an editor
@@ -729,7 +753,7 @@ def screenshot_area(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
     """
@@ -741,7 +765,7 @@ def space_context_cycle(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "NEXT",
+    direction: typing.Literal["PREV", "NEXT"] | None = "NEXT",
 ):
     """Cycle through the editor context by activating the next/previous one
 
@@ -749,7 +773,7 @@ def space_context_cycle(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to cycle through
-    :type direction: str | None
+    :type direction: typing.Literal['PREV','NEXT'] | None
     """
 
     ...
@@ -759,7 +783,28 @@ def space_type_set_or_cycle(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    space_type: str | None = "EMPTY",
+    space_type: typing.Literal[
+        "EMPTY",
+        "VIEW_3D",
+        "IMAGE_EDITOR",
+        "NODE_EDITOR",
+        "SEQUENCE_EDITOR",
+        "CLIP_EDITOR",
+        "DOPESHEET_EDITOR",
+        "GRAPH_EDITOR",
+        "NLA_EDITOR",
+        "TEXT_EDITOR",
+        "CONSOLE",
+        "INFO",
+        "TOPBAR",
+        "STATUSBAR",
+        "OUTLINER",
+        "PROPERTIES",
+        "FILE_BROWSER",
+        "SPREADSHEET",
+        "PREFERENCES",
+    ]
+    | None = "EMPTY",
 ):
     """Set the space type or cycle subtype
 
@@ -767,7 +812,7 @@ def space_type_set_or_cycle(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param space_type: Type
-    :type space_type: str | None
+    :type space_type: typing.Literal['EMPTY', 'VIEW_3D', 'IMAGE_EDITOR', 'NODE_EDITOR', 'SEQUENCE_EDITOR', 'CLIP_EDITOR', 'DOPESHEET_EDITOR', 'GRAPH_EDITOR', 'NLA_EDITOR', 'TEXT_EDITOR', 'CONSOLE', 'INFO', 'TOPBAR', 'STATUSBAR', 'OUTLINER', 'PROPERTIES', 'FILE_BROWSER', 'SPREADSHEET', 'PREFERENCES'] | None
     """
 
     ...
@@ -791,7 +836,24 @@ def userpref_show(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    section: str | None = "INTERFACE",
+    section: typing.Literal[
+        "INTERFACE",
+        "VIEWPORT",
+        "LIGHTS",
+        "EDITING",
+        "ANIMATION",
+        "EXTENSIONS",
+        "ADDONS",
+        "THEMES",
+        "INPUT",
+        "NAVIGATION",
+        "KEYMAP",
+        "SYSTEM",
+        "SAVE_LOAD",
+        "FILE_PATHS",
+        "EXPERIMENTAL",
+    ]
+    | None = "INTERFACE",
 ):
     """Edit user preferences and system settings
 
@@ -799,7 +861,7 @@ def userpref_show(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param section: Section to activate in the Preferences
-    :type section: str | None
+    :type section: typing.Literal['INTERFACE', 'VIEWPORT', 'LIGHTS', 'EDITING', 'ANIMATION', 'EXTENSIONS', 'ADDONS', 'THEMES', 'INPUT', 'NAVIGATION', 'KEYMAP', 'SYSTEM', 'SAVE_LOAD', 'FILE_PATHS', 'EXPERIMENTAL'] | None
     """
 
     ...
@@ -809,7 +871,7 @@ def workspace_cycle(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "NEXT",
+    direction: typing.Literal["PREV", "NEXT"] | None = "NEXT",
 ):
     """Cycle through workspaces
 
@@ -817,7 +879,7 @@ def workspace_cycle(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction, Direction to cycle through
-    :type direction: str | None
+    :type direction: typing.Literal['PREV','NEXT'] | None
     """
 
     ...