[WIP] Resupply Module

[IllianiCBT]

This is the test branch for the upcoming Resupply Module. For more information please see here

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.40%. Comparing base (2b3d042) to head (2cc5bda).
Report is 17 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #5158      +/-   ##
============================================
- Coverage     10.52%   10.40%   -0.13%     
+ Complexity     6042     6040       -2     
============================================
  Files           956      960       +4     
  Lines        134346   135814    +1468     
  Branches      19514    19781     +267     
============================================
- Hits          14145    14136       -9     
- Misses       118851   120325    +1474     
- Partials       1350     1353       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[repligator]

Error popped up. I'm guessing it's because I had my supply convoy assigned elsewhere at the end of the month.
mekhq.log
IS Logistics30680701.cpnx.gz
Autosave-1-IS Logistics-30680628.cpnx.gz

[IllianiCBT]

Error popped up. I'm guessing it's because I had my supply convoy assigned elsewhere at the end of the month. mekhq.log IS Logistics30680701.cpnx.gz Autosave-1-IS Logistics-30680628.cpnx.gz

Fixed. Thanks for the report :)

[Scoppio]

Add a new enum that works as a kind of "descriptive type", but that does not necessarily substitute whatever type the scenario is (meaning you can have a raid or extraction that count as Emergency Convoy Defense later on, which may be very relevant for a narrative someone is creating), and add types as needed, start with one specific that is for "rescue/protection convoy operation" and the rest are, initially, just the generic.
With that you can avoid the very fragile string comparsion.

Also, because you would be just adding it as something new, it becomes backwards compatible because it considers that it must be a "generic/non-interesting" scenario if it lacks the value by default, or simply the default is applied when the object is created.

[Scoppio]

Style: I prefer an early exit here instead, makes absolutelly no difference in how the code operates, but reduces one tab level.

[Scoppio]

This is a suggestion on how to use modern java with streams for data manipulation and reduce the number of branching operation in the CPU.

The following code was not tested and possibly has bug (like the simultaneos removal of units while iterate over its list), probably need to keep new ArrayList in there (commented out, and probably slightly wrong).

    /**
     * Processes an abandoned convoy. The player is presented with a defeat dialog,
     * and if they have independent command rights, it checks each player template force in the scenario
     * for being a convoy force. If it is a convoy force, its units are treated as abandoned units.
     * Each crew member of these units is set as either KIA or POW based on a die roll.
     * It finally removes each unit from the campaign.
     *
     * @param contract The current {@link AtBContract}.
     * @param scenario The relevant {@link AtBDynamicScenario}.
     */
    private void processAbandonedConvoy(AtBContract contract, AtBDynamicScenario scenario) {
        convoyFinalMessageDialog(this, contract.getEmployerFaction());

        if (!contract.getCommandRights().isIndependent()) {
            return;
        }

        scenario.getPlayerTemplateForceIDs().stream()
            .map(this::getForce).filter(Objects::nonNull)
            .filter(Force::isConvoyForce)
            .map(Force::getUnits)
            // .flatMap(new::ArrayList) ??? maybe this is necessary here? I cant test this case now
            .map(this::decideCrewFate)
            .forEach(this::removeUnit);
    }
    
    /**
     * decideCrewFate
     * <p>
     *     Decide the fate of the crew of a unit that was abandoned in a time of need
     * </p>
     * @param unitID
     * @return
     *
     */
    private UUID decideCrewFate(UUID unitID) {
        Optional.of(getUnit(unitID)).ifPresent(unit -> unit.getCrew().forEach(this::decideCrewmemberFate));
        return unitID;
    }

    /**
     * decidePersonFate
     * <p>
     *      We're using the CamOps rules for infantry survival here and
     *      assuming anyone who isn't dead has been captured.
     * </p>
     * @param person The person to decide the fate of.
     */
    private void decideCrewmemberFate(Person person) {
        PersonnelStatus status = KIA;
        if (Compute.d6(2) > 7) {
            status = PersonnelStatus.POW;
        }
        person.changeStatus(this, currentDay, status);
    }

[Scoppio]

I think this line is a good candidate to be its own function, so we have a place that is easy to find and change the max resuply size.

[Scoppio]

Suggested change

	this.convoyForce = convoyForce;
	if (setForSubForces) {
	for (Force force : subForces) {
	force.setConvoyForce(convoyForce, true);
	}
	}
	this.convoyForce = convoyForce;
	if (setForSubForces) {
	subForces.forEach(force -> force.setConvoyForce(convoyForce, true));
	}