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

Class RingSystemTerrainPlugin

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

All Implemented Interfaces:

CampaignTerrainPlugin

public class RingSystemTerrainPlugin
extends BaseRingTerrain

Nested Class Summary

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

BaseRingTerrain.RingParams

Field Summary

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

layers, 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 and Description
RingSystemTerrainPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.lang.String	getEffectCategory()
java.lang.String	getNameForTooltip()
float	getTooltipWidth()
static float	getVisibilityMult(CampaignFleetAPI fleet)
boolean	hasAIFlag(java.lang.Object flag)
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isTooltipExpandable()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
void	renderOnMap(float factor, float alphaMult) First pass.
void	setNameForTooltip(java.lang.String nameForTooltip)

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

containsEntity, containsPoint, getActiveLayers, getMaxEffectRadius, getMaxRadiusForContains, getMinEffectRadius, getMinRadiusForContains, getNameAOrAn, getOptimalEffectRadius, getProximitySoundFactor, getRelatedEntity, getRenderRange, getRingParams, readResolve, 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

Constructor Detail

RingSystemTerrainPlugin

public RingSystemTerrainPlugin()

Method Detail

getVisibilityMult

public static float getVisibilityMult(CampaignFleetAPI fleet)

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

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.

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

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

setNameForTooltip

public void setNameForTooltip(java.lang.String nameForTooltip)

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