Package mekhq.campaign

Class CampaignConfiguration

java.lang.Object
mekhq.campaign.CampaignConfiguration
public class CampaignConfiguration extends Object
A class for containing and passing Campaign configuration information. This is implemented as a Class rather than as a Record because we need the ability to mutate any given field for testing purposes; the "Wither" functionality from JEP 468 would allow us to do this easily with Records but is not yet supported.

  • Constructor Details

    • CampaignConfiguration

      public CampaignConfiguration()

    • CampaignConfiguration

      public CampaignConfiguration(String name, LocalDate date, CampaignOptions campaignOpts, Faction faction, megamek.common.enums.Faction techFaction, CurrencyManager currencyManager, ReputationController reputationController, FactionStandings factionStandings, RankSystem rankSystem, Formation formation, Finances finances, RandomEventLibraries randomEvents, FactionStandingUltimatumsLibrary ultimatums, RetirementDefectionTracker retDefTracker, AutosaveService autosave, megamek.client.bot.princess.BehaviorSettings behaviorSettings, PersonnelMarket persMarket, AtbMonthlyContractMarket atbMonthlyContractMarket, AbstractUnitMarket unitMarket, AbstractDivorce divorce, AbstractMarriage marriage, AbstractProcreation procreation)
      Partial CampaignConfiguration constructor; takes _some_ information needed to instantiate a Campaign. Meant for use by CampaignFactory and test methods.
      Parameters:
      name - Campaign name String
      date - LocalDate start date
      campaignOpts - CampaignOptions instance
      faction - Faction instance
      techFaction - Faction enum value describing tech base
      currencyManager - Default
      reputationController - Default
      factionStandings - Default
      rankSystem - Default Rank System
      formation - List of player's TOE formations
      finances - Default
      randomEvents - Default RandomEventsLibraries
      ultimatums - Default
      retDefTracker - RetirementDefectionTracker instance
      autosave - Autosave service instance
      behaviorSettings - Default behavior settings
      persMarket - Personnel Market (deprecated; replace with new market after refactoring)
      atbMonthlyContractMarket - Contract Market
      unitMarket - Unit Market
      divorce - AbstractDivorce instance, defaults to Disabled
      marriage - AbstractMarriage instance, defaults to Disabled
      procreation - AbstractProcreation instance, defaults to Disabled

    • CampaignConfiguration

      public CampaignConfiguration(megamek.common.game.Game game, megamek.common.Player player, String name, LocalDate date, CampaignOptions campaignOpts, megamek.common.options.GameOptions gameOptions, PartsStore partsStore, NewPersonnelMarket newPersonnelMarket, RandomDeath randomDeath, CampaignSummary campaignSummary, Faction faction, megamek.common.enums.Faction techFaction, CurrencyManager currencyManager, Systems systemsInstance, CurrentLocation startLocation, ReputationController reputationController, FactionStandings factionStandings, RankSystem rankSystem, Formation formation, Finances finances, RandomEventLibraries randomEvents, FactionStandingUltimatumsLibrary ultimatums, RetirementDefectionTracker retDefTracker, AutosaveService autosave, megamek.client.bot.princess.BehaviorSettings behaviorSettings, PersonnelMarket persMarket, AtbMonthlyContractMarket atbMonthlyContractMarket, AbstractUnitMarket unitMarket, AbstractDivorce divorce, AbstractMarriage marriage, AbstractProcreation procreation)
      Primary CampaignConfiguration constructor; takes all information needed to instantiate a Campaign. Meant for use by CampaignFactory methods.
      Parameters:
      game - Game instance
      player - Player instance
      name - Campaign name String
      date - LocalDate start date
      campaignOpts - CampaignOptions instance
      gameOptions - GameOptions instance, for MegaMek
      partsStore - PartsStore instance (Campaign or user must initialize with campaign reference!)
      newPersonnelMarket - NewPersonnelMarket instance (Campaign or user must initialize with campaign reference!)
      randomDeath - RandomDeath instance (Campaign or user must initialize with campaign reference!)
      campaignSummary - CampaignSummary instance (Campaign or user must initialize with campaign reference!)
      faction - Faction instance
      techFaction - Faction enum value describing tech base
      currencyManager - Default
      systemsInstance - Instance of Systems, for hooking into Systems lookups.
      startLocation - Location of starting planetary system.
      reputationController - Default
      factionStandings - Default
      rankSystem - Default Rank System
      formation - List of player's TOE formations
      finances - Default
      randomEvents - Default RandomEventsLibraries
      ultimatums - Default
      retDefTracker - RetirementDefectionTracker instance
      autosave - Autosave service instance
      behaviorSettings - Default behavior settings
      persMarket - Personnel Market (deprecated; replace with new market after refactoring)
      atbMonthlyContractMarket - Contract Market
      unitMarket - Unit Market
      divorce - AbstractDivorce instance, defaults to Disabled
      marriage - AbstractMarriage instance, defaults to Disabled
      procreation - AbstractProcreation instance, defaults to Disabled

  • Method Details

    • getGame

      public megamek.common.game.Game getGame()

    • getPlayer

      public megamek.common.Player getPlayer()

    • getName

      public String getName()

    • getDate

      public LocalDate getDate()

    • getCampaignOpts

      public CampaignOptions getCampaignOpts()

    • getGameOptions

      public megamek.common.options.GameOptions getGameOptions()

    • getPartsStore

      public PartsStore getPartsStore()

    • getNewPersonnelMarket

      public NewPersonnelMarket getNewPersonnelMarket()

    • getRandomDeath

      public RandomDeath getRandomDeath()

    • getCampaignSummary

      public CampaignSummary getCampaignSummary()

    • getfaction

      public Faction getfaction()

    • getTechFaction

      public megamek.common.enums.Faction getTechFaction()

    • getCurrencyManager

      public CurrencyManager getCurrencyManager()

    • getSystemsInstance

      public Systems getSystemsInstance()

    • getLocation

      public CurrentLocation getLocation()

    • getReputationController

      public ReputationController getReputationController()

    • getFactionStandings

      public FactionStandings getFactionStandings()

    • getRankSystem

      public RankSystem getRankSystem()

    • getFormations

      public Formation getFormations()

    • getfinances

      public Finances getfinances()

    • getRandomEvents

      public RandomEventLibraries getRandomEvents()

    • getUltimatums

      public FactionStandingUltimatumsLibrary getUltimatums()

    • getRetDefTracker

      public RetirementDefectionTracker getRetDefTracker()

    • getAutosave

      public IAutosaveService getAutosave()

    • getBehaviorSettings

      public megamek.client.bot.princess.BehaviorSettings getBehaviorSettings()

    • getPersonnelMarket

      public PersonnelMarket getPersonnelMarket()

    • getAtBMonthlyContractMarket

      public AbstractContractMarket getAtBMonthlyContractMarket()

    • getUnitMarket

      public AbstractUnitMarket getUnitMarket()

    • getDivorce

      public AbstractDivorce getDivorce()

    • getMarriage

      public AbstractMarriage getMarriage()

    • getProcreation

      public AbstractProcreation getProcreation()

    • setPlayer

      public void setPlayer(megamek.common.Player player)

    • setGame

      public void setGame(megamek.common.game.Game game)

    • setGameOptions

      public void setGameOptions(megamek.common.options.GameOptions gameOptions)

    • setName

      public void setName(String name)

    • setCurrentDay

      public void setCurrentDay(LocalDate currentDay)

    • setFormations

      public void setFormations(Formation formations)

    • setFaction

      public void setFaction(Faction faction)

    • setTechFaction

      public void setTechFaction(megamek.common.enums.Faction techFaction)

    • setRankSystem

      public void setRankSystem(RankSystem rankSystem)

    • setCurrencyManager

      public void setCurrencyManager(CurrencyManager currencyManager)

    • setFinances

      public void setFinances(Finances finances)

    • setSystemsInstance

      public void setSystemsInstance(Systems systemsInstance)

    • setLocation

      public void setLocation(CurrentLocation location)

    • setCampaignOptions

      public void setCampaignOptions(CampaignOptions campaignOptions)

    • setPersonnelMarket

      public void setPersonnelMarket(PersonnelMarket personnelMarket)

    • setContractMarket

      public void setContractMarket(AbstractContractMarket contractMarket)

    • setUnitMarket

      public void setUnitMarket(AbstractUnitMarket unitMarket)

    • setDivorce

      public void setDivorce(AbstractDivorce divorce)

    • setMarriage

      public void setMarriage(AbstractMarriage marriage)

    • setProcreation

      public void setProcreation(AbstractProcreation procreation)

    • setRandomEventLibraries

      public void setRandomEventLibraries(RandomEventLibraries randomEventLibraries)

    • setFactionStandingUltimatumsLibrary

      public void setFactionStandingUltimatumsLibrary(FactionStandingUltimatumsLibrary factionStandingUltimatumsLibrary)

    • setRetirementDefectionTracker

      public void setRetirementDefectionTracker(RetirementDefectionTracker retirementDefectionTracker)

    • setReputation

      public void setReputation(ReputationController reputation)

    • setFactionStandings

      public void setFactionStandings(FactionStandings factionStandings)

    • setAutoResolveBehaviorSettings

      public void setAutoResolveBehaviorSettings(megamek.client.bot.princess.BehaviorSettings autoResolveBehaviorSettings)

    • setAutosaveService

      public void setAutosaveService(IAutosaveService autosaveService)

    • setPartsStore

      public void setPartsStore(PartsStore partsStore)

    • setNewPersonnelMarket

      public void setNewPersonnelMarket(NewPersonnelMarket newPersonnelMarket)

    • setRandomDeath

      public void setRandomDeath(RandomDeath randomDeath)

    • setCampaignSummary

      public void setCampaignSummary(CampaignSummary campaignSummary)