LocationAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.Collection;
import java.util.List;
import java.util.Map;
 
import java.awt.Color;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.EveryFrameScript;
import com.fs.starfarer.api.campaign.rules.MemoryAPI;
import com.fs.starfarer.api.impl.campaign.procgen.Constellation;
import com.fs.starfarer.api.util.ColorShifterAPI;
 
public interface LocationAPI {
    
    String getId();
    
    boolean activeThisFrame();
    
    String getBackgroundTextureFilename();
    void setBackgroundTextureFilename(String backgroundTextureFilename);
    
    void addSpawnPoint(SpawnPointPlugin point);
    void removeSpawnPoint(SpawnPointPlugin point);
    List<SpawnPointPlugin> getSpawnPoints();
    
    void spawnFleet(SectorEntityToken anchor, float xOffset, float yOffset, CampaignFleetAPI fleet);
 
    SectorEntityToken createToken(float x, float y);
    
    SectorEntityToken createToken(Vector2f loc);
    
    
    void addEntity(SectorEntityToken entity);
    void removeEntity(SectorEntityToken entity);
 
    
    PlanetAPI addPlanet(String id, SectorEntityToken focus, String name, String type,
                        float angle, float radius, float orbitRadius, float orbitDays);
    SectorEntityToken addAsteroidBelt(SectorEntityToken focus, int numAsteroids, float orbitRadius, float width, float minOrbitDays, float maxOrbitDays);
 
    SectorEntityToken addAsteroidBelt(SectorEntityToken focus, int numAsteroids,
            float orbitRadius, float width, float minOrbitDays,
            float maxOrbitDays, String terrainId, String optionalName);
 
    void addOrbitalJunk(SectorEntityToken focus, String junkType, int num,
                        float minSize, float maxSize, float orbitRadius, float width,
                        float minOrbitDays, float maxOrbitDays, float minSpin, float maxSpin);
    
    
    RingBandAPI addRingBand(SectorEntityToken focus, String category, String key,
                     float bandWidthInTexture, int bandIndex, Color color,
                     float bandWidthInEngine, float middleRadius, float orbitDays);
 
    
    SectorEntityToken addRingBand(SectorEntityToken focus, String category,
            String key, float bandWidthInTexture, int bandIndex, Color color,
            float bandWidthInEngine, float middleRadius, float orbitDays,
            String terrainId, String optionalName);
 
    
//  /**
//   * Add station with custom graphic and radius.
//   * @param id
//   * @param focus
//   * @param category key in graphics section in settings.jsno
//   * @param key in category
//   * @param radius radius. Sprite will be sized to (radius * 2, radius * 2)
//   * @param angle
//   * @param orbitRadius
//   * @param orbitDays
//   * @param name
//   * @param factionId
//   * @return
//   */
//  SectorEntityToken addOrbitalStation(String id, SectorEntityToken focus,
//                                      String category, String key, float radius, 
//                                      float angle, float orbitRadius, float orbitDays,
//                                      String name, String factionId);
//  SectorEntityToken addOrbitalStation(String id, SectorEntityToken focus,
//                                      float angle, float orbitRadius, float orbitDays,
//                                      String name, String factionId);
    
    
    public CustomCampaignEntityAPI addCustomEntity(String id, String name, String type,
                                             String factionId);
    
    public CustomCampaignEntityAPI addCustomEntity(String id, String name, String type,
                                             String factionId, float radius, float spriteWidth, float spriteHeight);    
    
    
    public SectorEntityToken addTerrain(String terrainId, Object param);
    
    List getEntities(Class implementedClassOrInterface);
    
    List<SectorEntityToken> getEntitiesWithTag(String tag);
    
    List<CampaignFleetAPI> getFleets();
    List<PlanetAPI> getPlanets();
    
    @Deprecated List<SectorEntityToken> getOrbitalStations();
    List<SectorEntityToken> getAsteroids(); 
    
    @Deprecated
    SectorEntityToken getEntityByName(String name);
    SectorEntityToken getEntityById(String id);
    Vector2f getLocation();
 
    boolean isHyperspace();
    
    void addScript(EveryFrameScript script);
    void removeScriptsOfClass(Class c);
    void removeScript(EveryFrameScript script);
    
    String getName();
    void setName(String name);
 
    List<SectorEntityToken> getAllEntities();
 
    
    SectorEntityToken addCorona(SectorEntityToken star, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult);
    SectorEntityToken addCorona(SectorEntityToken star, String terrainType, float extraRadius, float windBurnLevel, float flareProbability, float crLossMult);
    List<CampaignTerrainAPI> getTerrainCopy();
 
    Map<String, Object> getPersistentData();
 
    AsteroidAPI addAsteroid(float radius);
 
    void setBackgroundOffset(float x, float y);
 
    SectorEntityToken addRadioChatter(SectorEntityToken entity, float extraRadius);
 
    void updateAllOrbits();
    
    boolean isNebula();
 
    String getNameWithLowercaseType();
 
    List<FleetStubAPI> getFleetStubs();
    void removeFleetStub(FleetStubAPI stub);
    void addFleetStub(FleetStubAPI stub);
 
    Constellation getConstellation();
 
    boolean isInConstellation();
 
    String getNameWithTypeIfNebula();
 
    Collection<String> getTags();
    boolean hasTag(String tag);
    void addTag(String tag);
    void removeTag(String tag);
    void clearTags();
 
    CustomCampaignEntityAPI addCustomEntity(String id, String name,
            String type, String factionId, float radius, float spriteWidth,
            float spriteHeight, Object pluginParams);
 
    CustomCampaignEntityAPI addCustomEntity(String id, String name,
            String type, String factionId, Object pluginParams);
 
    List<SectorEntityToken> getJumpPoints();
 
    long getLastPlayerVisitTimestamp();
 
    float getDaysSinceLastPlayerVisit();
 
    
    List<CustomCampaignEntityAPI> getCustomEntitiesWithTag(String tag);
 
    List<EveryFrameScript> getScripts();
 
    void addHitParticle(Vector2f loc, Vector2f vel, float size, float brightness, float duration, Color color);
    
    void renderingLayersUpdated(SectorEntityToken entity);
 
    MemoryAPI getMemoryWithoutUpdate();
 
    ParticleControllerAPI addParticle(Vector2f loc, Vector2f vel, float size, float brightness, float rampUp, float duration, Color color);
 
    String getNameWithNoType();
 
    boolean isCurrentLocation();
 
    String getNameWithLowercaseTypeShort();
 
    String getNameWithTypeShort();
 
    List<NascentGravityWellAPI> getGravityWells();
 
    List<CustomCampaignEntityAPI> getCustomEntities();
 
    ColorShifterAPI getBackgroundColorShifter();
 
    ColorShifterAPI getBackgroundParticleColorShifter();
 
    boolean isDeepSpace();
 
}