com.fs.starfarer.api.impl.campaign.terrain

Class PulsarBeamTerrainPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

com.fs.starfarer.api.impl.campaign.terrain.BaseRingTerrain

com.fs.starfarer.api.impl.campaign.terrain.PulsarBeamTerrainPlugin

All Implemented Interfaces:

CampaignTerrainPlugin, PulsarRenderer.PulsarRendererDelegate

public class PulsarBeamTerrainPlugin
extends BaseRingTerrain
implements PulsarRenderer.PulsarRendererDelegate

Nested Class Summary

Nested classes/interfaces inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseRingTerrain

BaseRingTerrain.RingParams

Field Summary

Fields

Modifier and Type	Field and Description
protected RangeBlockerUtil	blocker
protected PulsarRenderer	flare1
protected PulsarRenderer	flare2
protected SpriteAPI	flareTexture
protected StarCoronaTerrainPlugin.CoronaParams	params
static float	PULSAR_ARC
protected float	pulsarAngle
protected float	pulsarRotation

Fields inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

entity, EXTRA_SOUND_RADIUS, name, TERRAIN_LOCK_KEY, terrainId

Constructor Summary

Constructors

Constructor and Description
PulsarBeamTerrainPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
boolean	canPlayerHoldStationIn()
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
java.lang.String	getEffectCategory()
protected float	getExtraSoundRadius()
float	getIntensityAtPoint(org.lwjgl.util.vector.Vector2f point)
protected float	getLoopOneVolume()
float	getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
float	getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
java.awt.Color	getNameColor()
java.lang.String	getNameForTooltip()
float	getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
StarCoronaTerrainPlugin.CoronaParams	getParams()
RangeBlockerUtil	getPulsarBlocker()
org.lwjgl.util.vector.Vector2f	getPulsarCenterLoc()
java.awt.Color	getPulsarColorForAngle(float angle)
float	getPulsarInnerRadius()
float	getPulsarInnerWidth()
float	getPulsarOuterRadius()
float	getPulsarOuterWidth()
float	getPulsarScrollSpeed()
SpriteAPI	getPulsarTexture()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
java.lang.String	getTerrainName()
float	getTooltipWidth()
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasAIFlag(java.lang.Object flag, CampaignFleetAPI fleet)
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
protected boolean	isNearViewport(float angle, ViewportAPI viewport)
boolean	isTooltipExpandable()
protected java.lang.Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
protected boolean	shouldPlayLoopOne()

Methods inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseRingTerrain

containsEntity, getMaxRadiusForContains, getMinRadiusForContains, getNameAOrAn, getProximitySoundFactor, getRelatedEntity, getRingParams, renderOnMap, renderOnMapAbove

Methods inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

createCombatSection, createFirstSection, createTravelSection, getEntity, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getSpec, getTerrainId, hasMapIcon, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, renderOnRadar, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, shouldPlayLoopFour, shouldPlayLoopThree, shouldPlayLoopTwo, stacksWithSelf

Methods inherited from class java.lang.Object

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

Field Detail

PULSAR_ARC

public static float PULSAR_ARC

flareTexture

protected transient SpriteAPI flareTexture

flare1

protected transient PulsarRenderer flare1

flare2

protected transient PulsarRenderer flare2

params

protected StarCoronaTerrainPlugin.CoronaParams params

blocker

protected transient RangeBlockerUtil blocker

pulsarAngle

protected float pulsarAngle

pulsarRotation

protected float pulsarRotation

Constructor Detail

PulsarBeamTerrainPlugin

public PulsarBeamTerrainPlugin()

Method Detail

init

public void init(java.lang.String terrainId,
                 SectorEntityToken entity,
                 java.lang.Object param)

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseRingTerrain

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class BaseRingTerrain

shouldPlayLoopOne

protected boolean shouldPlayLoopOne()

Overrides:

shouldPlayLoopOne in class BaseTerrain

getLoopOneVolume

protected float getLoopOneVolume()

Overrides:

getLoopOneVolume in class BaseTerrain

getExtraSoundRadius

protected float getExtraSoundRadius()

Overrides:

getExtraSoundRadius in class BaseTerrain

getActiveLayers

public java.util.EnumSet<CampaignEngineLayers> getActiveLayers()

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Overrides:

getActiveLayers in class BaseRingTerrain

Returns:

getParams

public StarCoronaTerrainPlugin.CoronaParams getParams()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseRingTerrain

isNearViewport

protected boolean isNearViewport(float angle,
                                 ViewportAPI viewport)

getRenderRange

public float getRenderRange()

Description copied from interface: CampaignTerrainPlugin

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 CampaignTerrainPlugin

Overrides:

getRenderRange in class BaseRingTerrain

Returns:

containsPoint

public boolean containsPoint(org.lwjgl.util.vector.Vector2f point,
                             float radius)

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseRingTerrain

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

Overrides:

applyEffect in class BaseTerrain

getIntensityAtPoint

public float getIntensityAtPoint(org.lwjgl.util.vector.Vector2f point)

getNameColor

public java.awt.Color getNameColor()

Specified by:

getNameColor in interface CampaignTerrainPlugin

Overrides:

getNameColor in class BaseTerrain

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

Overrides:

createTooltip in class BaseTerrain

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface CampaignTerrainPlugin

Overrides:

isTooltipExpandable in class BaseTerrain

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface CampaignTerrainPlugin

Overrides:

getTooltipWidth in class BaseTerrain

getTerrainName

public java.lang.String getTerrainName()

Specified by:

getTerrainName in interface CampaignTerrainPlugin

Overrides:

getTerrainName in class BaseTerrain

getEffectCategory

public java.lang.String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag,
                         CampaignFleetAPI fleet)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

getMaxEffectRadius

public float getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMaxEffectRadius in interface CampaignTerrainPlugin

Overrides:

getMaxEffectRadius in class BaseRingTerrain

Returns:

getMinEffectRadius

public float getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMinEffectRadius in interface CampaignTerrainPlugin

Overrides:

getMinEffectRadius in class BaseRingTerrain

Returns:

getOptimalEffectRadius

public float getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getOptimalEffectRadius in interface CampaignTerrainPlugin

Overrides:

getOptimalEffectRadius in class BaseRingTerrain

Returns:

canPlayerHoldStationIn

public boolean canPlayerHoldStationIn()

Specified by:

canPlayerHoldStationIn in interface CampaignTerrainPlugin

Overrides:

canPlayerHoldStationIn in class BaseTerrain

getPulsarBlocker

public RangeBlockerUtil getPulsarBlocker()

Specified by:

getPulsarBlocker in interface PulsarRenderer.PulsarRendererDelegate

getPulsarCenterLoc

public org.lwjgl.util.vector.Vector2f getPulsarCenterLoc()

Specified by:

getPulsarCenterLoc in interface PulsarRenderer.PulsarRendererDelegate

getPulsarColorForAngle

public java.awt.Color getPulsarColorForAngle(float angle)

Specified by:

getPulsarColorForAngle in interface PulsarRenderer.PulsarRendererDelegate

getPulsarInnerRadius

public float getPulsarInnerRadius()

Specified by:

getPulsarInnerRadius in interface PulsarRenderer.PulsarRendererDelegate

getPulsarOuterRadius

public float getPulsarOuterRadius()

Specified by:

getPulsarOuterRadius in interface PulsarRenderer.PulsarRendererDelegate

getPulsarInnerWidth

public float getPulsarInnerWidth()

Specified by:

getPulsarInnerWidth in interface PulsarRenderer.PulsarRendererDelegate

getPulsarOuterWidth

public float getPulsarOuterWidth()

Specified by:

getPulsarOuterWidth in interface PulsarRenderer.PulsarRendererDelegate

getPulsarScrollSpeed

public float getPulsarScrollSpeed()

Specified by:

getPulsarScrollSpeed in interface PulsarRenderer.PulsarRendererDelegate

getPulsarTexture

public SpriteAPI getPulsarTexture()

Specified by:

getPulsarTexture in interface PulsarRenderer.PulsarRendererDelegate