diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-10-04 20:48:07 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-04 20:48:07 +0200 |
| commit | 3556bc48a1d357ff0109e2677c2e02b925a3e46b (patch) | |
| tree | 3a455f79892c8cef4861c0978243db991e02601b | |
| parent | 59e7a5a94f9625038c8f0f745be4ef4ba5b4558a (diff) | |
| parent | a8404cf56c68bb7ed56cdf6193bad9f92029a8b6 (diff) | |
Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xref
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
| -rw-r--r-- | doc/classes/ResourceLoader.xml | 4 | ||||
| -rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 1 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 6a864b1067..049613fa5d 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -6,7 +6,6 @@ <description> Singleton used to load resource files from the filesystem. It uses the many [ResourceFormatLoader] classes registered in the engine (either built-in or from a plugin) to load files into memory and convert them to a format that can be used by the engine. - GDScript has a simplified [method @GDScript.load] built-in method which can be used in most situations, leaving the use of [ResourceLoader] for more advanced scenarios. </description> <tutorials> <link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link> @@ -66,7 +65,8 @@ The registered [ResourceFormatLoader]s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. If [code]no_cache[/code] is [code]true[/code], the resource cache will be bypassed and the resource will be loaded anew. Otherwise, the cached resource will be returned if it exists. - Returns an empty resource if no ResourceFormatLoader could handle the file. + Returns an empty resource if no [ResourceFormatLoader] could handle the file. + GDScript has a simplified [method @GDScript.load] built-in method which can be used in most situations, leaving the use of [ResourceLoader] for more advanced scenarios. </description> </method> <method name="load_threaded_get"> diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 512452a8df..fc27892099 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -627,6 +627,7 @@ var main = load("res://main.tscn") # main will contain a PackedScene resource. [/codeblock] [b]Important:[/b] The path must be absolute, a local path will just return [code]null[/code]. + This method is a simplified version of [method ResourceLoader.load], which can be used for more advanced scenarios. </description> </method> <method name="log"> |