Add basic force generator role functionality to MekHQ scenario random unit generation #4214

SuperStucco · 2024-06-12T14:04:43Z

This is another chunky PR, touches lots of bits and pieces inside AtBDynamicScenarioFactory, some just for readability improvements (so I could follow along easily while testing). There's a minor interaction with pending #4164 (improved bomb selection), in that the populateAeroBombs(...) method gets called towards the bottom of the generateForce(...) method, but the two are complete independent.

Side note: due to the fixed MUL loading issue from #4213 and using similar functionality, did additional checking specifically for fixed MUL affects.

All these changes allow roles (EDIT: these are the force generator roles, from .../docs/RAT Stuff/rat-generator.txt) to be passed down from the 'generated force' level to the individual random unit selection. This has two immediate effects: artillery, and infantry in hostile environments.

Previously, artillery was read from a flag in the scenario settings and passed down through multiple levels using a specific boolean method parameter. That parameter has been removed, and the scenario flag is now used to add the ARTILLERY role to the force selection.

Infantry for hostile environments is an entirely new feature. When certain hostile conditions are present, either the XCT or MARINE roles are automatically added to the force selection for infantry, limiting what types of infantry are generated. Because there are so few official units that fit these parameters, a fall-back position has been included - if no explicit hostile environment infantry is available, normal infantry is generated and the armor kit is swapped out for hostile environment suits. As a bonus, under less hostile conditions that are still deadly to unprotected infantry, normal infantry will have their infantry kit swapped out for something appropriate e.g. snow/heatsuits for temperature, light environmental suits for low atmosphere pressure. The role selection and armor kit changes are applied to base scenario forces and scenario modifier forces, including infantry that is loaded into transport bays of APCs.

This PR adds in hooks to to allow force generator role filters to be added to the scenario template and scenario modifier XMLs. Each force can have an optional roleChoices element with one or more forceRole elements, using the same role formatting as the force generator XMLs. A single forceRole element will always be used while multiple instances will result in random selection. As an example, the HostileFacility.XML scenario template might look like this:

<scenarioForces>
   ...
   <entry>
            <key>Primary Opfor</key>
            <value>
               ...
               <roleChoices>
                   <forceRole></forceRole>
                   <forceRole>urban</forceRole>
                   <forceRole>urban</forceRole>
               </roleChoices>
               ...
            </value> 
   </entry>
   ...
</scenarioForces>

Two thirds of the time the Primary OpFor force will generate using the URBAN role, while the rest will be normal generation without roles (current behavior).

Similarly, the AlliedReinforcments.XML might look like this:

<forceDefinition>
    ...
    <forceName>Allied Ground Reinforcements</forceName>
    ...
    <roleChoices>
        <forceRole></forceRole>
        <forceRole>fire_support</forceRole>
    </roleChoices>
    ...
</forceDefinition>

Each time the modifier is used, it randomly chooses between standard generation and fire support.

Using an empty forceRole entry will select with no roles, as does not including the block (which is current behavior).

Multiple roles can combined using commas and no spaces e.g. "support,cargo". The more roles that are combined the smaller the number to choose from, so use with caution. Roles may have restrictions that are incompatible with other force properties e.g. the RECON role should not be used on a force that may generate heavy or assault weight units. Naturally these role selection elements have no affect on fixed MUL unit selection, but should still be omitted for clarity.

…c atmosphere, wind, gravity

…added parameter to getLance for passing mandatory roles to entity creation methods

…ts/javadoc for readability

…nfantry bays

…ling infantry armor kit swaps

…y code.

…arantee each unit's starting force roles are unique and can be modified independently.

… specific unit type

…nd roles

… infantry

Thom293 · 2024-06-12T15:05:29Z

This looks amazing and allows for so many new possibilities.

So if I read it correctly anytime X infantry is spawned it will check the weather and give them the appropriate kit? Will it work for the fixed mul units? E.g. the Horse Cavalary or the Air Mobile Infantry or Crack Field Artillery (which are always the same units given how the .muls work)? Id understand if it doesnt work that way with them.

I may bug you with lots of questions!

SuperStucco · 2024-06-12T15:19:42Z

This looks amazing and allows for so many new possibilities.

So if I read it correctly anytime X infantry is spawned it will check the weather and give them the appropriate kit? Will it work for the fixed mul units? E.g. the Horse Cavalary or the Air Mobile Infantry or Crack Field Artillery (which are always the same units given how the .muls work)?

I may bug you with lots of questions!

The fixed MUL units are generated in another method, so I don't think the infantry armor kit swaps will address those. The method which handles the replacement process should be callable for the fixed MUL forces, although there might need to be some jiggery-pokery to get environmental conditions to pass to that method. Not sure about the viability of a branth in parka, or breathing gear for horses though...

Sleet01 · 2024-06-12T16:46:47Z

MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java

+        if (scenario.getWind().isTornadoF1ToF3() || scenario.getWind().isTornadoF4()) {
+            allowsConvInfantry = false;
+            if (scenario.getWind().isTornadoF4()) {
+                allowsTanks = false;


Freakin' glorious, this is excellent!

IllianiCBT · 2024-06-12T18:25:55Z

I see you added a new XML tag, would you mind Discord DMing me the process you took to do this? An improperly added XML tag was the cause of the incorrectly loading Fixed MUL issue and I'd like to not fall into that trap again.

# Conflicts: # MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java # MekHQ/src/mekhq/campaign/mission/ScenarioForceTemplate.java

HammerGS

Tested and seems to work.

… specific unit type

…nd roles

… infantry

…y-unit-type # Conflicts: # MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java

Sleet01 · 2024-07-11T18:34:19Z

@SuperStucco I'm not sure all the merges went well; it looks like some of the older CI files got pulled in as well. I will examine more closely when I get the time.

IllianiCBT · 2024-07-11T20:28:52Z

Are you using IDEA? If so, check out Roles-by-unit-type, then select master. Make sure master is fully updated, then right-click master and select compare with 'roles-by-unit-type'. This will show you all the areas where master and roles-by-unit-type differ and will allow you to selectively rollback the bad merge until you're left only with the changes you want to keep. It's a pain in the bum, but is likely the easiest way to handle things at this point.

IllianiCBT · 2024-07-11T20:32:57Z

Another option, would be to manually-copy paste your changes into a new branch and just chalk this one up as a loss. If there are still merge issues at that point, DM me on Discord and I'll walk you through resolving them.

HammerGS · 2024-07-14T15:03:33Z

Wanted to check on this. Do you still need any help sorting this out?

SuperStucco · 2024-07-14T18:03:28Z

Wanted to check on this. Do you still need any help sorting this out?

Yeah. Not sure what/how is getting messed up here, not exactly doing well with the build script (?) updates, and a number of related issues. Not even sure what I've got here is everything that was originally submitted.

Quick edit: just double checked and I'm still getting some 'SerialKiller' thing which mean I can't even build to make debug passes.

SuperStucco · 2024-07-14T23:35:32Z

OK, I think I've gotten the issues worked out and it's building properly here. There's no code updates to push, and the failed check looked to be the gradle version/build script update problem which I've hopefully updated.

IllianiCBT · 2024-07-14T23:56:55Z

Hi Stucco, it looks like you need to update your MM and (presumably) your MML repos to current. I spoke with Tex and they confirmed that's the current cause behind the Gradle test failing. In their words...

the CI scripts check for authors repo branch (with same name) then defaults to their master

SuperStucco · 2024-07-15T00:19:39Z

Hi Stucco, it looks like you need to update your MM and (presumably) your MML repos to current. I spoke with Tex and they confirmed that's the current cause behind the Gradle test failing. In their words...

the CI scripts check for authors repo branch (with same name) then defaults to their master

Might be part of the issue - I'm not working off a specifically named 'master' branch as parent. I've had more than a few issues in the past I consider the actual 'master' branch completely unreliable at this point. So I'm working off a number of other branches which are named other-than-master e..g. master-v3 for MM and master-mhq for MHQ.

SuperStucco · 2024-07-15T14:23:39Z

Someone else is going to have to take a whack at fixing this, because I'm just going in circles - SerialKiller error, then than goes away and is replaced with code errors (even though I haven't changed anything), then back again.

rjhancock · 2024-07-15T14:36:46Z

Did you update your MM repo with the same branch name to the latest code of master?

That is where the SerialKiller issue is coming from.

Make sure all repos have been rebased with master for latest updates to build scripts.

IllianiCBT · 2024-07-15T21:04:36Z

Closing as superceded by #4418

SuperStucco added 21 commits June 7, 2024 10:49

Basic outline

fb43d5d

Basic definition of hostile environment - temperature, pressure, toxi…

70fb2e3

…c atmosphere, wind, gravity

Add MARINE/XCT mandatory roles for infantry in hostile environments, …

be763b4

…added parameter to getLance for passing mandatory roles to entity creation methods

Add master required roles Map object, pass it to generateLance calls

bb2d56b

Numerous changes to incorporate role handling, plus updates to commen…

e338907

…ts/javadoc for readability

Removed single-use local variable, rolled in environmental flag

241d682

Added filters so only units capable of transporting get checked for i…

d61a350

…nfantry bays

Adjustment to environmental conditions logging, added method for hand…

2bc6552

…ling infantry armor kit swaps

Improved handling of role map contents, some local variable renaming

ee11750

Add framework for pulling role data from force template. Remove legac…

9b22978

…y code.

Add infrastructure to support reading XML elements. Minor fixes to gu…

74149ed

…arantee each unit's starting force roles are unique and can be modified independently.

Ensure temperatures must be hot or cold to swap out to heat/snowsuits

d9132d1

Additional protection against passing null when separating roles to a…

6867d3d

… specific unit type

Extra feedback for when roles prevent randomly generating a unit

64b07a6

Minor code standards update

4d6c920

Add looping for filling large infantry bays with multiple platoons

e56df5d

More finesse in generating units weights, accounting for unit types a…

249a3aa

…nd roles

Minor notation updates

e082079

Log warning when conditions prohibit generation of ground vehicles or…

e862109

… infantry

Minor readability updates

5680bcf

Minor readability updates

450fb9d

Sleet01 reviewed Jun 12, 2024

View reviewed changes

IllianiCBT added the AtB label Jun 12, 2024

Merge branch 'refs/heads/mhq-master' into Roles-by-unit-type

afce5a4

# Conflicts: # MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java # MekHQ/src/mekhq/campaign/mission/ScenarioForceTemplate.java

IllianiCBT added the For New Dev Cycle label Jun 21, 2024

SuperStucco mentioned this pull request Jun 23, 2024

Create a Setting to Assign Different Bot Behavior to Each Unit Based on Unit Role MegaMek/megamek#1499

Open

HammerGS approved these changes Jun 30, 2024

View reviewed changes

SuperStucco added 11 commits July 10, 2024 21:54

Ensure temperatures must be hot or cold to swap out to heat/snowsuits

bbd0055

Additional protection against passing null when separating roles to a…

303f2a4

… specific unit type

Extra feedback for when roles prevent randomly generating a unit

942a82f

Minor code standards update

8ee8d69

Add looping for filling large infantry bays with multiple platoons

bbceec6

More finesse in generating units weights, accounting for unit types a…

19d6f24

…nd roles

Minor notation updates

dab665d

Log warning when conditions prohibit generation of ground vehicles or…

1fc6dfc

… infantry

Minor readability updates

e748805

Minor readability updates

2ceaa92

Merge remote-tracking branch 'origin/Roles-by-unit-type' into Roles-b…

645e66b

…y-unit-type # Conflicts: # MekHQ/src/mekhq/campaign/mission/AtBDynamicScenarioFactory.java

Merge branch 'master' into Roles-by-unit-type

1611bfb

Dummy update to initiate push

2ded6a0

IllianiCBT assigned IllianiCBT and SuperStucco and unassigned SuperStucco and IllianiCBT Jul 15, 2024

IllianiCBT closed this Jul 15, 2024

SuperStucco deleted the Roles-by-unit-type branch July 18, 2024 01:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic force generator role functionality to MekHQ scenario random unit generation #4214

Add basic force generator role functionality to MekHQ scenario random unit generation #4214

SuperStucco commented Jun 12, 2024 •

edited

Loading

Thom293 commented Jun 12, 2024 •

edited

Loading

SuperStucco commented Jun 12, 2024

Sleet01 Jun 12, 2024

IllianiCBT commented Jun 12, 2024

HammerGS left a comment

Sleet01 commented Jul 11, 2024

IllianiCBT commented Jul 11, 2024 •

edited

Loading

IllianiCBT commented Jul 11, 2024

HammerGS commented Jul 14, 2024

SuperStucco commented Jul 14, 2024 •

edited

Loading

SuperStucco commented Jul 14, 2024

IllianiCBT commented Jul 14, 2024

SuperStucco commented Jul 15, 2024

SuperStucco commented Jul 15, 2024

rjhancock commented Jul 15, 2024 •

edited

Loading

IllianiCBT commented Jul 15, 2024 •

edited

Loading

Add basic force generator role functionality to MekHQ scenario random unit generation #4214

Add basic force generator role functionality to MekHQ scenario random unit generation #4214

Conversation

SuperStucco commented Jun 12, 2024 • edited Loading

Thom293 commented Jun 12, 2024 • edited Loading

SuperStucco commented Jun 12, 2024

Sleet01 Jun 12, 2024

Choose a reason for hiding this comment

IllianiCBT commented Jun 12, 2024

HammerGS left a comment

Choose a reason for hiding this comment

Sleet01 commented Jul 11, 2024

IllianiCBT commented Jul 11, 2024 • edited Loading

IllianiCBT commented Jul 11, 2024

HammerGS commented Jul 14, 2024

SuperStucco commented Jul 14, 2024 • edited Loading

SuperStucco commented Jul 14, 2024

IllianiCBT commented Jul 14, 2024

SuperStucco commented Jul 15, 2024

SuperStucco commented Jul 15, 2024

rjhancock commented Jul 15, 2024 • edited Loading

IllianiCBT commented Jul 15, 2024 • edited Loading

SuperStucco commented Jun 12, 2024 •

edited

Loading

Thom293 commented Jun 12, 2024 •

edited

Loading

IllianiCBT commented Jul 11, 2024 •

edited

Loading

SuperStucco commented Jul 14, 2024 •

edited

Loading

rjhancock commented Jul 15, 2024 •

edited

Loading

IllianiCBT commented Jul 15, 2024 •

edited

Loading