MissionDefinitionAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.mission;
 
import java.awt.Color;
 
import com.fs.starfarer.api.campaign.PlanetAPI;
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.combat.BattleCreationContext;
import com.fs.starfarer.api.combat.BattleObjectiveAPI;
import com.fs.starfarer.api.combat.EveryFrameCombatPlugin;
import com.fs.starfarer.api.fleet.FleetGoal;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.fleet.FleetMemberType;
 
public interface MissionDefinitionAPI {
 
    public void initFleet(FleetSide side, String shipNamePrefix, FleetGoal goal, boolean useDefaultAI);
    
    public void initFleet(FleetSide side, String shipNamePrefix, FleetGoal goal, boolean useDefaultAI, int commandRating);
    
    
    public FleetMemberAPI addToFleet(FleetSide side, String variantId, FleetMemberType type, boolean isFlagship);
    
    
    public FleetMemberAPI addToFleet(FleetSide side, String variantId, FleetMemberType type, String shipName, boolean isFlagship);
    
    
    public void defeatOnShipLoss(String shipName);
    
    public void addBriefingItem(String item);
    
    public void setFleetTagline(FleetSide side, String tagline);
    
    public void initMap(float minX, float maxX, float minY, float maxY);
    
    public void addNebula(float x, float y, float radius);
    
    @Deprecated
    public void addObjective(float x, float y, String type, BattleObjectiveAPI.Importance importance);
    
    public void addObjective(float x, float y, String type);
    
    public void addPlanet(float x, float y, float radius, String type, float gravity);
    
    
    void addPlanet(float x, float y, float radius, String type, float gravity, boolean backgroundPlanet);
    
    
    void addPlanet(float x, float y, float radius, PlanetAPI planet, float gravity, boolean backgroundPlanet);
    
    void setPlanetBgSize(float bgWidth, float bgHeight);
    
    public void addAsteroidField(float x, float y, float angle, float width,
                                 float minSpeed, float maxSpeed, int quantity);
    
    
    public void addRingAsteroids(float x, float y, float angle, float width,
                    float minSpeed, float maxSpeed, int quantity);
 
    
    public int getFleetPointCost(String id);
 
    
    public void addPlugin(EveryFrameCombatPlugin plugin);
    public void setBackgroundSpriteName(String background);
    public void addFleetMember(FleetSide side, FleetMemberAPI member);
    
    
    void setHyperspaceMode(boolean hyperspaceMode);
 
    void setNebulaTex(String nebulaTex);
    void setNebulaMapTex(String nebulaMapTex);
 
    void setBackgroundGlowColor(Color backgroundGlowColor);
 
    void initFleet(FleetSide side, String shipNamePrefix, FleetGoal goal,
            boolean useDefaultAI, int commandRating, int allyCommandRating);
 
    BattleCreationContext getContext();
 
    PersonAPI getDefaultCommander(FleetSide side);
 
    boolean hasNebula();
}