com.fs.starfarer.api.impl.campaign

Class AbyssalLightEntityPlugin.DwellerEncounterScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.AbyssalLightEntityPlugin.DwellerEncounterScript

All Implemented Interfaces:

EveryFrameScript

Enclosing class:

AbyssalLightEntityPlugin

public static class AbyssalLightEntityPlugin.DwellerEncounterScript
extends java.lang.Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	done
protected float	elapsed
protected CampaignFleetAPI	fleet
protected SectorEntityToken	light
protected java.lang.String	trigger
protected float	triggerDelay

Constructor Summary

Constructors

Constructor and Description
DwellerEncounterScript(java.lang.String trigger, CampaignFleetAPI fleet, SectorEntityToken light)

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

Field Detail

elapsed

protected float elapsed

trigger

protected java.lang.String trigger

done

protected boolean done

triggerDelay

protected float triggerDelay

light

protected SectorEntityToken light

fleet

protected CampaignFleetAPI fleet

Constructor Detail

DwellerEncounterScript

public DwellerEncounterScript(java.lang.String trigger,
                              CampaignFleetAPI fleet,
                              SectorEntityToken light)

Method Detail

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.

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.