LazyLib

org.lazywizard.lazylib.campaign
Class FleetUtils

java.lang.Object
  extended by org.lazywizard.lazylib.campaign.FleetUtils

public class FleetUtils
extends java.lang.Object

Contains methods for working with fleets and fleet data.

Since:
1.0
Author:
LazyWizard

Method Summary
static boolean areAllies(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1, com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
          Checks if two fleets are allies.
static boolean areEnemies(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1, com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
          Checks if two fleets are enemies.
static boolean areNeutral(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1, com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
          Checks if two fleets are neutral towards each other.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getAlliedFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
          Find all allies of a CampaignFleetAPI present in the system.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getAlliedFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, boolean sortByDistance)
          Find all allies of a CampaignFleetAPI present in the system.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getEnemyFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
          Find all enemies of a CampaignFleetAPI present in the system.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getEnemyFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, boolean sortByDistance)
          Find all enemies of a CampaignFleetAPI present in the system.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyAlliedFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, float range)
          Finds all allied fleets within a certain range around a CampaignFleetAPI.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyAlliedFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, float range, boolean sortByDistance)
          Finds all allied fleets within a certain range around a CampaignFleetAPI.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyEnemyFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, float range)
          Finds all enemy fleets within a certain range around a CampaignFleetAPI.
static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyEnemyFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet, float range, boolean sortByDistance)
          Finds all enemy fleets within a certain range around a CampaignFleetAPI.
static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestAlliedFleet(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
          Find the closest allied fleet to a CampaignFleetAPI.
static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestEnemyFleet(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
          Find the closest enemy fleet to a CampaignFleetAPI.
static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestFleet(com.fs.starfarer.api.campaign.SectorEntityToken token)
          Find the closest CampaignFleetAPI near a SectorEntityToken.
static com.fs.starfarer.api.campaign.SectorEntityToken getNearestStation(com.fs.starfarer.api.campaign.SectorEntityToken token)
          Find the closest orbital station to a SectorEntityToken.
static boolean isPlayer(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
          Checks if a fleet is the player fleet.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isPlayer

public static boolean isPlayer(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
Checks if a fleet is the player fleet.

Parameters:
fleet - The CampaignFleetAPI to be checked.
Returns:
true if fleet is the player fleet, false otherwise.
Since:
1.0

areAllies

public static boolean areAllies(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1,
                                com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
Checks if two fleets are allies.

Parameters:
fleet1 - The first CampaignFleetAPI to check.
fleet2 - The second CampaignFleetAPI to check.
Returns:
true if the fleets are allies, false otherwise.
Since:
1.2

areEnemies

public static boolean areEnemies(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1,
                                 com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
Checks if two fleets are enemies.

Parameters:
fleet1 - The first CampaignFleetAPI to check.
fleet2 - The second CampaignFleetAPI to check.
Returns:
true if the fleets are enemies, false otherwise.
Since:
1.2

areNeutral

public static boolean areNeutral(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet1,
                                 com.fs.starfarer.api.campaign.CampaignFleetAPI fleet2)
Checks if two fleets are neutral towards each other.

Parameters:
fleet1 - The first CampaignFleetAPI to check.
fleet2 - The second CampaignFleetAPI to check.
Returns:
true if the fleets are neutral, false otherwise.
Since:
1.2

getNearestStation

public static com.fs.starfarer.api.campaign.SectorEntityToken getNearestStation(com.fs.starfarer.api.campaign.SectorEntityToken token)
Find the closest orbital station to a SectorEntityToken.

Parameters:
token - The SectorEntityToken to search around.
Returns:
The orbital station closest to token.
Since:
1.2

getNearestEnemyFleet

public static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestEnemyFleet(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
Find the closest enemy fleet to a CampaignFleetAPI.

Parameters:
fleet - The CampaignFleetAPI to search around.
Returns:
The enemy CampaignFleetAPI closest to fleet.
Since:
1.2

getNearestAlliedFleet

public static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestAlliedFleet(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
Find the closest allied fleet to a CampaignFleetAPI.

Parameters:
fleet - The CampaignFleetAPI to search around.
Returns:
The allied CampaignFleetAPI closest to fleet.
Since:
1.2

getNearestFleet

public static com.fs.starfarer.api.campaign.CampaignFleetAPI getNearestFleet(com.fs.starfarer.api.campaign.SectorEntityToken token)
Find the closest CampaignFleetAPI near a SectorEntityToken.

Parameters:
token - The SectorEntityToken to search around.
Returns:
The CampaignFleetAPI closest to token.
Since:
1.2

getEnemyFleetsInSystem

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getEnemyFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                    boolean sortByDistance)
Find all enemies of a CampaignFleetAPI present in the system.

Parameters:
fleet - The CampaignFleetAPI to search around.
sortByDistance - Whether to sort the results by distance from fleet.
Returns:
All enemies of fleet in the system.
Since:
1.2

getEnemyFleetsInSystem

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getEnemyFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
Find all enemies of a CampaignFleetAPI present in the system.

Parameters:
fleet - The CampaignFleetAPI to search around.
Returns:
All enemies of fleet in the system.
Since:
1.2
See Also:
getEnemyFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI, boolean)

getNearbyEnemyFleets

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyEnemyFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                  float range,
                                                                                                  boolean sortByDistance)
Finds all enemy fleets within a certain range around a CampaignFleetAPI.

Parameters:
fleet - The entity to search around.
range - How far around fleet to search.
sortByDistance - Whether to sort the results by distance from fleet.
Returns:
A List containing all enemy fleets within range.
Since:
1.2

getNearbyEnemyFleets

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyEnemyFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                  float range)
Finds all enemy fleets within a certain range around a CampaignFleetAPI.

Parameters:
fleet - The entity to search around.
range - How far around fleet to search.
Returns:
A List containing all enemy fleets within range.
Since:
1.2
See Also:
getNearbyEnemyFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI, float, boolean)

getAlliedFleetsInSystem

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getAlliedFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                     boolean sortByDistance)
Find all allies of a CampaignFleetAPI present in the system.

Parameters:
fleet - The CampaignFleetAPI to search around.
sortByDistance - Whether to sort the results by distance from fleet.
Returns:
All allies of fleet in the system.
Since:
1.2

getAlliedFleetsInSystem

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getAlliedFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet)
Find all allies of a CampaignFleetAPI present in the system.

Parameters:
fleet - The CampaignFleetAPI to search around.
Returns:
All allies of fleet in the system.
Since:
1.2
See Also:
getAlliedFleetsInSystem(com.fs.starfarer.api.campaign.CampaignFleetAPI, boolean)

getNearbyAlliedFleets

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyAlliedFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                   float range,
                                                                                                   boolean sortByDistance)
Finds all allied fleets within a certain range around a CampaignFleetAPI.

Parameters:
fleet - The entity to search around.
range - How far around fleet to search.
sortByDistance - Whether to sort the results by distance from fleet.
Returns:
A List containing all allied fleets within range.
Since:
1.2

getNearbyAlliedFleets

public static java.util.List<com.fs.starfarer.api.campaign.CampaignFleetAPI> getNearbyAlliedFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI fleet,
                                                                                                   float range)
Finds all allied fleets within a certain range around a CampaignFleetAPI.

Parameters:
fleet - The entity to search around.
range - How far around fleet to search.
Returns:
A List containing all allied fleets within range.
Since:
1.2
See Also:
getNearbyAlliedFleets(com.fs.starfarer.api.campaign.CampaignFleetAPI, float, boolean)

LazyLib