Enforce valid frame rate cap values #4732
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
In `AppPreferences`, use the default value whenever an invalid frame rate cap is detected. In the Preferences dialog, reject non-positive values with a `ParseException`. Though silent today, this is done in the hopes that it will one day be signalled to the user somehow.
|
https://wiki.rptools.info/index.php/MapTool_Preferences documentation could include a general note about ignoring invalid preference values perhaps? This may mitigate potential confusion noted under drawbacks above, well while we are awaiting the aspirational user validation error signaling feature! Similarly https://wiki.rptools.info/index.php/MapTool_Preferences#Performance documentation could include a specific note about +ve integer valid values for Frame Rate Cap. |
cwisniew
approved these changes
Mar 30, 2024
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.
Identify the Bug or Feature request
Fixes #4730
Description of the Change
We no longer allow frame rates that aren't positive integers. This is enforced in two ways:
AppPreferences, by using the default value wherever an invalid value is encountered. This lets all components be able to rely onAppPreferences.getFrameRateCap()to return a useable value.Possible Drawbacks
This can lead to confusion since invalid values are silently ignored in the Preferences dialog (this is already the case for invalid values in this field and others). The Preferences dialog deserves some TLC regarding validation.
Documentation Notes
N/A
Release Notes
This change is