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

Class NPCHassler

java.lang.Object

com.fs.starfarer.api.impl.campaign.NPCHassler

All Implemented Interfaces:

EveryFrameScript

public class NPCHassler
extends Object
implements EveryFrameScript

Field Summary

Fields

Modifier and Type	Field	Description
protected CampaignFleetAPI	fleet
protected IntervalUtil	interval
protected HassleNPCScript.HassleParams	params
protected StarSystemAPI	restrictTo

Constructor Summary

Constructors

Constructor	Description
NPCHassler(CampaignFleetAPI fleet)
NPCHassler(CampaignFleetAPI fleet, StarSystemAPI restrictTo)
NPCHassler(CampaignFleetAPI fleet, HassleNPCScript.HassleParams params, StarSystemAPI restrictTo)

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)	Use SectorAPI.getClock() to convert to campaign days.
HassleNPCScript.HassleParams	getParams()
boolean	isDone()
protected boolean	isTargetAllowed(CampaignFleetAPI target)
protected boolean	isTargetRightTypeOfFleet(CampaignFleetAPI target)	This is called in addition to the standard faction/hostility/visibility/etc checks in isTargetAllowed().
boolean	runWhilePaused()

Methods inherited from class java.lang.Object

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

Field Details

fleet

protected CampaignFleetAPI fleet

params

protected HassleNPCScript.HassleParams params

restrictTo

protected StarSystemAPI restrictTo

interval

protected IntervalUtil interval

Constructor Details

NPCHassler

public NPCHassler(CampaignFleetAPI fleet)

NPCHassler

public NPCHassler(CampaignFleetAPI fleet,
 StarSystemAPI restrictTo)

NPCHassler

public NPCHassler(CampaignFleetAPI fleet,
 HassleNPCScript.HassleParams params,
 StarSystemAPI restrictTo)

Method Details

getParams

public HassleNPCScript.HassleParams getParams()

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.

isTargetAllowed

protected boolean isTargetAllowed(CampaignFleetAPI target)

isTargetRightTypeOfFleet

protected boolean isTargetRightTypeOfFleet(CampaignFleetAPI target)

This is called in addition to the standard faction/hostility/visibility/etc checks in isTargetAllowed().

Parameters:

target -

Returns:

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.