summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2024-11-06 16:53:18 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2024-11-06 16:53:18 +0100
commit44b2c4e00d229bcbd9917e736cf3d68621546975 (patch)
treedb698a356e5946b23b5b3f0ec8a5e919475a4439
parent87318a2fb7fffeb72adca934e31915be077c3d1f (diff)
downloadredot-engine-44b2c4e00d229bcbd9917e736cf3d68621546975.tar.gz
Clarify `ResourceLoader.load_threaded_get_status()` completion ratio description
-rw-r--r--doc/classes/ResourceLoader.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml
index 56c3208fc3..f718ad15d8 100644
--- a/doc/classes/ResourceLoader.xml
+++ b/doc/classes/ResourceLoader.xml
@@ -104,7 +104,7 @@
<param index="1" name="progress" type="Array" default="[]" />
<description>
Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [param path]. See [enum ThreadLoadStatus] for possible return values.
- An array variable can optionally be passed via [param progress], and will return a one-element array containing the percentage of completion of the threaded loading.
+ An array variable can optionally be passed via [param progress], and will return a one-element array containing the ratio of completion of the threaded loading (between [code]0.0[/code] and [code]1.0[/code]).
[b]Note:[/b] The recommended way of using this method is to call it during different frames (e.g., in [method Node._process], instead of a loop).
</description>
</method>