Package mekhq.campaign.mission

Class AtBDynamicScenario

java.lang.Object
mekhq.campaign.mission.Scenario
mekhq.campaign.mission.AtBScenario
mekhq.campaign.mission.AtBDynamicScenario
All Implemented Interfaces:
IAtBScenario, IPlayerSettings
public class AtBDynamicScenario extends AtBScenario
Data structure intended to hold data relevant to AtB Dynamic Scenarios (AtB 3.0)

  • Field Details

  • Constructor Details

    • AtBDynamicScenario

      public AtBDynamicScenario()

  • Method Details

    • addForces

      public void addForces(int forceID)
      Overrides:
      addForces in class Scenario

    • addForce

      public void addForce(int forceID, String templateName)
      Add a force to the scenario, explicitly linked to the given template.
      Parameters:
      forceID - ID of the force to add.
      templateName - Name of the force template.

    • addUnit

      public void addUnit(UUID unitID, String templateName)

    • removeForce

      public void removeForce(int fid)
      Overrides:
      removeForce in class Scenario

    • removeUnit

      public void removeUnit(UUID unitID)
      Overrides:
      removeUnit in class Scenario

    • getStartingPos

      public int getStartingPos()
      The Board.START_X constant representing the starting zone for the player's primary force
      Specified by:
      getStartingPos in interface IPlayerSettings
      Overrides:
      getStartingPos in class Scenario

    • getMapX

      public int getMapX()
      Horizontal map size. Unlike the AtBScenario, we only perform map size calculations once (once all primary forces are committed), so we don't re-calculate the map size each time.
      Overrides:
      getMapX in class AtBScenario

    • getMapY

      public int getMapY()
      Vertical map size. Unlike the AtBScenario, we only perform map size calculations once (once all primary forces are committed), so we don't re-calculate the map size each time.
      Overrides:
      getMapY in class AtBScenario

    • setMapSize

      public void setMapSize()
      Overrides:
      setMapSize in class AtBScenario

    • addBotForce

      public void addBotForce(BotForce botForce, ScenarioForceTemplate forceTemplate, Campaign c)
      Adds a bot force to this scenario.

    • removeBotForce

      public void removeBotForce(int x)
      Removes a bot force from this dynamic scenario, and its associated template as well.
      Overrides:
      removeBotForce in class Scenario

    • getEffectivePlayerUnitCountMultiplier

      public double getEffectivePlayerUnitCountMultiplier()

    • setEffectivePlayerUnitCountMultiplier

      public void setEffectivePlayerUnitCountMultiplier(double multiplier)

    • getEffectivePlayerBVMultiplier

      public double getEffectivePlayerBVMultiplier()

    • setEffectivePlayerBVMultiplier

      public void setEffectivePlayerBVMultiplier(double multiplier)

    • getTemplate

      @Nullable public ScenarioTemplate getTemplate()

    • setTemplate

      public void setTemplate(@Nullable ScenarioTemplate template)

    • getPlayerForceTemplates

      public Map<Integer,ScenarioForceTemplate> getPlayerForceTemplates()

    • setPlayerForceTemplates

      public void setPlayerForceTemplates(Map<Integer,ScenarioForceTemplate> playerForceTemplates)

    • getPlayerUnitTemplates

      public Map<UUID,ScenarioForceTemplate> getPlayerUnitTemplates()

    • setPlayerUnitTemplates

      public void setPlayerUnitTemplates(Map<UUID,ScenarioForceTemplate> playerUnitTemplates)

    • getBotForceTemplates

      public Map<BotForce,ScenarioForceTemplate> getBotForceTemplates()

    • setBotForceTemplates

      public void setBotForceTemplates(Map<BotForce,ScenarioForceTemplate> botForceTemplates)

    • getBotUnitTemplates

      public Map<UUID,ScenarioForceTemplate> getBotUnitTemplates()

    • setBotUnitTemplates

      public void setBotUnitTemplates(Map<UUID,ScenarioForceTemplate> botUnitTemplates)

    • getPlayerUnitSwaps

      public Map<UUID,AtBDynamicScenario.BenchedEntityData> getPlayerUnitSwaps()

    • setPlayerUnitSwaps

      public void setPlayerUnitSwaps(Map<UUID,AtBDynamicScenario.BenchedEntityData> playerUnitSwaps)

    • getEffectiveOpForSkill

      public megamek.common.enums.SkillLevel getEffectiveOpForSkill()

    • setEffectiveOpForSkill

      public void setEffectiveOpForSkill(megamek.common.enums.SkillLevel skillLevel)

    • getEffectiveOpForQuality

      public int getEffectiveOpForQuality()

    • setEffectiveOpForQuality

      public void setEffectiveOpForQuality(int qualityLevel)

    • getFriendlyDelayedReinforcements

      public List<UUID> getFriendlyDelayedReinforcements()

    • setFriendlyDelayedReinforcements

      public void setFriendlyDelayedReinforcements(List<UUID> friendlyDelayedReinforcements)

    • getFriendlyInstantReinforcements

      public List<UUID> getFriendlyInstantReinforcements()

    • setFriendlyInstantReinforcements

      public void setFriendlyInstantReinforcements(List<UUID> friendlyInstantReinforcements)

    • getFriendlyReinforcementDelayReduction

      public int getFriendlyReinforcementDelayReduction()

    • setFriendlyReinforcementDelayReduction

      public void setFriendlyReinforcementDelayReduction(int friendlyReinforcementDelayReduction)

    • getHostileReinforcementDelayReduction

      public int getHostileReinforcementDelayReduction()

    • setHostileReinforcementDelayReduction

      public void setHostileReinforcementDelayReduction(int hostileReinforcementDelayReduction)

    • isFinalized

      public boolean isFinalized()
      This is used to indicate that player forces have been assigned to this scenario and that AtBDynamicScenarioFactory.finalizeScenario() has been called on this scenario to generate opposing forces and their bots, apply any present scenario modifiers, set up deployment turns, calculate which units belong to which objectives, and many other things.

      Further "post-force-generation" modifiers can be applied to this scenario, but calling finalizeScenario() on it again will lead to "unsupported" behavior.

      Can be called as a shorthand way of telling "is this scenario ready to play".

    • setFinalized

      public void setFinalized(boolean finalized)

    • getPlayerTemplateForceIDs

      public List<Integer> getPlayerTemplateForceIDs()
      A list of all the force IDs associated with pre-defined scenario templates

    • getLanceCommander

      public Person getLanceCommander(Campaign campaign)
      Convenience method that returns the commander of the first force assigned to this scenario.

    • getLanceCommanderSkill

      public int getLanceCommanderSkill(String skillType, Campaign campaign)
      Convenience method to return the int value of the lance commander's skill in the specified area. Encapsulates a fairly obnoxious number of null checks and other safety code.
      Parameters:
      skillType - The type of skill to check
      campaign - The campaign the lance commander is a part of
      Returns:
      The skill level. SKILL_NONE (0) if not present.

    • setScenarioModifiers

      public void setScenarioModifiers(List<AtBScenarioModifier> scenarioModifiers)

    • getScenarioModifiers

      public List<AtBScenarioModifier> getScenarioModifiers()

    • addScenarioModifier

      public void addScenarioModifier(@Nullable AtBScenarioModifier modifier)
      Adds a scenario modifier and any linked modifiers to this scenario, provided that the modifier exists and can be applied to the scenario (e.g. ground units on air map)

    • alreadyHasModifier

      public boolean alreadyHasModifier(AtBScenarioModifier modifier)
      Check if the modifier list already has a modifier with the given modifier's name.

    • getScenarioType

      public int getScenarioType()

    • getDesc

      public String getDesc()
      Overrides:
      getDesc in class AtBScenario

    • getScenarioTypeDescription

      public String getScenarioTypeDescription()

    • getResourceKey

      public String getResourceKey()

    • writeToXMLEnd

      protected void writeToXMLEnd(PrintWriter pw, int indent)
      Overrides:
      writeToXMLEnd in class AtBScenario

    • loadFieldsFromXmlNode

      protected void loadFieldsFromXmlNode(Node wn, megamek.Version version, Campaign campaign) throws ParseException
      Overrides:
      loadFieldsFromXmlNode in class AtBScenario
      Throws:
      ParseException

    • refresh

      public void refresh(Campaign campaign)
      Description copied from class: AtBScenario
      Corrects the enemy (special scenarios) and allies (big battles) as necessary based on player deployments. This ought to be called when the scenario details are displayed or the scenario is started.
      Overrides:
      refresh in class AtBScenario

    • clearAllForcesAndPersonnel

      public void clearAllForcesAndPersonnel(Campaign campaign)
      Overrides:
      clearAllForcesAndPersonnel in class Scenario

    • getBattlefieldControlDescription

      public String getBattlefieldControlDescription()
      Overrides:
      getBattlefieldControlDescription in class AtBScenario

    • getTeamTotalBattleValue

      public int getTeamTotalBattleValue(Campaign campaign, boolean isAllied)
      Returns the total battle value (BV) either for allied forces or opposing forces in a given contract campaign, as per the parameter isAllied.

      If isAllied is true, the method calculates the total BV for the allied forces inclusive of player forces. If isAllied is false, the total BV for opposing forces is calculated.

      The calculation is done based on Bot forces attributed to each side. In the case of PlanetOwner, the alignment of the owner faction is considered to determine the ownership of Bot forces.

      Parameters:
      campaign - The campaign in which the forces are participating.
      isAllied - A boolean value indicating whether to calculate the total BV for allied forces (if true) or opposing forces (if false).
      Returns:
      The total battle value (BV) either for the allied forces or opposing forces, as specified by the parameter isAllied.