From c0ef3dd52bb13d097d356bd5f18880dc1d1be180 Mon Sep 17 00:00:00 2001 From: Lisandro Lorea Date: Wed, 16 Jun 2021 18:42:51 -0300 Subject: [PATCH] Clarify the purpose of `load_steps` in TSCN file format (#5001) Co-authored-by: Hugo Locurcio --- development/file_formats/tscn.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/development/file_formats/tscn.rst b/development/file_formats/tscn.rst index f51ed3083..d2a2e6e53 100644 --- a/development/file_formats/tscn.rst +++ b/development/file_formats/tscn.rst @@ -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