From a2c4564dc33808db9b2627e8d9eedcce018be503 Mon Sep 17 00:00:00 2001 From: skyace65 Date: Tue, 1 Sep 2020 13:40:42 -0400 Subject: [PATCH] Move note about using Resource in the File documentation (cherry picked from commit 75c5a8b3542a288d055b9d7ed73fba0596c0031f) --- doc/classes/File.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/classes/File.xml b/doc/classes/File.xml index ea1973bcc01..b972301fe33 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -21,6 +21,7 @@ return content [/codeblock] In the example above, the file will be saved in the user data folder as specified in the [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] documentation. + [b]Note:[/b] To access project resources once exported, it is recommended to use [ResourceLoader] instead of the [File] API, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package. https://docs.godotengine.org/en/latest/getting_started/step_by_step/filesystem.html @@ -48,7 +49,7 @@ Returns [code]true[/code] if the file exists in the given path. - [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the [code]res://.import[/code] folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using [code]File.file_exists[/code] on an imported resource would work while you are developing in the editor (the source asset is present in [code]res://[/code], but fail when exported). + [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account.