CampaignFleetAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.List;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.Script;
import com.fs.starfarer.api.campaign.CampaignEventListener.FleetDespawnReason;
import com.fs.starfarer.api.campaign.ai.CampaignFleetAIAPI;
import com.fs.starfarer.api.campaign.listeners.FleetEventListener;
import com.fs.starfarer.api.characters.MutableCharacterStatsAPI;
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.fleet.FleetLogisticsAPI;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.fleet.FleetMemberViewAPI;
import com.fs.starfarer.api.fleet.MutableFleetStatsAPI;
 
public interface CampaignFleetAPI extends SectorEntityToken, FleetOrStubAPI {
 
    boolean isInCurrentLocation();
    boolean isInHyperspace();
    
    void setLocation(float x, float y);
    
    //boolean isAlive();
    
    void despawn();
    void despawn(FleetDespawnReason reason, Object param);
    
    void addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays);
    void addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion);
    void addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText);
    void addAssignment(FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion);
    void clearAssignments();
    void setPreferredResupplyLocation(SectorEntityToken token);
    
    
    //FactionAPI getFaction();
    Vector2f getVelocity();
    
    /* (non-Javadoc)
     * Do not use to set the location, it won't work.
     * 
     * Use setLocation instead.
     * @see com.fs.starfarer.api.campaign.SectorEntityToken#getLocation()
     */
    Vector2f getLocation();
    
    FleetLogisticsAPI getLogistics();
    
    LocationAPI getContainingLocation();
    
    PersonAPI getCommander();
    MutableCharacterStatsAPI getCommanderStats();
    FleetMemberAPI getFlagship();
    boolean isPlayerFleet();
    
    FleetDataAPI getFleetData();
//  List<FleetMemberAPI> getMembersListCopy();
//  List<FleetMemberAPI> getCombatReadyMembersListCopy();
//  int getFleetPoints();
//  void addFleetMember(FleetMemberAPI member);
//  void removeFleetMember(FleetMemberAPI member);
    
    void removeFleetMemberWithDestructionFlash(FleetMemberAPI member);
    
    void setName(String name);
    float getTotalSupplyCostPerDay();
    int getNumCapitals();
    int getNumCruisers();
    int getNumDestroyers();
    int getNumFrigates();
    int getNumFighters();
    void updateCounts();
    
    float getTravelSpeed();
    
    CampaignFleetAIAPI getAI();
 
    int getFleetPoints();
 
    String getNameWithFaction();
    String getName();
    
    
    boolean isValidPlayerFleet();
 
    void setNoEngaging(float seconds);
 
    MutableFleetStatsAPI getStats();
 
    
    void setMoveDestination(float x, float y);
    
    void setMoveDestinationOverride(float x, float y);
    
    SectorEntityToken getInteractionTarget();
    
    void setInteractionTarget(SectorEntityToken target);
    
    boolean isInHyperspaceTransition();
    
    
    void setAIMode(boolean aiMode);
    boolean isAIMode();
    
    
    int getFleetSizeCount();
    
    
    void setNoFactionInName(boolean noFactionInName);
    boolean isNoFactionInName();
    void setCommander(PersonAPI commander);
    
    
    void forceSync();
    
    boolean knowsWhoPlayerIs();
    
    
    boolean isHostileTo(SectorEntityToken other);
    
    
    
    List<FleetMemberViewAPI> getViews();
    
    FleetMemberViewAPI getViewForMember(FleetMemberAPI member);
    
    
    float getCurrBurnLevel();
    
    void setVelocity(float x, float y);
    
    
    float getAcceleration();
    void setFaction(String factionId, boolean includeCaptains);
    BattleAPI getBattle();
    void setBattle(BattleAPI battle);
    
    void setAI(CampaignFleetAIAPI campaignFleetAI);
    String getNameWithFactionKeepCase();
    boolean isFriendlyTo(SectorEntityToken other);
    float getBaseSensorRangeToDetect(float sensorProfile);
    
    Boolean isDoNotAdvanceAI();
    void setDoNotAdvanceAI(Boolean doNotAdvanceAI);
    List<FleetMemberAPI> getMembersWithFightersCopy();
    
//  FleetStubAPI getStub();
//  void setStub(FleetStubAPI stub);
//  
//  boolean isConvertToStub();
//  void setConvertToStub(boolean convertToStub);
    
    void setNullAIActionText(String nullAIActionText);
    String getNullAIActionText();
    
    void setStationMode(Boolean stationMode);
    boolean isStationMode();
    Boolean wasMousedOverByPlayer();
    void setWasMousedOverByPlayer(Boolean wasMousedOverByPlayer);
    boolean isDespawning();
    Vector2f getMoveDestination();
    List<FleetEventListener> getEventListeners();
    
    FleetInflater getInflater();
    void setInflater(FleetInflater inflater);
    void inflateIfNeeded();
    void deflate();
    boolean isEmpty();
    Boolean getForceNoSensorProfileUpdate();
    void setForceNoSensorProfileUpdate(Boolean forceNoSensorProfileUpdate);
    
    boolean isInflated();
    void setInflated(Boolean inflated);
    Boolean isNoAutoDespawn();
    void setNoAutoDespawn(Boolean noAutoDespawn);
    void addAssignment(FleetAssignment assignment, SectorEntityToken target,
            float maxDurationInDays, String actionText, boolean addTimeToNext,
            Script onStart, Script onCompletion);
    
    boolean isHidden();
    void setHidden(Boolean hidden);
    Boolean getAbortDespawn();
    void setAbortDespawn(Boolean abortDespawn);
    
    
    float getEffectiveStrength();
    int getNumMembersFast();
    
    void goSlowOneFrame(boolean stop);
    boolean wasSlowMoving();
    int getNumShips();
    void updateFleetView();
    
    boolean hasShipsWithUniqueSig();
    boolean getGoSlowStop();
    void goSlowOneFrame();
    boolean getGoSlowOneFrame();
    Vector2f getVelocityFromMovementModule();
    void fadeOutIndicator();
    void fadeInIndicator();
    void forceOutIndicator();
}