public class BaseTerrain extends java.lang.Object implements CampaignTerrainPlugin
Modifier and Type | Field and Description |
---|---|
protected SectorEntityToken |
entity |
static float |
EXTRA_SOUND_RADIUS |
protected java.lang.String |
name |
static java.lang.String |
TERRAIN_LOCK_KEY |
protected java.lang.String |
terrainId |
Constructor and Description |
---|
BaseTerrain() |
Modifier and Type | Method and Description |
---|---|
void |
advance(float amount) |
void |
applyEffect(SectorEntityToken entity,
float days) |
boolean |
canPlayerHoldStationIn() |
boolean |
containsEntity(SectorEntityToken other) |
boolean |
containsPoint(Vector2f point,
float radius) |
protected void |
createCombatSection(TooltipMakerAPI tooltip,
boolean expanded) |
protected void |
createFirstSection(TooltipMakerAPI tooltip,
boolean expanded) |
void |
createTooltip(TooltipMakerAPI tooltip,
boolean expanded) |
protected void |
createTravelSection(TooltipMakerAPI tooltip,
boolean expanded,
float firstPad) |
java.util.EnumSet<CampaignEngineLayers> |
getActiveLayers()
Set of layers can not change.
|
java.lang.String |
getEffectCategory() |
SectorEntityToken |
getEntity() |
protected float |
getExtraSoundRadius() |
java.lang.String |
getIconSpriteName() |
protected float |
getLoopFourPitch() |
protected float |
getLoopFourVolume() |
protected float |
getLoopOnePitch() |
protected float |
getLoopOneVolume() |
protected float |
getLoopThreePitch() |
protected float |
getLoopThreeVolume() |
protected float |
getLoopTwoPitch() |
protected float |
getLoopTwoVolume() |
float |
getMaxEffectRadius(Vector2f locFrom)
Mainly intended for AI use.
|
float |
getMinEffectRadius(Vector2f locFrom)
Mainly intended for AI use.
|
java.lang.String |
getModId() |
java.lang.String |
getNameAOrAn() |
java.awt.Color |
getNameColor() |
java.lang.String |
getNameForTooltip() |
float |
getOptimalEffectRadius(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.
|
TerrainSpecAPI |
getSpec() |
java.lang.String |
getTerrainId() |
java.lang.String |
getTerrainName() |
float |
getTooltipWidth() |
boolean |
hasAIFlag(java.lang.Object flag) |
boolean |
hasAIFlag(java.lang.Object flag,
CampaignFleetAPI fleet) |
boolean |
hasMapIcon() |
boolean |
hasTooltip() |
void |
init(java.lang.String terrainId,
SectorEntityToken entity,
java.lang.Object param) |
boolean |
isPreventedFromAffecting(SectorEntityToken other) |
boolean |
isTooltipExpandable() |
protected void |
preventOtherTerrainFromAffecting(SectorEntityToken other) |
protected void |
preventOtherTerrainFromAffecting(SectorEntityToken other,
float dur) |
void |
render(CampaignEngineLayers layer,
ViewportAPI viewport) |
void |
renderOnMap(float factor,
float alphaMult)
First pass.
|
void |
renderOnMapAbove(float factor,
float alphaMult)
Second pass.
|
void |
renderOnRadar(Vector2f radarCenter,
float factor,
float alphaMult) |
void |
setTerrainName(java.lang.String name) |
protected boolean |
shouldCheckFleetsToApplyEffect() |
protected boolean |
shouldPlayLoopFour() |
protected boolean |
shouldPlayLoopOne() |
protected boolean |
shouldPlayLoopThree() |
protected boolean |
shouldPlayLoopTwo() |
boolean |
stacksWithSelf() |
public static final float EXTRA_SOUND_RADIUS
protected SectorEntityToken entity
protected java.lang.String terrainId
protected java.lang.String name
public static java.lang.String TERRAIN_LOCK_KEY
public void init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
init
in interface CampaignTerrainPlugin
public java.lang.String getIconSpriteName()
getIconSpriteName
in interface CampaignTerrainPlugin
public SectorEntityToken getRelatedEntity()
public SectorEntityToken getEntity()
public java.lang.String getTerrainId()
getTerrainId
in interface CampaignTerrainPlugin
protected boolean shouldCheckFleetsToApplyEffect()
public void advance(float amount)
advance
in interface CampaignTerrainPlugin
protected float getExtraSoundRadius()
public java.lang.String getEffectCategory()
public boolean containsEntity(SectorEntityToken other)
containsEntity
in interface CampaignTerrainPlugin
public boolean containsPoint(Vector2f point, float radius)
containsPoint
in interface CampaignTerrainPlugin
public boolean stacksWithSelf()
public void applyEffect(SectorEntityToken entity, float days)
public float getProximitySoundFactor()
public java.lang.String getModId()
public java.util.EnumSet<CampaignEngineLayers> getActiveLayers()
CampaignTerrainPlugin
getActiveLayers
in interface CampaignTerrainPlugin
public float getRenderRange()
CampaignTerrainPlugin
getRenderRange
in interface CampaignTerrainPlugin
public void render(CampaignEngineLayers layer, ViewportAPI viewport)
render
in interface CampaignTerrainPlugin
public void renderOnMap(float factor, float alphaMult)
CampaignTerrainPlugin
renderOnMap
in interface CampaignTerrainPlugin
factor
- conversion factor from world coordinates to map screen coordinates, including current zoom level.public void renderOnMapAbove(float factor, float alphaMult)
CampaignTerrainPlugin
renderOnMapAbove
in interface CampaignTerrainPlugin
factor
- conversion factor from world coordinates to map screen coordinates, including current zoom level.public boolean hasTooltip()
hasTooltip
in interface CampaignTerrainPlugin
protected void createFirstSection(TooltipMakerAPI tooltip, boolean expanded)
protected void createTravelSection(TooltipMakerAPI tooltip, boolean expanded, float firstPad)
protected void createCombatSection(TooltipMakerAPI tooltip, boolean expanded)
protected boolean shouldPlayLoopOne()
protected boolean shouldPlayLoopTwo()
protected boolean shouldPlayLoopThree()
protected boolean shouldPlayLoopFour()
protected float getLoopOnePitch()
protected float getLoopOneVolume()
protected float getLoopTwoPitch()
protected float getLoopTwoVolume()
protected float getLoopThreePitch()
protected float getLoopThreeVolume()
protected float getLoopFourPitch()
protected float getLoopFourVolume()
public void createTooltip(TooltipMakerAPI tooltip, boolean expanded)
createTooltip
in interface CampaignTerrainPlugin
public boolean isTooltipExpandable()
isTooltipExpandable
in interface CampaignTerrainPlugin
public float getTooltipWidth()
getTooltipWidth
in interface CampaignTerrainPlugin
public java.lang.String getTerrainName()
getTerrainName
in interface CampaignTerrainPlugin
public java.lang.String getNameAOrAn()
getNameAOrAn
in interface CampaignTerrainPlugin
public void setTerrainName(java.lang.String name)
setTerrainName
in interface CampaignTerrainPlugin
public java.awt.Color getNameColor()
getNameColor
in interface CampaignTerrainPlugin
public boolean hasAIFlag(java.lang.Object flag)
hasAIFlag
in interface CampaignTerrainPlugin
public boolean hasAIFlag(java.lang.Object flag, CampaignFleetAPI fleet)
hasAIFlag
in interface CampaignTerrainPlugin
public float getMaxEffectRadius(Vector2f locFrom)
CampaignTerrainPlugin
getMaxEffectRadius
in interface CampaignTerrainPlugin
public float getMinEffectRadius(Vector2f locFrom)
CampaignTerrainPlugin
getMinEffectRadius
in interface CampaignTerrainPlugin
public float getOptimalEffectRadius(Vector2f locFrom)
CampaignTerrainPlugin
getOptimalEffectRadius
in interface CampaignTerrainPlugin
public boolean hasMapIcon()
hasMapIcon
in interface CampaignTerrainPlugin
public TerrainSpecAPI getSpec()
getSpec
in interface CampaignTerrainPlugin
public boolean canPlayerHoldStationIn()
canPlayerHoldStationIn
in interface CampaignTerrainPlugin
public void renderOnRadar(Vector2f radarCenter, float factor, float alphaMult)
renderOnRadar
in interface CampaignTerrainPlugin
public java.lang.String getNameForTooltip()
getNameForTooltip
in interface CampaignTerrainPlugin
public boolean isPreventedFromAffecting(SectorEntityToken other)
protected void preventOtherTerrainFromAffecting(SectorEntityToken other)
protected void preventOtherTerrainFromAffecting(SectorEntityToken other, float dur)
Copyright © 2013 Fractal Softworks, LLC. All Rights Reserved.