Overhauled CamOps Unit Reputation Calculations and Report #4605

IllianiCBT · 2024-08-11T06:47:57Z

As requested by Hammer, this PR goes through and rewrites how we handle CamOps Reputation (previously known as Unit Rating). This incorporates current errata and streamlines a lot of the calculations.

Furthermore, CamOps reputation was detached from IUnitRating, as this gave me a lot more freedom in how I could implement the new system.

The second reason was that I wanted to isolate FM:Mr's Unit Rating calculations entirely. While FM:Mr is considered deprecated at this point, by isolating it it's my hope that we can reduce the likelihood of some future change breaking FM:Mr's Unit Rating, which would then potentially result in its' removal. While CamOps rules are current and what we will be supporting, moving forward, I recognize that some users prefer to use FM:Mr. I wanted to make one last gesture of support before 50.0 ships and FM:Mr becomes visible as 'deprecated' to the wider userbase.

I also added Crime Tracking, because it amused me to do so. Right now it only tracks whether the campaign is a Pirate faction, but I intend to have some fun with this at a later date.

Closes #3475

Simplified the method for retrieving unit rating modifiers by implementing a new utility. Introduced the ReputationController class and the AverageExperienceRating class to manage reputation and experience ratings, respectively, facilitating better campaign management.

Added a new CommandRating class to calculate commander ratings based on skills and personality traits. Integrated this functionality into the ReputationController, storing the calculated ratings in a map and updating the total commander rating.

Replaced `getFinalSkillValue` with `getExperienceLevel` for skill assessment. This change ensures skill levels reflect experience more accurately.

Added null checks in getSkillValue and getPersonalityValue methods to ensure the functions return 0 when the Person object is null. This prevents potential NullPointerExceptions.

Integrated detailed logging to track commander rating calculations within CommandRating. Corrected logger instantiation in AverageExperienceRating for consistency and accuracy.

Renamed `commanderRating` to `commandRating` for clarity and consistency. Adjusted the logger statement for improved readability.

Introduced `retainerStartDate` to track the start date of a retainer. Added `CombatRecordRating` class to calculate and store ratings based on mission outcomes, and updated `ReputationController` to use this new rating.

Implemented the TransportationRating class to compute transportation metrics for a Campaign. Updated ReputationController to include transportation rating in reputation calculations and added isFullyCrewed method in Unit class.

Adjusted ratings for support personnel, JumpShip and WarShip presence, and docking collar requirements. Implemented a method to count non-unit personnel for accurate transport requirements.

Renamed the CamOpsRatingV2 package and its classes to CamOpsReputation for better clarity and alignment with the new naming conventions. Updated all relevant import statements to reflect these changes.

Introduced FinancialRating class with a method to calculate financial ratings based on current financial status. Updated ReputationController to integrate financial rating calculations into the reputation initialization process.

Introduced CrimeRating class and integrated crime rating calculation into the Campaign and ReputationController. Updated Campaign's XML handling to serialize and deserialize crime rating and date of last crime.

Modified the crime rating increment from 3 to 2 in the `updateCimeRating` method within the `Campaign` class.

Simplified the condition in processUnitReputation by removing the check for empty active missions. This change focuses the function on processing unit reputation solely based on the day of the month.

Introduced `OtherModifiers` class to calculate additional reputation modifiers considering inactive years. Updated `ReputationController` to integrate these calculations, storing results in `otherModifiersMap` and applying the total modifier to `reputationRating`.

Implemented a method to calculate the total reputation by aggregating various ratings and modifiers. This update ensures the reputationRating variable is properly updated with all relevant components.

Included getter and setter methods for average skill level, experience rating, commander map, and other attributes in ReputationController. These methods were added to improve encapsulation and allow external access to these fields while maintaining control over their modification.

Improved transportation rating calculations by fixing key mismatches and optimizing aggregation. Introduced detailed logging in ReputationController and improved experience calculation methods for better accuracy. Removed redundant methods in CombatRecordRating and streamlined imports.

Updated the comment format in Skill.java to use HTML tags and removed an unused variable from AverageExperienceRating.java. These changes improve code readability and eliminate unnecessary variables.

Enhanced the logging mechanism by tracking individual transportation values. Each transportation category now logs its rating, improving the debugging and analysis capabilities. Additionally, the method `calculateRating` was changed to protected for extended accessibility.

Added logic to set the date of the last crime if the faction is pirate. This ensures accurate crime tracking and proper update of the crime rating. Removed redundant initialization of ReputationController within the same method.

Added `getDescription` method to generate a comprehensive HTML summary of unit reputation, including experience, command, combat record, transportation, financial, and crime ratings. Also added helper methods to format mission and transport strings and updated `initializeReputation` to include transportation values.

Deleted the entire CampaignOpsReputation.java file as it is no longer needed. All references and related code have been purged to streamline project structure and eliminate unused code.

Changed the reputation calculation method to directly set rather than increment the initial value. Updated various UI elements to reflect the new terminology, replacing "Unit Rating" with "Reputation".

Deleted the AtB CamOps Division label, spinner, and associated properties from the CampaignOptionsPane. Updated the labeling for unit rating methods to emphasize reputation instead. Removed the feature's impact on the options setup and persistence logic.

Introduced a new `ReputationReportDialog` to handle non-FMMR unit ratings. Updated `CampaignGUI` and `CommandCenterTab` to dynamically choose between `UnitRatingReportDialog` and `ReputationReportDialog` based on campaign options. Adjusted `UnitRatingReportDialog` to use fixed font settings.

Refactored the `Person` class to separate different tech roles into distinct methods. Enhanced support rating calculations in `SupportRating` to include detailed requirements and added new methods for administration and technician requirements. Updated reputation handling to incorporate support ratings.

Implemented resource bundles to facilitate localization of the unit reputation descriptions. Refactored the existing string literals to use keys from the new CamOpsReputation.properties file.

Resolved errors in DropShip rating calculations by correctly referencing resources for text values. Added new text properties for transport and DropShip strings, improving display formatting and consistency.

Revised the crime rating method to return detailed crime metrics in a map. Introduced a separate piracy modifier to handle pirate crimes, allowing for more granular control and accurate logging. Updated related properties and XML handling to support these changes.

pheonixstorm · 2024-08-11T23:13:48Z

@IllianiCBT if you haven't already you may also want to check out #3610 as it also deals with the Cam Ops rating.

Consolidated skill level summation logic using a Consumer for code reuse and clarity. This change eliminates redundant code and improves the maintainability of the AverageExperienceRating class.

repligator · 2024-08-12T14:09:05Z

My unit Rep Report shows (+-10) for 1 failed mission. Is that meant to be read as 'plus negative ten', and if so could it be re-written as '-10' the same way No Dropship is -5?

repligator · 2024-08-12T15:13:12Z

NPE on first day of the month

11:10:55,807 ERROR [mekhq.MekHQ] {AWT-EventQueue-0}
mekhq.MekHQ.lambda$main$1(MekHQ.java:294) - Uncaught Exception Detected
java.lang.NullPointerException: temporal
	at java.base/java.util.Objects.requireNonNull(Objects.java:235)
	at java.base/java.time.LocalDate.from(LocalDate.java:394)
	at java.base/java.time.LocalDate.until(LocalDate.java:1641)
	at java.base/java.time.temporal.ChronoUnit.between(ChronoUnit.java:272)
	at mekhq.campaign.Campaign.processUnitReputation(Campaign.java:3805)

mekhq.log
Omega Galaxy31540201.cpnx.gz

EDIT: Happened first day of the next month as well.

HammerGS · 2024-08-12T16:04:30Z

I think we go with the CodeQL has the sanity check and merge this. Then it's easier for QA to test in the nightlies up to release.

IllianiCBT · 2024-08-12T18:41:15Z

Updated the mission string format to display the correct sign and added a null check for dateOfLastCrime

Updated the mission string format to display the correct multiplier and added a null check for dateOfLastCrime in the `Campaign` class.

IllianiCBT · 2024-08-12T18:42:30Z

This is the updated Action: https://github.com/MegaMek/mekhq/actions/runs/10357521893

MekHQ/src/mekhq/campaign/Campaign.java

Renamed `processUnitReputation` to `updateCrimeRating` to better reflect its functionality.

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java

Sleet01 · 2024-08-13T02:19:20Z

MekHQ/unittests/mekhq/campaign/rating/CampaignOpsReputationTest.java

I'm leery of deleting an entire unit test file without at least attempting to replicate its coverage. Is there a plan to implement unit tests of the new code at some point in the near future?

Sleet01

A couple questions, but overall looks good!

Eliminated several unused setter methods from `ReputationController.java` to improve code maintainability and readability.

Replaced reputationController with reputationRecord across multiple classes to improve modularity and clarity. Added static methods for initializing and fetching reputation reports. Reduced code duplication and improved encapsulation, ensuring all related data is now managed within the ReputationRecord. Fixed average experience and support requirement calculations for empty campaigns. Adjusting Reputation to only update on Monday.

MekHQ/src/mekhq/campaign/Campaign.java

Updated the Campaign class and related dialogs to use the new ReputationController methods and structure. Replaced all instances of getReputationController and setReputationController with getReputation and setReputation. Added XML serialization and deserialization for reputation data in the ReputationController class.

MekHQ/src/mekhq/campaign/Campaign.java

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java

Added try-catch blocks to handle NumberFormatException and NullPointerException during parsing of TechnicianRequirements. Logged errors to assist in debugging and prevent application crashes due to malformed input.

Changed from catching NullPointerException to catching all exceptions. This ensures that unanticipated exceptions are properly logged, improving error tracking and debugging.

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java

IllianiCBT added 30 commits August 9, 2024 20:27

Update skill value retrieval method

7d12bb9

Replaced `getFinalSkillValue` with `getExperienceLevel` for skill assessment. This change ensures skill levels reflect experience more accurately.

Handle null Person in skill and personality value methods

b5ab2a0

Added null checks in getSkillValue and getPersonalityValue methods to ensure the functions return 0 when the Person object is null. This prevents potential NullPointerExceptions.

Add logging for command rating calculation details

b1ef6b5

Integrated detailed logging to track commander rating calculations within CommandRating. Corrected logger instantiation in AverageExperienceRating for consistency and accuracy.

Rename variables in calculateCommanderRating method

0c46e5b

Renamed `commanderRating` to `commandRating` for clarity and consistency. Adjusted the logger statement for improved readability.

Add retainer start date and combat record rating

ec84bbe

Introduced `retainerStartDate` to track the start date of a retainer. Added `CombatRecordRating` class to calculate and store ratings based on mission outcomes, and updated `ReputationController` to use this new rating.

Add TransportationRating calculation for Campaign

8fc1af1

Implemented the TransportationRating class to compute transportation metrics for a Campaign. Updated ReputationController to include transportation rating in reputation calculations and added isFullyCrewed method in Unit class.

Improve transportation rating calculations

ef4d370

Adjusted ratings for support personnel, JumpShip and WarShip presence, and docking collar requirements. Implemented a method to count non-unit personnel for accurate transport requirements.

Rename CamOpsRatingV2 package to CamOpsReputation

bdf26fa

Renamed the CamOpsRatingV2 package and its classes to CamOpsReputation for better clarity and alignment with the new naming conventions. Updated all relevant import statements to reflect these changes.

Merge branch 'refs/heads/master' into camOps_unitRating

1e77205

Add financial rating calculation

b942f9b

Introduced FinancialRating class with a method to calculate financial ratings based on current financial status. Updated ReputationController to integrate financial rating calculations into the reputation initialization process.

Add Crime Rating calculation to the Campaign

86222b3

Introduced CrimeRating class and integrated crime rating calculation into the Campaign and ReputationController. Updated Campaign's XML handling to serialize and deserialize crime rating and date of last crime.

Reduce crime rating increment after one year

25132b9

Modified the crime rating increment from 3 to 2 in the `updateCimeRating` method within the `Campaign` class.

Remove empty mission check in processUnitReputation

2f1d5a7

Simplified the condition in processUnitReputation by removing the check for empty active missions. This change focuses the function on processing unit reputation solely based on the day of the month.

Add total reputation calculation to ReputationController

0747596

Implemented a method to calculate the total reputation by aggregating various ratings and modifiers. This update ensures the reputationRating variable is properly updated with all relevant components.

Update comment format and remove unused variable

3568f14

Updated the comment format in Skill.java to use HTML tags and removed an unused variable from AverageExperienceRating.java. These changes improve code readability and eliminate unnecessary variables.

Add manual unit rating modifier to campaign

2a8a510

Update unit reputation process for pirate factions

e2513ac

Added logic to set the date of the last crime if the faction is pirate. This ensures accurate crime tracking and proper update of the crime rating. Removed redundant initialization of ReputationController within the same method.

Remove CampaignOpsReputation.java

3ad5f30

Deleted the entire CampaignOpsReputation.java file as it is no longer needed. All references and related code have been purged to streamline project structure and eliminate unused code.

Update reputation calculation and related UI labels

740c2cc

Changed the reputation calculation method to directly set rather than increment the initial value. Updated various UI elements to reflect the new terminology, replacing "Unit Rating" with "Reputation".

Added internationalization support for reputation descriptions

04240fd

Implemented resource bundles to facilitate localization of the unit reputation descriptions. Refactored the existing string literals to use keys from the new CamOpsReputation.properties file.

IllianiCBT added 2 commits August 11, 2024 02:37

Fixed DropShip rating calculation and updated text properties

de4b1ff

Resolved errors in DropShip rating calculations by correctly referencing resources for text values. Added new text properties for transport and DropShip strings, improving display formatting and consistency.

IllianiCBT mentioned this pull request Aug 11, 2024

Vehicle crewmembers throwing off vehicle crew experience rating. #3610

Closed

Refactored skill handling in calculateRegularExperience.

d25483b

Consolidated skill level summation logic using a Consumer for code reuse and clarity. This change eliminates redundant code and improves the maintainability of the AverageExperienceRating class.

IllianiCBT mentioned this pull request Aug 12, 2024

Unit Rating (Reputation) does not handle mothballed units logically #2454

Open

Merge branch 'MegaMek:master' into camOps_unitRating

e20c3f2

Fixed mission string formatting and null check in CrimeModifier

fe5afc6

Updated the mission string format to display the correct multiplier and added a null check for dateOfLastCrime in the `Campaign` class.

Merge branch 'MegaMek:master' into camOps_unitRating

add52ed

Sleet01 reviewed Aug 12, 2024

View reviewed changes

MekHQ/src/mekhq/campaign/Campaign.java Outdated Show resolved Hide resolved

IllianiCBT and others added 2 commits August 12, 2024 18:44

Update crime rating method name

7753585

Renamed `processUnitReputation` to `updateCrimeRating` to better reflect its functionality.

Merge branch 'MegaMek:master' into camOps_unitRating

2119a9c

Sleet01 reviewed Aug 13, 2024

View reviewed changes

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java Outdated Show resolved Hide resolved

Sleet01 reviewed Aug 13, 2024

View reviewed changes

Sleet01 approved these changes Aug 13, 2024

View reviewed changes

IllianiCBT added 2 commits August 12, 2024 22:36

Removed unused setter methods.

dbcc43b

Eliminated several unused setter methods from `ReputationController.java` to improve code maintainability and readability.

github-advanced-security bot found potential problems Aug 13, 2024

View reviewed changes

MekHQ/src/mekhq/campaign/Campaign.java Fixed Show fixed Hide fixed

IllianiCBT added 2 commits August 13, 2024 11:44

Rolled back move to Java Record

1bc0fab

github-advanced-security bot found potential problems Aug 13, 2024

View reviewed changes

IllianiCBT added 2 commits August 13, 2024 14:35

Add exception handling for TechnicianRequirements parsing

7be8bcc

Added try-catch blocks to handle NumberFormatException and NullPointerException during parsing of TechnicianRequirements. Logged errors to assist in debugging and prevent application crashes due to malformed input.

Refactored exception handling in ReputationController.

55a2c0a

Changed from catching NullPointerException to catching all exceptions. This ensures that unanticipated exceptions are properly logged, improving error tracking and debugging.

github-advanced-security bot found potential problems Aug 13, 2024

View reviewed changes

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java Dismissed Show dismissed Hide dismissed

MekHQ/src/mekhq/campaign/rating/CamOpsReputation/ReputationController.java Dismissed Show dismissed Hide dismissed

IllianiCBT merged commit cb75889 into MegaMek:master Aug 13, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhauled CamOps Unit Reputation Calculations and Report #4605

Overhauled CamOps Unit Reputation Calculations and Report #4605

IllianiCBT commented Aug 11, 2024 •

edited

Loading

pheonixstorm commented Aug 11, 2024

repligator commented Aug 12, 2024 •

edited

Loading

repligator commented Aug 12, 2024 •

edited

Loading

HammerGS commented Aug 12, 2024

IllianiCBT commented Aug 12, 2024 •

edited

Loading

IllianiCBT commented Aug 12, 2024

Sleet01 Aug 13, 2024

Sleet01 left a comment

Overhauled CamOps Unit Reputation Calculations and Report #4605

Overhauled CamOps Unit Reputation Calculations and Report #4605

Conversation

IllianiCBT commented Aug 11, 2024 • edited Loading

Closes #3475

pheonixstorm commented Aug 11, 2024

repligator commented Aug 12, 2024 • edited Loading

repligator commented Aug 12, 2024 • edited Loading

HammerGS commented Aug 12, 2024

IllianiCBT commented Aug 12, 2024 • edited Loading

IllianiCBT commented Aug 12, 2024

Sleet01 Aug 13, 2024

Choose a reason for hiding this comment

Sleet01 left a comment

Choose a reason for hiding this comment

IllianiCBT commented Aug 11, 2024 •

edited

Loading

repligator commented Aug 12, 2024 •

edited

Loading

repligator commented Aug 12, 2024 •

edited

Loading

IllianiCBT commented Aug 12, 2024 •

edited

Loading