fake-bpy-module 20240516__py3-none-any.whl → 20240517__py3-none-any.whl

bl_operators/assets/__init__.pyi

@@ -1,10 +1,11 @@
 import typing
+import bpy.types
 import bpy_types
 
 GenericType = typing.TypeVar("GenericType")
 
 class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
-    """ """
+    """Open the blend file that contains the active asset"""
 
     bl_idname: typing.Any
     """ """
@@ -21,23 +22,35 @@ class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
     id_data: typing.Any
     """ """
 
-    def as_keywords(self, ignore):
-        """
+    def as_keywords(self, ignore=()):
+        """Return a copy of the properties as a dictionary
 
         :param ignore:
         """
         ...
 
-    def as_pointer(self):
-        """ """
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
         ...
 
-    def bl_rna_get_subclass(self):
-        """ """
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
         ...
 
-    def bl_rna_get_subclass_py(self):
-        """ """
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
         ...
 
     def cancel(self, context):
@@ -47,12 +60,20 @@ class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
         """
         ...
 
-    def driver_add(self):
-        """ """
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
         ...
 
-    def driver_remove(self):
-        """ """
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
         ...
 
     def execute(self, context):
@@ -63,51 +84,95 @@ class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
         ...
 
     def get(self):
-        """ """
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def id_properties_clear(self):
-        """ """
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ensure(self):
-        """ """
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ui(self):
-        """ """
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
         ...
 
-    def is_property_hidden(self):
-        """ """
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
         ...
 
-    def is_property_overridable_library(self):
-        """ """
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
         ...
 
-    def is_property_readonly(self):
-        """ """
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
         ...
 
-    def is_property_set(self):
-        """ """
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
         ...
 
     def items(self):
-        """ """
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
         ...
 
-    def keyframe_delete(self):
-        """ """
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
         ...
 
-    def keyframe_insert(self):
-        """ """
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
         ...
 
     def keys(self):
-        """ """
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
         ...
 
     def modal(self, context, event):
@@ -125,12 +190,17 @@ class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
         """
         ...
 
-    def path_from_id(self):
-        """ """
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
         ...
 
     def path_resolve(self):
-        """ """
+        """Returns the property from the path, raise an exception when not found."""
         ...
 
     def poll(self, context):
@@ -141,27 +211,42 @@ class ASSET_OT_open_containing_blend_file(bpy_types.Operator):
         ...
 
     def poll_message_set(self):
-        """ """
+        """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
         ...
 
     def pop(self):
-        """ """
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
-    def property_overridable_library_set(self):
-        """ """
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
         ...
 
     def property_unset(self):
-        """ """
+        """Unset a property, will use default value afterward."""
         ...
 
     def type_recast(self):
-        """ """
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
         ...
 
     def values(self):
-        """ """
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
         ...
 
 class AssetBrowserMetadataOperator:
@@ -175,7 +260,7 @@ class AssetBrowserMetadataOperator:
         ...
 
 class ASSET_OT_tag_add(AssetBrowserMetadataOperator, bpy_types.Operator):
-    """ """
+    """Add a new keyword tag to the active asset"""
 
     bl_idname: typing.Any
     """ """
@@ -192,31 +277,51 @@ class ASSET_OT_tag_add(AssetBrowserMetadataOperator, bpy_types.Operator):
     id_data: typing.Any
     """ """
 
-    def as_keywords(self, ignore):
-        """
+    def as_keywords(self, ignore=()):
+        """Return a copy of the properties as a dictionary
 
         :param ignore:
         """
         ...
 
-    def as_pointer(self):
-        """ """
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
         ...
 
-    def bl_rna_get_subclass(self):
-        """ """
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
         ...
 
-    def bl_rna_get_subclass_py(self):
-        """ """
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
         ...
 
-    def driver_add(self):
-        """ """
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
         ...
 
-    def driver_remove(self):
-        """ """
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
         ...
 
     def execute(self, context):
@@ -227,59 +332,108 @@ class ASSET_OT_tag_add(AssetBrowserMetadataOperator, bpy_types.Operator):
         ...
 
     def get(self):
-        """ """
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def id_properties_clear(self):
-        """ """
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ensure(self):
-        """ """
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ui(self):
-        """ """
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
         ...
 
-    def is_property_hidden(self):
-        """ """
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
         ...
 
-    def is_property_overridable_library(self):
-        """ """
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
         ...
 
-    def is_property_readonly(self):
-        """ """
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
         ...
 
-    def is_property_set(self):
-        """ """
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
         ...
 
     def items(self):
-        """ """
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
         ...
 
-    def keyframe_delete(self):
-        """ """
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
         ...
 
-    def keyframe_insert(self):
-        """ """
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
         ...
 
     def keys(self):
-        """ """
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
         ...
 
-    def path_from_id(self):
-        """ """
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
         ...
 
     def path_resolve(self):
-        """ """
+        """Returns the property from the path, raise an exception when not found."""
         ...
 
     def poll(self, context):
@@ -290,31 +444,46 @@ class ASSET_OT_tag_add(AssetBrowserMetadataOperator, bpy_types.Operator):
         ...
 
     def poll_message_set(self):
-        """ """
+        """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
         ...
 
     def pop(self):
-        """ """
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
-    def property_overridable_library_set(self):
-        """ """
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
         ...
 
     def property_unset(self):
-        """ """
+        """Unset a property, will use default value afterward."""
         ...
 
     def type_recast(self):
-        """ """
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
         ...
 
     def values(self):
-        """ """
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
         ...
 
 class ASSET_OT_tag_remove(AssetBrowserMetadataOperator, bpy_types.Operator):
-    """ """
+    """Remove an existing keyword tag from the active asset"""
 
     bl_idname: typing.Any
     """ """
@@ -331,31 +500,51 @@ class ASSET_OT_tag_remove(AssetBrowserMetadataOperator, bpy_types.Operator):
     id_data: typing.Any
     """ """
 
-    def as_keywords(self, ignore):
-        """
+    def as_keywords(self, ignore=()):
+        """Return a copy of the properties as a dictionary
 
         :param ignore:
         """
         ...
 
-    def as_pointer(self):
-        """ """
+    def as_pointer(self) -> int:
+        """Returns the memory address which holds a pointer to Blender's internal data
+
+        :return: int (memory address).
+        :rtype: int
+        """
         ...
 
-    def bl_rna_get_subclass(self):
-        """ """
+    def bl_rna_get_subclass(self) -> bpy.types.Struct:
+        """
+
+        :return: The RNA type or default when not found.
+        :rtype: bpy.types.Struct
+        """
         ...
 
-    def bl_rna_get_subclass_py(self):
-        """ """
+    def bl_rna_get_subclass_py(self) -> typing.Any:
+        """
+
+        :return: The class or default when not found.
+        :rtype: typing.Any
+        """
         ...
 
-    def driver_add(self):
-        """ """
+    def driver_add(self) -> bpy.types.FCurve:
+        """Adds driver(s) to the given property
+
+        :return: The driver(s) added.
+        :rtype: bpy.types.FCurve
+        """
         ...
 
-    def driver_remove(self):
-        """ """
+    def driver_remove(self) -> bool:
+        """Remove driver(s) from the given property
+
+        :return: Success of driver removal.
+        :rtype: bool
+        """
         ...
 
     def execute(self, context):
@@ -366,59 +555,108 @@ class ASSET_OT_tag_remove(AssetBrowserMetadataOperator, bpy_types.Operator):
         ...
 
     def get(self):
-        """ """
+        """Returns the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
     def id_properties_clear(self):
-        """ """
+        """
+
+        :return: Remove the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ensure(self):
-        """ """
+        """
+
+        :return: the parent group for an RNA struct's custom IDProperties.
+        """
         ...
 
     def id_properties_ui(self):
-        """ """
+        """
+
+        :return: Return an object used to manage an IDProperty's UI data.
+        """
         ...
 
-    def is_property_hidden(self):
-        """ """
+    def is_property_hidden(self) -> bool:
+        """Check if a property is hidden.
+
+        :return: True when the property is hidden.
+        :rtype: bool
+        """
         ...
 
-    def is_property_overridable_library(self):
-        """ """
+    def is_property_overridable_library(self) -> bool:
+        """Check if a property is overridable.
+
+        :return: True when the property is overridable.
+        :rtype: bool
+        """
         ...
 
-    def is_property_readonly(self):
-        """ """
+    def is_property_readonly(self) -> bool:
+        """Check if a property is readonly.
+
+        :return: True when the property is readonly (not writable).
+        :rtype: bool
+        """
         ...
 
-    def is_property_set(self):
-        """ """
+    def is_property_set(self) -> bool:
+        """Check if a property is set, use for testing operator properties.
+
+        :return: True when the property has been set.
+        :rtype: bool
+        """
         ...
 
     def items(self):
-        """ """
+        """Returns the items of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property key, value pairs.
+        """
         ...
 
-    def keyframe_delete(self):
-        """ """
+    def keyframe_delete(self) -> bool:
+        """Remove a keyframe from this properties fcurve.
+
+        :return: Success of keyframe deletion.
+        :rtype: bool
+        """
         ...
 
-    def keyframe_insert(self):
-        """ """
+    def keyframe_insert(self) -> bool:
+        """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
+
+        :return: Success of keyframe insertion.
+        :rtype: bool
+        """
         ...
 
     def keys(self):
-        """ """
+        """Returns the keys of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property keys.
+        """
         ...
 
-    def path_from_id(self):
-        """ """
+    def path_from_id(self) -> str:
+        """Returns the data path from the ID to this object (string).
+
+                :return: The path from `bpy.types.bpy_struct.id_data`
+        to this struct and property (when given).
+                :rtype: str
+        """
         ...
 
     def path_resolve(self):
-        """ """
+        """Returns the property from the path, raise an exception when not found."""
         ...
 
     def poll(self, context):
@@ -429,25 +667,40 @@ class ASSET_OT_tag_remove(AssetBrowserMetadataOperator, bpy_types.Operator):
         ...
 
     def poll_message_set(self):
-        """ """
+        """Set the message to show in the tool-tip when poll fails.When message is callable, additional user defined positional arguments are passed to the message function."""
         ...
 
     def pop(self):
-        """ """
+        """Remove and return the value of the custom property assigned to key or default
+        when not found (matches Python's dictionary function of the same name).
+
+        """
         ...
 
-    def property_overridable_library_set(self):
-        """ """
+    def property_overridable_library_set(self) -> bool:
+        """Define a property as overridable or not (only for custom properties!).
+
+        :return: True when the overridable status of the property was successfully set.
+        :rtype: bool
+        """
         ...
 
     def property_unset(self):
-        """ """
+        """Unset a property, will use default value afterward."""
         ...
 
     def type_recast(self):
-        """ """
+        """Return a new instance, this is needed because types
+        such as textures can be changed at runtime.
+
+                :return: a new instance of this object with the type initialized again.
+        """
         ...
 
     def values(self):
-        """ """
+        """Returns the values of this objects custom properties (matches Python's
+        dictionary function of the same name).
+
+                :return: custom property values.
+        """
         ...