Skip to content

Commit

Permalink
Add Scene Tree manual
Browse files Browse the repository at this point in the history
  • Loading branch information
vgezer committed Aug 13, 2024
1 parent 2bad814 commit 39dc595
Show file tree
Hide file tree
Showing 29 changed files with 260 additions and 26 deletions.
6 changes: 3 additions & 3 deletions getting_started/introduction/first_look_at_the_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Below is the 3D one:

.. seealso:: To learn more on the 3D viewport and 3D in general, read :ref:`doc_introduction_to_3d`.

On either side of the viewport sit the **docks**. And at the bottom of the
window lies the **bottom panel**.
On either side of the viewport sit the :ref:`doc_docks`. And at the bottom of the
window lies the :ref:`doc_bottom_panel`.

Let's look at the docks. The **FileSystem** dock lists your project files, including
scripts, images, audio samples, and more:
Expand All @@ -100,7 +100,7 @@ The **Inspector** allows you to edit the properties of a selected node:

.. seealso:: To read more on inspector, see :ref:`doc_editor_inspector_dock`.

.. seealso:: Docks can be customized. Read more on :ref:`doc_customizing_editor_moving_docks`.
.. seealso:: Docks can be customized. Read more on :ref:`doc_customizing_editor_moving_resizing_docks`.

The **bottom panel**, situated below the viewport, is the host for the debug
console, the animation editor, the audio mixer, and more. They can take precious
Expand Down
2 changes: 1 addition & 1 deletion tutorials/editor/customizing_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Godot's interface lives in a single window by default. Since Godot 4.0, you can
split several elements to separate windows to better make use of multi-monitor
setups.

.. _doc_customizing_editor_moving_docks:
.. _doc_customizing_editor_moving_resizing_docks:

Moving and resizing docks
-------------------------
Expand Down
1 change: 0 additions & 1 deletion tutorials/editor/default_key_mapping.rst
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,6 @@ Property Editor
| Paste Value | :kbd:`Ctrl + V` | :kbd:`Opt + V` | ``property_editor/paste_value`` |
+--------------------+-------------------------+------------------------+----------------------------------------+


.. _doc_default_key_mapping_particles:

Particles
Expand Down
11 changes: 2 additions & 9 deletions tutorials/editor/docks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,20 @@
Docks
-----

.. warning:: This page is a work-in-progress.

Docks or tabs are positioned on the left and right sides of the viewport.
Their usage is covered in their respective pages.

.. toctree::
:maxdepth: 1
:name: toc-editor-docks

inspector_dock
scene_tree_dock
import_dock
filesystem_dock
inspector_dock
node_dock
history_dock

- Scene Tree Dock
- Import Dock
- FileSystem Dock
- :ref:`Inspector Dock <doc_editor_inspector_dock>`
- Node Dock
- History Dock

You can also customize the docks by moving, or resizing them.
Read :ref:`doc_customizing_editor` for more on this.
2 changes: 1 addition & 1 deletion tutorials/editor/history_dock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ the project.
If you click on an item, the project will be reverted to that state. If you do not
make any changes, you can change the state back and forth without losing anything.

You can choose whether to display the `Scene` related actions and include `Global`
You can choose whether to display the `Scene` related actions and also include `Global`
changes, such as changing an editor setting in Godot's Editor. Global changes will be
displayed in blue text.

Expand Down
Binary file added tutorials/editor/img/scene_tree_add_node.webp
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_context_menu.webp
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_empty.webp
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_icons/Group.webp
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_icons/Groups.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_icons/Lock.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_icons/Script.webp
Binary file not shown.
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_icons/Signals.webp
Binary file not shown.
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_sub_res.webp
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_toolbar.webp
Binary file not shown.
Binary file not shown.
Binary file added tutorials/editor/img/scene_tree_with_nodes.webp
Binary file not shown.
20 changes: 11 additions & 9 deletions tutorials/editor/inspector_dock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ From left to right:
- `Make Resource Built-In` to work in a built-in resource, not the one from the disk.

- The "<" and ">" arrows let you navigate through your edited object history.
- The button next to them opens this list for a quicker navigation. If you created multiple
- The button next to them opens the history list for a quicker navigation. If you created multiple
resources in the memory, you will also see them here.

Below, you can find the selected node's icon, its name, and the quick button to open
Expand All @@ -43,7 +43,7 @@ Then comes the search bar. Type anything in it to filter displayed properties.
Delete the text to clear the search.
This search is case insensitive and also searches letter by letter as you type.
For instance, if you type ``vsb``, one of the results you see will be
**V** isi **b** i **l** ity property.
Visibility property as this property contains all of these letters.

Before discussing the tool button next to the filter bar, it is worth mentioning
what you actually see below it and how it is structured.
Expand All @@ -61,10 +61,11 @@ Similarly, you can right click on a property and copy or paste its value,
copy the property path, or open its documentation page.

If you hover your mouse over a property, you will see the description of what
it does from the documentation, as well as how it can be called inside the script.
it does as well as how it can be called inside the script.

You can directly change the values by clicking, typing, or selecting from the menu.
If it is a number or a slider, you can keep your left mouse button pressed and drag.
If the property is a number or a slider, you can keep your left mouse button
pressed and drag to change the values.

.. |undo| image:: img/inspector_dock_revert.webp

Expand All @@ -85,9 +86,9 @@ various view and edit options.
than the current value (the properties with |undo| icon).
- **Property Name Style**: This section determines how the properties' text is displayed in
the inspector. `Raw` uses the property's own naming, `Capitalized` uses title
case by changing the initial letters of each word to uppercase, `Localized`
displays the translation of the properties if you are using the Editor in a language
other than English.
case by changing the initial letters of each word to uppercase and removing underscores,
`Localized` displays the translation of the properties if you are using the Editor
in a language other than English.
- **Copy Properties**: Copies all properties of the current node with their current values.
- **Paste Properties**: Pastes the copied properties from the clipboard. Useful to apply
the common properties of one node to another.
Expand All @@ -97,8 +98,9 @@ various view and edit options.
Clicking this option makes each sub-resource used in this node unique, separated from
other nodes.

.. note:: If a node has exported variables in its attached script, you will also see these
in the inspector. See :ref:`doc_gdscript_exports` for more on this topic.
.. tip:: If a node has exported variables in its attached script, you will also see these
in the inspector. The first image in this section has one for the Player node:
`Action Suffix`. See :ref:`doc_gdscript_exports` for more on this topic.

.. seealso:: Refer to :ref:`doc_customizing_editor` for dock customization options.

Expand Down
8 changes: 6 additions & 2 deletions tutorials/editor/project_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ To create a new project:

.. note:: You can optionally choose a version control system. Currently, only
`git <https://git-scm.com>`__ is supported and it needs the Godot Git Plugin to be installed,
either manually or using the :ref:`Asset Library <doc_using_assetlib>`. To learn more about the Godot Git Plugin, see its `wiki <https://github.com/godotengine/godot-git-plugin/wiki>`__.
either manually or using the :ref:`Asset Library <doc_using_assetlib>`. To learn more about the
Godot Git Plugin, see its `wiki <https://github.com/godotengine/godot-git-plugin/wiki>`__.

Using the file browser
~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -77,6 +78,9 @@ list. Double click on it to open it in the editor.

.. image:: img/editor_ui_intro_project_manager_06.webp

You can use the star icon located on the left of a project to favorite/unfavorite it. Favorited
projects will be listed and exempted from the sorting.

You can similarly import existing projects using the **Import** button. Locate the
folder that contains the project or the **project.godot** file to import and
edit it.
Expand Down Expand Up @@ -140,5 +144,5 @@ another machine, and import it into the project manager you will see the tags
you created.

To remove a tag from your project manager it must be removed from all the projects it's
used by. Once that's done close the project manager, open it up again, and the tag should
used by. Once that's done close the project manager, open it up again, and the tag will
be gone.
2 changes: 2 additions & 0 deletions tutorials/editor/project_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Project Settings
================

.. warning:: This page is a work-in-progress.

This page explains how to use the Project Settings window. If you would like to access and modify
project settings via code, see :ref:`ProjectSettings <class_ProjectSettings>`.

Expand Down
Loading

0 comments on commit 39dc595

Please sign in to comment.