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

bpy/ops/outliner/__init__.pyi

@@ -29,7 +29,10 @@ def animdata_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CLEAR_ANIMDATA",
+    type: typing.Literal[
+        "CLEAR_ANIMDATA", "SET_ACT", "CLEAR_ACT", "REFRESH_DRIVERS", "CLEAR_DRIVERS"
+    ]
+    | None = "CLEAR_ANIMDATA",
 ):
     """Undocumented, consider contributing.
 
@@ -52,7 +55,7 @@ def animdata_operation(
 
     CLEAR_DRIVERS
     Clear Drivers.
-        :type type: str | None
+        :type type: typing.Literal['CLEAR_ANIMDATA','SET_ACT','CLEAR_ACT','REFRESH_DRIVERS','CLEAR_DRIVERS'] | None
     """
 
     ...
@@ -76,7 +79,18 @@ def collection_color_tag_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    color: str | None = "NONE",
+    color: typing.Literal[
+        "NONE",
+        "COLOR_01",
+        "COLOR_02",
+        "COLOR_03",
+        "COLOR_04",
+        "COLOR_05",
+        "COLOR_06",
+        "COLOR_07",
+        "COLOR_08",
+    ]
+    | None = "NONE",
 ):
     """Set a color tag for the selected collections
 
@@ -84,7 +98,7 @@ def collection_color_tag_set(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param color: Color Tag
-    :type color: str | None
+    :type color: typing.Literal['NONE', 'COLOR_01', 'COLOR_02', 'COLOR_03', 'COLOR_04', 'COLOR_05', 'COLOR_06', 'COLOR_07', 'COLOR_08'] | None
     """
 
     ...
@@ -438,7 +452,7 @@ def constraint_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ENABLE",
+    type: typing.Literal["ENABLE", "DISABLE", "DELETE"] | None = "ENABLE",
 ):
     """Undocumented, consider contributing.
 
@@ -446,7 +460,7 @@ def constraint_operation(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Constraint Operation
-    :type type: str | None
+    :type type: typing.Literal['ENABLE','DISABLE','DELETE'] | None
     """
 
     ...
@@ -604,7 +618,20 @@ def id_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "UNLINK",
+    type: typing.Literal[
+        "UNLINK",
+        "LOCAL",
+        "SINGLE",
+        "DELETE",
+        "REMAP",
+        "COPY",
+        "PASTE",
+        "ADD_FAKE",
+        "CLEAR_FAKE",
+        "RENAME",
+        "SELECT_LINKED",
+    ]
+    | None = "UNLINK",
 ):
     """General data-block management operations
 
@@ -645,7 +672,7 @@ def id_operation(
 
     SELECT_LINKED
     Select Linked.
-        :type type: str | None
+        :type type: typing.Literal['UNLINK','LOCAL','SINGLE','DELETE','REMAP','COPY','PASTE','ADD_FAKE','CLEAR_FAKE','RENAME','SELECT_LINKED'] | None
     """
 
     ...
@@ -669,7 +696,48 @@ def id_remap(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    id_type: str | None = "OBJECT",
+    id_type: typing.Literal[
+        "ACTION",
+        "ARMATURE",
+        "BRUSH",
+        "CACHEFILE",
+        "CAMERA",
+        "COLLECTION",
+        "CURVE",
+        "CURVES",
+        "FONT",
+        "GREASEPENCIL",
+        "GREASEPENCIL_V3",
+        "IMAGE",
+        "KEY",
+        "LATTICE",
+        "LIBRARY",
+        "LIGHT",
+        "LIGHT_PROBE",
+        "LINESTYLE",
+        "MASK",
+        "MATERIAL",
+        "MESH",
+        "META",
+        "MOVIECLIP",
+        "NODETREE",
+        "OBJECT",
+        "PAINTCURVE",
+        "PALETTE",
+        "PARTICLE",
+        "POINTCLOUD",
+        "SCENE",
+        "SCREEN",
+        "SOUND",
+        "SPEAKER",
+        "TEXT",
+        "TEXTURE",
+        "VOLUME",
+        "WINDOWMANAGER",
+        "WORKSPACE",
+        "WORLD",
+    ]
+    | None = "OBJECT",
     old_id: str | None = "",
     new_id: str | None = "",
 ):
@@ -679,7 +747,7 @@ def id_remap(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param id_type: ID Type
-    :type id_type: str | None
+    :type id_type: typing.Literal['ACTION', 'ARMATURE', 'BRUSH', 'CACHEFILE', 'CAMERA', 'COLLECTION', 'CURVE', 'CURVES', 'FONT', 'GREASEPENCIL', 'GREASEPENCIL_V3', 'IMAGE', 'KEY', 'LATTICE', 'LIBRARY', 'LIGHT', 'LIGHT_PROBE', 'LINESTYLE', 'MASK', 'MATERIAL', 'MESH', 'META', 'MOVIECLIP', 'NODETREE', 'OBJECT', 'PAINTCURVE', 'PALETTE', 'PARTICLE', 'POINTCLOUD', 'SCENE', 'SCREEN', 'SOUND', 'SPEAKER', 'TEXT', 'TEXTURE', 'VOLUME', 'WINDOWMANAGER', 'WORKSPACE', 'WORLD'] | None
     :param old_id: Old ID, Old ID to replace
     :type old_id: str | None
     :param new_id: New ID, New ID to remap all selected IDs' users to
@@ -798,7 +866,7 @@ def lib_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "DELETE",
+    type: typing.Literal["DELETE", "RELOCATE", "RELOAD"] | None = "DELETE",
 ):
     """Undocumented, consider contributing.
 
@@ -815,7 +883,7 @@ def lib_operation(
 
     RELOAD
     Reload -- Reload all data from this library.
-        :type type: str | None
+        :type type: typing.Literal['DELETE','RELOCATE','RELOAD'] | None
     """
 
     ...
@@ -839,8 +907,14 @@ def liboverride_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "OVERRIDE_LIBRARY_CREATE_HIERARCHY",
-    selection_set: str | None = "SELECTED",
+    type: typing.Literal[
+        "OVERRIDE_LIBRARY_CREATE_HIERARCHY",
+        "OVERRIDE_LIBRARY_RESET",
+        "OVERRIDE_LIBRARY_CLEAR_SINGLE",
+    ]
+    | None = "OVERRIDE_LIBRARY_CREATE_HIERARCHY",
+    selection_set: typing.Literal["SELECTED", "CONTENT", "SELECTED_AND_CONTENT"]
+    | None = "SELECTED",
 ):
     """Create, reset or clear library override hierarchies
 
@@ -857,7 +931,7 @@ def liboverride_operation(
 
     OVERRIDE_LIBRARY_CLEAR_SINGLE
     Clear -- Delete the selected local overrides and relink their usages to the linked data-blocks if possible, else reset them and mark them as non editable.
-        :type type: str | None
+        :type type: typing.Literal['OVERRIDE_LIBRARY_CREATE_HIERARCHY','OVERRIDE_LIBRARY_RESET','OVERRIDE_LIBRARY_CLEAR_SINGLE'] | None
         :param selection_set: Selection Set, Over which part of the tree items to apply the operation
 
     SELECTED
@@ -868,7 +942,7 @@ def liboverride_operation(
 
     SELECTED_AND_CONTENT
     Selected & Content -- Apply the operation over selected data-blocks and all their dependencies.
-        :type selection_set: str | None
+        :type selection_set: typing.Literal['SELECTED','CONTENT','SELECTED_AND_CONTENT'] | None
     """
 
     ...
@@ -878,8 +952,14 @@ def liboverride_troubleshoot_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "OVERRIDE_LIBRARY_RESYNC_HIERARCHY",
-    selection_set: str | None = "SELECTED",
+    type: typing.Literal[
+        "OVERRIDE_LIBRARY_RESYNC_HIERARCHY",
+        "OVERRIDE_LIBRARY_RESYNC_HIERARCHY_ENFORCE",
+        "OVERRIDE_LIBRARY_DELETE_HIERARCHY",
+    ]
+    | None = "OVERRIDE_LIBRARY_RESYNC_HIERARCHY",
+    selection_set: typing.Literal["SELECTED", "CONTENT", "SELECTED_AND_CONTENT"]
+    | None = "SELECTED",
 ):
     """Advanced operations over library override to help fix broken hierarchies
 
@@ -896,7 +976,7 @@ def liboverride_troubleshoot_operation(
 
     OVERRIDE_LIBRARY_DELETE_HIERARCHY
     Delete -- Delete the selected local overrides (including their hierarchies of override dependencies) and relink their usages to the linked data-blocks.
-        :type type: str | None
+        :type type: typing.Literal['OVERRIDE_LIBRARY_RESYNC_HIERARCHY','OVERRIDE_LIBRARY_RESYNC_HIERARCHY_ENFORCE','OVERRIDE_LIBRARY_DELETE_HIERARCHY'] | None
         :param selection_set: Selection Set, Over which part of the tree items to apply the operation
 
     SELECTED
@@ -907,7 +987,7 @@ def liboverride_troubleshoot_operation(
 
     SELECTED_AND_CONTENT
     Selected & Content -- Apply the operation over selected data-blocks and all their dependencies.
-        :type selection_set: str | None
+        :type selection_set: typing.Literal['SELECTED','CONTENT','SELECTED_AND_CONTENT'] | None
     """
 
     ...
@@ -931,7 +1011,7 @@ def modifier_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "APPLY",
+    type: typing.Literal["APPLY", "DELETE", "TOGVIS", "TOGREN"] | None = "APPLY",
 ):
     """Undocumented, consider contributing.
 
@@ -939,7 +1019,7 @@ def modifier_operation(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Modifier Operation
-    :type type: str | None
+    :type type: typing.Literal['APPLY','DELETE','TOGVIS','TOGREN'] | None
     """
 
     ...
@@ -949,7 +1029,8 @@ def object_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "SELECT",
+    type: typing.Literal["SELECT", "DESELECT", "SELECT_HIERARCHY", "REMAP", "RENAME"]
+    | None = "SELECT",
 ):
     """Undocumented, consider contributing.
 
@@ -972,7 +1053,7 @@ def object_operation(
 
     RENAME
     Rename.
-        :type type: str | None
+        :type type: typing.Literal['SELECT','DESELECT','SELECT_HIERARCHY','REMAP','RENAME'] | None
     """
 
     ...
@@ -1076,7 +1157,7 @@ def scene_operation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "DELETE",
+    type: typing.Literal["DELETE"] | None = "DELETE",
 ):
     """Context menu for scene operations
 
@@ -1084,7 +1165,7 @@ def scene_operation(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Scene Operation
-    :type type: str | None
+    :type type: typing.Literal['DELETE'] | None
     """
 
     ...
@@ -1112,7 +1193,7 @@ def select_all(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "TOGGLE",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
 ):
     """Toggle the Outliner selection of items
 
@@ -1132,7 +1213,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -1148,7 +1229,7 @@ def select_box(
     ymin: int | None = 0,
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
 ):
     """Use box selection to select tree elements
 
@@ -1177,7 +1258,7 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1187,7 +1268,7 @@ def select_walk(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN", "LEFT", "RIGHT"] | None = "UP",
     extend: bool | None = False,
     toggle_all: bool | None = False,
 ):
@@ -1197,7 +1278,7 @@ def select_walk(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Walk Direction, Select/Deselect element in this direction
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN','LEFT','RIGHT'] | None
     :param extend: Extend, Extend selection on walk
     :type extend: bool | None
     :param toggle_all: Toggle All, Toggle open/close hierarchy