Package com.fs.starfarer.api.campaign

Interface FleetDataAPI

public interface FleetDataAPI

  • Method Details

    • getMembersInPriorityOrder

      List<FleetMemberAPI> getMembersInPriorityOrder()
      Returns: "logistical priority" members first, then non-mothballed, then mothballed. Retains normal order within each category.
      Returns:

    • getMembersListCopy

      List<FleetMemberAPI> getMembersListCopy()

    • getCombatReadyMembersListCopy

      List<FleetMemberAPI> getCombatReadyMembersListCopy()

    • getFleetPointsUsed

      float getFleetPointsUsed()

    • addFleetMember

      void addFleetMember(FleetMemberAPI member)

    • removeFleetMember

      void removeFleetMember(FleetMemberAPI member)

    • clear

      void clear()

    • scuttle

      void scuttle(FleetMemberAPI member)
      Removes from the fleet, adds fuel/supplies gained from scuttling, adds any equipped weapons to cargo.
      Parameters:
      member -

    • getMaxBurnLevel

      float getMaxBurnLevel()
      Maximum burn level of fastest ship in the fleet. Includes getStats().getFleetwideMaxBurnMod(). Does NOT include mothballed ships.
      Returns:

    • getMinBurnLevel

      float getMinBurnLevel()
      Maximum burn level of slowest ship in the fleet. Includes getStats().getFleetwideMaxBurnMod()
      Returns:

    • getBurnLevel

      float getBurnLevel()
      Effective burn level this fleet can go at; includes effect of being in deep hyperspace (where getMinBurnLevel() does not).
      Returns:

    • setFlagship

      void setFlagship(FleetMemberAPI flagship)
      Will also set the captains of all the other ships to a new person with all-0 stats.
      Parameters:
      flagship -

    • getFleet

      CampaignFleetAPI getFleet()

    • getTravelSpeed

      float getTravelSpeed()
      In pixels/second. There are 10 real seconds in a day.
      Returns:

    • takeSnapshot

      void takeSnapshot()
      Makes a copy of the current fleet members. The snapshot is transient and will not be in the save file.

    • getSnapshot

      ArrayList<FleetMemberAPI> getSnapshot()
      Returns fleet members at time snapshot was taken. Useful to get the state of the fleet before a battle/prior to it being destroyed/etc.
      Returns:

    • areAnyShipsPerformingRepairs

      boolean areAnyShipsPerformingRepairs()

    • sort

      void sort()

    • getOfficersCopy

      List<OfficerDataAPI> getOfficersCopy()

    • addOfficer

      void addOfficer(PersonAPI person)

    • removeOfficer

      void removeOfficer(PersonAPI person)

    • getOfficerData

      OfficerDataAPI getOfficerData(PersonAPI person)

    • getMemberWithCaptain

      FleetMemberAPI getMemberWithCaptain(PersonAPI captain)

    • getNumMembers

      int getNumMembers()

    • syncMemberLists

      void syncMemberLists()

    • isOnlySyncMemberLists

      boolean isOnlySyncMemberLists()

    • setOnlySyncMemberLists

      void setOnlySyncMemberLists(boolean onlySyncMemberLists)

    • syncIfNeeded

      void syncIfNeeded()

    • setSyncNeeded

      void setSyncNeeded()

    • getMembersListWithFightersCopy

      List<FleetMemberAPI> getMembersListWithFightersCopy()

    • getCommander

      PersonAPI getCommander()

    • getMinCrew

      float getMinCrew()

    • ensureHasFlagship

      void ensureHasFlagship()

    • addFleetMember

      FleetMemberAPI addFleetMember(String variantId)

    • addOfficer

      void addOfficer(OfficerDataAPI officer)

    • updateCargoCapacities

      void updateCargoCapacities()

    • pickShipName

      String pickShipName(FleetMemberAPI member, Random random)

    • getEffectiveStrength

      float getEffectiveStrength()

    • getCacheClearedOnSync

      Map<String,Object> getCacheClearedOnSync()
      Useful for skills that need to do some computations to figure out effect magnitude, but where the values might change if the fleet composition changed.
      Returns:

    • getMinBurnLevelUnmodified

      float getMinBurnLevelUnmodified()

    • getShipNameRandom

      Random getShipNameRandom()

    • setShipNameRandom

      void setShipNameRandom(Random shipNameRandom)

    • sortToMatchOrder

      void sortToMatchOrder(List<FleetMemberAPI> originalOrder)

    • isForceNoSync

      boolean isForceNoSync()

    • setForceNoSync

      void setForceNoSync(boolean forceNoSync)