Package mekhq.campaign.digitalGM.stratCon

Class StratConReinforcementStrategy

java.lang.Object

mekhq.campaign.digitalGM.stratCon.StratConReinforcementStrategy

All Implemented Interfaces:

IReinforcementStrategy

public class StratConReinforcementStrategy
extends Object
implements IReinforcementStrategy

Default StratCon implementation of IReinforcementStrategy. Every method delegates to the existing static logic on StratConRulesManager, so this class introduces the overridable seam without moving any behaviour.

Since:

0.51.01

Constructor Summary

Constructors

Constructor	Description
StratConReinforcementStrategy()

Method Summary

Modifier and Type	Method	Description
megamek.common.rolls.TargetRoll	calculateReinforcementTargetNumber(Person commandLiaison, AtBContract contract, int baseTargetNumber)	Calculates the target number a reinforcement attempt must beat.
StratConRulesManager.ReinforcementEligibilityType	getReinforcementType(int forceID, StratConTrackState trackState, Campaign campaign, StratConCampaignState campaignState)	Determines a force's eligibility to reinforce, given its current commitments.
StratConRulesManager.ReinforcementResultsType	processReinforcementDeployment(Formation formation, StratConRulesManager.ReinforcementEligibilityType reinforcementType, StratConCampaignState campaignState, StratConScenario scenario, Campaign campaign, int reinforcementTargetNumber, boolean isGMReinforcement)	Processes a reinforcement deployment attempt.
StratConRulesManager.ReinforcementResultsType	processReinforcementDeployment(Formation formation, StratConRulesManager.ReinforcementEligibilityType reinforcementType, StratConCampaignState campaignState, StratConScenario scenario, Campaign campaign, int reinforcementTargetNumber, boolean isGMReinforcement, boolean isInstantlyDeployed)	Processes a reinforcement deployment attempt, optionally bypassing the roll for an instant deployment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StratConReinforcementStrategy

public StratConReinforcementStrategy()

Method Details

getReinforcementType

public StratConRulesManager.ReinforcementEligibilityType getReinforcementType(int forceID,
 StratConTrackState trackState,
 Campaign campaign,
 StratConCampaignState campaignState)

Description copied from interface: IReinforcementStrategy

Determines a force's eligibility to reinforce, given its current commitments.

Specified by:

getReinforcementType in interface IReinforcementStrategy

Parameters:

forceID - the force in question

trackState - the track the reinforcement would occur on

campaign - the active campaign

campaignState - the StratCon state for the contract

Returns:

the reinforcement eligibility category for the force

calculateReinforcementTargetNumber

public megamek.common.rolls.TargetRoll calculateReinforcementTargetNumber(@Nullable
 Person commandLiaison,
 AtBContract contract,
 int baseTargetNumber)

Description copied from interface: IReinforcementStrategy

Calculates the target number a reinforcement attempt must beat.

Specified by:

calculateReinforcementTargetNumber in interface IReinforcementStrategy

Parameters:

commandLiaison - the liaison influencing the roll, if any

contract - the active contract

baseTargetNumber - the base target number before modifiers

Returns:

the assembled reinforcement target roll

processReinforcementDeployment

public StratConRulesManager.ReinforcementResultsType processReinforcementDeployment(Formation formation,
 StratConRulesManager.ReinforcementEligibilityType reinforcementType,
 StratConCampaignState campaignState,
 StratConScenario scenario,
 Campaign campaign,
 int reinforcementTargetNumber,
 boolean isGMReinforcement)

Description copied from interface: IReinforcementStrategy

Processes a reinforcement deployment attempt.

Specified by:

processReinforcementDeployment in interface IReinforcementStrategy

Parameters:

formation - the reinforcing formation

reinforcementType - the force's reinforcement eligibility

campaignState - the StratCon state for the contract

scenario - the scenario being reinforced

campaign - the active campaign

reinforcementTargetNumber - the target number to beat

isGMReinforcement - true if the deployment is GM-forced

Returns:

the result of the reinforcement attempt

processReinforcementDeployment

public StratConRulesManager.ReinforcementResultsType processReinforcementDeployment(Formation formation,
 StratConRulesManager.ReinforcementEligibilityType reinforcementType,
 StratConCampaignState campaignState,
 StratConScenario scenario,
 Campaign campaign,
 int reinforcementTargetNumber,
 boolean isGMReinforcement,
 boolean isInstantlyDeployed)

Description copied from interface: IReinforcementStrategy

Processes a reinforcement deployment attempt, optionally bypassing the roll for an instant deployment.

Specified by:

processReinforcementDeployment in interface IReinforcementStrategy

Parameters:

formation - the reinforcing formation

reinforcementType - the force's reinforcement eligibility

campaignState - the StratCon state for the contract

scenario - the scenario being reinforced

campaign - the active campaign

reinforcementTargetNumber - the target number to beat

isGMReinforcement - true if the deployment is GM-forced

isInstantlyDeployed - true to deploy immediately, skipping the roll

Returns:

the result of the reinforcement attempt