Merge pull request #98899 from Calinou/doc-resourceloader-load-threaded-get-status

Clarify `ResourceLoader.load_threaded_get_status()` completion ratio description
This commit is contained in:
Thaddeus Crews 2024-11-07 12:36:30 -06:00
commit 8d03a463b3
No known key found for this signature in database
GPG Key ID: 62181B86FE9E5D84

View File

@ -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>