PGCRYPT/OpenBlender_Train huggingface dataset:
user: What is Bpy.Ops and how is it used in Blender Python scripting?

assistant:  Operators File Operators Fluid Operators Font Operators Geometry Operators Gizmogroup Operators Gpencil Operators Graph Operators Grease Pencil Operators Image Operators Import Anim Operators Import Curve Operators Import Scene Operators Info Operators Lattice Operators Marker Operators Mask Operators Material Operators Mball Operators Mesh Operators Nla Operators Node Operators Object Operators Outliner Operators Paint Operators Paintcurve Operators Palette Operators Particle Operators Pointcloud Operators Pose Operators Poselib Operators Preferences Operators Ptcache Operators Render Operators Rigidbody Operators Scene Operators Screen Operators Script Operators Sculpt Operators Sculpt Curves Operators Sequencer Operators Sound Operators Spreadsheet Operators Surface Operators Text Operators Text Editor Operators Texture Operators Transform Operators Ui Operators Uilist Operators Uv Operators View2D Operators View3D Operators Wm Operators Workspace Operators World Operators Next Action Operators Previous Message Bus (bpy.msgbus) Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Operators (bpy.ops) Calling Operators Keywords and Positional Arguments Overriding Context Execution Context
user: Explain UDIMTile(bpy_struct) in complete detail according to the official Blender documentation.

assistant: # UDIMTile(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.UDIMTile(*bpy_struct*)
:   Properties of the UDIM tile

    channels
    :   Number of channels in the tile pixels buffer

        Type:
        :   int in [0, inf], default 0, (readonly)

    generated_color
    :   Fill color for the generated image

        Type:
        :   float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

    generated_height
    :   Generated image height

        Type:
        :   int in [1, 65536], default 0

    generated_type
    :   Generated image type

        Type:
        :   enum in [Image Generated Type Items](bpy_types_enum_items/image_generated_type_items.html#rna-enum-image-generated-type-items), default `'BLANK'`

    generated_width
    :   Generated image width

        Type:
        :   int in [1, 65536], default 0

    is_generated_tile
    :   Is this image tile generated

        Type:
        :   boolean, default False, (readonly)

    label
    :   Tile label

        Type:
        :   string, default “”, (never None)

    number
    :   Number of the position that this tile covers

        Type:
        :   int in [-inf, inf], default 0

    size
    :   Width and height of the tile buffer in pixels, zero when image data cannot be loaded

        Type:
        :   int array of 2 items in [-inf, inf], default (0, 0), (readonly)

    use_generated_float
    :   Generate floating-point buffer

        Type:
        :   boolean, default False

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Show practical ways to work with Save As in a Blender add-on or script – include code.

assistant: Choose a file path to save the blend-file to.

### Options

Compress
:   Reduces the file size of the resulting blend-file but takes longer to save and load.
    This option is useful for distributing files online and saving drive space for large projects.
    But it can cause slowdowns when quitting Blender,
    or under normal operation when auto-saving backup files.
    See [Compression & Memory Use](../linked_libraries/link_append.xhtml#files-linked-libraries-known-limitations-compression) for more information.

Remap Relative
:   This option remaps [Relative Paths](#files-blend-relative-paths)
    (such as linked libraries and images) when saving a file in a new location.

Save Copy
:   Saves a copy of the actual working state but does not make the saved file active.
user: What is GeometryNodeInputInstanceScale(GeometryNode) and how is it used in Blender Python scripting?

assistant: # GeometryNodeInputInstanceScale(GeometryNode)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`Node`](bpy.types.Node.html#bpy.types.Node "bpy.types.Node"), [`NodeInternal`](bpy.types.NodeInternal.html#bpy.types.NodeInternal "bpy.types.NodeInternal"), [`GeometryNode`](bpy.types.GeometryNode.html#bpy.types.GeometryNode "bpy.types.GeometryNode")

*class* bpy.types.GeometryNodeInputInstanceScale(*GeometryNode*)
:   Retrieve the scale of each instance in the geometry

    *classmethod* is_registered_node_type()
    :   True if a registered node type

        Returns:
        :   Result

        Return type:
        :   boolean

    *classmethod* input_template(*index*)
    :   Input socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* output_template(*index*)
    :   Output socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: What is Text Strip and how is it used in Blender Python scripting?

assistant: # Text Strip

The Text strip allows you to directly display text in the Sequence editor.
The strip will display the text inserted in its text field on the final sequence.

[image reference removed]

Text effect.
user: Show practical ways to work with Simulation Zone in a Blender add-on or script – include code.

assistant: # Simulation Zone

Simulation zones allow the result of one frame to influence the next one.
That way even a set of simple rules can lead to complex results, with the passing of time.
The most common type of them is physics simulation, with specific solvers for physical phenomena.

[image reference removed]

Initial simulation nodes and simulation zone.

When adding a simulation, two nodes are added, defining between them a “Simulation Zone”.

The inputs that are connected to the Simulation Input node are evaluated only once,
at the beginning of the simulation, passed to the next simulation state and eventually outputted.
Other nodes can be linked inside the simulation region from the outside.
Those are re-evaluated every step based on their value at the given frame.

It is not possible to have any link going towards outside.
The result of the simulation can only be accessed via the Simulation Output node.
This also allows sub-frame interpolation for motion blur.
user: Describe References from the Blender manual or Python API, including usage steps and snippets.

assistant: |  |  |
| --- | --- |
| - [`Context.gizmo_group`](bpy.types.Context.html#bpy.types.Context.gizmo_group "bpy.types.Context.gizmo_group") | - [`Gizmo.group`](bpy.types.Gizmo.html#bpy.types.Gizmo.group "bpy.types.Gizmo.group") |
user: What is Filters and how is it used in Blender Python scripting?

assistant: # Filters

Filters are tools which provide an alternative way of sculpting, because they do not rely on a brush radius.
Instead they will affect any vertices that are visible and not masked.

[image reference removed]

The strength is controlled by click & dragging from left to right.
The position of the cursor can be used to only affect specific areas, if auto-masking is used.

Many of the same brush types are also available as a filter type.
This way much of the mesh can simultaneously be smoothed, colored or have some cloth simulation applied.
user: Provide the full official documentation entry for Building the Manual, preserving all code examples.

assistant: # Building the Manual

Converting the RST-files into pretty HTML pages is simple.

Open a terminal or Command Prompt in the `~/blender-manual` directory and simply run:

```
make
```

This is the command you should use when building the docs, however, other commands are available by typing `make
help`. This command will convert the RST-files into HTML pages and automatically open your default web browser to
view the result. The command will continue to run and watch for changes made to the RST-files and refresh the HTML
pages as necessary.

The building process may take several minutes the first time (or after any major changes), but for subsequent changes
it should only take a few seconds.
user: How do I use Mask From Face Sets Boundary in Blender? Include parameters, examples, warnings and best practices.

assistant: Generates a mask based on the face set islands of the mesh. The settings of the operation can be changed
in the [Adjust Last Operation](../../../interface/undo_redo.xhtml) panel.

Mode
:   Choose how the newly created mask is mixed with the existing one. By default it will replace the old mask via
    “Mix”.

Mix Factor
:   The factor of the mix effect. Choose how strong the new mask is applied on the existing one.

Automask Settings
:   The same settings as the [Auto-Masking](../controls.xhtml) settings are applied.

Propagation Steps
:   Same as [Auto-Masking](../controls.xhtml).
user: Show practical ways to work with RepeatItem(bpy_struct) in a Blender add-on or script – include code.

assistant: # RepeatItem(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.RepeatItem(*bpy_struct*)
:   color
    :   Color of the corresponding socket type in the node editor

        Type:
        :   float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0), (readonly)

    name
    :   Type:
        :   string, default “”, (never None)

    socket_type
    :   Type:
        :   enum in [Node Socket Data Type Items](bpy_types_enum_items/node_socket_data_type_items.html#rna-enum-node-socket-data-type-items), default `'FLOAT'`

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Show practical ways to work with Data in a Blender add-on or script – include code.

assistant: Fonts
:   Default location to browse for [text object](../../modeling/texts/index.xhtml) font files.

Textures
:   Default location to browse for image textures.

Sounds
:   Default location to browse for sound files.

Temporary Files
:   The directory for storing temporary save files. The path must reference an existing directory
    or it will be ignored and the systems temporary directory will be used instead.
    When left blank, the systems temporary directory will be used (see [Temporary Directory](../../advanced/blender_directory_layout.xhtml#temp-dir) for details).

### Render

Render Output
:   Where rendered images/videos are saved.

Render Cache
:   The location where cached render images are stored.
user: Give a detailed overview of NodeSocketFloatAngle(NodeSocketStandard): syntax, arguments, return values, common patterns.

assistant: # NodeSocketFloatAngle(NodeSocketStandard)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`NodeSocket`](bpy.types.NodeSocket.html#bpy.types.NodeSocket "bpy.types.NodeSocket"), [`NodeSocketStandard`](bpy.types.NodeSocketStandard.html#bpy.types.NodeSocketStandard "bpy.types.NodeSocketStandard")

*class* bpy.types.NodeSocketFloatAngle(*NodeSocketStandard*)
:   Floating-point number socket of a node

    default_value
    :   Input value used for unconnected socket

        Type:
        :   float in [-inf, inf], default 0.0

    links
    :   List of node links from or to this socket.

        Type:
        :   [`NodeLinks`](bpy.types.NodeLinks.html#bpy.types.NodeLinks "bpy.types.NodeLinks")

        (readonly)

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Give a detailed overview of Visual Transform: syntax, arguments, return values, common patterns.

assistant: Constraints give their owning object or bone a new location, rotation, and/or scale which together
are called the *visual transform*. This transform is separate from the “base” transform found
in the *Transform* panel of the Properties Editor,
and as its name implies, it determines where the owner *really* appears in the world.

For example, even when an object’s *Transform* panel still shows the original *Location* of (0, 0, 0),
a constraint could have placed it somewhere else entirely. What’s more, attempting to move or even
animate that object won’t work: its *Location* numbers will change, but visually,
it will remain stuck in place. The only way to “free” the object is to disable or delete the constraint,
or to set its [Influence](interface/common.xhtml#bpy-types-constraint-influence) to zero.

Of course, transform properties that are not constrained can still be changed as usual.

While the visual transform is not shown in the UI, it can be copied to the base transform:

- By running [Apply Visual Transform](../../scene_layout/object/editing/apply.xhtml#bpy-ops-object-visual-transform-apply).
- By [applying](interface/header.xhtml#bpy-ops-constraint-apply) the constraint. This also deletes the constraint.
user: How do I use Options in Blender? Include parameters, examples, warnings and best practices.

assistant: [image reference removed]

Follow Path constraint.

[Target](../interface/common.html#rigging-constraints-interface-common-target)
:   The Curve object to follow.

Offset Fixed Position disabled
:   The number of frames to subtract from the Curve’s *Evaluation Time*. A positive value will
    move the owner to an earlier point on the Curve, while a negative value will move it to
    a later point.

Offset Factor Fixed Position enabled
:   Relative position along the Curve, independent of its *Evaluation Time*. A value of 0 corresponds
    to the start of the Curve while a value of 1 corresponds to the end.

Forward Axis
:   The local axis of the owner that should be aligned to the Curve’s tangent direction.
    Requires that *Follow Curve* is enabled.

    A negative axis will make the owner point in the opposite direction.

Up Axis
:   The local axis of the owner that should be aligned (as much as possible) to the global Z axis.
    Requires that *Follow Curve* is enabled.

Fixed Position
:   Ignore the Curve’s *Evaluation Time* and position the owner using only the *Offset Factor*.

    Despite the name of this property, the owner can still be moved over time by animating
    the *Offset Factor*.

Curve Radius
:   Scale the owner based on the [radii](../../../modeling/curves/editing/curve.html#modeling-curve-radius) of the Curve’s
    control points.

Follow Curve
:   Rotate the owner according to the *Forward Axis* and the *Up Axis*.

Animate Path
:   By default, the Curve’s *Evaluation Time* is static and the constraint owner doesn’t move.
    Clicking this button will animate the *Evaluation Time* so that it’s always equal to the
    current scene frame.

    Of course, it’s also possible to skip this button and animate the *Evaluation Time* by hand.

[Influence](../interface/common.html#bpy-types-constraint-influence)
:   How strongly the constraint affects the owner.
user: How do I use ActionKeyframeStrip(ActionStrip) in Blender? Include parameters, examples, warnings and best practices.

assistant: # ActionKeyframeStrip(ActionStrip)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`ActionStrip`](bpy.types.ActionStrip.html#bpy.types.ActionStrip "bpy.types.ActionStrip")

*class* bpy.types.ActionKeyframeStrip(*ActionStrip*)
:   Strip with a set of F-Curves for each action slot

    channelbags
    :   Type:
        :   [`ActionChannelbags`](bpy.types.ActionChannelbags.html#bpy.types.ActionChannelbags "bpy.types.ActionChannelbags") [`bpy_prop_collection`](bpy.types.bpy_prop_collection.html#bpy.types.bpy_prop_collection "bpy.types.bpy_prop_collection") of [`ActionChannelbag`](bpy.types.ActionChannelbag.html#bpy.types.ActionChannelbag "bpy.types.ActionChannelbag"), (readonly)

    channelbag(*slot*, *\**, *ensure=False*)
    :   Find the ActionChannelbag for a specific Slot

        Parameters:
        :   - **slot** ([`ActionSlot`](bpy.types.ActionSlot.html#bpy.types.ActionSlot "bpy.types.ActionSlot")) – Slot, The slot for which to find the channelbag
            - **ensure** (*boolean**,* *(**optional**)*) – Create if necessary, Ensure the channelbag exists for this slot, creating it if necessary

        Returns:
        :   Channels

        Return type:
        :   [`ActionChannelbag`](bpy.types.ActionChannelbag.html#bpy.types.ActionChannelbag "bpy.types.ActionChannelbag")

    key_insert(*slot*, *data_path*, *array_index*, *value*, *time*)
    :   key_insert

        Parameters:
        :   - **slot** ([`ActionSlot`](bpy.types.ActionSlot.html#bpy.types.ActionSlot "bpy.types.ActionSlot")) – Slot, The slot that identifies which ‘thing’ should be keyed
            - **data_path** (*string**,* *(**never None**)*) – Data Path, F-Curve data path
            - **array_index** (*int in* *[**-inf**,* *inf**]*) – Array Index, Index of the animated array element, or -1 if the property is not an array
            - **value** (*float in* *[**-inf**,* *inf**]*) – Value to key, Value of the animated property
            - **time** (*float in* *[**-inf**,* *inf**]*) – Time of the key, Time, in frames, of the key

        Returns:
        :   Success, Whether the key was successfully inserted

        Return type:
        :   boolean

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Provide the full official documentation entry for File Substitution Tokens, preserving all code examples.

assistant: Substitution tokens are special sequences of characters in a filename
that can be replaced with more meaningful and context aware information.
In this case, tokens are identified by being text wrapped in angle bracket characters.

This substitution is used while load loading or saving an image
to automatically identify the tile associated with a particular texture in the UDIM array.

The following tokens are supported:

- `<UDIM>`: A 4-digit notation calculated as `1001 + u-tile + v-tile * 10`.
- `<UVTILE>`: A notation defined as `u(u-tile + 1)_v(v-tile + 1)`.

Examples:

- `monster-basecolor.<UDIM>.png` will load/save files like `monster-basecolor.1021.png` etc.
- `monster-basecolor.<UVTILE>.png` will load/save files like `monster-basecolor.u1_v3.png` etc.
user: How do I use NodeGeometryCaptureAttributeItems(bpy_struct) in Blender? Include parameters, examples, warnings and best practices.

assistant: # NodeGeometryCaptureAttributeItems(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.NodeGeometryCaptureAttributeItems(*bpy_struct*)
:   Collection of capture attribute items

    new(*socket_type*, *name*)
    :   Add an item at the end

        Parameters:
        :   - **socket_type** (enum in [Node Socket Data Type Items](bpy_types_enum_items/node_socket_data_type_items.html#rna-enum-node-socket-data-type-items)) – Socket Type, Socket type of the item
            - **name** (*string**,* *(**never None**)*) – Name

        Returns:
        :   Item, New item

        Return type:
        :   [`NodeGeometryCaptureAttributeItem`](bpy.types.NodeGeometryCaptureAttributeItem.html#bpy.types.NodeGeometryCaptureAttributeItem "bpy.types.NodeGeometryCaptureAttributeItem")

    remove(*item*)
    :   Remove an item

        Parameters:
        :   **item** ([`NodeGeometryCaptureAttributeItem`](bpy.types.NodeGeometryCaptureAttributeItem.html#bpy.types.NodeGeometryCaptureAttributeItem "bpy.types.NodeGeometryCaptureAttributeItem"), (never None)) – Item, The item to remove

    clear()
    :   Remove all items

    move(*from_index*, *to_index*)
    :   Move an item to another position

        Parameters:
        :   - **from_index** (*int in* *[**0**,* *inf**]*) – From Index, Index of the item to move
            - **to_index** (*int in* *[**0**,* *inf**]*) – To Index, Target index for the item

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Show practical ways to work with Options in a Blender add-on or script – include code.

assistant: Noise Basis
:   Shape of wave to produce bands.

    Sine, Saw, Triangle

Wood Type
:   Set the bands to either straight or ring-shaped, with or without turbulence.

    Bands, Rings, Band Noise, Ring Noise

Noise Type
:   There are two methods available for the Noise function.

    Soft, Hard

Size
:   Dimension of the Noise table.

Turbulence
:   Turbulence of the Band Noise and Ring Noise types.
user: Explain Inputs in complete detail according to the official Blender documentation.

assistant: Instances
:   Standard geometry input.

Selection
:   Boolean field used to determine if an instance will be rotated.

Transform
:   The transformation matrix to translate, rotate, and scale individual instances.
user: How do I use FunctionNodeCombineColor(FunctionNode) in Blender? Include parameters, examples, warnings and best practices.

assistant: # FunctionNodeCombineColor(FunctionNode)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`Node`](bpy.types.Node.html#bpy.types.Node "bpy.types.Node"), [`NodeInternal`](bpy.types.NodeInternal.html#bpy.types.NodeInternal "bpy.types.NodeInternal"), [`FunctionNode`](bpy.types.FunctionNode.html#bpy.types.FunctionNode "bpy.types.FunctionNode")

*class* bpy.types.FunctionNodeCombineColor(*FunctionNode*)
:   Combine four channels into a single color, based on a particular color model

    mode
    :   Mode of color processing

        Type:
        :   enum in [Node Combsep Color Items](bpy_types_enum_items/node_combsep_color_items.html#rna-enum-node-combsep-color-items), default `'RGB'`

    *classmethod* is_registered_node_type()
    :   True if a registered node type

        Returns:
        :   Result

        Return type:
        :   boolean

    *classmethod* input_template(*index*)
    :   Input socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* output_template(*index*)
    :   Output socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Give a detailed overview of Pixelate Node: syntax, arguments, return values, common patterns.

assistant: # Pixelate Node

[image reference removed]

The Pixelate node reduces the detail in an image by making individual pixels more prominent.
It results in a blocky or mosaic-like appearance, where the fine details of the image are obscured,
and the overall image is represented using larger, more noticeable pixels.
user: Explain Inherited Properties in complete detail according to the official Blender documentation.

assistant: |  |  |
| --- | --- |
| - [`bpy_struct.id_data`](bpy.types.bpy_struct.html#bpy.types.bpy_struct.id_data "bpy.types.bpy_struct.id_data") | - [`SpreadsheetTableID.type`](bpy.types.SpreadsheetTableID.html#bpy.types.SpreadsheetTableID.type "bpy.types.SpreadsheetTableID.type") |
user: What is GeometryNodeFieldOnDomain(GeometryNode) and how is it used in Blender Python scripting?

assistant: # GeometryNodeFieldOnDomain(GeometryNode)

base classes — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct"), [`Node`](bpy.types.Node.html#bpy.types.Node "bpy.types.Node"), [`NodeInternal`](bpy.types.NodeInternal.html#bpy.types.NodeInternal "bpy.types.NodeInternal"), [`GeometryNode`](bpy.types.GeometryNode.html#bpy.types.GeometryNode "bpy.types.GeometryNode")

*class* bpy.types.GeometryNodeFieldOnDomain(*GeometryNode*)
:   Retrieve values from a field on a different domain besides the domain from the context

    data_type
    :   Type:
        :   enum in [Attribute Type Items](bpy_types_enum_items/attribute_type_items.html#rna-enum-attribute-type-items), default `'FLOAT'`

    domain
    :   Domain the field is evaluated in

        Type:
        :   enum in [Attribute Domain Items](bpy_types_enum_items/attribute_domain_items.html#rna-enum-attribute-domain-items), default `'POINT'`

    *classmethod* is_registered_node_type()
    :   True if a registered node type

        Returns:
        :   Result

        Return type:
        :   boolean

    *classmethod* input_template(*index*)
    :   Input socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* output_template(*index*)
    :   Output socket template

        Parameters:
        :   **index** (*int in* *[**0**,* *inf**]*) – Index

        Returns:
        :   result

        Return type:
        :   [`NodeInternalSocketTemplate`](bpy.types.NodeInternalSocketTemplate.html#bpy.types.NodeInternalSocketTemplate "bpy.types.NodeInternalSocketTemplate")

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Explain W in complete detail according to the official Blender documentation.

assistant: |  |  |
| --- | --- |
| - [**Walk Cycle**](glossary/index.xhtml#term-Walk-Cycle) - [**Weight Painting**](glossary/index.xhtml#term-Weight-Painting) | - [**White Point**](glossary/index.xhtml#term-White-Point) - [**World Space**](glossary/index.xhtml#term-World-Space) |
user: How do I use Image Overlays in Blender? Include parameters, examples, warnings and best practices.

assistant: # Image Overlays

The Overlays pop-over configures the overlays that are displayed on top of images.
In the header, there is a button to turn off all overlays for the Image Editor.
This option also toggles the visibility of [UDIM](../../modeling/meshes/uv/workflows/udims.html)
tile information.

The options that are visible in the pop-over depend on the Image Editor mode.
The following overlay categories are available:
user: Describe Socket Syncing from the Blender manual or Python API, including usage steps and snippets.

assistant: Bundles use socket names to match their inputs and outputs.
If two bundle nodes are connected but have mismatched signatures,
Blender can offer to sync them automatically.

- Sync happens automatically when a node is connected for the first time.
- Existing sockets are never updated automatically to avoid overwriting data.
- A  button (*Sync Sockets*) button appears in the node header when a mismatch is detected, allowing manual synchronization.
user: Show practical ways to work with Known Limitations in a Blender add-on or script – include code.

assistant: - Remeshing only works on the original mesh data and
  ignores generated geometry from modifiers, shape keys, rigging, etc.
- Remeshing will not work with the [Multiresolution Modifier](../../../modeling/modifiers/generate/multiresolution.xhtml).
user: How do I use Node Compare Operation Items in Blender? Include parameters, examples, warnings and best practices.

assistant: # Node Compare Operation Items

LESS_THAN:
:   Less Than.

    True when the first input is smaller than second input.

LESS_EQUAL:
:   Less Than or Equal.

    True when the first input is smaller than the second input or equal.

GREATER_THAN:
:   Greater Than.

    True when the first input is greater than the second input.

GREATER_EQUAL:
:   Greater Than or Equal.

    True when the first input is greater than the second input or equal.

EQUAL:
:   Equal.

    True when both inputs are approximately equal.

NOT_EQUAL:
:   Not Equal.

    True when both inputs are not approximately equal.

BRIGHTER:
:   Brighter.

    True when the first input is brighter.

DARKER:
:   Darker.

    True when the first input is darker.
user: Show practical ways to work with Inputs in a Blender add-on or script – include code.

assistant: Resolution
:   The number of edges on the curve.

Start, Middle, End
:   Positions of the three control points.
    The generated curve passes through the two end points, and is tangent to the lines between
    the middle point and the two end points.
user: Show practical ways to work with Options in a Blender add-on or script – include code.

assistant: [image reference removed]

The Shrinkwrap modifier in Nearest Surface Point mode.

Wrap Method
:   This selector specifies the method to be used to determine the nearest
    point on the target’s surface for each vertex of the modified object.
    Some options will add some extra, specific controls to the panel.
    See [Wrap Methods](#wrap-methods) for an explanation of each method.

Snap Mode
:   Most modes support an additional setting to control how the vertex
    is moved to the target point selected by the methods described above.
    Some of the choices only differ if *Offset* is not zero.

    On Surface
    :   The vertex is always moved. The offset is applied along the projection line
        connecting the original vertex and selected target point towards the original position.

    Outside Surface
    :   Like *On Surface*, but the offset is always applied towards the outside of the target.

    Above Surface
    :   Like *On Surface*, but the offset is applied along the smooth normal of the target.

    Inside
    :   The vertex is not moved if it is already inside the target.
        Offset shrinks the allowed volume towards the inside along the projection line.

    Outside
    :   The vertex is not moved if it is already outside the target.
        Offset expands the exclusion volume towards the outside along the projection line.

Target
:   Shrink target, the mesh to shrink to/wrap around.

Offset
:   The distance that must be kept from the calculated target position.

Vertex Group
:   The vertex group to control whether and how much each vertex is displaced to its target position.
    If a vertex is not a member of this group, it is not displaced (same as weight 0).
user: What is ObjectShaderFx(bpy_struct) and how is it used in Blender Python scripting?

assistant: # ObjectShaderFx(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.ObjectShaderFx(*bpy_struct*)
:   Collection of object effects

    new(*name*, *type*)
    :   Add a new shader fx

        Parameters:
        :   - **name** (*string**,* *(**never None**)*) – New name for the effect
            - **type** (enum in [Object Shaderfx Type Items](bpy_types_enum_items/object_shaderfx_type_items.html#rna-enum-object-shaderfx-type-items)) – Effect type to add

        Returns:
        :   Newly created effect

        Return type:
        :   [`ShaderFx`](bpy.types.ShaderFx.html#bpy.types.ShaderFx "bpy.types.ShaderFx")

    remove(*shader_fx*)
    :   Remove an existing effect from the object

        Parameters:
        :   **shader_fx** ([`ShaderFx`](bpy.types.ShaderFx.html#bpy.types.ShaderFx "bpy.types.ShaderFx"), (never None)) – Effect to remove

    clear()
    :   Remove all effects from the object

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Provide the full official documentation entry for Library Overrides, preserving all code examples.

assistant: # Library Overrides

Library Overrides is a system designed to allow editing
[linked data](link_append.xhtml), while keeping it in sync
with the original library data. Most types of linked data-blocks can be overridden,
and the properties of these overrides can then be edited. When the library data changes,
unmodified properties of the overridden one will be updated accordingly.

Library overrides supports:

- Multiple independent overrides of a same linked data
  (e.g. having the same character multiple times in the same scene).
- Adding new modifiers and constraints, anywhere in the stack.
- Recursively chaining overrides (i.e. link and override overrides from another library file, etc.).
user: Explain File Context in complete detail according to the official Blender documentation.

assistant: bpy.context.active_file
:   Type:
    :   [`bpy.types.FileSelectEntry`](bpy.types.FileSelectEntry.html#bpy.types.FileSelectEntry "bpy.types.FileSelectEntry")

bpy.context.selected_files
:   Type:
    :   sequence of [`bpy.types.FileSelectEntry`](bpy.types.FileSelectEntry.html#bpy.types.FileSelectEntry "bpy.types.FileSelectEntry")

bpy.context.asset_library_reference
:   Type:
    :   [`bpy.types.AssetLibraryReference`](bpy.types.AssetLibraryReference.html#bpy.types.AssetLibraryReference "bpy.types.AssetLibraryReference")

bpy.context.asset
:   Type:
    :   [`bpy.types.AssetRepresentation`](bpy.types.AssetRepresentation.html#bpy.types.AssetRepresentation "bpy.types.AssetRepresentation")

bpy.context.selected_assets
:   Type:
    :   sequence of [`bpy.types.AssetRepresentation`](bpy.types.AssetRepresentation.html#bpy.types.AssetRepresentation "bpy.types.AssetRepresentation")

bpy.context.id
:   Type:
    :   [`bpy.types.ID`](bpy.types.ID.html#bpy.types.ID "bpy.types.ID")

bpy.context.selected_ids
:   Type:
    :   sequence of [`bpy.types.ID`](bpy.types.ID.html#bpy.types.ID "bpy.types.ID")
user: Describe Inputs from the Blender manual or Python API, including usage steps and snippets.

assistant: Curve
:   Standard geometry input with a curve component.

Group ID
:   Value used to group curves together.
    Curves with different Group ID are treated separately.

Mode
:   The type of geometry the output consists of.

    Triangles:
    :   The output is made up of triangles.

    N-gons:
    :   The output is made up of n-gons.
user: Explain Arrange in complete detail according to the official Blender documentation.

assistant: Change the drawing order of the strokes in the 2D layer.

Bring to Front
:   Moves to the top the selected points/strokes.

Bring Forward
:   Moves the selected points/strokes upper the next one in the drawing order.

Send Backward
:   Moves the selected points/strokes below the previous one in the drawing order.

Send to Back
:   Moves to the bottom the selected points/strokes.
user: Describe The Current File Asset Library from the Blender manual or Python API, including usage steps and snippets.

assistant: To help with the management of assets in the current blend-file, you can set the Asset Browser
to show the **Current File asset library**. This always shows the assets in the current file,
even when the current file is not saved in an asset library.
This also makes it possible to create assets and use them in the same file,
for small single-file projects.

When the current blend-file is part of an asset library, you can also see its assets in that library, of course.
The assets that are in the current file are marked with an icon; only those are editable.
user: Describe Float4x4AttributeValue(bpy_struct) from the Blender manual or Python API, including usage steps and snippets.

assistant: # Float4x4AttributeValue(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.Float4x4AttributeValue(*bpy_struct*)
:   Matrix value in geometry attribute

    value
    :   Matrix

        Type:
        :   [`mathutils.Matrix`](mathutils.html#mathutils.Matrix "mathutils.Matrix") of 4 \* 4 items in [-inf, inf], default ((0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0), (0.0, 0.0, 0.0, 0.0))

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: Provide the full official documentation entry for BrushCapabilitiesSculpt(bpy_struct), preserving all code examples.

assistant: # BrushCapabilitiesSculpt(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.BrushCapabilitiesSculpt(*bpy_struct*)
:   Read-only indications of which brush operations are supported by the current sculpt tool

    has_accumulate
    :   Type:
        :   boolean, default False, (readonly)

    has_auto_smooth
    :   Type:
        :   boolean, default False, (readonly)

    has_auto_smooth_pressure
    :   Type:
        :   boolean, default False, (readonly)

    has_color
    :   Type:
        :   boolean, default False, (readonly)

    has_direction
    :   Type:
        :   boolean, default False, (readonly)

    has_dyntopo
    :   Type:
        :   boolean, default False, (readonly)

    has_gravity
    :   Type:
        :   boolean, default False, (readonly)

    has_hardness_pressure
    :   Type:
        :   boolean, default False, (readonly)

    has_height
    :   Type:
        :   boolean, default False, (readonly)

    has_jitter
    :   Type:
        :   boolean, default False, (readonly)

    has_normal_weight
    :   Type:
        :   boolean, default False, (readonly)

    has_persistence
    :   Type:
        :   boolean, default False, (readonly)

    has_pinch_factor
    :   Type:
        :   boolean, default False, (readonly)

    has_plane_depth
    :   Type:
        :   boolean, default False, (readonly)

    has_plane_height
    :   Type:
        :   boolean, default False, (readonly)

    has_plane_offset
    :   Type:
        :   boolean, default False, (readonly)

    has_rake_factor
    :   Type:
        :   boolean, default False, (readonly)

    has_random_texture_angle
    :   Type:
        :   boolean, default False, (readonly)

    has_sculpt_plane
    :   Type:
        :   boolean, default False, (readonly)

    has_secondary_color
    :   Type:
        :   boolean, default False, (readonly)

    has_size_pressure
    :   Type:
        :   boolean, default False, (readonly)

    has_smooth_stroke
    :   Type:
        :   boolean, default False, (readonly)

    has_space_attenuation
    :   Type:
        :   boolean, default False, (readonly)

    has_strength_pressure
    :   Type:
        :   boolean, default False, (readonly)

    has_tilt
    :   Type:
        :   boolean, default False, (readonly)

    has_topology_rake
    :   Type:
        :   boolean, default False, (readonly)

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type
user: What is References and how is it used in Blender Python scripting?

assistant: |  |  |
| --- | --- |
| - [`BlendData.fonts`](bpy.types.BlendData.html#bpy.types.BlendData.fonts "bpy.types.BlendData.fonts") - [`BlendDataFonts.load`](bpy.types.BlendDataFonts.html#bpy.types.BlendDataFonts.load "bpy.types.BlendDataFonts.load") - [`BlendDataFonts.remove`](bpy.types.BlendDataFonts.html#bpy.types.BlendDataFonts.remove "bpy.types.BlendDataFonts.remove") - [`GeometryNodeStringToCurves.font`](bpy.types.GeometryNodeStringToCurves.html#bpy.types.GeometryNodeStringToCurves.font "bpy.types.GeometryNodeStringToCurves.font") - [`TextCurve.font`](bpy.types.TextCurve.html#bpy.types.TextCurve.font "bpy.types.TextCurve.font") | - [`TextCurve.font_bold`](bpy.types.TextCurve.html#bpy.types.TextCurve.font_bold "bpy.types.TextCurve.font_bold") - [`TextCurve.font_bold_italic`](bpy.types.TextCurve.html#bpy.types.TextCurve.font_bold_italic "bpy.types.TextCurve.font_bold_italic") - [`TextCurve.font_italic`](bpy.types.TextCurve.html#bpy.types.TextCurve.font_italic "bpy.types.TextCurve.font_italic") - [`TextStrip.font`](bpy.types.TextStrip.html#bpy.types.TextStrip.font "bpy.types.TextStrip.font") |
user: Describe Editing Meta Objects from the Blender manual or Python API, including usage steps and snippets.

assistant: # Editing Meta Objects

In addition to having several meta objects in a same family,
you can also have several meta primitives in a single object (just add some more while in Edit Mode).
Each will be an element, with its own shape, editing rings (in the viewport), and settings.
user: Give a detailed overview of basic.copy_chain: syntax, arguments, return values, common patterns.

assistant: Copies the bone chain keeping all the parent relations within the chain untouched.
Useful as a utility rig type for custom rigs.

Requirement: A chain of at least two connected bones.

Control (Boolean)
:   When enabled control bones and widgets will be created.

Deform (Boolean)
:   When enabled deform bones will be created.
user: Describe LineStyleGeometryModifiers(bpy_struct) from the Blender manual or Python API, including usage steps and snippets.

assistant: # LineStyleGeometryModifiers(bpy_struct)

base class — [`bpy_struct`](bpy.types.bpy_struct.html#bpy.types.bpy_struct "bpy.types.bpy_struct")

*class* bpy.types.LineStyleGeometryModifiers(*bpy_struct*)
:   Geometry modifiers for changing line geometries

    new(*name*, *type*)
    :   Add a geometry modifier to line style

        Parameters:
        :   - **name** (*string**,* *(**never None**)*) – New name for the geometry modifier (not unique)
            - **type** (enum in [Linestyle Geometry Modifier Type Items](bpy_types_enum_items/linestyle_geometry_modifier_type_items.html#rna-enum-linestyle-geometry-modifier-type-items)) – Geometry modifier type to add

        Returns:
        :   Newly added geometry modifier

        Return type:
        :   [`LineStyleGeometryModifier`](bpy.types.LineStyleGeometryModifier.html#bpy.types.LineStyleGeometryModifier "bpy.types.LineStyleGeometryModifier")

    remove(*modifier*)
    :   Remove a geometry modifier from line style

        Parameters:
        :   **modifier** ([`LineStyleGeometryModifier`](bpy.types.LineStyleGeometryModifier.html#bpy.types.LineStyleGeometryModifier "bpy.types.LineStyleGeometryModifier"), (never None)) – Geometry modifier to remove

    *classmethod* bl_rna_get_subclass(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The RNA type or default when not found.

        Return type:
        :   [`bpy.types.Struct`](bpy.types.Struct.html#bpy.types.Struct "bpy.types.Struct") subclass

    *classmethod* bl_rna_get_subclass_py(*id*, *default=None*, */*)
    :   Parameters:
        :   **id** (*str*) – The RNA type identifier.

        Returns:
        :   The class or default when not found.

        Return type:
        :   type