Overhaul Project Settings page #10282
Open
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
- Add screenshots - Document reading and writing settings - Document manually editing project.godot - Note that most settings are changed in different classes at runtime
tetrapod00
added
enhancement
area:manual
tetrapod00
commented
Nov 18, 2024
| .. code-tab:: gdscript GDScript | ||
|
|
||
| ProjectSettings.set_setting("application/run/max_fps", 60) | ||
| ProjectSettings.set_setting("display/window/size/mode", DisplayServer.WINDOW_MODE_WINDOWED) |
There was a problem hiding this comment.
For the set of example project settings used throughout the page, I picked these two because:
- I know them reasonably well
- They both need runtime duplicates, in different classes
- They have different types (int and enum) which is mildly instructive especially for the C# examples
- They are reasonably common
I'm open to suggestions for alternate project settings to use as examples. We can also add a third example if there is a good string example to use.
tetrapod00
commented
Nov 18, 2024
| :ref:`RenderingServer <class_RenderingServer>`, | ||
| :ref:`Viewport <class_Viewport>`, or :ref:`Window <class_Window>` classes. In the | ||
| :ref:`ProjectSettings <class_ProjectSettings>` class reference, settings | ||
| links to their equivalent runtime property or method. |
There was a problem hiding this comment.
This was originally "each project setting links to its runtime equivalent" but that's not true until #9944 is done...
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.
Closes #10234.
project.godot.This page is still a bit barebones for my taste, and it doesn't yet document project settings overrides. That's work for future PRs.