Rename Preferences to Settings in the appropriate places#24613
Open
cart wants to merge 3 commits into
Open
Conversation
cart
added
the
C-Code-Quality
davewa
reviewed
Jun 13, 2026
| /// Builds the settings file registry by scanning the type registry for settings resources. | ||
| /// This is separated from loading to enable testing without file I/O. | ||
| /// | ||
| /// Returns the [`PreferencesFileRegistry`] that tracks which resources are associated with |
There was a problem hiding this comment.
Suggested change
| /// Returns the [`PreferencesFileRegistry`] that tracks which resources are associated with | |
| /// Returns the [`SettingsFileRegistry`] that tracks which resources are associated with |
| /// Saving of settings is not automatic; the recommended practice is to issue a | ||
| /// [`SaveSettingsDeferred`] command after modifying a settings resource. This will wait for | ||
| /// a short interval and then spawn an i/o task to write out the changed settings file. You can | ||
| /// also issue a [`SavePreferencesSync::IfChanged`] command immediately before exiting the app. |
There was a problem hiding this comment.
Suggested change
| /// also issue a [`SavePreferencesSync::IfChanged`] command immediately before exiting the app. | |
| /// also issue a [`SaveSettingsSync::IfChanged`] command immediately before exiting the app. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Objective
bevy_settingscurrently conflates "settings" and "preferences" in a number of places. The name of the framework itself is Bevy Settings, so anything that drives general "settings" behaviors should use "settings" terminology. For example,PreferencesPluginshould beSettingsPluginbecause it handles allSettingsGrouptypes (regardless of their "scope" such as "preferences.toml").Solution
Use "settings" instead of "preferences" in the appropriate places. I've also removed the custom
ExitAfterSavecommands in the examples as they are unnecessary.This should land in 0.19 because we haven't published this API yet and getting naming right is important.