com.fs.starfarer.api.impl.campaign

Class GateEntityPlugin

java.lang.Object

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

com.fs.starfarer.api.impl.campaign.GateEntityPlugin

All Implemented Interfaces:

CustomCampaignEntityPlugin

public class GateEntityPlugin
extends BaseCustomEntityPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GateEntityPlugin.GateData

Field Summary

Fields

Modifier and Type	Field and Description
static float	ACCUMULATED_TRANSIT_DIST_DECAY_RATE
protected float	accumulatedTransitDistLY
protected SpriteAPI	activeGlow
protected boolean	addedIntel
protected SpriteAPI	baseSprite
protected FaderUtil	beingUsedFader
static java.lang.String	CAN_SCAN_GATES
protected SpriteAPI	concentric
static java.lang.String	GATE_DATA
static java.lang.String	GATE_SCANNED
static java.lang.String	GATES_ACTIVE
protected FaderUtil	glowFader
protected float	inUseAngle
protected JitterUtil	jitter
protected java.awt.Color	jitterColor
protected FaderUtil	jitterFader
protected boolean	madeActive
static float	MOTE_SPAWN_MULT_BASELINE_DIST_LY
protected IntervalUtil	moteSpawn
static java.lang.String	NUM_GATES_SCANNED
static java.lang.String	PLAYER_CAN_USE_GATES
protected SpriteAPI	rays
protected boolean	scaledSprites
protected SpriteAPI	scannedGlow
protected float	showBeingUsedDur
protected SpriteAPI	starfield
protected WarpingSpriteRendererUtil	warp
protected SpriteAPI	whirl1
protected SpriteAPI	whirl2

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

entity

Constructor Summary

Constructors

Constructor and Description
GateEntityPlugin()

Method Summary

Modifier and Type	Method and Description
static void	addGateScanned()
void	advance(float amount)
void	appendToCampaignTooltip(TooltipMakerAPI tooltip, SectorEntityToken.VisibilityLevel level)
static boolean	areGatesActive()
static boolean	canUseGates()
void	createMapTooltip(TooltipMakerAPI tooltip, boolean expanded)
static GateEntityPlugin.GateData	getGateData()
java.awt.Color	getJitterColor()
float	getJitterLevel()
static int	getNumGatesScanned()
float	getProximitySoundFactor()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
boolean	hasCustomMapTooltip()
void	init(SectorEntityToken entity, java.lang.Object pluginParams)
boolean	isActive()
static boolean	isActive(SectorEntityToken gate)
static boolean	isScanned(SectorEntityToken gate)
void	jitter()
void	playProximityLoop()
void	render(CampaignEngineLayers layer, ViewportAPI viewport) Should only render for specified layer.
protected void	scaleGlowSprites()
void	setJitterColor(java.awt.Color jitterColor)
void	showBeingUsed(float transitDistLY)
void	showBeingUsed(float dur, float transitDistLY)

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

getMapTooltipWidth, 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 Detail

ACCUMULATED_TRANSIT_DIST_DECAY_RATE

public static float ACCUMULATED_TRANSIT_DIST_DECAY_RATE

MOTE_SPAWN_MULT_BASELINE_DIST_LY

public static float MOTE_SPAWN_MULT_BASELINE_DIST_LY

GATE_DATA

public static java.lang.String GATE_DATA

GATE_SCANNED

public static java.lang.String GATE_SCANNED

CAN_SCAN_GATES

public static java.lang.String CAN_SCAN_GATES

GATES_ACTIVE

public static java.lang.String GATES_ACTIVE

PLAYER_CAN_USE_GATES

public static java.lang.String PLAYER_CAN_USE_GATES

NUM_GATES_SCANNED

public static java.lang.String NUM_GATES_SCANNED

baseSprite

protected transient SpriteAPI baseSprite

scannedGlow

protected transient SpriteAPI scannedGlow

activeGlow

protected transient SpriteAPI activeGlow

whirl1

protected transient SpriteAPI whirl1

whirl2

protected transient SpriteAPI whirl2

starfield

protected transient SpriteAPI starfield

rays

protected transient SpriteAPI rays

concentric

protected transient SpriteAPI concentric

warp

protected transient WarpingSpriteRendererUtil warp

beingUsedFader

protected FaderUtil beingUsedFader

glowFader

protected FaderUtil glowFader

madeActive

protected boolean madeActive

addedIntel

protected boolean addedIntel

showBeingUsedDur

protected float showBeingUsedDur

accumulatedTransitDistLY

protected float accumulatedTransitDistLY

jitterColor

protected java.awt.Color jitterColor

jitter

protected JitterUtil jitter

jitterFader

protected FaderUtil jitterFader

moteSpawn

protected IntervalUtil moteSpawn

inUseAngle

protected float inUseAngle

scaledSprites

protected transient boolean scaledSprites

Constructor Detail

GateEntityPlugin

public GateEntityPlugin()

Method Detail

getNumGatesScanned

public static int getNumGatesScanned()

addGateScanned

public static void addGateScanned()

getGateData

public static GateEntityPlugin.GateData getGateData()

isScanned

public static boolean isScanned(SectorEntityToken gate)

isActive

public static boolean isActive(SectorEntityToken gate)

areGatesActive

public static boolean areGatesActive()

canUseGates

public static boolean canUseGates()

init

public void init(SectorEntityToken entity,
                 java.lang.Object pluginParams)

Specified by:

init in interface CustomCampaignEntityPlugin

Overrides:

init in class BaseCustomEntityPlugin

jitter

public void jitter()

getJitterLevel

public float getJitterLevel()

getJitterColor

public java.awt.Color getJitterColor()

setJitterColor

public void setJitterColor(java.awt.Color jitterColor)

isActive

public boolean isActive()

showBeingUsed

public void showBeingUsed(float transitDistLY)

showBeingUsed

public void showBeingUsed(float dur,
                          float transitDistLY)

getProximitySoundFactor

public float getProximitySoundFactor()

playProximityLoop

public void playProximityLoop()

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:

createMapTooltip

public void createMapTooltip(TooltipMakerAPI tooltip,
                             boolean expanded)

Specified by:

createMapTooltip in interface CustomCampaignEntityPlugin

Overrides:

createMapTooltip in class BaseCustomEntityPlugin

hasCustomMapTooltip

public boolean hasCustomMapTooltip()

Specified by:

hasCustomMapTooltip in interface CustomCampaignEntityPlugin

Overrides:

hasCustomMapTooltip in class BaseCustomEntityPlugin

appendToCampaignTooltip

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

Specified by:

appendToCampaignTooltip in interface CustomCampaignEntityPlugin

Overrides:

appendToCampaignTooltip in class BaseCustomEntityPlugin

scaleGlowSprites

protected void scaleGlowSprites()

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