com.fs.starfarer.api.impl.campaign.fleets

Class RouteManager

java.lang.Object

com.fs.starfarer.api.impl.campaign.fleets.RouteManager

All Implemented Interfaces:

FleetEventListener

public class RouteManager
extends java.lang.Object
implements FleetEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteManager.OptionalFleetData
static class	RouteManager.RouteData
static interface	RouteManager.RouteFleetSpawner
static class	RouteManager.RouteSegment

Field Summary

Fields

Modifier and Type	Field and Description
static float	DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_CLOSE
static float	DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_FAR
static float	DESPAWN_DIST_LY_CLOSE
static float	DESPAWN_DIST_LY_FAR
static float	IN_OUT_PHASE_DAYS
static float	IN_OUT_PHASE_FRACTION
static java.lang.String	KEY
protected java.util.List<RouteManager.RouteData>	routes
protected java.util.Map<LocationAPI,java.util.List<RouteManager.RouteData>>	routesByLocation
protected java.util.Map<java.lang.String,java.util.List<RouteManager.RouteData>>	sourceToRoute
static float	SPAWN_DIST_LY

Constructor Summary

Constructors

Constructor and Description
RouteManager()

Method Summary

Modifier and Type	Method and Description
RouteManager.RouteData	addRoute(java.lang.String source, MarketAPI market, java.lang.Long seed, RouteManager.OptionalFleetData extra, RouteManager.RouteFleetSpawner spawner)
RouteManager.RouteData	addRoute(java.lang.String source, MarketAPI market, java.lang.Long seed, RouteManager.OptionalFleetData extra, RouteManager.RouteFleetSpawner spawner, java.lang.Object custom)
void	addToMap(RouteManager.RouteData route)
void	advance(float amount)
protected void	advanceRoutes(float days)
static RouteManager	getInstance()
int	getNumRoutesFor(java.lang.String source)
RouteManager.RouteData	getRoute(java.lang.String source, CampaignFleetAPI fleet)
java.util.List<RouteManager.RouteData>	getRoutesForSource(java.lang.String source)
java.util.List<RouteManager.RouteData>	getRoutesInLocation(LocationAPI location)
static boolean	isPlayerInSpawnRange(SectorEntityToken from)
void	removeFromMap(RouteManager.RouteData route)
void	removeRote(RouteManager.RouteData route) Deprecated.
void	removeRoute(RouteManager.RouteData route)
void	reportBattleOccurred(CampaignFleetAPI fleet, CampaignFleetAPI primaryWinner, BattleAPI battle) "fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.
void	reportFleetDespawnedToListener(CampaignFleetAPI fleet, CampaignEventListener.FleetDespawnReason reason, java.lang.Object param)
protected boolean	shouldDespawn(RouteManager.RouteData data)
protected boolean	shouldSpawn(RouteManager.RouteData data)
protected void	spawnAndDespawn()

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

IN_OUT_PHASE_DAYS

public static float IN_OUT_PHASE_DAYS

IN_OUT_PHASE_FRACTION

public static float IN_OUT_PHASE_FRACTION

DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_FAR

public static float DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_FAR

DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_CLOSE

public static float DAYS_SINCE_SEEN_BEFORE_DESPAWN_IF_CLOSE

DESPAWN_DIST_LY_FAR

public static float DESPAWN_DIST_LY_FAR

DESPAWN_DIST_LY_CLOSE

public static float DESPAWN_DIST_LY_CLOSE

SPAWN_DIST_LY

public static float SPAWN_DIST_LY

routes

protected java.util.List<RouteManager.RouteData> routes

sourceToRoute

protected transient java.util.Map<java.lang.String,java.util.List<RouteManager.RouteData>> sourceToRoute

routesByLocation

protected transient java.util.Map<LocationAPI,java.util.List<RouteManager.RouteData>> routesByLocation

Constructor Detail

RouteManager

public RouteManager()

Method Detail

getInstance

public static RouteManager getInstance()

getRoutesInLocation

public java.util.List<RouteManager.RouteData> getRoutesInLocation(LocationAPI location)

addRoute

public RouteManager.RouteData addRoute(java.lang.String source,
                                       MarketAPI market,
                                       java.lang.Long seed,
                                       RouteManager.OptionalFleetData extra,
                                       RouteManager.RouteFleetSpawner spawner)

removeRote

@Deprecated
public void removeRote(RouteManager.RouteData route)

Deprecated.

removeRoute

public void removeRoute(RouteManager.RouteData route)

addRoute

public RouteManager.RouteData addRoute(java.lang.String source,
                                       MarketAPI market,
                                       java.lang.Long seed,
                                       RouteManager.OptionalFleetData extra,
                                       RouteManager.RouteFleetSpawner spawner,
                                       java.lang.Object custom)

getNumRoutesFor

public int getNumRoutesFor(java.lang.String source)

addToMap

public void addToMap(RouteManager.RouteData route)

removeFromMap

public void removeFromMap(RouteManager.RouteData route)

getRoutesForSource

public java.util.List<RouteManager.RouteData> getRoutesForSource(java.lang.String source)

getRoute

public RouteManager.RouteData getRoute(java.lang.String source,
                                       CampaignFleetAPI fleet)

advance

public void advance(float amount)

spawnAndDespawn

protected void spawnAndDespawn()

shouldSpawn

protected boolean shouldSpawn(RouteManager.RouteData data)

isPlayerInSpawnRange

public static boolean isPlayerInSpawnRange(SectorEntityToken from)

shouldDespawn

protected boolean shouldDespawn(RouteManager.RouteData data)

advanceRoutes

protected void advanceRoutes(float days)

reportFleetDespawnedToListener

public void reportFleetDespawnedToListener(CampaignFleetAPI fleet,
                                           CampaignEventListener.FleetDespawnReason reason,
                                           java.lang.Object param)

Specified by:

reportFleetDespawnedToListener in interface FleetEventListener

reportBattleOccurred

public void reportBattleOccurred(CampaignFleetAPI fleet,
                                 CampaignFleetAPI primaryWinner,
                                 BattleAPI battle)

Description copied from interface: FleetEventListener

"fleet" will be null if the listener is registered with the ListenerManager, and non-null if the listener is added directly to a fleet.

Specified by:

reportBattleOccurred in interface FleetEventListener