diff options
author | Aaron Carlisle <carlisle.b3d@gmail.com> | 2021-01-07 03:52:13 +0300 |
---|---|---|
committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2021-01-07 03:52:13 +0300 |
commit | 27426c05b16c0ab4a3bd34aff4093576a9400dfb (patch) | |
tree | 100b59c02241f32499d8c8fe04d60a68718a6b85 /doc/python_api/rst/info_api_reference.rst | |
parent | b138c8f5b3a63b0cf10b20e874f6a16b8393485b (diff) |
PyAPI Docs: Link to user docs instead of describing in API doc
Diffstat (limited to 'doc/python_api/rst/info_api_reference.rst')
-rw-r--r-- | doc/python_api/rst/info_api_reference.rst | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/doc/python_api/rst/info_api_reference.rst b/doc/python_api/rst/info_api_reference.rst index e39dc6e2c3e..fb53fb1a992 100644 --- a/doc/python_api/rst/info_api_reference.rst +++ b/doc/python_api/rst/info_api_reference.rst @@ -185,23 +185,19 @@ For example, if you want to access the texture of a brush via Python to adjust i #. Start in the default scene and enable Sculpt Mode from the 3D Viewport header. #. From the Sidebar expand the Brush Settings panel's *Texture* subpanel and add a new texture. *Notice the texture data-block menu itself doesn't have very useful links (you can check the tooltips).* -#. The contrast setting isn't exposed in the Sidebar, so view the texture in the properties editor: - - - In the properties editor select the Texture tab. - - Select brush texture. - - Expand the *Colors* panel to locate the *Contrast* number field. +#. The contrast setting isn't exposed in the Sidebar, so view the texture in the + :ref:`Properties Editor <blender_manual:bpy.types.Texture.contrast` #. Open the context menu of the contrast field and select *Online Python Reference*. 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. Sometimes there are many references, and it may take some guesswork to find the right one, 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`` 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. Now you can use the Python console to form the nested properties needed to access brush textures contrast: -*Context -> Tool Settings --> Sculpt --> Brush -> Texture -> Contrast*. +:menuselection:`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: |