com.fs.starfarer.api.impl.campaign

Class LeashScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.LeashScript

All Implemented Interfaces:

EveryFrameScript

public class LeashScript
extends java.lang.Object
implements EveryFrameScript

Constructor Summary

Constructors

Constructor and Description
LeashScript(CampaignFleetAPI fleet, float range, SectorEntityToken anchor, org.lwjgl.util.vector.Vector2f offset, Script onBroken)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LeashScript

public LeashScript(CampaignFleetAPI fleet,
                   float range,
                   SectorEntityToken anchor,
                   org.lwjgl.util.vector.Vector2f offset,
                   Script onBroken)

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.

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.