JumpPointAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.List;
 
 
public interface JumpPointAPI extends SectorEntityToken {
    
    public static class JumpDestination {
        private SectorEntityToken destination;
        private String labelInInteractionDialog;
        
        private float minDistFromToken = 0;
        private float maxDistFromToken = 0;
        
        public JumpDestination(SectorEntityToken destination, String labelInInteractionDialog) {
            this.destination = destination;
            this.labelInInteractionDialog = labelInInteractionDialog;
        }
        
        public SectorEntityToken getDestination() {
            return destination;
        }
        public void setDestination(SectorEntityToken destination) {
            this.destination = destination;
        }
        public String getLabelInInteractionDialog() {
            return labelInInteractionDialog;
        }
        public void setLabelInInteractionDialog(String labelInInteractionDialog) {
            this.labelInInteractionDialog = labelInInteractionDialog;
        }
        public float getMinDistFromToken() {
            return minDistFromToken;
        }
        public void setMinDistFromToken(float minDistFromToken) {
            this.minDistFromToken = minDistFromToken;
        }
        public float getMaxDistFromToken() {
            return maxDistFromToken;
        }
        public void setMaxDistFromToken(float maxDistFromToken) {
            this.maxDistFromToken = maxDistFromToken;
        }
    }
    
    void setRadius(float radius);
    
    void addDestination(JumpDestination destination);
    void clearDestinations();
    void removeDestination(SectorEntityToken destination);
    List<JumpDestination> getDestinations();
    
    
    void setDestinationVisual(String category, String id, SectorEntityToken entity);
    void setStandardWormholeToStarOrPlanetVisual(SectorEntityToken entity);
    void setStandardWormholeToHyperspaceVisual();
    void setStandardWormholeToStarfieldVisual();
    void setStandardWormholeToNothingVisual();
    
    boolean isAutoCreateEntranceFromHyperspace();
    
    boolean isStarAnchor();
    
    boolean isGasGiantAnchor();
    
    void setAutoCreateEntranceFromHyperspace(boolean autoCreateEntrance);
 
    SectorEntityToken getDestinationVisualEntity();
    
    
    SectorEntityToken getRelatedPlanet();
    
    void setRelatedPlanet(SectorEntityToken relatedPlanet);
    
    
    void autoUpdateHyperJumpPointLocationBasedOnInSystemEntityAtRadius(SectorEntityToken entity, float radius);
    
    
    void open();
    
    void close();
    
    void forceOpen();
    
    void forceClose();
 
    StarSystemAPI getDestinationStarSystem();
 
    boolean isWormhole();
 
 
}