diff options
author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-05-08 07:00:33 +0200 |
---|---|---|
committer | RĂ©mi Verschelde <rverschelde@gmail.com> | 2023-05-12 12:31:21 +0200 |
commit | 35fa05fa51df23b481e852e0d715a42ba4db68c8 (patch) | |
tree | c88716eb5dbfd044e805371a53544c028e8ff99d /modules/gdscript | |
parent | dcca6485d0c9b1724496b150fb777fc3d0aabfa5 (diff) |
Document caveats related to exported project binary resource conversion
(cherry picked from commit febc674f4818dd1185b2e43e899115f70f55b4f5)
Diffstat (limited to 'modules/gdscript')
-rw-r--r-- | modules/gdscript/doc_classes/@GDScript.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index 5f2ca0d215..04877e521a 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -170,6 +170,7 @@ [b]Important:[/b] The path must be absolute. A relative path will always return [code]null[/code]. This function is a simplified version of [method ResourceLoader.load], which can be used for more advanced scenarios. [b]Note:[/b] Files have to be imported into the engine first to load them using this function. If you want to load [Image]s at run-time, you may use [method Image.load]. If you want to import audio files, you can use the snippet described in [member AudioStreamMP3.data]. + [b]Note:[/b] If [member ProjectSettings.editor/export/convert_text_resources_to_binary] is [code]true[/code], [method @GDScript.load] will not be able to read converted files in an exported project. If you rely on run-time loading of files present within the PCK, set [member ProjectSettings.editor/export/convert_text_resources_to_binary] to [code]false[/code]. </description> </method> <method name="preload"> |