com.fs.starfarer.api.impl.campaign

Class HasslePlayerScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.HasslePlayerScript

All Implemented Interfaces:

EveryFrameScript

public class HasslePlayerScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HASSLE_COMPLETE_KEY
static java.lang.String	HASSLE_TIMEOUT_KEY

Constructor Summary

Constructors

Constructor and Description
HasslePlayerScript()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected void	cleanUpCurr()
boolean	isDone()
void	maintainOngoingHassle(float days)
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Field Detail

HASSLE_COMPLETE_KEY

public static final java.lang.String HASSLE_COMPLETE_KEY

See Also:

Constant Field Values

HASSLE_TIMEOUT_KEY

public static final java.lang.String HASSLE_TIMEOUT_KEY

See Also:

Constant Field Values

Constructor Detail

HasslePlayerScript

public HasslePlayerScript()

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.

maintainOngoingHassle

public void maintainOngoingHassle(float days)

cleanUpCurr

protected void cleanUpCurr()

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.