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

Class BaseRingTerrain

java.lang.Object

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

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

All Implemented Interfaces:

CampaignTerrainPlugin

Direct Known Subclasses:

AsteroidBeltTerrainPlugin, DebrisFieldTerrainPlugin, MagneticFieldTerrainPlugin, PulsarBeamTerrainPlugin, RadioChatterTerrainPlugin, RingSystemTerrainPlugin, SpatialAnomalyTerrainPlugin, StarCoronaTerrainPlugin

public abstract class BaseRingTerrain
extends BaseTerrain

No visuals - meant to be used in conjunction with the various LocationAPI.addRingBand() methods.

Author:

Alex Mosolov Copyright 2015 Fractal Softworks, LLC

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseRingTerrain.RingParams

Field Summary

Fields

Modifier and Type	Field	Description
protected EnumSet<CampaignEngineLayers>	layers
BaseRingTerrain.RingParams	params

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	Description
BaseRingTerrain()

Method Summary

Modifier and Type	Method	Description
boolean	containsEntity(SectorEntityToken other)
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
EnumSet<CampaignEngineLayers>	getActiveLayers()	Set of layers can not change.
float	getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)	Mainly intended for AI use.
protected float	getMaxRadiusForContains()
float	getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)	Mainly intended for AI use.
protected float	getMinRadiusForContains()
String	getNameAOrAn()
float	getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)	Mainly intended for AI use.
float	getProximitySoundFactor()
SectorEntityToken	getRelatedEntity()
float	getRenderRange()	How far away from the viewport the center of this entity can be before it stops being rendered.
BaseRingTerrain.RingParams	getRingParams()
void	init(String terrainId, SectorEntityToken entity, Object param)
protected Object	readResolve()
void	render(CampaignEngineLayers layer, ViewportAPI v)
void	renderOnMap(float factor, float alphaMult)	First pass.
void	renderOnMapAbove(float factor, float alphaMult)	Second pass.

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

advance, applyEffect, canPlayerHoldStationIn, createCombatSection, createFirstSection, createTooltip, createTravelSection, getEffectCategory, getEntity, getExtraSoundRadius, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameColor, getNameForTooltip, getSpec, getTerrainId, getTerrainName, getTooltipWidth, hasAIFlag, hasAIFlag, hasMapIcon, hasTooltip, isPreventedFromAffecting, isTooltipExpandable, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, renderOnRadar, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, shouldPlayLoopFour, shouldPlayLoopOne, shouldPlayLoopThree, shouldPlayLoopTwo, stacksWithSelf

Methods inherited from class java.lang.Object

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

Field Details

params

public BaseRingTerrain.RingParams params

layers

protected transient EnumSet<CampaignEngineLayers> layers

Constructor Details

BaseRingTerrain

public BaseRingTerrain()

Method Details

init

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

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTerrain

getRelatedEntity

public SectorEntityToken getRelatedEntity()

Overrides:

getRelatedEntity in class BaseTerrain

readResolve

protected Object readResolve()

getActiveLayers

public EnumSet<CampaignEngineLayers> getActiveLayers()

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Overrides:

getActiveLayers in class BaseTerrain

Returns:

containsEntity

public boolean containsEntity(SectorEntityToken other)

Specified by:

containsEntity in interface CampaignTerrainPlugin

Overrides:

containsEntity in class BaseTerrain

containsPoint

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

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseTerrain

getMinRadiusForContains

protected float getMinRadiusForContains()

getMaxRadiusForContains

protected float getMaxRadiusForContains()

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 BaseTerrain

Returns:

getRingParams

public BaseRingTerrain.RingParams getRingParams()

getProximitySoundFactor

public float getProximitySoundFactor()

Overrides:

getProximitySoundFactor in class BaseTerrain

render

public void render(CampaignEngineLayers layer,
 ViewportAPI v)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTerrain

renderOnMap

public void renderOnMap(float factor,
 float alphaMult)

Description copied from interface: CampaignTerrainPlugin

First pass.

Specified by:

renderOnMap in interface CampaignTerrainPlugin

Overrides:

renderOnMap in class BaseTerrain

Parameters:

factor - conversion factor from world coordinates to map screen coordinates, including current zoom level.

renderOnMapAbove

public void renderOnMapAbove(float factor,
 float alphaMult)

Description copied from interface: CampaignTerrainPlugin

Second pass.

Specified by:

renderOnMapAbove in interface CampaignTerrainPlugin

Overrides:

renderOnMapAbove in class BaseTerrain

Parameters:

factor - conversion factor from world coordinates to map screen coordinates, including current zoom level.

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 BaseTerrain

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 BaseTerrain

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 BaseTerrain

Returns:

getNameAOrAn

public String getNameAOrAn()

Specified by:

getNameAOrAn in interface CampaignTerrainPlugin

Overrides:

getNameAOrAn in class BaseTerrain