SaveNagScript (Starfarer API)

java.lang.Object

com.fs.starfarer.api.impl.campaign.tutorial.SaveNagScript

All Implemented Interfaces:: EveryFrameScript

public class SaveNagScript extends Object implements EveryFrameScript

Field Summary

Fields

Modifier and Type

Field

Description

protected float

duration

protected boolean

playerSaved
Constructor Summary

Constructors

Constructor

Description

SaveNagScript(float duration)
Method Summary

Modifier and Type

Method

Description

void

advance(float amount)

Use SectorAPI.getClock() to convert to campaign days.

boolean

isDone()

boolean

runWhilePaused()

protected Object

writeReplace()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- duration
  
  protected float duration
- playerSaved
  
  protected boolean playerSaved
Constructor Details
- SaveNagScript
  
  public SaveNagScript(float duration)
Method Details
- writeReplace
  
  protected Object writeReplace()
- 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.