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

Class PersonalFleetScript

java.lang.Object

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

All Implemented Interfaces:

FleetEventListener, EveryFrameScript

Direct Known Subclasses:

PersonalFleetHoracioCaden, PersonalFleetOxanaHyder, SDFBase

public abstract class PersonalFleetScript
extends Object
implements EveryFrameScript, FleetEventListener

Field Summary

Fields

Modifier and Type	Field	Description
protected float	currDelay
protected String	defeatTrigger
protected boolean	done
protected CampaignFleetAPI	fleet
protected float	maxFailedSpawnRespawnDelayDays
protected float	maxRespawnDelayDays
protected float	minFailedSpawnRespawnDelayDays
protected float	minRespawnDelayDays
protected float	origFP
protected String	personId
protected Random	random

Constructor Summary

Constructors

Constructor	Description
PersonalFleetScript(String personId)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
abstract boolean	canSpawnFleetNow()
float	getCurrDelay()
String	getDefeatTrigger()
CampaignFleetAPI	getFleet()
float	getMaxFailedSpawnRespawnDelayDays()
float	getMaxRespawnDelayDays()
float	getMinFailedSpawnRespawnDelayDays()
float	getMinRespawnDelayDays()
PersonAPI	getPerson()
String	getPersonId()
Random	getRandom()
protected abstract MarketAPI	getSourceMarket()
boolean	isDone()
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, Object param)
boolean	runWhilePaused()
void	setCurrDelay(float currDelay)
void	setDefeatTrigger(String defeatTrigger)
void	setFleet(CampaignFleetAPI fleet)
void	setMaxFailedSpawnRespawnDelayDays(float maxFailedSpawnRespawnDelayDays)
void	setMaxRespawnDelayDays(float maxRespawnDelayDays)
void	setMinFailedSpawnRespawnDelayDays(float minFailedSpawnRespawnDelayDays)
void	setMinRespawnDelayDays(float minRespawnDelayDays)
void	setPersonId(String personId)
void	setRandom(Random random)
abstract boolean	shouldScriptBeRemoved()
abstract CampaignFleetAPI	spawnFleet()

Methods inherited from class java.lang.Object

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

Field Details

personId

protected String personId

minRespawnDelayDays

protected float minRespawnDelayDays

maxRespawnDelayDays

protected float maxRespawnDelayDays

minFailedSpawnRespawnDelayDays

protected float minFailedSpawnRespawnDelayDays

maxFailedSpawnRespawnDelayDays

protected float maxFailedSpawnRespawnDelayDays

currDelay

protected float currDelay

fleet

protected CampaignFleetAPI fleet

random

protected Random random

done

protected boolean done

defeatTrigger

protected String defeatTrigger

origFP

protected float origFP

Constructor Details

PersonalFleetScript

public PersonalFleetScript(String personId)

Method Details

getPerson

public PersonAPI getPerson()

isDone

public boolean isDone()

Specified by:

isDone in interface EveryFrameScript

Returns:

true when the script is finished and can be cleaned up by the engine.

runWhilePaused

public boolean runWhilePaused()

Specified by:

runWhilePaused in interface EveryFrameScript

Returns:

whether advance() should be called while the campaign engine is paused.

getDefeatTrigger

public String getDefeatTrigger()

setDefeatTrigger

public void setDefeatTrigger(String defeatTrigger)

getSourceMarket

protected abstract MarketAPI getSourceMarket()

advance

public void advance(float amount)

Description copied from interface: EveryFrameScript

Use SectorAPI.getClock() to convert to campaign days.

Specified by:

advance in interface EveryFrameScript

Parameters:

amount - seconds elapsed during the last frame.

spawnFleet

public abstract CampaignFleetAPI spawnFleet()

canSpawnFleetNow

public abstract boolean canSpawnFleetNow()

shouldScriptBeRemoved

public abstract boolean shouldScriptBeRemoved()

reportFleetDespawnedToListener

public void reportFleetDespawnedToListener(CampaignFleetAPI fleet,
 CampaignEventListener.FleetDespawnReason reason,
 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

getPersonId

public String getPersonId()

setPersonId

public void setPersonId(String personId)

getMinRespawnDelayDays

public float getMinRespawnDelayDays()

setMinRespawnDelayDays

public void setMinRespawnDelayDays(float minRespawnDelayDays)

getMaxRespawnDelayDays

public float getMaxRespawnDelayDays()

setMaxRespawnDelayDays

public void setMaxRespawnDelayDays(float maxRespawnDelayDays)

getMinFailedSpawnRespawnDelayDays

public float getMinFailedSpawnRespawnDelayDays()

setMinFailedSpawnRespawnDelayDays

public void setMinFailedSpawnRespawnDelayDays(float minFailedSpawnRespawnDelayDays)

getMaxFailedSpawnRespawnDelayDays

public float getMaxFailedSpawnRespawnDelayDays()

setMaxFailedSpawnRespawnDelayDays

public void setMaxFailedSpawnRespawnDelayDays(float maxFailedSpawnRespawnDelayDays)

getCurrDelay

public float getCurrDelay()

setCurrDelay

public void setCurrDelay(float currDelay)

getFleet

public CampaignFleetAPI getFleet()

setFleet

public void setFleet(CampaignFleetAPI fleet)

getRandom

public Random getRandom()

setRandom

public void setRandom(Random random)