Package com.fs.starfarer.api.impl.campaign.intel.bar

Class PortsideBarData

java.lang.Object

com.fs.starfarer.api.impl.campaign.intel.bar.PortsideBarData

All Implemented Interfaces:

EveryFrameScript

public class PortsideBarData
extends Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PortsideBarEvent>	active
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
PortsideBarData()

Method Summary

Modifier and Type	Method	Description
void	addEvent(PortsideBarEvent event)
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
List<PortsideBarEvent>	getEvents()
static PortsideBarData	getInstance()
boolean	isDone()
void	removeEvent(PortsideBarEvent event)
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

active

protected List<PortsideBarEvent> active

Constructor Details

PortsideBarData

public PortsideBarData()

Method Details

getInstance

public static PortsideBarData getInstance()

addEvent

public void addEvent(PortsideBarEvent event)

removeEvent

public void removeEvent(PortsideBarEvent event)

getEvents

public List<PortsideBarEvent> getEvents()

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.