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

Class DerelictShipEntityPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

com.fs.starfarer.api.impl.campaign.DerelictShipEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class DerelictShipEntityPlugin
extends BaseCustomEntityPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DerelictShipEntityPlugin.DerelictShipData
static enum	DerelictShipEntityPlugin.DerelictType

Field Summary

Fields

Modifier and Type	Field	Description
static float	DEFAULT_SMOD_PROB
protected float	elapsed
protected Boolean	expiring

Fields inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

entity

Constructor Summary

Constructors

Constructor	Description
DerelictShipEntityPlugin()

Method Summary

Modifier and Type	Method	Description
void	advance(float amount)
void	appendToCampaignTooltip(TooltipMakerAPI tooltip, SectorEntityToken.VisibilityLevel level)
static DerelictShipEntityPlugin.DerelictShipData	createHull(String hullId, Random random, float sModProb)
static DerelictShipEntityPlugin.DerelictShipData	createRandom(String factionId, DerelictShipEntityPlugin.DerelictType type, Random random)
static DerelictShipEntityPlugin.DerelictShipData	createRandom(String factionId, DerelictShipEntityPlugin.DerelictType type, Random random, float sModProb)
static DerelictShipEntityPlugin.DerelictShipData	createVariant(String variantId, Random random, float sModProb)
static float	getBaseDuration(ShipAPI.HullSize size)
static float	getBasicDropValue(FleetMemberAPI member)
DerelictShipEntityPlugin.DerelictShipData	getData()
static float	getDefaultSModProb()
static float	getDetectedAtRange(ShipAPI.HullSize size)
static float	getRadius(ShipAPI.HullSize size)
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
void	init(SectorEntityToken entity, Object params)
static ShipRecoverySpecial.ShipCondition	pickBadCondition(Random random)
static String	pickCivilianVariantId(String factionId, Random random)
static ShipRecoverySpecial.ShipCondition	pickDerelictCondition(Random random)
static DerelictShipEntityPlugin.DerelictType	pickDerelictType(Random random)
static String	pickLargeVariantId(String factionId, Random random)
static String	pickMediumVariantId(String factionId, Random random)
static String	pickSmallVariantId(String factionId, Random random)
static String	pickVariant(String factionId, Random random, Object... shipRoles)
void	render(CampaignEngineLayers layer, ViewportAPI viewport)	Should only render for specified layer.

Methods inherited from class com.fs.starfarer.api.impl.campaign.BaseCustomEntityPlugin

createMapTooltip, getMapTooltipWidth, hasCustomMapTooltip, isMapTooltipExpandable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.fs.starfarer.api.campaign.CustomCampaignEntityPlugin

isRenderWhenViewportAlphaMultIsZero

Field Details

DEFAULT_SMOD_PROB

public static float DEFAULT_SMOD_PROB

elapsed

protected float elapsed

expiring

protected Boolean expiring

Constructor Details

DerelictShipEntityPlugin

public DerelictShipEntityPlugin()

Method Details

getDefaultSModProb

public static float getDefaultSModProb()

createHull

public static DerelictShipEntityPlugin.DerelictShipData createHull(String hullId,
 Random random,
 float sModProb)

createVariant

public static DerelictShipEntityPlugin.DerelictShipData createVariant(String variantId,
 Random random,
 float sModProb)

createRandom

public static DerelictShipEntityPlugin.DerelictShipData createRandom(String factionId,
 DerelictShipEntityPlugin.DerelictType type,
 Random random)

createRandom

public static DerelictShipEntityPlugin.DerelictShipData createRandom(String factionId,
 DerelictShipEntityPlugin.DerelictType type,
 Random random,
 float sModProb)

pickDerelictType

public static DerelictShipEntityPlugin.DerelictType pickDerelictType(Random random)

pickDerelictCondition

public static ShipRecoverySpecial.ShipCondition pickDerelictCondition(Random random)

pickBadCondition

public static ShipRecoverySpecial.ShipCondition pickBadCondition(Random random)

pickCivilianVariantId

public static String pickCivilianVariantId(String factionId,
 Random random)

pickSmallVariantId

public static String pickSmallVariantId(String factionId,
 Random random)

pickMediumVariantId

public static String pickMediumVariantId(String factionId,
 Random random)

pickLargeVariantId

public static String pickLargeVariantId(String factionId,
 Random random)

pickVariant

public static String pickVariant(String factionId,
 Random random,
 Object... shipRoles)

init

public void init(SectorEntityToken entity,
 Object params)

Specified by:

init in interface CustomCampaignEntityPlugin

Overrides:

init in class BaseCustomEntityPlugin

getRadius

public static float getRadius(ShipAPI.HullSize size)

getBaseDuration

public static float getBaseDuration(ShipAPI.HullSize size)

getDetectedAtRange

public static float getDetectedAtRange(ShipAPI.HullSize size)

getBasicDropValue

public static float getBasicDropValue(FleetMemberAPI member)

advance

public void advance(float amount)

Specified by:

advance in interface CustomCampaignEntityPlugin

Overrides:

advance in class BaseCustomEntityPlugin

Parameters:

amount - in seconds. Use SectorAPI.getClock() to figure out how many campaign days that is.

getRenderRange

public float getRenderRange()

Description copied from interface: CustomCampaignEntityPlugin

How far away from the viewport the center of this entity can be before it stops being rendered. Should at least be the radius of the entity; sometimes more may be necessary depending on the visual effect desired.

Specified by:

getRenderRange in interface CustomCampaignEntityPlugin

Overrides:

getRenderRange in class BaseCustomEntityPlugin

Returns:

render

public void render(CampaignEngineLayers layer,
 ViewportAPI viewport)

Description copied from interface: CustomCampaignEntityPlugin

Should only render for specified layer. Will be called once per each layer, per frame. Needs to respect viewport.getAlphaMult() - i.e. use that alpha value for rendering. Needs to render at the entity's location - there's no translation before this method call. If a sprite is specified, it will be rendered in the bottommost layer of the layers this entity renders for. This method will be called after the sprite has rendered.

Specified by:

render in interface CustomCampaignEntityPlugin

Overrides:

render in class BaseCustomEntityPlugin

getData

public DerelictShipEntityPlugin.DerelictShipData getData()

appendToCampaignTooltip

public void appendToCampaignTooltip(TooltipMakerAPI tooltip,
 SectorEntityToken.VisibilityLevel level)

Specified by:

appendToCampaignTooltip in interface CustomCampaignEntityPlugin

Overrides:

appendToCampaignTooltip in class BaseCustomEntityPlugin