Codechange: rename SettingGuiFlag to SettingFlag #9332
Merged
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
LordAro
reviewed
Jun 3, 2021
src/settings_internal.h
Outdated
| SF_NEWGAME_ONLY = 1 << 6, ///< this setting cannot be changed in a game. | ||
| SF_SCENEDIT_TOO = 1 << 7, ///< this setting can be changed in the scenario editor (only makes sense when SF_NEWGAME_ONLY is set). | ||
| SF_SCENEDIT_ONLY = 1 << 8, ///< this setting can only be changed in the scenario editor. | ||
| SF_PER_COMPANY = 1 << 9, ///< this setting can be different for each company (saved in company struct). |
There was a problem hiding this comment.
Is reordering this going to cause any issues?
There was a problem hiding this comment.
not as far as I can see and as far as I could test.
Nowhere this value is stored in the savegame. But I would love some extra pairs of eyes on it to validate that claim.
There was a problem hiding this comment.
Shouldn't the comments start with a capital?
frosch123
reviewed
Jun 3, 2021
frosch123
reviewed
Jun 3, 2021
TrueBrain
force-pushed
the
rename-setting-flags
branch
from
64884dd
to
193423f
Compare
frosch123
previously approved these changes
Jun 3, 2021
It is a lovely organicly grown enum, where it started off with GUI-only flags, and after that a few flags got added that can be considered GUI-only (the GUI disables/enables based on them), to only have flags added that has nothing to do with the GUI. So be less confusing, and rename them to what they do. Additionally, I took this opportunity to rename 0ISDISABLED to reflect what it really does.
TrueBrain
force-pushed
the
rename-setting-flags
branch
from
193423f
to
e5c5de7
Compare
frosch123
approved these changes
Jun 3, 2021
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.
Motivation / Problem
@rubidium42 : it happened, it annoyed me enough!!
For the rest: settings have this weird quirk where something is called "guiflags" but is really the flags of the settings. And we have a "flags" which is really the flags of the saveload part. This is so confusing ...
Description
In a follow-up commit I am going to address the
flagsvsguiflags.Limitations
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.