Added MHQDialogImmersive for Immersive Dialog Functionality that Immersively Improves Immersion
#5709
Conversation
Updated references and class declarations across the codebase to reflect the new name. This improves clarity by better describing the purpose of the base class within the GUI structure.
Replaced references to AbstractMHQNagDialog.getSpeakerDescription with MHQDialogImmersive.getSpeakerDescription across several classes. Removed the getSpeakerDescription implementation from AbstractMHQNagDialog, streamlining the code with a more centralized utility approach.
Introduced a new class, MHQDialogImmersive, to provide an immersive dialog interface with support for customizable speakers, messages, and buttons. This new dialog is designed to improve user interaction and flexibility by allowing detailed configurations like speaker roles, images, and out-of-character messages. The implementation includes dynamic panel scaling and resource localization to ensure seamless integration into the UI.
Replaced the ButtonLabelTooltipPair class with a Java record for improved readability and conciseness. Updated method calls to directly use record accessors, reducing boilerplate code.
Updated the copyright years in several source files to include 2025. This maintains licensing compliance and reflects the ongoing development of MekHQ.
| import static mekhq.gui.dialog.resupplyAndCaches.ResupplyDialogUtilities.getSpeakerIcon; | ||
| import static mekhq.utilities.ImageUtilities.scaleImageIconToWidth; | ||
|
|
||
| public class MHQDialogImmersive extends JDialog { |
There was a problem hiding this comment.
I couldn't determine whether this should be called MHQDialogImmersive or AbstractMHQDialogImmersive. Guidance would be appreciated. :)
There was a problem hiding this comment.
By our standards, Abstract... should only be used in the name of a class that is Abstract.
Only a class that does not implement, or inherit from another class, its own methods should be Abstract, so
in this case MHQDialogImmersive is more correct.
| @@ -1,3 +1,21 @@ | |||
| /* | |||
There was a problem hiding this comment.
Apparently, I forgot to include the copyright notice when I wrote this class in 2024, so adding it here.
| @@ -0,0 +1,417 @@ | |||
| /* | |||
There was a problem hiding this comment.
Note for Reviewer: this is the only class that has had functionality change/be introduced. The rest is just housekeeping.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5709 +/- ##
============================================
+ Coverage 10.03% 10.20% +0.16%
- Complexity 6069 6073 +4
============================================
Files 1074 1010 -64
Lines 141525 139327 -2198
Branches 20666 20443 -223
============================================
+ Hits 14209 14220 +11
+ Misses 125944 123735 -2209
Partials 1372 1372 ☔ View full report in Codecov by Sentry. |
|
@IllianiCBT Hit a conflict after merging the prior patches. |
# Conflicts: # MekHQ/src/mekhq/gui/stratcon/StratconScenarioWizard.java
# Conflicts: # MekHQ/src/mekhq/gui/dialog/AutoResolveChanceDialog.java
MHQDialogImmersive, to provide an immersive dialog interface with support for customizable speakers, messages, and buttons.AbstractMHQDialogtoAbstractMHQDialogBasicto clarify its purpose and use-cases.This new dialog is designed to allow developers to easily generate dialogs that conform with the new 'incoming transmission' style debuted in 50.02.
I wrote this class in a way that encourages developers to keep functionality code out of dialogs, which makes the functions a lot easier to write Unit Tests for, as we test in a headless environment, so hiding code inside dialogs makes that code effectively untestable.
I've also ensured that any interaction with the dialog will cause it to be dismissed, rather than simply hidden. This ensures we're releasing memory when the dialog is closed, rather than keeping it in memory until the client restarts or such a time GC decides to finally eat it.
At time of writing this class is not used, as I wanted to be kind to whoever reviews this and allow them to focus on reviewing the new class, rather than needing to worry about the 101 implementations of said class.