godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the purpose of load_steps in TSCN file format (#5001)

Browse Source 
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
This commit is contained in:
Lisandro Lorea
2021-06-16 18:42:51 -03:00
committed by Hugo Locurcio
parent 9b8fb00e25
commit c0ef3dd52b
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
development/file_formats/tscn.rst
View File

@@ -28,10 +28,12 @@ There are five main sections inside the TSCN file:
3. Nodes
4. Connections
The file descriptor looks like ``[gd_scene load_steps=1 format=2]`` and should
be the first entry in the file. The ``load_steps`` parameter should (in theory)
be the number of resources within the file. However, in practice, its value seems
not to matter.
The file descriptor looks like ``[gd_scene load_steps=3 format=2]`` and should
be the first entry in the file. The ``load_steps`` parameter is equal to the
total amount of resources (internal and external) plus one (for the file itself).
If the file has no resources, ``load_steps`` is omitted. The engine will
still load the file correctly if ``load_steps`` is incorrect, but this will affect
loading bars and any other piece of code relying on that value.
These sections should appear in order, but it can be hard to distinguish them.
The only difference between them is the first element in the heading for all of