PyAPI Docs: Update Indirect Data Access docs
Fixes T84432
This commit is contained in:
@@ -194,34 +194,26 @@ For example, if you want to access the texture of a brush via Python to adjust i
|
|||||||
This takes you to ``bpy.types.Texture.contrast``. Now you can see that ``contrast`` is a property of texture.
|
This takes you to ``bpy.types.Texture.contrast``. Now you can see that ``contrast`` is a property of texture.
|
||||||
#. To find out how to access the texture from the brush check on the references at the bottom of the page.
|
#. To find out how to access the texture from the brush check on the references at the bottom of the page.
|
||||||
Sometimes there are many references, and it may take some guesswork to find the right one,
|
Sometimes there are many references, and it may take some guesswork to find the right one,
|
||||||
but in this case it's ``Brush.texture``.
|
but in this case it's ``tool_settings.sculpt.brush.texture``.
|
||||||
|
|
||||||
#. Now you know that the texture can be accessed from ``bpy.data.brushes["BrushName"].texture``
|
#. Now you know that the texture can be accessed from ``bpy.data.brushes["BrushName"].texture``
|
||||||
but normally you *won't* want to access the brush by name, instead you want to access the active brush.
|
but normally you *won't* want to access the brush by name, instead you want to access the active brush.
|
||||||
So the next step is to check on where brushes are accessed from via the references.
|
So the next step is to check on where brushes are accessed from via the references.
|
||||||
In this case there it is simply ``bpy.context.brush``.
|
|
||||||
|
|
||||||
Now you can use the Python console to form the nested properties needed to access brush textures contrast:
|
Now you can use the Python console to form the nested properties needed to access brush textures contrast:
|
||||||
*Context -> Brush -> Texture -> Contrast*.
|
*Context -> Tool Settings --> Sculpt --> Brush -> Texture -> Contrast*.
|
||||||
|
|
||||||
Since the attribute for each is given along the way you can compose the data path in the Python console:
|
Since the attribute for each is given along the way you can compose the data path in the Python console:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
bpy.context.brush.texture.contrast
|
bpy.context.tool_settings.sculpt.brush.texture.contrast
|
||||||
|
|
||||||
There can be multiple ways to access the same data, which you choose often depends on the task.
|
|
||||||
An alternate path to access the same setting is:
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
bpy.context.sculpt.brush.texture.contrast
|
|
||||||
|
|
||||||
Or access the brush directly:
|
Or access the brush directly:
|
||||||
|
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
bpy.data.brushes["BrushName"].texture.contrast
|
bpy.data.textures["Texture"].contrast
|
||||||
|
|
||||||
|
|
||||||
If you are writing a user tool normally you want to use the :mod:`bpy.context` since the user normally expects
|
If you are writing a user tool normally you want to use the :mod:`bpy.context` since the user normally expects
|
||||||
|
|||||||
Reference in New Issue
Block a user