Skip to content

Commit 3b5a0f1

Browse files
committed
Add documentation for Docks
1 parent 4a52813 commit 3b5a0f1

16 files changed

+242
-0
lines changed

tutorials/editor/docks.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _doc_docks:
2+
3+
Docks
4+
-----
5+
6+
Docks or tabs are positioned on the left and right sides of the viewport.
7+
Their usage is covered in their respective pages.
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
:name: toc-editor-docks
12+
13+
import_dock
14+
filesystem_dock
15+
inspector_dock
16+
node_dock
17+
history_dock
18+
19+
20+
You can also customize the docks by moving, or resizing them.
21+
Read :ref:`doc_customizing_editor` for more on this.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
.. _doc_filesystem_dock:
2+
3+
FileSystem Dock
4+
===============
5+
6+
FileSystem dock contains lists all resources available for the current project.
7+
You can think it as a built-in file browser in the Godot's Editor.
8+
The root folder is the :ref:`res:// <doc_filesystem>` folder.
9+
10+
.. image:: img/filesystem_dock.webp
11+
12+
The "<" and ">" arrows navigate between the previous and next selected file in the view history.
13+
The text field next to the arrows shows the relative path to the selected file or folder.
14+
Below this field is the location of all files and folders in the project.
15+
16+
The button next to the relative path field switches through the look of the contents.
17+
The square shows the resources in tree view, which the files and folders share the same location.
18+
Clicking on this button changes the split mode of the folders and files.
19+
Clicking once lists the folders above and the subfolders or the files inside
20+
the folders below. Clicking it again moves the folders to the left, and the subfolders and
21+
the files to the right.
22+
23+
In any viewing mode, you can use the "Filter Files" bar to search for a file or folder.
24+
The button next to this bar provides a set of sorting options for the contents.
25+
You can sort the contents by name, type, or modification time, in ascending or descending order.
26+
27+
If using a split mode, you can also change the look of thumbnails in the files section, by pressing
28+
the button next to the sort button.
29+
30+
The blue ``.tscn`` file (Scene File) in the file list means that this scene is the main scene
31+
if the project.
32+
You can right click on any other scene files and choose "Set As Main Scene" to change it.
33+
This can also later be changed via navigating to `Project > Project Settings > Run`.
34+
You can also `instantiate` the scene or create a new scene by `inheriting` it using the context
35+
menu on the scene files.
36+
37+
Hovering over a file gives information on the file size and the type.
38+
Some resources can be dragged and dropped onto the 2D or 3D viewport if they are supported.
39+
If a resource is accepted as a sub-resource, you can also drag it onto a sub-resource section
40+
inside the Inspector dock.
41+
42+
.. Refer to :ref:`doc_inspector_dock`
43+
44+
Right-clicking on a folder or a file provides a set of options such as renaming, deleting, moving,
45+
or duplicating.
46+
47+
Some of the interesting options are the following:
48+
49+
Note that, not all items will be visible for a single type of file.
50+
51+
- **Edit Dependencies...**: Shows a window with files that this file depends on. If you have
52+
missing dependencies, you can also pick replacements to fix them.
53+
- **View Owners...**: Opens a window which shows the owners of a file. You can click on a result to
54+
open it.
55+
- **Create New**: Lets you create a new folder, scene, script, resource, or a text file inside a folder.
56+
- **Copy Path**: Copies the relative path of the file or folder starting with ``res://``.
57+
- **Copy Absolute Path**: Copies the absolute system path of a file or folder start.
58+
- **Copy UID**: Copies the unique identifier of a resource if it has one. The path will start with ``uid://``.
59+
The UID will not change when the item is renamed or moved. See :ref:`ResourceUID <class_ResourceUID>` for more.
60+
- **Add to Favorites**: Adds the selected file or folder to the favorites which will can easily be seen
61+
under `Favorites` section in the resource list.
62+
- **Reimport**: If this file is a non-native resource, you can reimport them.
63+
64+
If you right click on a folder, you will have options to expand a folder or the hierarchy, or collapse it.
65+
Also, "Set Folder Color..." submenu will be visible to change the color of the folder.
66+
67+
.. tip:: To move an item from one folder to another, you can drag and drop it directly onto
68+
the destination folder.
69+
70+
.. tip:: Double-clicking a file opens the file if it can be opened inside the Editor.
71+
72+
.. seealso:: Refer to :ref:`doc_customizing_editor` for dock customization options.

tutorials/editor/history_dock.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _doc_history_dock:
2+
3+
History Dock
4+
============
5+
6+
If you are unhappy with a recent setting change you made in Godot, or you prefer the
7+
previous value of a node property, Godot keeps a list of actions in the `History` dock.
8+
This history of actions is separate for each scene and is remembered until you close
9+
the project.
10+
11+
.. image:: img/history_dock.webp
12+
13+
If you click on an item, the project will be reverted to that state. If you do not
14+
make any changes, you can change the state back and forth without losing anything.
15+
16+
You can choose whether to display the `Scene` related actions and also include `Global`
17+
changes, such as changing an editor setting in Godot's Editor. Global changes will be
18+
displayed in blue text.
19+
20+
.. warning:: The changes made in the script/text editor are not displayed here.
21+
22+
.. tip:: Alternatively, you can use the `Scene` menu and select `Undo` or `Redo`, or use
23+
the default :kbd:`Ctrl + Z` or :kbd:`Ctrl + Y` shortcuts (:kbd:`Cmd + Z` or
24+
:kbd:`Cmd + Z` on Mac).
25+
26+
.. seealso:: Refer to :ref:`doc_customizing_editor` for dock customization options.
2.36 KB
Loading
8.44 KB
Loading
6.68 KB
Loading
7.29 KB
Loading
3.37 KB
Loading
16.3 KB
Loading
17.4 KB
Loading

0 commit comments

Comments
 (0)