WeaponAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.combat;
 
import java.util.List;
 
import java.awt.Color;
 
import org.lwjgl.util.vector.Vector2f;
 
import com.fs.starfarer.api.AnimationAPI;
import com.fs.starfarer.api.graphics.SpriteAPI;
import com.fs.starfarer.api.loading.MuzzleFlashSpec;
import com.fs.starfarer.api.loading.WeaponSlotAPI;
import com.fs.starfarer.api.loading.WeaponSpecAPI;
 
public interface WeaponAPI {
    
    public static interface DerivedWeaponStatsAPI {
        float getBurstFireDuration();
        float getSustainedDps();
        float getEmpPerSecond();
        float getDamageOver30Sec();
        float getDps();
        float getBurstDamage();
        float getFluxPerDam();
        float getRoF();
        float getFluxPerSecond();
        float getSustainedFluxPerSecond();
        float getDamagePerShot();
        float getEmpPerShot();
    }
    
    public static enum WeaponType {
        BALLISTIC("Ballistic"),
        ENERGY("Energy"),
        MISSILE("Missile"),
        LAUNCH_BAY("Launch Bay"),
        UNIVERSAL("Universal"),
        HYBRID("Hybrid"),
        SYNERGY("Synergy"),
        COMPOSITE("Composite"),
        BUILT_IN("Built in"),
        DECORATIVE("Decorative"),
        SYSTEM("System"),
        STATION_MODULE("Station Module");
        
        private String displayName;
        private WeaponType(String displayName) {
            this.displayName = displayName;
        }
        public String getDisplayName() {
            return displayName;
        }
        
    }
    
    public static enum WeaponSize {
        SMALL("Small"),
        MEDIUM("Medium"),
        LARGE("Large");
        
        private String displayName;
        private WeaponSize(String name) {
            this.displayName = name;
        }
        public String getDisplayName() {
            return displayName;
        }
    }
    
    public static enum AIHints {
        PD,
        PD_ONLY,
        PD_ALSO, // PD, but only if there are no other targets
        USE_VS_FRIGATES,
        STRIKE,
        DANGEROUS, 
        BOMB,
        GUIDED_POOR,
        DO_NOT_AIM,
        ANTI_FTR,
        HEATSEEKER,
        SYSTEM,
        SHOW_IN_CODEX,
        AUTOZOOM,
        DO_NOT_CONSERVE,
        CONSERVE_1,
        CONSERVE_2,
        CONSERVE_3,
        CONSERVE_4,
        CONSERVE_5,
        CONSERVE_ALL,
        CONSERVE_FOR_ANTI_ARMOR,
        FIRE_WHEN_INEFFICIENT,
        EXTRA_RANGE_ON_FIGHTER,
        
        IGNORES_FLARES,
        
        GROUP_LINKED,
        GROUP_ALTERNATING,
        
        MISSILE_SPREAD,
        DIRECT_AIM,
        NO_TURN_RATE_BOOST_WHEN_IDLE,
        RESET_BARREL_INDEX_ON_BURST,
        
        USE_LESS_VS_SHIELDS,
        
        RANGE_FROM_TARGETING_OVAL,
        
        RANGE_FROM_SHIP_RADIUS,
        
        IMPORTANT,
        
        NO_MANUAL_FIRE,
    }
    
    
    String getId();
    WeaponType getType();
    WeaponSize getSize();
    
    void setPD(boolean pd);
    
    float distanceFromArc(Vector2f target);
    boolean isAlwaysFire();
    
    float getCurrSpread();
    float getCurrAngle();
    float getArcFacing();
    float getArc();
    void setCurrAngle(float angle);
    
    float getRange();
    float getDisplayArcRadius();
    float getChargeLevel();
    float getTurnRate();
    float getProjectileSpeed();
    String getDisplayName();
    int getAmmo();
    int getMaxAmmo();
    void setMaxAmmo(int maxAmmo);
    void resetAmmo();
    float getCooldownRemaining();
    float getCooldown();
    void setRemainingCooldownTo(float value);
    
    boolean isBeam();
    boolean isBurstBeam();
    boolean isPulse();
    boolean requiresFullCharge();
    
    Vector2f getLocation();
    
    boolean isFiring();
    
    boolean usesAmmo();
    boolean usesEnergy();
    
    boolean hasAIHint(AIHints hint);
    CollisionClass getProjectileCollisionClass();
    
    void beginSelectionFlash();
    float getFluxCostToFire();
    
    float getMaxHealth();
    float getCurrHealth();
    boolean isDisabled();
    float getDisabledDuration();
    
    boolean isPermanentlyDisabled();
    
    DamageType getDamageType();
    
    ShipAPI getShip();
    
    DerivedWeaponStatsAPI getDerivedStats();
    
    void setAmmo(int ammo);
 
    AnimationAPI getAnimation();
    
    
    SpriteAPI getSprite();
    
    SpriteAPI getUnderSpriteAPI();
    
    SpriteAPI getBarrelSpriteAPI();
    void renderBarrel(SpriteAPI sprite, Vector2f loc, float alphaMult);
    boolean isRenderBarrelBelow();
    
    
    void disable();
    
    void disable(boolean permanent);
    
    void repair();
    
    WeaponSpecAPI getSpec();
    WeaponSlotAPI getSlot();
    
    EveryFrameWeaponEffectPlugin getEffectPlugin();
    
    List<MissileRenderDataAPI> getMissileRenderData();
    DamageAPI getDamage();
    float getProjectileFadeRange();
    boolean isDecorative();
    void ensureClonedSpec();
    float getAmmoPerSecond();
    void setPDAlso(boolean pdAlso);
    void setCurrHealth(float currHealth);
    MuzzleFlashSpec getMuzzleFlashSpec();
    List<BeamAPI> getBeams();
    Vector2f getFirePoint(int barrel);
    void setTurnRateOverride(Float turnRateOverride);
    SpriteAPI getGlowSpriteAPI();
    AmmoTrackerAPI getAmmoTracker();
    void setRefireDelay(float delay);
    void setFacing(float facing);
    void updateBeamFromPoints();
    boolean isKeepBeamTargetWhileChargingDown();
    void setKeepBeamTargetWhileChargingDown(boolean keepTargetWhileChargingDown);
    void setScaleBeamGlowBasedOnDamageEffectiveness(boolean scaleGlowBasedOnDamageEffectiveness);
    void setForceFireOneFrame(boolean forceFire);
    void setGlowAmount(float glow, Color glowColor);
    void setForceNoFireOneFrame(boolean forceNoFireOneFrame);
    void setSuspendAutomaticTurning(boolean suspendAutomaticTurning);
    float getBurstFireTimeRemaining();
    Vector2f getRenderOffsetForDecorativeBeamWeaponsOnly();
    void setRenderOffsetForDecorativeBeamWeaponsOnly(Vector2f renderOffsetForDecorativeBeamWeaponsOnly);
    float getRefireDelay();
    void forceShowBeamGlow();
    boolean isInBurst();
    WeaponSpecAPI getOriginalSpec();
    void setWeaponGlowWidthMult(float weaponGlowWidthMult);
    void setWeaponGlowHeightMult(float weaponGlowHeightMult);
    void stopFiring();
    boolean isForceDisabled();
    void setForceDisabled(boolean forceDisabled);
    Object getCustom();
    void setCustom(Object custom);
    boolean isForceNoFireOneFrame();
}