Mention ProjectSettings won't be affected by convert_text_resources_to_binary
#91300
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
doc/classes/ProjectSettings.xml
Outdated
| @@ -917,6 +917,7 @@ | |||
| </member> | |||
| <member name="editor/export/convert_text_resources_to_binary" type="bool" setter="" getter="" default="true"> | |||
| If [code]true[/code], text resources are converted to a binary format on export. This decreases file sizes and speeds up loading slightly. | |||
| [b]Note:[/b] Project Settings are not a resource so "project.godot" will always be converted to "project.binary" on export. | |||
| [b]Note:[/b] If [member editor/export/convert_text_resources_to_binary] is [code]true[/code], [method @GDScript.load] will not be able to return the converted files in an exported project. Some file paths within the exported PCK will also change, such as [code]project.godot[/code] becoming [code]project.binary[/code]. If you rely on run-time loading of files present within the PCK, set [member editor/export/convert_text_resources_to_binary] to [code]false[/code]. | |||
There was a problem hiding this comment.
This needs to be changed to some useful example, it now contradicts what it just said above
However a file like foo.tscn isn't saved as foo.scn but instead export-{md5}-foo.scn etc. so unsure how to explain it here
There was a problem hiding this comment.
I think the converted name (export-{md5}-foo.scn) is an implementation detail, no?
There was a problem hiding this comment.
Agreed, so let's just mention it like "it will turn tscn to scn and tres to res" and perhaps mention something about how you can't open these with FileAccess, as per:
And so on, unsure exactly where to refer to, so making a note about not being able to open them directly, and to use ResourceLoader instead generally
AThousandShips
added
enhancement
documentation
cherrypick:4.1
timothyqiu
reviewed
Apr 29, 2024
jsjtxietian
force-pushed
the
project-binary-doc
branch
from
69b6011 to
b0c43a5
Compare
Mickeon
reviewed
Jul 5, 2024
jsjtxietian
force-pushed
the
project-binary-doc
branch
from
b0c43a5 to
9d18983
Compare
Mickeon
approved these changes
Jul 8, 2024
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #90999 (comment)
Fixes #90981