Package com.fs.starfarer.api.combat

Interface CombatFleetManagerAPI

public interface CombatFleetManagerAPI
Author:
Alex Mosolov Copyright 2012 Fractal Softworks, LLC

  • Method Details

    • spawnShipOrWing

      ShipAPI spawnShipOrWing(String specId, org.lwjgl.util.vector.Vector2f location, float facing)
      Deploy a ship/fighter wing with the given spec or variant id. If there isn't one in the reserves, a temporary FleetMemberAPI is created and added to the reserves (but not the underlying CampaignFleetAPI, if any)
      Parameters:
      id -
      location - Where to deploy.
      facing - Facing at time of deployment.
      Returns:

    • spawnShipOrWing

      ShipAPI spawnShipOrWing(String specId, org.lwjgl.util.vector.Vector2f location, float facing, float initialBurnDur)
      Deploy a ship/fighter wing with the given spec or variant id. If there isn't one in the reserves, a temporary FleetMemberAPI is created and added to the reserves (but not the underlying CampaignFleetAPI, if any)
      Parameters:
      specId -
      location -
      facing -
      level - crew experience level
      initialBurnDur - amount of time travel drive should be on (in seconds)
      Returns:

    • spawnFleetMember

      ShipAPI spawnFleetMember(FleetMemberAPI member, org.lwjgl.util.vector.Vector2f location, float facing, float initialBurnDur)
      member does not actually have to be in the reserves.
      Parameters:
      member -
      location -
      facing -
      initialBurnDur -
      Returns:

    • getShipFor

      ShipAPI getShipFor(FleetMemberAPI fleetMember)
      Returns ship that corresponds to the fleet member passed in. Returns the wing leader for fighter wings.
      Parameters:
      fleetMember -
      Returns:

    • getDeployedCopy

      List<FleetMemberAPI> getDeployedCopy()

    • getReservesCopy

      List<FleetMemberAPI> getReservesCopy()

    • getDeployedFleetMember

      DeployedFleetMemberAPI getDeployedFleetMember(ShipAPI ship)

    • getDeployedFleetMemberEvenIfDisabled

      DeployedFleetMemberAPI getDeployedFleetMemberEvenIfDisabled(ShipAPI ship)

    • createWaypoint

      AssignmentTargetAPI createWaypoint(org.lwjgl.util.vector.Vector2f location, boolean ally)

    • getGoal

      FleetGoal getGoal()

    • addToReserves

      void addToReserves(FleetMemberAPI member)

    • removeFromReserves

      void removeFromReserves(FleetMemberAPI member)

    • getTaskManager

      CombatTaskManagerAPI getTaskManager(boolean ally)

    • isOnlyTimidOrNonCombatDeployed

      boolean isOnlyTimidOrNonCombatDeployed()

    • getDisabledCopy

      List<FleetMemberAPI> getDisabledCopy()

    • getDestroyedCopy

      List<FleetMemberAPI> getDestroyedCopy()

    • getRetreatedCopy

      List<FleetMemberAPI> getRetreatedCopy()

    • isSuppressDeploymentMessages

      boolean isSuppressDeploymentMessages()

    • setSuppressDeploymentMessages

      void setSuppressDeploymentMessages(boolean suppressDeploymentMessages)

    • isDefendingStation

      boolean isDefendingStation()

    • getStations

      List<DeployedFleetMemberAPI> getStations()

    • getDeployedCopyDFM

      List<DeployedFleetMemberAPI> getDeployedCopyDFM()

    • getOwner

      int getOwner()

    • setDefaultCommander

      void setDefaultCommander(PersonAPI defaultCommander)

    • getDefaultCommander

      PersonAPI getDefaultCommander()

    • getFleetCommander

      PersonAPI getFleetCommander()
      May return null if both the reserves and the deployed lists are empty.
      Returns:

    • getMaxStrength

      int getMaxStrength()
      Max deployment points available.
      Returns:

    • isDeployedStation

      boolean isDeployedStation()

    • setDeployedStation

      void setDeployedStation(boolean deployedStation)

    • setDeploymentYOffset

      void setDeploymentYOffset(float deploymentYOffset)

    • getDeploymentYOffset

      float getDeploymentYOffset()

    • getEnemyCleanDisengageProgress

      float getEnemyCleanDisengageProgress()

    • getEnemyCleanDisengageThreshold

      float getEnemyCleanDisengageThreshold()

    • getEnemyCleanDisengagePoints

      float getEnemyCleanDisengagePoints()

    • canEnemyDisengageCleanly

      boolean canEnemyDisengageCleanly()

    • getAllFleetCommanders

      List<PersonAPI> getAllFleetCommanders()

    • getFleetCommanderPreferPlayer

      PersonAPI getFleetCommanderPreferPlayer()

    • getAllEverDeployedCopy

      List<DeployedFleetMemberAPI> getAllEverDeployedCopy()

    • isCanForceShipsToEngageWhenBattleClearlyLost

      boolean isCanForceShipsToEngageWhenBattleClearlyLost()

    • setCanForceShipsToEngageWhenBattleClearlyLost

      void setCanForceShipsToEngageWhenBattleClearlyLost(boolean canForceShipsToEngageWhenBattleClearlyLost)
      Defaults to true for enemy, false for player side.
      Parameters:
      canForceShipsToEngageWhenBattleClearlyLost -

    • spawnShipOrWing

      ShipAPI spawnShipOrWing(String specId, org.lwjgl.util.vector.Vector2f location, float facing, float initialBurnDur, PersonAPI captain)

    • getShardToOriginalShipMap

      Map<DeployedFleetMemberAPI,DeployedFleetMemberAPI> getShardToOriginalShipMap()

    • getDeployedFleetMemberFromAllEverDeployed

      DeployedFleetMemberAPI getDeployedFleetMemberFromAllEverDeployed(ShipAPI ship)

    • getShipFor

      ShipAPI getShipFor(PersonAPI captain)

    • getBiggestStationDeployedOrNot

      FleetMemberAPI getBiggestStationDeployedOrNot()

    • getAdmiralAI

      AdmiralAIPlugin getAdmiralAI()

    • setAdmiralAI

      void setAdmiralAI(AdmiralAIPlugin admiralAI)

    • removeDeployed

      void removeDeployed(ShipAPI ship, boolean retreated)

    • setMaxStrength

      void setMaxStrength(int maxStrength)

    • getCurrStrength

      int getCurrStrength()

    • modifyFlatMax

      void modifyFlatMax(String source, int value)

    • modifyPercentMax

      void modifyPercentMax(String source, float percent)

    • unmodifyMax

      void unmodifyMax()

    • removeDeployed

      void removeDeployed(FighterWingAPI wing, boolean retreated)