ShipAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.combat;
 
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
 
import java.awt.Color;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.combat.ShieldAPI.ShieldType;
import com.fs.starfarer.api.combat.WeaponAPI.WeaponType;
import com.fs.starfarer.api.combat.listeners.CombatListenerManagerAPI;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.graphics.SpriteAPI;
import com.fs.starfarer.api.loading.WeaponSlotAPI;
 
public interface ShipAPI extends CombatEntityAPI {
 
    
    public static enum HullSize {
        DEFAULT, // also makes FIGHTER.ordinal() = 1, which is convenient
        FIGHTER,
        FRIGATE,
        DESTROYER,
        CRUISER,
        CAPITAL_SHIP;
        
        public HullSize smaller(boolean allowFighter) {
            if (this == FRIGATE && allowFighter) return FIGHTER;            
            if (this == DESTROYER) return FRIGATE;          
            if (this == CRUISER) return DESTROYER;          
            if (this == CAPITAL_SHIP) return CRUISER;
            return this;
        }
        
        public HullSize larger() {
            if (this == FIGHTER) return FRIGATE;            
            if (this == FRIGATE) return DESTROYER;          
            if (this == DESTROYER) return CRUISER;          
            if (this == CRUISER) return CAPITAL_SHIP;           
            return this;
        }
    }
    
    String getFleetMemberId();
    
    
    Vector2f getMouseTarget();
    
    boolean isShuttlePod();
    boolean isDrone();
    boolean isFighter();
    boolean isFrigate();
    boolean isDestroyer();
    boolean isCruiser();
    boolean isCapital();
    
    HullSize getHullSize();
 
    
    ShipAPI getShipTarget();
    void setShipTarget(ShipAPI ship);
    
    int getOriginalOwner();
    void setOriginalOwner(int originalOwner);
    void resetOriginalOwner();
    
    MutableShipStatsAPI getMutableStats();
    
    boolean isHulk();
    
    List<WeaponAPI> getAllWeapons();
    
    ShipSystemAPI getPhaseCloak();
    ShipSystemAPI getSystem();
    ShipSystemAPI getTravelDrive();
    void toggleTravelDrive();
    
    
    void setShield(ShieldType type, float shieldUpkeep, float shieldEfficiency, float arc);
    
    ShipHullSpecAPI getHullSpec();
    ShipVariantAPI getVariant();
    
    void useSystem();
    
    FluxTrackerAPI getFluxTracker();
    
    
    @Deprecated List<ShipAPI> getWingMembers();
    
    ShipAPI getWingLeader();
    
    boolean isWingLeader();
    
    FighterWingAPI getWing();
    
    List<ShipAPI> getDeployedDrones();
    ShipAPI getDroneSource();
    
    Object getWingToken();
    
    
    ArmorGridAPI getArmorGrid();
    
    void setRenderBounds(boolean renderBounds);
 
 
    void setCRAtDeployment(float cr);
    float getCRAtDeployment();
    float getCurrentCR();
    void setCurrentCR(float cr);
    
    float getWingCRAtDeployment();
 
    void setHitpoints(float value);
 
    float getTimeDeployedForCRReduction();
    
    float getFullTimeDeployed();
    
    boolean losesCRDuringCombat();
    
    boolean controlsLocked();
    
    void setControlsLocked(boolean controlsLocked);
    
    
    void setShipSystemDisabled(boolean systemDisabled);
 
    
    
    Set<WeaponAPI> getDisabledWeapons();
    
    int getNumFlameouts();
 
    float getHullLevelAtDeployment();
 
    void setSprite(String category, String key);
    
    SpriteAPI getSpriteAPI();
    
    ShipEngineControllerAPI getEngineController();
    
    
    void giveCommand(ShipCommand command, Object param, int groupNumber);
    
    void setShipAI(ShipAIPlugin ai);
    
    ShipAIPlugin getShipAI();
    
    
    void resetDefaultAI();
    
    
    void turnOnTravelDrive();
    void turnOnTravelDrive(float dur);
    void turnOffTravelDrive();
    
    boolean isRetreating();
    //void setRetreating(boolean retreating);
    
    
    void abortLanding();
    
    void beginLandingAnimation(ShipAPI target);
    
    boolean isLanding();
    
    
    boolean isFinishedLanding();
 
 
    boolean isAlive();
    
    
    boolean isInsideNebula();
    void setInsideNebula(boolean isInsideNebula);
    boolean isAffectedByNebula();
    void setAffectedByNebula(boolean affectedByNebula);
    
    float getDeployCost();
    
    void removeWeaponFromGroups(WeaponAPI weapon);
    
    
    
    void applyCriticalMalfunction(Object module);
    
    float getBaseCriticalMalfunctionDamage();
    float getEngineFractionPermanentlyDisabled();
 
 
    float getCombinedAlphaMult();
 
 
    float getLowestHullLevelReached();
 
 
    ShipwideAIFlags getAIFlags();
    List<WeaponGroupAPI> getWeaponGroupsCopy();
 
 
    boolean isHoldFire();
    boolean isHoldFireOneFrame();
    void setHoldFireOneFrame(boolean holdFireOneFrame);
    
    boolean isPhased();
 
 
    boolean isAlly();
 
 
    void setWeaponGlow(float glow, Color color, EnumSet<WeaponType> types);
    void setVentCoreColor(Color color);
    void setVentFringeColor(Color color);
    Color getVentCoreColor();
    Color getVentFringeColor();
 
 
//  void setVentCoreTexture(String textureId);
//  void setVentFringeTexture(String textureId);
//  String getVentFringeTexture();
//  String getVentCoreTexture();
    String getHullStyleId();
    WeaponGroupAPI getWeaponGroupFor(WeaponAPI weapon);
 
    void setCopyLocation(Vector2f loc, float copyAlpha, float copyFacing);
    Vector2f getCopyLocation();
    
 
    void setAlly(boolean ally);
    
    void applyCriticalMalfunction(Object module, boolean permanent);
 
 
    String getId();
 
 
    String getName();
 
 
    void setJitter(Object source, Color color, float intensity, int copies, float range);
    void setJitterUnder(Object source, Color color, float intensity, int copies, float range);
    void setJitter(Object source, Color color, float intensity, int copies, float minRange, float range);
    void setJitterUnder(Object source, Color color, float intensity, int copies, float minRange, float range);
 
 
    float getTimeDeployedUnderPlayerControl();
 
 
    SpriteAPI getSmallTurretCover();
    SpriteAPI getSmallHardpointCover();
    SpriteAPI getMediumTurretCover();
    SpriteAPI getMediumHardpointCover();
    SpriteAPI getLargeTurretCover();
    SpriteAPI getLargeHardpointCover();
 
    boolean isDefenseDisabled();
    void setDefenseDisabled(boolean defenseDisabled);
 
 
    void setPhased(boolean phased);
 
    void setExtraAlphaMult(float transparency);
    void setApplyExtraAlphaToEngines(boolean applyExtraAlphaToEngines);
 
 
    void setOverloadColor(Color color);
    void resetOverloadColor();
    Color getOverloadColor();
 
 
    boolean isRecentlyShotByPlayer();
 
 
    float getMaxSpeedWithoutBoost();
 
 
    float getHardFluxLevel();
 
 
    void fadeToColor(Object source, Color color, float durIn, float durOut, float maxShift);
 
 
    boolean isShowModuleJitterUnder();
    
    void setShowModuleJitterUnder(boolean showModuleJitterUnder);
 
 
    void addAfterimage(Color color, float locX, float locY, float velX,
            float velY, float maxJitter, float in, float dur, float out,
            boolean additive, boolean combineWithSpriteColor, boolean aboveShip);
 
 
    PersonAPI getCaptain();
 
 
    WeaponSlotAPI getStationSlot();
    void setStationSlot(WeaponSlotAPI stationSlot);
 
    ShipAPI getParentStation();
    void setParentStation(ShipAPI station);
 
 
    Vector2f getFixedLocation();
    void setFixedLocation(Vector2f fixedLocation);
 
 
    boolean hasRadarRibbonIcon();
    boolean isTargetable();
 
 
    void setStation(boolean isStation);
 
 
    boolean isSelectableInWarroom();
 
 
    //boolean isAITargetable();
 
 
    boolean isShipWithModules();
    void setShipWithModules(boolean isShipWithModules);
    List<ShipAPI> getChildModulesCopy();
 
 
    boolean isPiece();
 
 
    BoundsAPI getVisualBounds();
 
 
    Vector2f getRenderOffset();
 
 
    ShipAPI splitShip();
 
 
    int getNumFighterBays();
 
 
    boolean isPullBackFighters();
    void setPullBackFighters(boolean pullBackFighters);
 
    boolean hasLaunchBays();
    List<FighterLaunchBayAPI> getLaunchBaysCopy();
    float getFighterTimeBeforeRefit();
    void setFighterTimeBeforeRefit(float fighterTimeBeforeRefit);
 
    List<FighterWingAPI> getAllWings();
 
    float getSharedFighterReplacementRate();
    
    boolean areSignificantEnemiesInRange();
 
 
    List<WeaponAPI> getUsableWeapons();
 
 
    Vector2f getModuleOffset();
 
 
    float getMassWithModules();
 
 
    PersonAPI getOriginalCaptain();
 
    boolean isRenderEngines();
    void setRenderEngines(boolean renderEngines);
 
 
    WeaponGroupAPI getSelectedGroupAPI();
    void setHullSize(HullSize hullSize);
    void ensureClonedStationSlotSpec();
    void setMaxHitpoints(float maxArmor);
    void setDHullOverlay(String spriteName);
    boolean isStation();
    boolean isStationModule();
    boolean areAnyEnemiesInRange();
 
    void blockCommandForOneFrame(ShipCommand command);
 
    float getMaxTurnRate();
    float getTurnAcceleration();
    float getTurnDeceleration();
    float getDeceleration();
    float getAcceleration();
    float getMaxSpeed();
    float getFluxLevel();
    float getCurrFlux();
    float getMaxFlux();
    float getMinFluxLevel();
    float getMinFlux();
 
    void setLightDHullOverlay();
    void setMediumDHullOverlay();
    void setHeavyDHullOverlay();
 
 
    boolean isJitterShields();
    void setJitterShields(boolean jitterShields);
 
 
    boolean isInvalidTransferCommandTarget();
    void setInvalidTransferCommandTarget(boolean invalidTransferCommandTarget);
 
    void clearDamageDecals();
 
 
    void syncWithArmorGridState();
    void syncWeaponDecalsWithArmorDamage();
 
 
    boolean isDirectRetreat();
 
    void setRetreating(boolean retreating, boolean direct);
 
 
    boolean isLiftingOff();
 
 
    void setVariantForHullmodCheckOnly(ShipVariantAPI variant);
 
 
    Vector2f getShieldCenterEvenIfNoShield();
    float getShieldRadiusEvenIfNoShield();
 
 
    FleetMemberAPI getFleetMember();
 
 
    Vector2f getShieldTarget();
    void setShieldTargetOverride(float x, float y);
 
 
    
    CombatListenerManagerAPI getListenerManager();
    
    void addListener(Object listener);
    void removeListener(Object listener);
    void removeListenerOfClass(Class<?> c);
    boolean hasListener(Object listener);
    boolean hasListenerOfClass(Class<?> c);
    <T> List<T> getListeners(Class<T> c);
 
 
    Object getParamAboutToApplyDamage();
    void setParamAboutToApplyDamage(Object param);
 
 
    float getFluxBasedEnergyWeaponDamageMultiplier();
 
 
    void setName(String name);
 
 
    void setHulk(boolean isHulk);
 
 
    void setCaptain(PersonAPI captain);
    float getShipExplosionRadius();
 
 
    void setCircularJitter(boolean circular);
 
 
    float getExtraAlphaMult();
 
 
    void setAlphaMult(float alphaMult);
    float getAlphaMult();
 
 
    void setAnimatedLaunch();
 
 
    void setLaunchingShip(ShipAPI launchingShip);
 
 
    boolean isNonCombat(boolean considerOrders);
 
 
    float findBestArmorInArc(float facing, float arc);
    float getAverageArmorInSlice(float direction, float arc);
 
 
    void setHoldFire(boolean holdFire);
 
 
    void cloneVariant();
 
 
    void setTimeDeployed(float timeDeployed);
 
 
    void setFluxVentTextureSheet(String textureId);
    String getFluxVentTextureSheet();
 
    float getAimAccuracy();
 
 
    float getForceCarrierTargetTime();
    void setForceCarrierTargetTime(float forceCarrierTargetTime);
    float getForceCarrierPullBackTime();
    void setForceCarrierPullBackTime(float forceCarrierPullBackTime);
    ShipAPI getForceCarrierTarget();
    void setForceCarrierTarget(ShipAPI forceCarrierTarget);
 
 
    void setWing(FighterWingAPI wing);
    float getExplosionScale();
    void setExplosionScale(float explosionScale);
    Color getExplosionFlashColorOverride();
    void setExplosionFlashColorOverride(Color explosionFlashColorOverride);
    Vector2f getExplosionVelocityOverride();
    void setExplosionVelocityOverride(Vector2f explosionVelocityOverride);
 
 
    void setNextHitHullDamageThresholdMult(float threshold, float multBeyondThreshold);
 
 
    boolean isEngineBoostActive();
 
 
    void makeLookDisabled();
 
 
    void setExtraAlphaMult2(float transparency);
 
 
    float getExtraAlphaMult2();
 
 
    void setDrone(boolean isDrone);
 
 
    CombatEngineLayers getLayer();
    void setLayer(CombatEngineLayers layer);
 
 
    boolean isForceHideFFOverlay();
    void setForceHideFFOverlay(boolean forceHideFFOverlay);
 
 
    Set<String> getTags();
    void addTag(String tag);
    boolean hasTag(String tag);
 
 
    void setSprite(SpriteAPI sprite);
 
 
    float getPeakTimeRemaining();
 
    EnumSet<CombatEngineLayers> getActiveLayers();
 
 
    boolean isShipSystemDisabled();
 
 
    boolean isDoNotFlareEnginesWhenStrafingOrDecelerating();
    void setDoNotFlareEnginesWhenStrafingOrDecelerating(boolean doNotFlare);
 
 
    PersonAPI getFleetCommander();
 
 
    boolean isDoNotRender();
    void setDoNotRender(boolean doNotRender);
    float getHulkChanceOverride();
    void setHulkChanceOverride(float hulkChanceOverride);
    float getImpactVolumeMult();
    void setImpactVolumeMult(float impactVolumeMult);
 
 
    Vector2f checkCollisionVsRay(Vector2f from, Vector2f to);
 
 
    boolean isPointInBounds(Vector2f p);
 
 
    boolean isSpawnDebris();
    void setSpawnDebris(boolean spawnDebris);
 
    float getDHullOverlayAngleOffset();
    void setDHullOverlayAngleOffset(float dHullOverlayAngleOffset);
 
    float getExtraOverlayAngleOffset();
    void setExtraOverlayAngleOffset(float extraOverlayAngleOffset);
    void setExtraOverlay(String spriteName);
    float getExtraOverlayShadowOpacity();
    void setExtraOverlayShadowOpacity(float extraOverlayOpacity);
    boolean isExtraOverlayMatchHullColor();
    void setExtraOverlayMatchHullColor(boolean extraOverlayMatchHullColor);
 
 
    void resetSelectedGroup();
    void removeTag(String tag);
 
 
    boolean isSkipNextDamagedExplosion();
    void setSkipNextDamagedExplosion(boolean skipNextDamagedExplosion);
    void setDefaultAI(FleetMemberAPI member);
    boolean isNoDamagedExplosions();
    void setNoDamagedExplosions(boolean noDamagedExplosions);
 
    boolean isDoNotRenderSprite();
    void setDoNotRenderSprite(boolean doNotRenderSprite);
    boolean isDoNotRenderShield();
    void setDoNotRenderShield(boolean doNotRenderShield);
    boolean isDoNotRenderWeapons();
    void setDoNotRenderWeapons(boolean doNotRenderWeapons);
    void setDoNotRenderVentingAnimation(boolean doNotRenderVentingAnimation);
    boolean isDoNotRenderVentingAnimation();
    String getShipCollisionSoundOverride();
    void setShipCollisionSoundOverride(String shipCollisionSoundOverride);
    String getAsteroidCollisionSoundOverride();
    void setAsteroidCollisionSoundOverride(String asteroidCollisionSoundOverride);
    
    String getParentPieceId();
    void setParentPieceId(String parentPieceId);
 
 
    void applyEffectsAfterShipAddedToCombatEngine();
 
 
    float getSinceLastDamageTaken();
 
    boolean isNoMuzzleFlash();
    void setNoMuzzleFlash(boolean noMuzzleFlash);
 
 
    boolean isBeingIgnored();
    
    void setBeingIgnored(boolean beingIgnored);
 
 
    void setLowestHullLevelReached(float lowestHullLevelReached);
 
 
    void setFleetMember(FleetMemberAPI member);
}