Package mekhq.campaign.digitalGM

Interface IOpForDeploymentStrategy

All Known Implementing Classes:
StratConOpForDeploymentStrategy
public interface IOpForDeploymentStrategy
Strategy for deciding where on the track the OpFor deploys — which coordinates a generated scenario is placed at. This is distinct from IOpForGenerationStrategy (what the OpFor fields) and from IMapGenerationStrategy (the terrain of the resulting battle): a GM can keep the standard enemy composition but change where hostile scenarios appear on the strategic map.

The default StratCon implementation delegates to StratConContractInitializer.getUnoccupiedCoords — the existing weighted-random selection of an unoccupied, non-ocean hex. The accessor lives on AbstractStratConGM.

Since:
0.51.01

  • Method Summary

    Modifier and Type
    Method
    Description
    default StratConCoords
    getUnoccupiedCoords(StratConTrackState track)
    Selects the coordinates a hostile scenario deploys to, using the default constraints (no placement on player facilities or forces, no strategic emphasis).
    StratConCoords
    getUnoccupiedCoords(StratConTrackState track, boolean allowPlayerFacilities, boolean allowPlayerForces, boolean emphasizeStrategicTargets)
    Selects the coordinates a hostile scenario deploys to on the track.

  • Method Details

    • getUnoccupiedCoords

      @Nullable StratConCoords getUnoccupiedCoords(StratConTrackState track, boolean allowPlayerFacilities, boolean allowPlayerForces, boolean emphasizeStrategicTargets)
      Selects the coordinates a hostile scenario deploys to on the track.
      Parameters:
      track - the track to place the scenario on
      allowPlayerFacilities - true to allow placement on player-allied facility hexes
      allowPlayerForces - true to allow placement on hexes occupied by player forces
      emphasizeStrategicTargets - true to weight placement toward strategic targets
      Returns:
      the chosen coordinates, or null if the track has no eligible hex

    • getUnoccupiedCoords

      @Nullable default StratConCoords getUnoccupiedCoords(StratConTrackState track)
      Selects the coordinates a hostile scenario deploys to, using the default constraints (no placement on player facilities or forces, no strategic emphasis).
      Parameters:
      track - the track to place the scenario on
      Returns:
      the chosen coordinates, or null if the track has no eligible hex