HasslePlayerScript (Starfarer API)

java.lang.Object

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

All Implemented Interfaces:: EveryFrameScript

public class HasslePlayerScript extends Object implements EveryFrameScript

Field Summary

Fields

Modifier and Type

Field

Description

static final String

HASSLE_COMPLETE_KEY

static final String

HASSLE_TIMEOUT_KEY
Constructor Summary

Constructors

Constructor

Description

HasslePlayerScript()
Method Summary

Modifier and Type

Method

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 Details
- HASSLE_COMPLETE_KEY
  
  public static final String HASSLE_COMPLETE_KEY
  See Also:
  
  Constant Field Values
- HASSLE_TIMEOUT_KEY
  
  public static final String HASSLE_TIMEOUT_KEY
  See Also:
  
  Constant Field Values
Constructor Details
- HasslePlayerScript
  
  public HasslePlayerScript()
Method Details
- 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.