diff options
author | skyace65 <trekie96@hotmail.com> | 2020-12-15 19:16:43 -0500 |
---|---|---|
committer | skyace65 <trekie96@hotmail.com> | 2020-12-15 19:16:43 -0500 |
commit | dbcc9d360033b37689ad27c3100762e1797dd965 (patch) | |
tree | fe7f072cd52db766b2a496b6e46b8e3e0b715c00 /doc/classes | |
parent | 92d4deedaa542e9458845fdf2b2a44fedd19fde8 (diff) |
Document what can be used as a type hint
Diffstat (limited to 'doc/classes')
-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. |