com.fs.starfarer.api.impl.campaign

Class MilitaryResponseScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.MilitaryResponseScript

All Implemented Interfaces:

EveryFrameScript

public class MilitaryResponseScript
extends java.lang.Object
implements EveryFrameScript

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MilitaryResponseScript.MilitaryResponseParams

Field Summary

Fields

Modifier and Type	Field and Description
protected float	elapsed
protected MilitaryResponseScript.MilitaryResponseParams	params
static java.lang.String	RESPONSE_ASSIGNMENT
protected IntervalUtil	tracker

Constructor Summary

Constructors

Constructor and Description
MilitaryResponseScript(MilitaryResponseScript.MilitaryResponseParams params)

Method Summary

Modifier and Type	Method and Description
protected void	addToResponseTotal()
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected boolean	couldRespond(CampaignFleetAPI fleet)
void	forceDone()
float	getElapsed()
MilitaryResponseScript.MilitaryResponseParams	getParams()
protected float	getResponseTotal()
protected java.lang.String	getResponseTotalKey()
void	initiateResponse()
boolean	isDone()
protected boolean	isResponding(CampaignFleetAPI fleet)
protected boolean	isTemporarilyNotResponding(CampaignFleetAPI fleet)
protected void	removeFromResponseTotal()
protected void	respond(CampaignFleetAPI fleet)
boolean	runWhilePaused()
protected void	seeIfFleetShouldRespond(CampaignFleetAPI fleet)
void	setElapsed(float elapsed)
protected void	unrespond(CampaignFleetAPI fleet)

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_ASSIGNMENT

public static java.lang.String RESPONSE_ASSIGNMENT

tracker

protected IntervalUtil tracker

params

protected MilitaryResponseScript.MilitaryResponseParams params

elapsed

protected float elapsed

Constructor Detail

MilitaryResponseScript

public MilitaryResponseScript(MilitaryResponseScript.MilitaryResponseParams params)

Method Detail

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.

initiateResponse

public void initiateResponse()

isTemporarilyNotResponding

protected boolean isTemporarilyNotResponding(CampaignFleetAPI fleet)

seeIfFleetShouldRespond

protected void seeIfFleetShouldRespond(CampaignFleetAPI fleet)

respond

protected void respond(CampaignFleetAPI fleet)

unrespond

protected void unrespond(CampaignFleetAPI fleet)

isResponding

protected boolean isResponding(CampaignFleetAPI fleet)

couldRespond

protected boolean couldRespond(CampaignFleetAPI fleet)

getResponseTotalKey

protected java.lang.String getResponseTotalKey()

addToResponseTotal

protected void addToResponseTotal()

removeFromResponseTotal

protected void removeFromResponseTotal()

getResponseTotal

protected float getResponseTotal()

forceDone

public void forceDone()

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.

getParams

public MilitaryResponseScript.MilitaryResponseParams getParams()

getElapsed

public float getElapsed()

setElapsed

public void setElapsed(float elapsed)