ShipAPI (Starfarer API)

All Superinterfaces:

CombatEntityAPI
```
public interface ShipAPI
extends CombatEntityAPI
```
Author:

Alex Mosolov Copyright 2012 Fractal Softworks, LLC

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ShipAPI.HullSize

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ShipAPI.HullSize`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abortLanding()` Call this if beginLandingAnimation() was already called, but the ship being landed on was destroyed before FighterLaunchBayAPI.land() is called.
`void`	`addAfterimage(java.awt.Color color, float locX, float locY, float velX, float velY, float maxJitter, float in, float dur, float out, boolean additive, boolean combineWithSpriteColor, boolean aboveShip)` Location is relative to center of ship.
`void`	`addListener(java.lang.Object listener)`
`void`	`addTag(java.lang.String tag)`
`void`	`applyCriticalMalfunction(java.lang.Object module)`
`void`	`applyCriticalMalfunction(java.lang.Object module, boolean permanent)`
`boolean`	`areAnyEnemiesInRange()`
`boolean`	`areSignificantEnemiesInRange()`
`void`	`beginLandingAnimation(ShipAPI target)` The fighter will become invulnerable and gradually get smaller/fade out.
`void`	`blockCommandForOneFrame(ShipCommand command)`
`void`	`clearDamageDecals()`
`void`	`cloneVariant()`
`boolean`	`controlsLocked()` If controls are locked due to crash (or regular) mothballing; only applicable in "ESCAPE" battles.
`void`	`ensureClonedStationSlotSpec()`
`void`	`fadeToColor(java.lang.Object source, java.awt.Color color, float durIn, float durOut, float maxShift)`
`float`	`findBestArmorInArc(float facing, float arc)`
`float`	`getAcceleration()`
`java.util.EnumSet<CombatEngineLayers>`	`getActiveLayers()`
`ShipwideAIFlags`	`getAIFlags()` Null if the ship is not AI-controlled.
`float`	`getAimAccuracy()`
`java.util.List<WeaponAPI>`	`getAllWeapons()`
`java.util.List<FighterWingAPI>`	`getAllWings()`
`float`	`getAlphaMult()`
`ArmorGridAPI`	`getArmorGrid()`
`float`	`getAverageArmorInSlice(float direction, float arc)`
`float`	`getBaseCriticalMalfunctionDamage()`
`PersonAPI`	`getCaptain()`
`java.util.List<ShipAPI>`	`getChildModulesCopy()`
`float`	`getCombinedAlphaMult()` Alpha the base ship should be rendered at.
`Vector2f`	`getCopyLocation()`
`float`	`getCRAtDeployment()`
`float`	`getCurrentCR()`
`float`	`getCurrFlux()`
`float`	`getDeceleration()`
`float`	`getDeployCost()` CR cost to deploy, range is [0, 1].
`java.util.List<ShipAPI>`	`getDeployedDrones()`
`java.util.Set<WeaponAPI>`	`getDisabledWeapons()` All weapons ever disabled during the last battle.
`ShipAPI`	`getDroneSource()`
`ShipEngineControllerAPI`	`getEngineController()`
`float`	`getEngineFractionPermanentlyDisabled()`
`java.awt.Color`	`getExplosionFlashColorOverride()`
`float`	`getExplosionScale()`
`Vector2f`	`getExplosionVelocityOverride()`
`float`	`getExtraAlphaMult()`
`float`	`getExtraAlphaMult2()`
`float`	`getFighterTimeBeforeRefit()`
`Vector2f`	`getFixedLocation()`
`PersonAPI`	`getFleetCommander()`
`FleetMemberAPI`	`getFleetMember()`
`java.lang.String`	`getFleetMemberId()` ID of FleetMemberAPI this Ship corresponds to.
`float`	`getFluxBasedEnergyWeaponDamageMultiplier()`
`float`	`getFluxLevel()`
`FluxTrackerAPI`	`getFluxTracker()`
`java.lang.String`	`getFluxVentTextureSheet()`
`float`	`getForceCarrierPullBackTime()`
`ShipAPI`	`getForceCarrierTarget()`
`float`	`getForceCarrierTargetTime()`
`float`	`getFullTimeDeployed()`
`float`	`getHardFluxLevel()`
`float`	`getHullLevelAtDeployment()`
`ShipAPI.HullSize`	`getHullSize()`
`ShipHullSpecAPI`	`getHullSpec()`
`java.lang.String`	`getHullStyleId()`
`java.lang.String`	`getId()`
`SpriteAPI`	`getLargeHardpointCover()`
`SpriteAPI`	`getLargeTurretCover()`
`java.util.List<FighterLaunchBayAPI>`	`getLaunchBaysCopy()`
`CombatEngineLayers`	`getLayer()`
`CombatListenerManagerAPI`	`getListenerManager()` Will be null if no listeners added.
`<T> java.util.List<T>`	`getListeners(java.lang.Class<T> c)`
`float`	`getLowestHullLevelReached()`
`float`	`getMassWithModules()`
`float`	`getMaxFlux()`
`float`	`getMaxSpeed()`
`float`	`getMaxSpeedWithoutBoost()`
`float`	`getMaxTurnRate()`
`SpriteAPI`	`getMediumHardpointCover()`
`SpriteAPI`	`getMediumTurretCover()`
`float`	`getMinFlux()`
`float`	`getMinFluxLevel()`
`Vector2f`	`getModuleOffset()`
`Vector2f`	`getMouseTarget()`
`MutableShipStatsAPI`	`getMutableStats()`
`java.lang.String`	`getName()`
`int`	`getNumFighterBays()`
`int`	`getNumFlameouts()` Number of times a full engine flameout occurred during the last battle.
`PersonAPI`	`getOriginalCaptain()`
`int`	`getOriginalOwner()`
`java.awt.Color`	`getOverloadColor()`
`java.lang.Object`	`getParamAboutToApplyDamage()`
`ShipAPI`	`getParentStation()`
`float`	`getPeakTimeRemaining()`
`ShipSystemAPI`	`getPhaseCloak()`
`Vector2f`	`getRenderOffset()` Rendering offset for weapons and such, due to ship center changes on a ship piece.
`WeaponGroupAPI`	`getSelectedGroupAPI()`
`float`	`getSharedFighterReplacementRate()`
`Vector2f`	`getShieldCenterEvenIfNoShield()`
`float`	`getShieldRadiusEvenIfNoShield()`
`Vector2f`	`getShieldTarget()`
`ShipAIPlugin`	`getShipAI()` Does NOT return the same ai passed in to setShipAI(), but a wrapper around it.
`float`	`getShipExplosionRadius()`
`ShipAPI`	`getShipTarget()`
`SpriteAPI`	`getSmallHardpointCover()`
`SpriteAPI`	`getSmallTurretCover()`
`SpriteAPI`	`getSpriteAPI()` A wrapper around the internal implementation of a sprite.
`WeaponSlotAPI`	`getStationSlot()`
`ShipSystemAPI`	`getSystem()`
`java.util.Set<java.lang.String>`	`getTags()`
`float`	`getTimeDeployedForCRReduction()`
`float`	`getTimeDeployedUnderPlayerControl()`
`ShipSystemAPI`	`getTravelDrive()`
`float`	`getTurnAcceleration()`
`float`	`getTurnDeceleration()`
`java.util.List<WeaponAPI>`	`getUsableWeapons()`
`ShipVariantAPI`	`getVariant()`
`java.awt.Color`	`getVentCoreColor()`
`java.awt.Color`	`getVentFringeColor()`
`BoundsAPI`	`getVisualBounds()` Visual clipping bounds for pieces of ships.
`WeaponGroupAPI`	`getWeaponGroupFor(WeaponAPI weapon)`
`java.util.List<WeaponGroupAPI>`	`getWeaponGroupsCopy()`
`FighterWingAPI`	`getWing()`
`float`	`getWingCRAtDeployment()`
`ShipAPI`	`getWingLeader()` Use getWing().getLeader() instead.
`java.util.List<ShipAPI>`	`getWingMembers()` Deprecated.
`java.lang.Object`	`getWingToken()` Useful for determining whether fighters are part of the same wing.
`void`	`giveCommand(ShipCommand command, java.lang.Object param, int groupNumber)` Should only be used by a ShipAIPlugin.
`boolean`	`hasLaunchBays()`
`boolean`	`hasListener(java.lang.Object listener)`
`boolean`	`hasListenerOfClass(java.lang.Class<?> c)`
`boolean`	`hasRadarRibbonIcon()`
`boolean`	`hasTag(java.lang.String tag)`
`boolean`	`isAffectedByNebula()`
`boolean`	`isAlive()`
`boolean`	`isAlly()`
`boolean`	`isCapital()`
`boolean`	`isCruiser()`
`boolean`	`isDefenseDisabled()`
`boolean`	`isDestroyer()`
`boolean`	`isDirectRetreat()`
`boolean`	`isDoNotFlareEnginesWhenStrafingOrDecelerating()`
`boolean`	`isDrone()`
`boolean`	`isEngineBoostActive()`
`boolean`	`isFighter()`
`boolean`	`isFinishedLanding()`
`boolean`	`isForceHideFFOverlay()`
`boolean`	`isFrigate()`
`boolean`	`isHoldFire()`
`boolean`	`isHoldFireOneFrame()`
`boolean`	`isHulk()`
`boolean`	`isInsideNebula()`
`boolean`	`isInvalidTransferCommandTarget()`
`boolean`	`isJitterShields()`
`boolean`	`isLanding()`
`boolean`	`isLiftingOff()`
`boolean`	`isNonCombat(boolean considerOrders)`
`boolean`	`isPhased()`
`boolean`	`isPiece()`
`boolean`	`isPullBackFighters()`
`boolean`	`isRecentlyShotByPlayer()`
`boolean`	`isRenderEngines()`
`boolean`	`isRetreating()`
`boolean`	`isSelectableInWarroom()`
`boolean`	`isShipSystemDisabled()`
`boolean`	`isShipWithModules()`
`boolean`	`isShowModuleJitterUnder()`
`boolean`	`isShuttlePod()`
`boolean`	`isStation()`
`boolean`	`isStationModule()`
`boolean`	`isTargetable()`
`boolean`	`isWingLeader()`
`boolean`	`losesCRDuringCombat()`
`void`	`makeLookDisabled()`
`void`	`removeListener(java.lang.Object listener)`
`void`	`removeListenerOfClass(java.lang.Class<?> c)`
`void`	`removeWeaponFromGroups(WeaponAPI weapon)` Removes weapon from any groups it's in.
`void`	`resetDefaultAI()` Sets the ship's AI to the core implementation.
`void`	`resetOriginalOwner()`
`void`	`resetOverloadColor()`
`void`	`setAffectedByNebula(boolean affectedByNebula)`
`void`	`setAlly(boolean ally)`
`void`	`setAlphaMult(float alphaMult)`
`void`	`setAnimatedLaunch()`
`void`	`setApplyExtraAlphaToEngines(boolean applyExtraAlphaToEngines)`
`void`	`setCaptain(PersonAPI captain)`
`void`	`setCircularJitter(boolean circular)`
`void`	`setControlsLocked(boolean controlsLocked)`
`void`	`setCopyLocation(Vector2f loc, float copyAlpha, float copyFacing)`
`void`	`setCRAtDeployment(float cr)`
`void`	`setCurrentCR(float cr)`
`void`	`setDefenseDisabled(boolean defenseDisabled)`
`void`	`setDHullOverlay(java.lang.String spriteName)`
`void`	`setDoNotFlareEnginesWhenStrafingOrDecelerating(boolean doNotFlare)`
`void`	`setDrone(boolean isDrone)`
`void`	`setExplosionFlashColorOverride(java.awt.Color explosionFlashColorOverride)`
`void`	`setExplosionScale(float explosionScale)`
`void`	`setExplosionVelocityOverride(Vector2f explosionVelocityOverride)`
`void`	`setExtraAlphaMult(float transparency)`
`void`	`setExtraAlphaMult2(float transparency)`
`void`	`setFighterTimeBeforeRefit(float fighterTimeBeforeRefit)`
`void`	`setFixedLocation(Vector2f fixedLocation)`
`void`	`setFluxVentTextureSheet(java.lang.String textureId)`
`void`	`setForceCarrierPullBackTime(float forceCarrierPullBackTime)`
`void`	`setForceCarrierTarget(ShipAPI forceCarrierTarget)`
`void`	`setForceCarrierTargetTime(float forceCarrierTargetTime)`
`void`	`setForceHideFFOverlay(boolean forceHideFFOverlay)`
`void`	`setHeavyDHullOverlay()`
`void`	`setHitpoints(float value)`
`void`	`setHoldFire(boolean holdFire)`
`void`	`setHoldFireOneFrame(boolean holdFireOneFrame)`
`void`	`setHulk(boolean isHulk)`
`void`	`setHullSize(ShipAPI.HullSize hullSize)`
`void`	`setInsideNebula(boolean isInsideNebula)`
`void`	`setInvalidTransferCommandTarget(boolean invalidTransferCommandTarget)`
`void`	`setJitter(java.lang.Object source, java.awt.Color color, float intensity, int copies, float range)`
`void`	`setJitter(java.lang.Object source, java.awt.Color color, float intensity, int copies, float minRange, float range)`
`void`	`setJitterShields(boolean jitterShields)`
`void`	`setJitterUnder(java.lang.Object source, java.awt.Color color, float intensity, int copies, float range)`
`void`	`setJitterUnder(java.lang.Object source, java.awt.Color color, float intensity, int copies, float minRange, float range)`
`void`	`setLaunchingShip(ShipAPI launchingShip)`
`void`	`setLayer(CombatEngineLayers layer)`
`void`	`setLightDHullOverlay()`
`void`	`setMaxHitpoints(float maxArmor)`
`void`	`setMediumDHullOverlay()`
`void`	`setName(java.lang.String name)`
`void`	`setNextHitHullDamageThresholdMult(float threshold, float multBeyondThreshold)`
`void`	`setOriginalOwner(int originalOwner)`
`void`	`setOverloadColor(java.awt.Color color)`
`void`	`setParamAboutToApplyDamage(java.lang.Object param)`
`void`	`setParentStation(ShipAPI station)`
`void`	`setPhased(boolean phased)`
`void`	`setPullBackFighters(boolean pullBackFighters)`
`void`	`setRenderBounds(boolean renderBounds)`
`void`	`setRenderEngines(boolean renderEngines)`
`void`	`setRetreating(boolean retreating, boolean direct)`
`void`	`setShield(ShieldAPI.ShieldType type, float shieldUpkeep, float shieldEfficiency, float arc)`
`void`	`setShieldTargetOverride(float x, float y)`
`void`	`setShipAI(ShipAIPlugin ai)` Only should be called if the AI needs to be changed dynamically.
`void`	`setShipSystemDisabled(boolean systemDisabled)`
`void`	`setShipTarget(ShipAPI ship)`
`void`	`setShipWithModules(boolean isShipWithModules)`
`void`	`setShowModuleJitterUnder(boolean showModuleJitterUnder)` False by default.
`void`	`setSprite(SpriteAPI sprite)`
`void`	`setSprite(java.lang.String category, java.lang.String key)` Note: If also changing bounds, make sure they are still within the armor grid of the ship, which is determined by the original sprite.
`void`	`setStation(boolean isStation)`
`void`	`setStationSlot(WeaponSlotAPI stationSlot)`
`void`	`setTimeDeployed(float timeDeployed)`
`void`	`setVariantForHullmodCheckOnly(ShipVariantAPI variant)`
`void`	`setVentCoreColor(java.awt.Color color)`
`void`	`setVentFringeColor(java.awt.Color color)`
`void`	`setWeaponGlow(float glow, java.awt.Color color, java.util.EnumSet<WeaponAPI.WeaponType> types)`
`void`	`setWing(FighterWingAPI wing)`
`ShipAPI`	`splitShip()` Should be called on a ship that's already a hulk.
`void`	`syncWeaponDecalsWithArmorDamage()`
`void`	`syncWithArmorGridState()`
`void`	`toggleTravelDrive()`
`void`	`turnOffTravelDrive()`
`void`	`turnOnTravelDrive()`
`void`	`turnOnTravelDrive(float dur)`
`void`	`useSystem()` The ship will try to use its system next frame.

Methods inherited from interface com.fs.starfarer.api.combat.CombatEntityAPI
getAI, getAngularVelocity, getCollisionClass, getCollisionRadius, getCustomData, getExactBounds, getFacing, getHitpoints, getHullLevel, getLocation, getMass, getMaxHitpoints, getOwner, getShield, getVelocity, isExpired, removeCustomData, setAngularVelocity, setCollisionClass, setCollisionRadius, setCustomData, setFacing, setMass, setOwner

Method Detail

getFleetMemberId
```
java.lang.String getFleetMemberId()
```
ID of FleetMemberAPI this Ship corresponds to. Can be null if there isn't one.

Returns:

getMouseTarget
```
Vector2f getMouseTarget()
```
Returns:
Where the ship is aiming with the mouse pointer, in engine coordinates. Works for AI controlled ships too.

isShuttlePod
```
boolean isShuttlePod()
```

isDrone
```
boolean isDrone()
```

isFighter
```
boolean isFighter()
```

isFrigate
```
boolean isFrigate()
```

isDestroyer
```
boolean isDestroyer()
```

isCruiser
```
boolean isCruiser()
```

isCapital
```
boolean isCapital()
```

getHullSize
```
ShipAPI.HullSize getHullSize()
```

getShipTarget
```
ShipAPI getShipTarget()
```

setShipTarget
```
void setShipTarget(ShipAPI ship)
```

getOriginalOwner
```
int getOriginalOwner()
```
Returns:
0 or 1, never 100 (neutral).

setOriginalOwner

void setOriginalOwner(int originalOwner)

resetOriginalOwner
```
void resetOriginalOwner()
```

getMutableStats
```
MutableShipStatsAPI getMutableStats()
```

isHulk
```
boolean isHulk()
```

getAllWeapons

java.util.List<WeaponAPI> getAllWeapons()

getPhaseCloak
```
ShipSystemAPI getPhaseCloak()
```

getSystem
```
ShipSystemAPI getSystem()
```

getTravelDrive
```
ShipSystemAPI getTravelDrive()
```

toggleTravelDrive
```
void toggleTravelDrive()
```

setShield

void setShield(ShieldAPI.ShieldType type,
             float shieldUpkeep,
             float shieldEfficiency,
             float arc)

getHullSpec
```
ShipHullSpecAPI getHullSpec()
```

getVariant
```
ShipVariantAPI getVariant()
```

useSystem
```
void useSystem()
```
The ship will try to use its system next frame. Equivalent to the player pressing the "use system" button while controlling a ship. So, it may fail for various reasons - out of ammo, not enough flux, overloaded, etc.

getFluxTracker
```
FluxTrackerAPI getFluxTracker()
```

getWingMembers
```
@Deprecated
java.util.List<ShipAPI> getWingMembers()
```
Deprecated.

Use getWing().getWingMembers() instead.

Returns:
null, or list of fighter wing members.

getWingLeader
```
ShipAPI getWingLeader()
```
Use getWing().getLeader() instead.

Returns:

isWingLeader
```
boolean isWingLeader()
```

getWing
```
FighterWingAPI getWing()
```

getDeployedDrones

java.util.List<ShipAPI> getDeployedDrones()

getDroneSource
```
ShipAPI getDroneSource()
```

getWingToken
```
java.lang.Object getWingToken()
```
Useful for determining whether fighters are part of the same wing.

Returns:

getArmorGrid
```
ArmorGridAPI getArmorGrid()
```

setRenderBounds

void setRenderBounds(boolean renderBounds)

setCRAtDeployment
```
void setCRAtDeployment(float cr)
```

getCRAtDeployment
```
float getCRAtDeployment()
```

getCurrentCR
```
float getCurrentCR()
```

setCurrentCR
```
void setCurrentCR(float cr)
```

getWingCRAtDeployment
```
float getWingCRAtDeployment()
```

setHitpoints
```
void setHitpoints(float value)
```
Specified by:

setHitpoints in interface CombatEntityAPI

getTimeDeployedForCRReduction
```
float getTimeDeployedForCRReduction()
```
Returns:
the time that counts for peak CR reduction purposes, not necessarily the full time.

getFullTimeDeployed
```
float getFullTimeDeployed()
```

losesCRDuringCombat
```
boolean losesCRDuringCombat()
```

controlsLocked
```
boolean controlsLocked()
```
If controls are locked due to crash (or regular) mothballing; only applicable in "ESCAPE" battles.

Returns:

setControlsLocked

void setControlsLocked(boolean controlsLocked)

setShipSystemDisabled

void setShipSystemDisabled(boolean systemDisabled)

getDisabledWeapons
```
java.util.Set<WeaponAPI> getDisabledWeapons()
```
All weapons ever disabled during the last battle.

Returns:

getNumFlameouts
```
int getNumFlameouts()
```
Number of times a full engine flameout occurred during the last battle.

Returns:

getHullLevelAtDeployment
```
float getHullLevelAtDeployment()
```

setSprite
```
void setSprite(java.lang.String category,
             java.lang.String key)
```
Note: If also changing bounds, make sure they are still within the armor grid of the ship, which is determined by the original sprite.

Parameters:
category - under "graphics" in settings.json
key - id under category.

getSpriteAPI
```
SpriteAPI getSpriteAPI()
```
A wrapper around the internal implementation of a sprite. Creates a new wrapper with every call, should store the return value and reuse it when possible instead of calling this method every time.

Returns:

getEngineController

ShipEngineControllerAPI getEngineController()

giveCommand
```
void giveCommand(ShipCommand command,
               java.lang.Object param,
               int groupNumber)
```
Should only be used by a ShipAIPlugin.

Parameters:
command - type of the command.
param - Generally a Vector2f with a "mouse" location. See ShipCommand.java for details.
groupNumber - Only used for weapon-group-related commands.

setShipAI
```
void setShipAI(ShipAIPlugin ai)
```
Only should be called if the AI needs to be changed dynamically. Otherwise, use ModPlugin.pickShipAI() instead.

Parameters:
ai -

getShipAI
```
ShipAIPlugin getShipAI()
```
Does NOT return the same ai passed in to setShipAI(), but a wrapper around it. Can be used to save/restore the AI.

Returns:

resetDefaultAI
```
void resetDefaultAI()
```
Sets the ship's AI to the core implementation.

turnOnTravelDrive
```
void turnOnTravelDrive()
```

turnOnTravelDrive
```
void turnOnTravelDrive(float dur)
```

turnOffTravelDrive
```
void turnOffTravelDrive()
```

isRetreating
```
boolean isRetreating()
```

abortLanding
```
void abortLanding()
```
Call this if beginLandingAnimation() was already called, but the ship being landed on was destroyed before FighterLaunchBayAPI.land() is called. Will cause the fighter to reverse its landing animation and take off.

beginLandingAnimation
```
void beginLandingAnimation(ShipAPI target)
```
The fighter will become invulnerable and gradually get smaller/fade out. Purely visual. If nothing else is done, it will remain this way, so FighterLaunchBayAPI.land() should be called to remove it from the engine when the landing animation is complete.

Parameters:
target - Used to determine what ship the fighter's shadow is cast on.

isLanding
```
boolean isLanding()
```
Returns:
whether the landing animation has been kicked off (i.e. beginLandingAnimation() was called, and abortLanding() was not)

isFinishedLanding
```
boolean isFinishedLanding()
```
Returns:
whether the landing animation is finished.

isAlive
```
boolean isAlive()
```
Returns:
true if the ship is still in play, including fighters that are currently landed in a launch bay.

isInsideNebula
```
boolean isInsideNebula()
```

setInsideNebula

void setInsideNebula(boolean isInsideNebula)

isAffectedByNebula
```
boolean isAffectedByNebula()
```

setAffectedByNebula

void setAffectedByNebula(boolean affectedByNebula)

getDeployCost
```
float getDeployCost()
```
CR cost to deploy, range is [0, 1]. For fighters returns cost for entire wing.

Returns:

removeWeaponFromGroups
```
void removeWeaponFromGroups(WeaponAPI weapon)
```
Removes weapon from any groups it's in. Should be used in conjunction with permanently disabling the weapon.

Parameters:
weapon -

applyCriticalMalfunction
```
void applyCriticalMalfunction(java.lang.Object module)
```
Parameters:
module - WeaponAPI or ShipEngineAPI.

getBaseCriticalMalfunctionDamage

float getBaseCriticalMalfunctionDamage()

getEngineFractionPermanentlyDisabled

float getEngineFractionPermanentlyDisabled()

getCombinedAlphaMult
```
float getCombinedAlphaMult()
```
Alpha the base ship should be rendered at. Includes alpha modifier from ship systems and from fighters taking off/landing.

Returns:

getLowestHullLevelReached
```
float getLowestHullLevelReached()
```

getAIFlags
```
ShipwideAIFlags getAIFlags()
```
Null if the ship is not AI-controlled.

Returns:

getWeaponGroupsCopy

java.util.List<WeaponGroupAPI> getWeaponGroupsCopy()

isHoldFire
```
boolean isHoldFire()
```

isHoldFireOneFrame
```
boolean isHoldFireOneFrame()
```

setHoldFireOneFrame

void setHoldFireOneFrame(boolean holdFireOneFrame)

isPhased
```
boolean isPhased()
```

isAlly
```
boolean isAlly()
```

setWeaponGlow

void setWeaponGlow(float glow,
                 java.awt.Color color,
                 java.util.EnumSet<WeaponAPI.WeaponType> types)

setVentCoreColor

void setVentCoreColor(java.awt.Color color)

setVentFringeColor

void setVentFringeColor(java.awt.Color color)

getVentCoreColor
```
java.awt.Color getVentCoreColor()
```

getVentFringeColor
```
java.awt.Color getVentFringeColor()
```

getHullStyleId
```
java.lang.String getHullStyleId()
```

getWeaponGroupFor

WeaponGroupAPI getWeaponGroupFor(WeaponAPI weapon)

setCopyLocation

void setCopyLocation(Vector2f loc,
                   float copyAlpha,
                   float copyFacing)

getCopyLocation
```
Vector2f getCopyLocation()
```

setAlly
```
void setAlly(boolean ally)
```

applyCriticalMalfunction

void applyCriticalMalfunction(java.lang.Object module,
                            boolean permanent)

getId
```
java.lang.String getId()
```

getName
```
java.lang.String getName()
```

setJitter

void setJitter(java.lang.Object source,
             java.awt.Color color,
             float intensity,
             int copies,
             float range)

setJitterUnder

void setJitterUnder(java.lang.Object source,
                  java.awt.Color color,
                  float intensity,
                  int copies,
                  float range)

setJitter

void setJitter(java.lang.Object source,
             java.awt.Color color,
             float intensity,
             int copies,
             float minRange,
             float range)

setJitterUnder

void setJitterUnder(java.lang.Object source,
                  java.awt.Color color,
                  float intensity,
                  int copies,
                  float minRange,
                  float range)

getTimeDeployedUnderPlayerControl

float getTimeDeployedUnderPlayerControl()

getSmallTurretCover
```
SpriteAPI getSmallTurretCover()
```

getSmallHardpointCover
```
SpriteAPI getSmallHardpointCover()
```

getMediumTurretCover
```
SpriteAPI getMediumTurretCover()
```

getMediumHardpointCover
```
SpriteAPI getMediumHardpointCover()
```

getLargeTurretCover
```
SpriteAPI getLargeTurretCover()
```

getLargeHardpointCover
```
SpriteAPI getLargeHardpointCover()
```

isDefenseDisabled
```
boolean isDefenseDisabled()
```

setDefenseDisabled

void setDefenseDisabled(boolean defenseDisabled)

setPhased
```
void setPhased(boolean phased)
```

setExtraAlphaMult

void setExtraAlphaMult(float transparency)

setApplyExtraAlphaToEngines

void setApplyExtraAlphaToEngines(boolean applyExtraAlphaToEngines)

setOverloadColor

void setOverloadColor(java.awt.Color color)

resetOverloadColor
```
void resetOverloadColor()
```

getOverloadColor
```
java.awt.Color getOverloadColor()
```

isRecentlyShotByPlayer
```
boolean isRecentlyShotByPlayer()
```

getMaxSpeedWithoutBoost
```
float getMaxSpeedWithoutBoost()
```

getHardFluxLevel
```
float getHardFluxLevel()
```

fadeToColor

void fadeToColor(java.lang.Object source,
               java.awt.Color color,
               float durIn,
               float durOut,
               float maxShift)

isShowModuleJitterUnder
```
boolean isShowModuleJitterUnder()
```

setShowModuleJitterUnder
```
void setShowModuleJitterUnder(boolean showModuleJitterUnder)
```
False by default. May need to set to true for ships with large decorative weapons etc.

Parameters:
showModuleJitterUnder -

addAfterimage

void addAfterimage(java.awt.Color color,
                 float locX,
                 float locY,
                 float velX,
                 float velY,
                 float maxJitter,
                 float in,
                 float dur,
                 float out,
                 boolean additive,
                 boolean combineWithSpriteColor,
                 boolean aboveShip)

Location is relative to center of ship.

Parameters:: color -; locX -; locY -; velX -; velY -; maxJitter -; in -; dur -; out -; additive -; combineWithSpriteColor -; aboveShip -

getCaptain
```
PersonAPI getCaptain()
```

getStationSlot
```
WeaponSlotAPI getStationSlot()
```

setStationSlot

void setStationSlot(WeaponSlotAPI stationSlot)

getParentStation
```
ShipAPI getParentStation()
```

setParentStation

void setParentStation(ShipAPI station)

getFixedLocation
```
Vector2f getFixedLocation()
```

setFixedLocation

void setFixedLocation(Vector2f fixedLocation)

hasRadarRibbonIcon
```
boolean hasRadarRibbonIcon()
```

isTargetable
```
boolean isTargetable()
```

setStation
```
void setStation(boolean isStation)
```

isSelectableInWarroom
```
boolean isSelectableInWarroom()
```

isShipWithModules
```
boolean isShipWithModules()
```

setShipWithModules

void setShipWithModules(boolean isShipWithModules)

getChildModulesCopy

java.util.List<ShipAPI> getChildModulesCopy()

isPiece
```
boolean isPiece()
```

getVisualBounds
```
BoundsAPI getVisualBounds()
```
Visual clipping bounds for pieces of ships. Returns null for intact ships.

Returns:

getRenderOffset
```
Vector2f getRenderOffset()
```
Rendering offset for weapons and such, due to ship center changes on a ship piece. (0, 0) for an intact ship.

Returns:

splitShip
```
ShipAPI splitShip()
```
Should be called on a ship that's already a hulk. Will return the smaller of the two pieces (the current ship becomes the larger piece), or null if it did not find a way to split the ship. Calling the method again in this case may result in a valid split being found.

Returns:

getNumFighterBays
```
int getNumFighterBays()
```

isPullBackFighters
```
boolean isPullBackFighters()
```

setPullBackFighters

void setPullBackFighters(boolean pullBackFighters)

hasLaunchBays
```
boolean hasLaunchBays()
```

getLaunchBaysCopy

java.util.List<FighterLaunchBayAPI> getLaunchBaysCopy()

getFighterTimeBeforeRefit
```
float getFighterTimeBeforeRefit()
```

setFighterTimeBeforeRefit

void setFighterTimeBeforeRefit(float fighterTimeBeforeRefit)

getAllWings

java.util.List<FighterWingAPI> getAllWings()

getSharedFighterReplacementRate

float getSharedFighterReplacementRate()

areSignificantEnemiesInRange
```
boolean areSignificantEnemiesInRange()
```

getUsableWeapons

java.util.List<WeaponAPI> getUsableWeapons()

getModuleOffset
```
Vector2f getModuleOffset()
```

getMassWithModules
```
float getMassWithModules()
```

getOriginalCaptain
```
PersonAPI getOriginalCaptain()
```

isRenderEngines
```
boolean isRenderEngines()
```

setRenderEngines

void setRenderEngines(boolean renderEngines)

getSelectedGroupAPI
```
WeaponGroupAPI getSelectedGroupAPI()
```

setHullSize

void setHullSize(ShipAPI.HullSize hullSize)

ensureClonedStationSlotSpec
```
void ensureClonedStationSlotSpec()
```

setMaxHitpoints
```
void setMaxHitpoints(float maxArmor)
```

setDHullOverlay

void setDHullOverlay(java.lang.String spriteName)

isStation
```
boolean isStation()
```

isStationModule
```
boolean isStationModule()
```

areAnyEnemiesInRange
```
boolean areAnyEnemiesInRange()
```

blockCommandForOneFrame

void blockCommandForOneFrame(ShipCommand command)

getMaxTurnRate
```
float getMaxTurnRate()
```

getTurnAcceleration
```
float getTurnAcceleration()
```

getTurnDeceleration
```
float getTurnDeceleration()
```

getDeceleration
```
float getDeceleration()
```

getAcceleration
```
float getAcceleration()
```

getMaxSpeed
```
float getMaxSpeed()
```

getFluxLevel
```
float getFluxLevel()
```

getCurrFlux
```
float getCurrFlux()
```

getMaxFlux
```
float getMaxFlux()
```

getMinFluxLevel
```
float getMinFluxLevel()
```

getMinFlux
```
float getMinFlux()
```

setLightDHullOverlay
```
void setLightDHullOverlay()
```

setMediumDHullOverlay
```
void setMediumDHullOverlay()
```

setHeavyDHullOverlay
```
void setHeavyDHullOverlay()
```

isJitterShields
```
boolean isJitterShields()
```

setJitterShields

void setJitterShields(boolean jitterShields)

isInvalidTransferCommandTarget

boolean isInvalidTransferCommandTarget()

setInvalidTransferCommandTarget

void setInvalidTransferCommandTarget(boolean invalidTransferCommandTarget)

clearDamageDecals
```
void clearDamageDecals()
```

syncWithArmorGridState
```
void syncWithArmorGridState()
```

syncWeaponDecalsWithArmorDamage
```
void syncWeaponDecalsWithArmorDamage()
```

isDirectRetreat
```
boolean isDirectRetreat()
```

setRetreating

void setRetreating(boolean retreating,
                 boolean direct)

isLiftingOff
```
boolean isLiftingOff()
```

setVariantForHullmodCheckOnly

void setVariantForHullmodCheckOnly(ShipVariantAPI variant)

getShieldCenterEvenIfNoShield

Vector2f getShieldCenterEvenIfNoShield()

getShieldRadiusEvenIfNoShield
```
float getShieldRadiusEvenIfNoShield()
```

getFleetMember
```
FleetMemberAPI getFleetMember()
```

getShieldTarget
```
Vector2f getShieldTarget()
```

setShieldTargetOverride

void setShieldTargetOverride(float x,
                           float y)

getListenerManager
```
CombatListenerManagerAPI getListenerManager()
```
Will be null if no listeners added.

Returns:

addListener

void addListener(java.lang.Object listener)

removeListener

void removeListener(java.lang.Object listener)

removeListenerOfClass

void removeListenerOfClass(java.lang.Class<?> c)

hasListener

boolean hasListener(java.lang.Object listener)

hasListenerOfClass

boolean hasListenerOfClass(java.lang.Class<?> c)

getListeners

<T> java.util.List<T> getListeners(java.lang.Class<T> c)

getParamAboutToApplyDamage

java.lang.Object getParamAboutToApplyDamage()

setParamAboutToApplyDamage

void setParamAboutToApplyDamage(java.lang.Object param)

getFluxBasedEnergyWeaponDamageMultiplier

float getFluxBasedEnergyWeaponDamageMultiplier()

setName
```
void setName(java.lang.String name)
```

setHulk
```
void setHulk(boolean isHulk)
```

setCaptain
```
void setCaptain(PersonAPI captain)
```

getShipExplosionRadius
```
float getShipExplosionRadius()
```

setCircularJitter

void setCircularJitter(boolean circular)

getExtraAlphaMult
```
float getExtraAlphaMult()
```

setAlphaMult
```
void setAlphaMult(float alphaMult)
```

getAlphaMult
```
float getAlphaMult()
```

setAnimatedLaunch
```
void setAnimatedLaunch()
```

setLaunchingShip

void setLaunchingShip(ShipAPI launchingShip)

isNonCombat

boolean isNonCombat(boolean considerOrders)

findBestArmorInArc

float findBestArmorInArc(float facing,
                       float arc)

getAverageArmorInSlice

float getAverageArmorInSlice(float direction,
                           float arc)

setHoldFire
```
void setHoldFire(boolean holdFire)
```

cloneVariant
```
void cloneVariant()
```

setTimeDeployed

void setTimeDeployed(float timeDeployed)

setFluxVentTextureSheet

void setFluxVentTextureSheet(java.lang.String textureId)

getFluxVentTextureSheet

java.lang.String getFluxVentTextureSheet()

getAimAccuracy
```
float getAimAccuracy()
```

getForceCarrierTargetTime
```
float getForceCarrierTargetTime()
```

setForceCarrierTargetTime

void setForceCarrierTargetTime(float forceCarrierTargetTime)

getForceCarrierPullBackTime
```
float getForceCarrierPullBackTime()
```

setForceCarrierPullBackTime

void setForceCarrierPullBackTime(float forceCarrierPullBackTime)

getForceCarrierTarget
```
ShipAPI getForceCarrierTarget()
```

setForceCarrierTarget

void setForceCarrierTarget(ShipAPI forceCarrierTarget)

setWing
```
void setWing(FighterWingAPI wing)
```

getExplosionScale
```
float getExplosionScale()
```

setExplosionScale

void setExplosionScale(float explosionScale)

getExplosionFlashColorOverride

java.awt.Color getExplosionFlashColorOverride()

setExplosionFlashColorOverride

void setExplosionFlashColorOverride(java.awt.Color explosionFlashColorOverride)

getExplosionVelocityOverride

Vector2f getExplosionVelocityOverride()

setExplosionVelocityOverride

void setExplosionVelocityOverride(Vector2f explosionVelocityOverride)

setNextHitHullDamageThresholdMult

void setNextHitHullDamageThresholdMult(float threshold,
                                     float multBeyondThreshold)

isEngineBoostActive
```
boolean isEngineBoostActive()
```

makeLookDisabled
```
void makeLookDisabled()
```

setExtraAlphaMult2

void setExtraAlphaMult2(float transparency)

getExtraAlphaMult2
```
float getExtraAlphaMult2()
```

setDrone
```
void setDrone(boolean isDrone)
```

getLayer
```
CombatEngineLayers getLayer()
```

setLayer

void setLayer(CombatEngineLayers layer)

isForceHideFFOverlay
```
boolean isForceHideFFOverlay()
```

setForceHideFFOverlay

void setForceHideFFOverlay(boolean forceHideFFOverlay)

getTags

java.util.Set<java.lang.String> getTags()

addTag
```
void addTag(java.lang.String tag)
```

hasTag
```
boolean hasTag(java.lang.String tag)
```

setSprite
```
void setSprite(SpriteAPI sprite)
```

getPeakTimeRemaining
```
float getPeakTimeRemaining()
```

getActiveLayers

java.util.EnumSet<CombatEngineLayers> getActiveLayers()

isShipSystemDisabled
```
boolean isShipSystemDisabled()
```

isDoNotFlareEnginesWhenStrafingOrDecelerating

boolean isDoNotFlareEnginesWhenStrafingOrDecelerating()

setDoNotFlareEnginesWhenStrafingOrDecelerating

void setDoNotFlareEnginesWhenStrafingOrDecelerating(boolean doNotFlare)

getFleetCommander
```
PersonAPI getFleetCommander()
```

Interface ShipAPI

Nested Class Summary

Method Summary

Methods inherited from interface com.fs.starfarer.api.combat.CombatEntityAPI

Method Detail

getFleetMemberId

getMouseTarget

isShuttlePod

isDrone

isFighter

isFrigate

isDestroyer

isCruiser

isCapital

getHullSize

getShipTarget

setShipTarget

getOriginalOwner

setOriginalOwner

resetOriginalOwner

getMutableStats

isHulk

getAllWeapons

getPhaseCloak

getSystem

getTravelDrive

toggleTravelDrive

setShield

getHullSpec

getVariant

useSystem

getFluxTracker

getWingMembers

getWingLeader

isWingLeader

getWing

getDeployedDrones

getDroneSource

getWingToken

getArmorGrid

setRenderBounds

setCRAtDeployment

getCRAtDeployment

getCurrentCR

setCurrentCR

getWingCRAtDeployment

setHitpoints

getTimeDeployedForCRReduction

getFullTimeDeployed

losesCRDuringCombat

controlsLocked

setControlsLocked

setShipSystemDisabled

getDisabledWeapons

getNumFlameouts

getHullLevelAtDeployment

setSprite

getSpriteAPI

getEngineController

giveCommand

setShipAI

getShipAI

resetDefaultAI

turnOnTravelDrive

turnOnTravelDrive

turnOffTravelDrive

isRetreating

abortLanding

beginLandingAnimation

isLanding

isFinishedLanding

isAlive

isInsideNebula

setInsideNebula

isAffectedByNebula

setAffectedByNebula

getDeployCost

removeWeaponFromGroups

applyCriticalMalfunction

getBaseCriticalMalfunctionDamage