user: How do I use Object Operators in Blender? Include parameters, examples, warnings and best practices.

assistant: umber to remove

bpy.ops.object.instance_offset_from_cursor()
:   Set offset used for collection instances based on cursor position

    File:
    :   [startup/bl_operators/object.py:914](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L914)

bpy.ops.object.instance_offset_from_object()
:   Set offset used for collection instances based on the active object position

    File:
    :   [startup/bl_operators/object.py:946](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L946)

bpy.ops.object.instance_offset_to_cursor()
:   Set cursor position to the offset used for collection instances

    File:
    :   [startup/bl_operators/object.py:929](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L929)

bpy.ops.object.isolate_type_render()
:   Hide unselected render objects of same type as active by setting the hide render flag

    File:
    :   [startup/bl_operators/object.py:709](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L709)

bpy.ops.object.join()
:   Join selected objects into active object

bpy.ops.object.join_shapes(*\**, *use_mirror=False*)
:   Add the vertex positions of selected objects as shape keys or update existing shape keys with matching names

    Parameters:
    :   **use_mirror** (*boolean**,* *(**optional**)*) – Mirror, Mirror the new shape key values

bpy.ops.object.join_uvs()
:   Transfer UV Maps from active to selected objects (needs matching geometry)

    File:
    :   [startup/bl_operators/object.py:610](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L610)

bpy.ops.object.laplaciandeform_bind(*\**, *modifier=''*)
:   Bind mesh to system in laplacian deform modifier

    Parameters:
    :   **modifier** (*string**,* *(**optional**,* *never None**)*) – Modifier, Name of the modifier to edit

bpy.ops.object.lattice_add_to_selected(*\**, *fit_to_selected=True*, *radius=1.0*, *margin=0.0*, *add_modifiers=True*, *resolution_u=2*, *resolution_v=2*, *resolution_w=2*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a lattice and use it to deform selected objects

    Parameters:
    :   - **fit_to_selected** (*boolean**,* *(**optional**)*) – Fit to Selected, Resize lattice to fit selected deformable objects
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **margin** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Margin, Add margin to lattice dimensions
        - **add_modifiers** (*boolean**,* *(**optional**)*) – Add Modifiers, Automatically add lattice modifiers to selected objects
        - **resolution_u** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – Resolution U, Lattice resolution in U direction
        - **resolution_v** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – V, Lattice resolution in V direction
        - **resolution_w** (*int in* *[**1**,* *64**]**,* *(**optional**)*) – W, Lattice resolution in W direction
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.light_add(*\**, *type='POINT'*, *radius=1.0*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a light object to the scene

    Parameters:
    :   - **type** (enum in [Light Type Items](bpy_types_enum_items/light_type_items.html#rna-enum-light-type-items), (optional)) – Type
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.light_linking_blocker_collection_new()
:   Create new light linking collection used by the active emitter

bpy.ops.object.light_linking_blockers_link(*\**, *link_state='INCLUDE'*)
:   Light link selected blockers to the active emitter object

    Parameters:
    :   **link_state** (enum in [`'INCLUDE'`, `'EXCLUDE'`], (optional)) –

        Link State, State of the shadow linking

        - `INCLUDE`
          Include – Include selected blockers to cast shadows from the active emitter.
        - `EXCLUDE`
          Exclude – Exclude selected blockers from casting shadows from the active emitter.

bpy.ops.object.light_linking_blockers_select()
:   Select all objects which block light from this emitter

bpy.ops.object.light_linking_receiver_collection_new()
:   Create new light linking collection used by the active emitter

bpy.ops.object.light_linking_receivers_link(*\**, *link_state='INCLUDE'*)
:   Light link selected receivers to the active emitter object

    Parameters:
    :   **link_state** (enum in [`'INCLUDE'`, `'EXCLUDE'`], (optional)) –

        Link State, State of the light linking

        - `INCLUDE`
          Include – Include selected receivers to receive light from the active emitter.
        - `EXCLUDE`
          Exclude – Exclude selected receivers from receiving light from the active emitter.

bpy.ops.object.light_linking_receivers_select()
:   Select all objects which receive light from this emitter

bpy.ops.object.light_linking_unlink_from_collection()
:   Remove this object or collection from the light linking collection

bpy.ops.object.lightprobe_add(*\**, *type='SPHERE'*, *radius=1.0*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add a light probe object

    Parameters:
    :   - **type** (enum in [`'SPHERE'`, `'PLANE'`, `'VOLUME'`], (optional)) –

          Type

          - `SPHERE`
            Sphere – Light probe that captures precise lighting from all directions at a single point in space.
          - `PLANE`
            Plane – Light probe that captures incoming light from a single direction on a plane.
          - `VOLUME`
            Volume – Light probe that captures low frequency lighting inside a volume.
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.lightprobe_cache_bake(*\**, *subset='ALL'*)
:   Bake irradiance volume light cache

    Parameters:
    :   **subset** (enum in [`'ALL'`, `'SELECTED'`, `'ACTIVE'`], (optional)) –

        Subset, Subset of probes to update

        - `ALL`
          All Volumes – Bake all light probe volumes.
        - `SELECTED`
          Selected Only – Only bake selected light probe volumes.
        - `ACTIVE`
          Active Only – Only bake the active light probe volume.

bpy.ops.object.lightprobe_cache_free(*\**, *subset='SELECTED'*)
:   Delete cached indirect lighting

    Parameters:
    :   **subset** (enum in [`'ALL'`, `'SELECTED'`, `'ACTIVE'`], (optional)) –

        Subset, Subset of probes to update

        - `ALL`
          All Light Probes – Delete all light probes’ baked lighting data.
        - `SELECTED`
          Selected Only – Only delete selected light probes’ baked lighting data.
        - `ACTIVE`
          Active Only – Only delete the active light probe’s baked lighting data.

bpy.ops.object.lineart_bake_strokes(*\**, *bake_all=False*)
:   Bake Line Art for current Grease Pencil object

    Parameters:
    :   **bake_all** (*boolean**,* *(**optional**)*) – Bake All, Bake all Line Art modifiers

bpy.ops.object.lineart_clear(*\**, *clear_all=False*)
:   Clear all strokes in current Grease Pencil object

    Parameters:
    :   **clear_all** (*boolean**,* *(**optional**)*) – Clear All, Clear all Line Art modifier bakes

bpy.ops.object.link_to_collection(*\**, *collection_uid=-1*, *is_new=False*, *new_collection_name=''*)
:   Link objects to a collection

    Parameters:
    :   - **collection_uid** (*int in* *[**-1**,* *inf**]**,* *(**optional**)*) – Collection UID, Session UID of the collection to link to
        - **is_new** (*boolean**,* *(**optional**)*) – New, Link objects to a new collection
        - **new_collection_name** (*string**,* *(**optional**,* *never None**)*) – Name, Name of the newly added collection

bpy.ops.object.location_clear(*\**, *clear_delta=False*)
:   Clear the object’s location

    Parameters:
    :   **clear_delta** (*boolean**,* *(**optional**)*) – Clear Delta, Clear delta location in addition to clearing the normal location transform

bpy.ops.object.make_dupli_face()
:   Convert objects into instanced faces

    File:
    :   [startup/bl_operators/object.py:692](https://projects.blender.org/blender/blender/src/branch/main/scripts/startup/bl_operators/object.py#L692)

bpy.ops.object.make_links_data(*\**, *type='OBDATA'*)
:   Transfer data from active object to selected objects

    Parameters:
    :   **type** (enum in [`'OBDATA'`, `'MATERIAL'`, `'ANIMATION'`, `'GROUPS'`, `'DUPLICOLLECTION'`, `'FONTS'`, `'MODIFIERS'`, `'EFFECTS'`], (optional)) –

        Type

        - `OBDATA`
          Link Object Data – Replace assigned Object Data.
        - `MATERIAL`
          Link Materials – Replace assigned Materials.
        - `ANIMATION`
          Link Animation Data – Replace assigned Animation Data.
        - `GROUPS`
          Link Collections – Replace assigned Collections.
        - `DUPLICOLLECTION`
          Link Instance Collection – Replace assigned Collection Instance.
        - `FONTS`
          Link Fonts to Text – Replace Text object Fonts.
        - `MODIFIERS`
          Copy Modifiers – Replace Modifiers.
        - `EFFECTS`
          Copy Grease Pencil Effects – Replace Grease Pencil Effects.

bpy.ops.object.make_links_scene(*\**, *scene=''*)
:   Link selection to another scene

    Parameters:
    :   **scene** (*enum in* *[**]**,* *(**optional**)*) – Scene

bpy.ops.object.make_local(*\**, *type='SELECT_OBJECT'*)
:   Make library linked data-blocks local to this file

    Parameters:
    :   **type** (enum in [`'SELECT_OBJECT'`, `'SELECT_OBDATA'`, `'SELECT_OBDATA_MATERIAL'`, `'ALL'`], (optional)) – Type

bpy.ops.object.make_override_library(*\**, *collection=0*)
:   Create a local override of the selected linked objects, and their hierarchy of dependencies

    Parameters:
    :   **collection** (*int in* *[**-inf**,* *inf**]**,* *(**optional**)*) – Override Collection, Session UID of the directly linked collection containing the selected object, to make an override from

bpy.ops.object.make_single_user(*\**, *type='SELECTED_OBJECTS'*, *object=False*, *obdata=False*, *material=False*, *animation=False*, *obdata_animation=False*)
:   Make linked data local to each object

    Parameters:
    :   - **type** (enum in [`'SELECTED_OBJECTS'`, `'ALL'`], (optional)) – Type
        - **object** (*boolean**,* *(**optional**)*) – Object, Make single user objects
        - **obdata** (*boolean**,* *(**optional**)*) – Object Data, Make single user object data
        - **material** (*boolean**,* *(**optional**)*) – Materials, Make materials local to each data-block
        - **animation** (*boolean**,* *(**optional**)*) – Object Animation, Make object animation data local to each object
        - **obdata_animation** (*boolean**,* *(**optional**)*) – Object Data Animation, Make object data (mesh, curve etc.) animation data local to each object

bpy.ops.object.material_slot_add()
:   Add a new material slot

bpy.ops.object.material_slot_assign()
:   Assign active material slot to selection

bpy.ops.object.material_slot_copy()
:   Copy material to selected objects

bpy.ops.object.material_slot_deselect()
:   Deselect by active material slot

bpy.ops.object.material_slot_move(*\**, *direction='UP'*)
:   Move the active material up/down in the list

    Parameters:
    :   **direction** (enum in [`'UP'`, `'DOWN'`], (optional)) – Direction, Direction to move the active material towards

bpy.ops.object.material_slot_remove()
:   Remove the selected material slot

bpy.ops.object.material_slot_remove_all()
:   Remove all materials

bpy.ops.object.material_slot_remove_unused()
:   Remove unused material slots

bpy.ops.object.material_slot_select()
:   Select by active material slot

bpy.ops.object.meshdeform_bind(*\**, *modifier=''*)
:   Bind mesh to cage in mesh deform modifier

    Parameters:
    :   **modifier** (*string**,* *(**optional**,* *never None**)*) – Modifier, Name of the modifier to edit

bpy.ops.object.metaball_add(*\**, *type='BALL'*, *radius=2.0*, *enter_editmode=False*, *align='WORLD'*, *location=(0.0, 0.0, 0.0)*, *rotation=(0.0, 0.0, 0.0)*, *scale=(0.0, 0.0, 0.0)*)
:   Add an metaball object to the scene

    Parameters:
    :   - **type** (enum in [Metaelem Type Items](bpy_types_enum_items/metaelem_type_items.html#rna-enum-metaelem-type-items), (optional)) – Primitive
        - **radius** (*float in* *[**0**,* *inf**]**,* *(**optional**)*) – Radius
        - **enter_editmode** (*boolean**,* *(**optional**)*) – Enter Edit Mode, Enter edit mode when adding this object
        - **align** (enum in [`'WORLD'`, `'VIEW'`, `'CURSOR'`], (optional)) –

          Align, The alignment of the new object

          - `WORLD`
            World – Align the new object to the world.
          - `VIEW`
            View – Align the new object to the view.
          - `CURSOR`
            3D Cursor – Use the 3D cursor orientation for the new object.
        - **location** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Location, Location for the newly added object
        - **rotation** ([`mathutils.Euler`](mathutils.html#mathutils.Euler "mathutils.Euler") rotation of 3 items in [-inf, inf], (optional)) – Rotation, Rotation for the newly added object
        - **scale** ([`mathutils.Vector`](mathutils.html#mathutils.Vector "mathutils.Vector") of 3 items in [-inf, inf], (optional)) – Scale, Scale for the newly added object

bpy.ops.object.mode_set(*\**, *mode='OBJECT'*, *toggle=False*)
:   Sets the object interaction mode

    Parameters:
    :   - **mode** (enum in [Object Mode Items](bpy_types_enum_items/object_mode_items.html#rna-enum-object-mode-items), (optional)) – Mode
        - **toggle** (*boolean**,* *(**optional**)*) – Toggle

bpy.ops.object.mode_set_with_submode(*\**, *mode='OBJECT'*, *toggle=False*, *mesh_select_mode={}*)
:   Sets the object interaction mode

    Parameters:
    :   - **mode** (enum in [Object Mode Items](bpy_types_enum_items/object_mode_items.html#rna-enum-object-mode-items), (optional)) – Mode
        - **toggle** (*boolean**,* *(**optional**)*) – Toggle
        - **mesh_select_mode** (enum set in [Mesh Select Mode Items](bpy_types_enum_items/mesh_select_mode_items.html#rna-enum-mesh-select-mode-items), (optional)) – Mesh Mode

bpy.ops.object.modifier_add(*\**, *type='SUBSURF'*, *use_selected_objects=False*)
:   Add a procedural operation/effect to the active object

    Parameters:
    :   - **type** (enum in [Object Modifier Type Items](bpy_types_enum_items/object_modifier_type_items.html#rna-enum-object-modifier-type-items), (optional)) – Type
        - **use_selected_objects** (*boolean**,* *(**optional**)*) – Selected Objects, Affect all selected objects instead of just the active object

bpy.ops.object.