Merge pull request #7200 from IllianiBird/civilianProfessionOptions

Improvement: #7196 Improved Civilian Generation to Include Better Control Over Random Profession Selection

Author: rjhancock

MekHQ/resources/mekhq/resources/CampaignOptionsDialog.properties

@@ -551,6 +551,21 @@ lblUseRandomDependentAddition.tooltip=This enables the monthly addition of rando
 lblUseRandomDependentRemoval.text=Random Removal
 lblUseRandomDependentRemoval.tooltip=This enables the monthly removal of random civilians from the\
   \ campaign.
+lblDependentProfessionDieSize.text=Dependent Profession Chance: \u26A0 <span style="color:#C344C3;">\u2605</span> 1 in
+lblDependentProfessionDieSize.tooltip=This is the number of sides on the die rolled to determine whether a\
+  \ a civilian should generate with the Dependent profession.\
+  <br>\
+  <br>A civilian will generation with the Dependent profession on a roll of 1. Set to 0 to prevent Civilians from \
+  spawning with the catch-all 'Professional' profession.
+lblCivilianProfessionDieSize.text=Civilian Profession Chance: \u26A0 <span style="color:#C344C3;">\u2605</span> 1 in
+lblCivilianProfessionDieSize.tooltip=This is the number of sides on the die rolled to determine whether a\
+  \ a civilian should generate with a random non-Dependent profession.\
+  <br>\
+  <br>A civilian will generate with a non-Dependent profession on a roll of 1. Set to 0 to disable random \
+  non-Dependent profession assignment.\
+  <br>\
+  <br><b>Warning:</b> This check is made <i>after</i> the check to see whether a character is generated as a \
+  Dependent. That means the actual chance of a character generating as a Dependent will be lower than displayed.
 # createMedicalTab
 lblMedicalTab.text=Medical Options
 lblUseAdvancedMedical.text=Use Advanced Medical \u270E \u2318

MekHQ/src/mekhq/campaign/Campaign.java

@@ -1911,7 +1911,7 @@ public Person newDependent(Gender gender) {
     }
 
     /**
-     * Creates a new dependent with given gender, origin faction and origin planet.
+     * Creates a new dependent with the given gender, origin faction, and origin planet.
      *
      * @param gender        The {@link Gender} of the new dependent.
      * @param originFaction The {@link Faction} that represents the origin faction for the new dependent. This can be
@@ -1924,11 +1924,22 @@ public Person newDependent(Gender gender) {
     public Person newDependent(Gender gender, @Nullable Faction originFaction, @Nullable Planet originPlanet) {
         PersonnelRole civilianProfession = PersonnelRole.MISCELLANEOUS_JOB;
 
-        if (randomInt(20) == 0) {
-            List<PersonnelRole> civilianRoles = PersonnelRole.getCivilianRolesExceptNone();
-            civilianProfession = ObjectUtility.getRandomItem(civilianRoles);
+        int dependentProfessionDieSize = campaignOptions.getDependentProfessionDieSize();
+        if (dependentProfessionDieSize == 0 || randomInt(dependentProfessionDieSize) == 0) {
+            civilianProfession = PersonnelRole.DEPENDENT;
         }
 
+        int civilianProfessionDieSize = campaignOptions.getCivilianProfessionDieSize();
+        if (civilianProfessionDieSize > 0) { // A value of 0 denotes that this system has been disabled
+            if (randomInt(civilianProfessionDieSize) == 0) {
+                List<PersonnelRole> civilianRoles = PersonnelRole.getCivilianRolesExceptNone();
+                civilianProfession = ObjectUtility.getRandomItem(civilianRoles);
+            }
+        }
+
+        // When a character is generated we include age checks to ensure they're old enough for the profession
+        // chosen, so we don't need to include age-checks here.
+
         return newPerson(civilianProfession,
               PersonnelRole.NONE,
               new DefaultFactionSelector(getCampaignOptions().getRandomOriginOptions(), originFaction),

MekHQ/src/mekhq/campaign/CampaignOptions.java

@@ -277,6 +277,8 @@ public static String getTechLevelName(final int techLevel) {
     // Dependent
     private boolean useRandomDependentAddition;
     private boolean useRandomDependentRemoval;
+    private int dependentProfessionDieSize;
+    private int civilianProfessionDieSize;
 
     // Personnel Removal
     private boolean usePersonnelRemoval;
@@ -833,6 +835,8 @@ public CampaignOptions() {
         // Dependent
         setUseRandomDependentAddition(false);
         setUseRandomDependentRemoval(false);
+        setDependentProfessionDieSize(4);
+        setCivilianProfessionDieSize(2);
 
         // Personnel Removal
         setUsePersonnelRemoval(false);
@@ -2398,6 +2402,22 @@ public boolean isUseRandomDependentRemoval() {
     public void setUseRandomDependentRemoval(final boolean useRandomDependentRemoval) {
         this.useRandomDependentRemoval = useRandomDependentRemoval;
     }
+
+    public int getDependentProfessionDieSize() {
+        return dependentProfessionDieSize;
+    }
+
+    public void setDependentProfessionDieSize(final int dependentProfessionDieSize) {
+        this.dependentProfessionDieSize = dependentProfessionDieSize;
+    }
+
+    public int getCivilianProfessionDieSize() {
+        return civilianProfessionDieSize;
+    }
+
+    public void setCivilianProfessionDieSize(final int civilianProfessionDieSize) {
+        this.civilianProfessionDieSize = civilianProfessionDieSize;
+    }
     // endregion Dependent
 
     // region Personnel Removal
@@ -5062,6 +5082,8 @@ public void writeToXml(final PrintWriter pw, int indent) {
         // region Dependent
         MHQXMLUtility.writeSimpleXMLTag(pw, indent, "useRandomDependentAddition", isUseRandomDependentAddition());
         MHQXMLUtility.writeSimpleXMLTag(pw, indent, "useRandomDependentRemoval", isUseRandomDependentRemoval());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "dependentProfessionDieSize", getDependentProfessionDieSize());
+        MHQXMLUtility.writeSimpleXMLTag(pw, indent, "civilianProfessionDieSize", getCivilianProfessionDieSize());
         // endregion Dependent
 
         // region Personnel Removal
@@ -5911,6 +5933,10 @@ public static CampaignOptions generateCampaignOptionsFromXml(Node parentNod, Ver
                     campaignOptions.setUseRandomDependentAddition(Boolean.parseBoolean(nodeContents));
                 } else if (nodeName.equalsIgnoreCase("useRandomDependentRemoval")) {
                     campaignOptions.setUseRandomDependentRemoval(Boolean.parseBoolean(nodeContents));
+                } else if (nodeName.equalsIgnoreCase("dependentProfessionDieSize")) {
+                    campaignOptions.setDependentProfessionDieSize(MathUtility.parseInt(nodeContents, 4));
+                } else if (nodeName.equalsIgnoreCase("civilianProfessionDieSize")) {
+                    campaignOptions.setCivilianProfessionDieSize(MathUtility.parseInt(nodeContents, 2));
                     // endregion Dependent
 
                     // region Personnel Removal

MekHQ/src/mekhq/gui/campaignOptions/CampaignOptionsUtilities.java

@@ -245,6 +245,25 @@ public static int processWrapSize(@Nullable Integer customWrapSize) {
         return customWrapSize == null ? 100 : customWrapSize;
     }
 
+    /**
+     * Creates a {@link MouseAdapter} that updates the text of a {@link JLabel} within the specified panel to display a
+     * tip string when the mouse enters a related component.
+     *
+     * <p>
+     * When the mouse enters a component with the specified name, this adapter retrieves a localized tip string
+     * associated with that component. If the tip contains fewer than five HTML line break tags ({@code <br>}), extra
+     * line breaks are appended to ensure a minimum number of lines. The formatted tip is then set as the text of a
+     * {@link JLabel} within the provided panel, specifically targeting labels whose name matches the required pattern.
+     * </p>
+     *
+     * @param associatedHeaderPanel   the {@link JPanel} containing the label to update
+     * @param sourceComponentBaseName the name of the component whose tip string will be shown in the label
+     *
+     * @return a {@link MouseAdapter} instance that updates the label with formatted tip text on mouse enter
+     *
+     * @author Illiani
+     * @since 0.50.06
+     */
     public static MouseAdapter createTipPanelUpdater(CampaignOptionsHeaderPanel associatedHeaderPanel,
           @Nullable String sourceComponentBaseName) {
         return createTipPanelUpdater(associatedHeaderPanel, sourceComponentBaseName, null);
@@ -263,6 +282,8 @@ public static MouseAdapter createTipPanelUpdater(CampaignOptionsHeaderPanel asso
      *
      * @param associatedHeaderPanel         the {@link JPanel} containing the label to update
      * @param sourceComponentBaseName the name of the component whose tip string will be shown in the label
+     * @param replacementText the specific text to use, or {@code null} if the text should be dynamically fetched
+     *                        from the source component.
      *
      * @return a {@link MouseAdapter} instance that updates the label with formatted tip text on mouse enter
      *

MekHQ/src/mekhq/gui/campaignOptions/contents/PersonnelTab.java

@@ -199,6 +199,10 @@ public class PersonnelTab {
     private JPanel dependentsPanel;
     private JCheckBox chkUseRandomDependentAddition;
     private JCheckBox chkUseRandomDependentRemoval;
+    private JLabel lblDependentProfessionDieSize;
+    private JSpinner spnDependentProfessionDieSize;
+    private JLabel lblCivilianProfessionDieSize;
+    private JSpinner spnCivilianProfessionDieSize;
     //end Prisoners and Dependents Tab
     //end Salaries Tab
 
@@ -239,6 +243,10 @@ private void initializePrisonersAndDependentsTab() {
         dependentsPanel = new JPanel();
         chkUseRandomDependentAddition = new JCheckBox();
         chkUseRandomDependentRemoval = new JCheckBox();
+        lblDependentProfessionDieSize = new JLabel();
+        spnDependentProfessionDieSize = new JSpinner();
+        lblCivilianProfessionDieSize = new JLabel();
+        spnCivilianProfessionDieSize = new JSpinner();
     }
 
     /**
@@ -1050,7 +1058,7 @@ public JPanel createPrisonersAndDependentsTab() {
         // Header
         prisonersAndDependentsHeader = new CampaignOptionsHeaderPanel("PrisonersAndDependentsTab",
               getImageDirectory() + "logo_illyrian_palatinate.png",
-              2);
+              9);
 
         // Contents
         prisonerPanel = createPrisonersPanel();
@@ -1133,10 +1141,27 @@ private JPanel createDependentsPanel() {
         chkUseRandomDependentAddition = new CampaignOptionsCheckBox("UseRandomDependentAddition");
         chkUseRandomDependentAddition.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
               "UseRandomDependentAddition"));
+
         chkUseRandomDependentRemoval = new CampaignOptionsCheckBox("UseRandomDependentRemoval");
         chkUseRandomDependentRemoval.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
               "UseRandomDependentRemoval"));
 
+        lblDependentProfessionDieSize = new CampaignOptionsLabel("DependentProfessionDieSize");
+        lblDependentProfessionDieSize.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
+              "DependentProfessionDieSize"));
+        spnDependentProfessionDieSize = new CampaignOptionsSpinner("DependentProfessionDieSize",
+              4, 0, 100, 1);
+        spnDependentProfessionDieSize.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
+              "DependentProfessionDieSize"));
+
+        lblCivilianProfessionDieSize = new CampaignOptionsLabel("CivilianProfessionDieSize");
+        lblCivilianProfessionDieSize.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
+              "CivilianProfessionDieSize"));
+        spnCivilianProfessionDieSize = new CampaignOptionsSpinner("CivilianProfessionDieSize",
+              2, 0, 100, 1);
+        spnCivilianProfessionDieSize.addMouseListener(createTipPanelUpdater(prisonersAndDependentsHeader,
+              "CivilianProfessionDieSize"));
+
         // Layout the Panel
         final JPanel panel = new CampaignOptionsStandardPanel("DependentsPanel", true, "DependentsPanel");
         final GridBagConstraints layout = new CampaignOptionsGridBagConstraints(panel);
@@ -1149,6 +1174,17 @@ private JPanel createDependentsPanel() {
         layout.gridy++;
         panel.add(chkUseRandomDependentRemoval, layout);
 
+        layout.gridy++;
+        panel.add(lblDependentProfessionDieSize, layout);
+        layout.gridx++;
+        panel.add(spnDependentProfessionDieSize, layout);
+
+        layout.gridx = 0;
+        layout.gridy++;
+        panel.add(lblCivilianProfessionDieSize, layout);
+        layout.gridx++;
+        panel.add(spnCivilianProfessionDieSize, layout);
+
         return panel;
     }
 
@@ -1308,6 +1344,8 @@ public void loadValuesFromCampaignOptions(@Nullable CampaignOptions presetCampai
         comboPrisonerCaptureStyle.setSelectedItem(options.getPrisonerCaptureStyle());
         chkUseRandomDependentAddition.setSelected(options.isUseRandomDependentAddition());
         chkUseRandomDependentRemoval.setSelected(options.isUseRandomDependentRemoval());
+        spnDependentProfessionDieSize.setValue(options.getDependentProfessionDieSize());
+        spnCivilianProfessionDieSize.setValue(options.getCivilianProfessionDieSize());
     }
 
     /**
@@ -1400,5 +1438,7 @@ public void applyCampaignOptionsToCampaign(Campaign campaign, @Nullable Campaign
         }
         options.setUseRandomDependentAddition(chkUseRandomDependentAddition.isSelected());
         options.setUseRandomDependentRemoval(chkUseRandomDependentRemoval.isSelected());
+        options.setDependentProfessionDieSize((int) spnDependentProfessionDieSize.getValue());
+        options.setCivilianProfessionDieSize((int) spnCivilianProfessionDieSize.getValue());
     }
 }