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

Class AsteroidBeltTerrainPlugin

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.AsteroidBeltTerrainPlugin

All Implemented Interfaces:

CampaignTerrainPlugin, AsteroidSource

Direct Known Subclasses:

AsteroidFieldTerrainPlugin

public class AsteroidBeltTerrainPlugin
extends BaseRingTerrain
implements AsteroidSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsteroidBeltTerrainPlugin.AsteroidBeltParams

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 boolean	needToCreateAsteroids
AsteroidBeltTerrainPlugin.AsteroidBeltParams	params

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

layers

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
AsteroidBeltTerrainPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
protected void	createAsteroids()
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.lang.String	getEffectCategory()
java.lang.String	getNameAOrAn()
java.lang.String	getNameForTooltip()
float	getTooltipWidth()
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isTooltipExpandable()
protected java.lang.Object	readResolve()
void	regenerateAsteroids() Called after game load to regenerate asteroids that haven't been persisted.
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult) First pass.
void	reportAsteroidPersisted(SectorEntityToken asteroid) Report that the game engine decided to persist the given asteroid, meaning it doesn't need to be re-generated on game load etc.

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

containsEntity, containsPoint, getActiveLayers, getMaxEffectRadius, getMaxRadiusForContains, getMinEffectRadius, getMinRadiusForContains, getOptimalEffectRadius, getProximitySoundFactor, getRelatedEntity, getRenderRange, getRingParams, renderOnMapAbove

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

canPlayerHoldStationIn, createCombatSection, createFirstSection, createTravelSection, getEntity, getExtraSoundRadius, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameColor, getSpec, getTerrainId, getTerrainName, hasAIFlag, hasMapIcon, isPreventedFromAffecting, 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 Detail

needToCreateAsteroids

protected boolean needToCreateAsteroids

params

public AsteroidBeltTerrainPlugin.AsteroidBeltParams params

Constructor Detail

AsteroidBeltTerrainPlugin

public AsteroidBeltTerrainPlugin()

Method Detail

readResolve

protected java.lang.Object readResolve()

Overrides:

readResolve in class BaseRingTerrain

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 BaseRingTerrain

Parameters:

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

regenerateAsteroids

public void regenerateAsteroids()

Description copied from interface: AsteroidSource

Called after game load to regenerate asteroids that haven't been persisted.

Specified by:

regenerateAsteroids in interface AsteroidSource

createAsteroids

protected void createAsteroids()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

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

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseRingTerrain

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

Overrides:

applyEffect in class BaseTerrain

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

getNameAOrAn

public java.lang.String getNameAOrAn()

Specified by:

getNameAOrAn in interface CampaignTerrainPlugin

Overrides:

getNameAOrAn in class BaseRingTerrain

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

getEffectCategory

public java.lang.String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

hasAIFlag

public boolean hasAIFlag(java.lang.Object flag)

Specified by:

hasAIFlag in interface CampaignTerrainPlugin

Overrides:

hasAIFlag in class BaseTerrain

reportAsteroidPersisted

public void reportAsteroidPersisted(SectorEntityToken asteroid)

Description copied from interface: AsteroidSource

Report that the game engine decided to persist the given asteroid, meaning it doesn't need to be re-generated on game load etc.

Specified by:

reportAsteroidPersisted in interface AsteroidSource