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

Class AsteroidFieldTerrainPlugin

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

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

All Implemented Interfaces:

CampaignTerrainPlugin, AsteroidSource

public class AsteroidFieldTerrainPlugin
extends AsteroidBeltTerrainPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsteroidFieldTerrainPlugin.AsteroidFieldParams

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

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
AsteroidFieldTerrainPlugin.AsteroidFieldParams	params

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

needToCreateAsteroids

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

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
protected void	createAsteroidField()
java.lang.String	getNameForTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
void	regenerateAsteroids() Called after game load to regenerate asteroids that haven't been persisted.
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.AsteroidBeltTerrainPlugin

applyEffect, createAsteroids, createTooltip, getEffectCategory, getNameAOrAn, getTooltipWidth, hasAIFlag, hasTooltip, isTooltipExpandable, readResolve, render

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

params

public AsteroidFieldTerrainPlugin.AsteroidFieldParams params

Constructor Detail

AsteroidFieldTerrainPlugin

public AsteroidFieldTerrainPlugin()

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 AsteroidBeltTerrainPlugin

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 AsteroidBeltTerrainPlugin

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

Overrides:

regenerateAsteroids in class AsteroidBeltTerrainPlugin

createAsteroidField

protected void createAsteroidField()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class AsteroidBeltTerrainPlugin

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class AsteroidBeltTerrainPlugin

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

Overrides:

reportAsteroidPersisted in class AsteroidBeltTerrainPlugin