diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2020-12-16 14:17:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-16 14:17:46 +0100 |
| commit | 16a249bd22b70d64c777d48eeac58583e3b24a0d (patch) | |
| tree | ac0a8ecd53f0b36ebc7c6089c28ef85e78c2622d /doc | |
| parent | 3d7b01723b7f577bb57d0a3009363e2dd7f8c08f (diff) | |
| parent | dbcc9d360033b37689ad27c3100762e1797dd965 (diff) | |
Merge pull request #44414 from skyace65/TypeHint
Document what can be used as a type hint
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/ResourceLoader.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index 049613fa5d..c55a51c7ae 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -20,7 +20,7 @@ </argument> <description> Returns whether a recognized resource exists for the given [code]path[/code]. - An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. + An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. </description> </method> <method name="get_dependencies"> @@ -63,7 +63,7 @@ <description> Loads a resource at the given [code]path[/code], caching the result for further access. 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]. + An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. 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. 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. |