com.fs.starfarer.api.impl.campaign

Class HassleNPCScript

java.lang.Object

com.fs.starfarer.api.impl.campaign.HassleNPCScript

All Implemented Interfaces:

EveryFrameScript

public class HassleNPCScript
extends java.lang.Object
implements EveryFrameScript

Unlike HasslePlayerScript, this is a fleet-fleet interaction and needs to be initiated by some other script. Copyright 2023 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HassleNPCScript.HassleParams

Field Summary

Fields

Modifier and Type	Field and Description
protected float	durDays
protected CampaignFleetAPI	fleet
static java.lang.String	HASSLE_ASSIGNMENT_ID
protected org.lwjgl.util.vector.Vector2f	loc1
protected org.lwjgl.util.vector.Vector2f	loc2
protected HassleNPCScript.HassleParams	params
protected CampaignFleetAPI	target

Constructor Summary

Constructors

Constructor and Description
HassleNPCScript(CampaignFleetAPI fleet, CampaignFleetAPI target)
HassleNPCScript(CampaignFleetAPI fleet, CampaignFleetAPI target, HassleNPCScript.HassleParams params)
HassleNPCScript(CampaignFleetAPI fleet, CampaignFleetAPI target, java.lang.String fleetAction, java.lang.String targetAction)

Method Summary

Modifier and Type	Method and Description
void	abort()
void	advance(float amount) Use SectorAPI.getClock() to convert to campaign days.
protected void	cleanUpFleet(CampaignFleetAPI fleet)
float	getCrDamageMult()
float	getDurDays()
HassleNPCScript.HassleParams	getParams()
boolean	isDone()
boolean	runWhilePaused()
void	setCrDamageMult(float crDamageMult)
void	setDurDays(float durDays)

Methods inherited from class java.lang.Object

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

Field Detail

HASSLE_ASSIGNMENT_ID

public static java.lang.String HASSLE_ASSIGNMENT_ID

fleet

protected CampaignFleetAPI fleet

target

protected CampaignFleetAPI target

loc1

protected org.lwjgl.util.vector.Vector2f loc1

loc2

protected org.lwjgl.util.vector.Vector2f loc2

params

protected HassleNPCScript.HassleParams params

durDays

protected float durDays

Constructor Detail

HassleNPCScript

public HassleNPCScript(CampaignFleetAPI fleet,
                       CampaignFleetAPI target)

HassleNPCScript

public HassleNPCScript(CampaignFleetAPI fleet,
                       CampaignFleetAPI target,
                       HassleNPCScript.HassleParams params)

HassleNPCScript

public HassleNPCScript(CampaignFleetAPI fleet,
                       CampaignFleetAPI target,
                       java.lang.String fleetAction,
                       java.lang.String targetAction)

Method Detail

getDurDays

public float getDurDays()

setDurDays

public void setDurDays(float durDays)

abort

public void abort()

cleanUpFleet

protected void cleanUpFleet(CampaignFleetAPI fleet)

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.

getCrDamageMult

public float getCrDamageMult()

setCrDamageMult

public void setCrDamageMult(float crDamageMult)

getParams

public HassleNPCScript.HassleParams getParams()