Package mekhq.campaign.rating

Interface IUnitRating

All Known Implementing Classes:
AbstractUnitRating, FieldManualMercRevDragoonsRating
public interface IUnitRating
Since:
3/12/2012

  • Field Details

  • Method Details

    • reInitialize

      void reInitialize()

    • getUnitRating

      int getUnitRating(int score)
      Returns the static constant representation of the passed in Unit rating.
      Parameters:
      score - The total Dragoon's score.

    • getUnitRatingAsInteger

      int getUnitRatingAsInteger()
      Returns the static constant representation of the computed Unit/Dragoon's rating as an integer.

    • getScore

      int getScore()

    • getModifier

      int getModifier()

    • getUnitRatingName

      String getUnitRatingName(int rating)
      Returns the letter code of the passed in Unit rating.
      Parameters:
      rating - The numeric rating to be converted.

    • getUnitRating

      String getUnitRating()
      Calculates the force's Unit rating and returns the appropriate letter code.

    • getExperienceValue

      int getExperienceValue()
      Returns the Unit Rating score for the force's average experience level.

    • getAverageExperience

      megamek.common.enums.SkillLevel getAverageExperience()
      Returns the unit's average experience level.

    • getCommanderValue

      int getCommanderValue()
      Returns the Unit Rating score for the force's commander.

    • getCommander

      Person getCommander()
      Return's the commander of the force.

    • getCombatRecordValue

      int getCombatRecordValue()
      Returns the Unit Rating score for the force's contract success/failure record.

    • getSupportPercent

      BigDecimal getSupportPercent()
      Returns the percentage of units that are properly supported.

    • getSupportValue

      int getSupportValue()
      Returns the Unit Rating score for the force's ratio of support to combat units.

    • getTransportPercent

      BigDecimal getTransportPercent()
      Returns the percentage of units that can be transported without outside help.

    • getTransportValue

      int getTransportValue()
      Returns the Unit Rating score for the force's ratio of transportation available to transportation needs.

    • getTechValue

      int getTechValue()
      Returns the Unit Rating score for the percentage of combat units greater than L1 tech.

    • getFinancialValue

      int getFinancialValue()
      Returns the Unit Rating score for the force's financial record. If the unit has never been in debt, a value of 0 is returned. If the unit has been in debt, a negative number will be returned.

    • getDetails

      String getDetails()
      Returns a text description of how the Unit rating was calculated.

    • getHelpText

      String getHelpText()
      Returns descriptive text that should be displayed in a Help/About dialog to inform users of the means by which the Unit rating is calculated.

    • getUnitRatingMethod

      UnitRatingMethod getUnitRatingMethod()
      Returns the typs of unit rating method used.