-
Notifications
You must be signed in to change notification settings - Fork 0
ships.Interface.Ship
@elite-dangerous-almanac/core / ships / Ship
Defined in: src/ships/ships.ts:42
One ship hull — its identity, stats and slot layout in one record.
symbol and any entitlement come from Frontier's shipyard registry. name is the
installed English localisation string where in-game verification differs from that
registry. manufacturer, size, the stats fields (hullMass, maximumSpeed, …), and the
slot-layout fields (core, hardpoints, optional, …) come primarily from
coriolis-data, with verified in-game readings governing stat disagreements and
omissions. manufacturer and size are present for every hull; fields documented
as optional below remain absent where their source carries no value. The Lynx
Highliner (MediumTransport01), which is absent from the pinned coriolis-data
revision, carries equivalent fields sourced from EDSY, Frontier's update notes and
in-game verification. Masses are tonnes, speed/boost fields are metres per second,
and rotation rates are degrees per second. Minimum/full endpoint pairs are the
installed values at zero/four ENG pips.
readonlybaseArmour:number
Defined in: src/ships/ships.ts:81
Base armour (hull hit points) before reinforcement.
readonlybaseShieldStrength:number
Defined in: src/ships/ships.ts:79
Base shield strength, in megajoules, before generator and boosters.
readonlyboost:number
Defined in: src/ships/ships.ts:77
Boost speed, in metres per second.
readonlycore:CoreSlots
Defined in: src/ships/ships.ts:131
The seven core-internal mount sizes.
readonlycrew:number
Defined in: src/ships/ships.ts:87
Number of crew seats (SLF/multicrew).
readonlyoptionalentitlement?:string
Defined in: src/ships/ships.ts:66
Frontier's DLC / purchase-grant entitlement token, e.g.
"ELITE_HORIZONS_V_PLANETARY_LANDINGS".
Present only when the hull is gated behind an entitlement; absent (rather than empty) for hulls available to everyone.
readonlyhardness:number
Defined in: src/ships/ships.ts:83
Hull hardness — resistance to armour piercing.
readonlyhardpoints: readonlyHardpointSlotSpec[]
Defined in: src/ships/ships.ts:137
Weapon hardpoints, largest first (1 Small – 4 Huge). A mount carries a
restriction only when it takes one family of weapons and nothing else — on
the Type-11 Prospector's four mining mounts alone.
readonlyheatCapacity:number
Defined in: src/ships/ships.ts:89
Heat capacity — how much heat the hull absorbs before taking damage.
readonlyheatDissipation:number
Defined in: src/ships/ships.ts:102
Maximum heat dissipation, in thermal-load units per second — the heat the hull
sheds at heat level 1, and the load a build can carry indefinitely.
The stat a heat calculation reads: heat settles where thermal load and
dissipation balance, and heatCapacity only decides how long the ship
takes to get there. See ./heat.
Community-measured rather than published by Frontier. Every player-flyable hull
carries a value, from the Hauler's 16.2 through the Cutter's 72.58.
readonlyhullCost:number
Defined in: src/ships/ships.ts:109
Standard price of the hull alone, in credits, before any discount. This is the figure a shipyard quotes when you already own the modules.
readonlyhullMass:number
Defined in: src/ships/ships.ts:71
Empty-hull mass, in tonnes. A build's unladen mass is this plus every fitted module.
readonlymanufacturer:string
Defined in: src/ships/ships.ts:55
Hull manufacturer as the shipyard names it, e.g. "Faulcon DeLacy".
readonlymasslock:number
Defined in: src/ships/ships.ts:85
Mass-lock factor — how strongly the hull impedes a smaller ship's FSD.
readonlymaximumSpeed:number
Defined in: src/ships/ships.ts:75
Speed at four ENG pips, in metres per second.
readonlyminimumSpeed:number
Defined in: src/ships/ships.ts:73
Speed at zero ENG pips, in metres per second.
readonlyminPitch:number
Defined in: src/ships/ships.ts:116
Pitch rate at zero ENG pips, in degrees per second from 0 through pitch.
readonlyminRoll:number
Defined in: src/ships/ships.ts:120
Roll rate at zero ENG pips, in degrees per second from 0 through roll.
readonlyminYaw:number
Defined in: src/ships/ships.ts:124
Yaw rate at zero ENG pips, in degrees per second from 0 through yaw.
readonlyname:string
Defined in: src/ships/ships.ts:53
Installed English display name, e.g. "Imperial Clipper". Unique across the catalogue.
readonlyoptional: readonlyOptionalSlotSpec[]
Defined in: src/ships/ships.ts:146
Optional-internal mounts, largest first. A mount carries a name only where the
game's slot key is not what enumerateSlots would number it — the Anaconda's
Slot14_Size1, the Type-9 Heavy's Slot00_Size8, the Keelback's
Slot03_Size3.
readonlypitch:number
Defined in: src/ships/ships.ts:118
Pitch rate at four ENG pips, in degrees per second.
readonlyreserveFuelCapacity:number
Defined in: src/ships/ships.ts:104
Reserve tank capacity, in tonnes (feeds the main tank from empty).
readonlyretailCost:number
Defined in: src/ships/ships.ts:114
Standard price of the hull with its default module loadout, in credits — the "retail" price a shipyard shows for a ready-to-fly ship. Always ≥ hullCost.
readonlyroll:number
Defined in: src/ships/ships.ts:122
Roll rate at four ENG pips, in degrees per second.
readonlysize:"small"|"medium"|"large"
Defined in: src/ships/ships.ts:57
Landing-pad size class required by the hull.
readonlysymbol:string
Defined in: src/ships/ships.ts:51
Internal identifier, e.g. "Empire_Trader" (Imperial Clipper).
The journal's Ship field carries this lower-cased ("empire_trader");
getShipBySymbol matches case-insensitively so either form resolves.
This is the hull's key — Frontier's numeric ship-type id is not carried.
readonlyutility:number
Defined in: src/ships/ships.ts:139
Number of tiny utility mounts.
readonlyyaw:number
Defined in: src/ships/ships.ts:126
Yaw rate at four ENG pips, in degrees per second.
Guides
astro
Classes (1)
ProceduralSystem
Properties
Accessors
Methods
Interfaces (16)
Type Aliases (3)
Variables (11)
Functions (37)
- absoluteBoxelToBoxelCode
- boxelCodeToAbsoluteBoxel
- boxelCodeToLetters
- boxelEdgeLy
- boxelInternalSize
- canonicalizeSectorName
- canonicalizeSystemName
- decodeModSystemAddress
- decodeSystemAddress
- encodeModSystemAddress
- encodeSystemAddress
- findHandAuthoredRegionAt
- formatSystemName
- getCodexRegion
- getCodexRegionByName
- getHandAuthoredRegionOrigin
- getNebulaByName
- isPermitLockedRegionName
- isPermitLockedSystemName
- isProceduralSystemName
- lettersToBoxelCode
- massCodeToSizeClass
- nearestNebulae
- nebulaeWithin
- parseSystemName
- permitLockedRegionForSystemName
- permitLockedSystemForAddress
- permitLockedSystemForName
- permitLockForSystemName
- resolveNamingRegionOrigin
- sectorGridPositionFromGalacticPosition
- sectorGridPositionFromName
- sectorNameFromGalacticPosition
- sectorNameFromGridPosition
- sizeClassToMassCode
- toSystemAddress
- tryToSystemAddress
commodities
Interfaces (1)
Type Aliases (1)
Variables (3)
Functions (3)
equipment
Interfaces (6)
Type Aliases (8)
Variables (3)
Functions (10)
Subpath modules (2)
i18n
Interfaces (1)
Type Aliases (1)
Functions (17)
- getBlueprintName
- getCalculationIssueMessage
- getEngineeringGroupName
- getExperimentalEffectDescription
- getExperimentalEffectName
- getLoadoutEditErrorMessage
- getLoadoutIssueMessage
- getLoadoutSlotName
- getMaterialName
- getMicroResourceName
- getModuleName
- getOutfittingFamilyName
- getPreEngineeredVariantName
- getShipManufacturer
- getShipName
- getSlefDiagnosticMessage
- getSlotRestrictionLabel
materials
Enumerations (2)
Interfaces (2)
Type Aliases (2)
Variables (9)
ships
Classes (3)
BuildMetrics
Methods
- armourMetrics()
- buildCost()
- buildMass()
- cellBanks()
- distributorMetrics()
- distributorMetricsResult()
- frameShiftDrive()
- frameShiftDriveMassFactor()
- fuelPerJump()
- heatMetrics()
- heatMetricsResult()
- jumpRange()
- jumpRangeSummary()
- ladenJumpRange()
- loadout()
- maxJumpRange()
- mobilityCapacitorMetrics()
- mobilityCapacitorMetricsResult()
- mobilityMetrics()
- mobilityMetricsResult()
- powerBudget()
- shieldCapacitorMetrics()
- shieldCapacitorMetricsResult()
- shieldMetrics()
- shieldMetricsResult()
- shieldRecovery()
- shieldRecoveryResult()
- standardLoad()
- standardLoadResult()
- thrusters()
- totalRange()
- weaponMetrics()
- weaponsCapacitorMetrics()
- of()
LoadoutEditError
Constructors
Properties
Methods
ShipLoadout
Accessors
- cargoCapacity
- fuelCapacity
- hullValue
- importOutcomes
- modulesValue
- rebuy
- shipIdent
- shipName
- shipSymbol
- sourcePurchase
- unladenMass
Methods
- applyBlueprint()
- availableBlueprints()
- availableExperimentalEffects()
- clearEngineering()
- completeEngineeringGrade()
- fittedModuleAt()
- fittedModules()
- modulesForSlot()
- removeModule()
- repairFixedMount()
- setExperimentalEffect()
- setModule()
- setModuleEnabled()
- setModulePriority()
- setPreEngineeredVariant()
- slots()
- toLoadoutEvent()
- toSlef()
- toSlefString()
- validation()
- default()
- empty()
- fromLoadout()
- fromSlef()
Interfaces (125)
- AmmunitionCapacity
- AmmunitionStats
- ApplyBlueprintOptions
- ArmourInput
- ArmourMetrics
- AvailableBlueprint
- Blueprint
- BlueprintFeature
- BlueprintGrade
- BlueprintModuleEngineering
- BuildCost
- BuildCredits
- BuildMass
- BuildSlotBase
- BuildWeaponMetrics
- BulkheadParams
- CalculationIssue
- CellBankInput
- CellBankMetrics
- CellBankSummary
- CoreBuildSlot
- CoreSlots
- DamageComponents
- DamageDistribution
- DamageResistanceParams
- DamageSplit
- DamageTypeValues
- DistributorCapacitorMetrics
- DistributorInput
- DistributorMetrics
- DistributorOptions
- DistributorPips
- EngineeringMaterial
- EngineeringModifier
- EngineeringNormalizationUnchanged
- EngineeringNormalizationUnsupported
- EngineeringNormalized
- EngineeringOptionGroup
- ExperimentalContribution
- ExperimentalEffect
- ExperimentalEffectUnchanged
- ExperimentalEffectUnsupported
- ExperimentalEffectUpdated
- FittedModule
- FittedWeaponMetrics
- FrameShiftDriveJumpStats
- FrameShiftDriveParams
- FuelCapacity
- GunsightPoint
- HardpointBuildSlot
- HardpointSlotSpec
- HeatInput
- HeatMetrics
- HeatState
- HeatWeapon
- HullReinforcementParams
- JumpOptions
- JumpRangeSummary
- LoadoutCalculationModule
- LoadoutEvent
- LoadoutExportOptions
- LoadoutIssue
- LoadoutMass
- LoadoutModule
- LoadoutValidation
- LoadoutValidationInput
- MassCurveStats
- MobilityCapacitorInput
- MobilityCapacitorMetrics
- MobilityCapacitorOptions
- MobilityInput
- MobilityMetrics
- ModuleLimitEntry
- ModuleLimitIncrease
- ModuleLimitUsage
- ModuleReinforcementParams
- OptionalBuildSlot
- OptionalSlotSpec
- OutfittingModule
- OutfittingModuleIdentity
- OutfittingModuleStats
- ParsedSlot
- PowerBand
- PowerBudget
- PowerConsumer
- PowerConsumerResult
- PowerDistributorStats
- PowerGenerationStats
- PreEngineeredModifier
- PreEngineeredVariant
- ProjectileRangeBoundaries
- ShieldBoosterParams
- ShieldCapacitorInput
- ShieldCapacitorMetrics
- ShieldCapacitorOptions
- ShieldGeneratorParams
- ShieldInput
- ShieldMetrics
- ShieldRecovery
- ShieldRecoveryInput
- ShieldRecoveryOptions
- ShieldRegenerationStats
- Ship
- ShipSlots
- SimpleBuildSlot
- SlefDiagnostic
- SlefEntry
- SlefExportOptions
- SlefHeader
- SlefInspection
- SlefStringifyOptions
- SourceModuleValue
- SourcePurchaseRecord
- StandardLoadInputs
- ThrusterCurveParams
- ThrusterParams
- TotalRangeDetails
- ValidationModule
- WeaponDamageStats
- WeaponMetrics
- WeaponsCapacitorInput
- WeaponsCapacitorMetrics
- WeaponsOptions
- WeaponStats
- WeaponTotals
Type Aliases (44)
- BlueprintGrades
- BuildSlot
- CalculationIssueReason
- CalculationResult
- CoreSlotType
- DamageResistances
- DamageType
- EngineeringGroupId
- EngineeringNormalizationCode
- EngineeringNormalizationResult
- ExperimentalEffectMutationCode
- ExperimentalEffectMutationResult
- FixedMountRepairResult
- GunsightOffset
- HardpointRestriction
- ImmovableReason
- LoadoutEditErrorCode
- LoadoutImportOutcome
- LoadoutIssueCode
- LoadoutIssueParam
- LoadoutIssueParams
- LoadoutSlot
- ModifierMethod
- ModuleCategory
- ModuleEngineering
- ModuleExclusionGroup
- ModuleFitConstraint
- ModuleGuidance
- ModuleLimitGroup
- ModuleMount
- ModuleRating
- ModuleSlot
- OptionalRestriction
- OutfittingFamilyId
- PreEngineeredAcquisition
- ShipGunsight
- ShipGunsightCatalogue
- Slef
- SlefConstraint
- SlefDiagnosticCode
- SlotKind
- SlotRestriction
- StandardLoad
- ThrusterLoad
Variables (10)
Functions (85)
- ammunitionCapacity
- armourMetrics
- armourPiercingFactor
- calculateCargoCapacity
- calculateFuelCapacity
- calculateModuleLimits
- calculateUnladenMass
- cellBankSummary
- combinedRateOfFire
- computeModifiers
- damageFalloff
- damagePerSecond
- distributorMetrics
- effectiveHitPoints
- effectiveWeaponThermalLoad
- energyPerSecond
- enumerateSlots
- equilibriumHeatLevel
- frameShiftDriveMassFactor
- fuelPerJump
- getBlueprint
- getBlueprintGrade
- getBlueprintsForModule
- getBulkheadsForShip
- getEngineeringGroup
- getExperimentalEffect
- getExperimentalsForBlueprint
- getExperimentalsForModule
- getLoadoutModifier
- getModuleBySymbol
- getModulesByName
- getPreEngineeredJournalModifiers
- getPreEngineeredModifiers
- getPreEngineeredStats
- getPreEngineeredVariants
- getShipByName
- getShipBySymbol
- getShipGunsight
- getShipSlots
- getSourceModuleValue
- hasFrameShiftDriveJumpStats
- hasMassCurveStats
- hasPowerDistributorStats
- hasPowerGenerationStats
- hasShieldRegenerationStats
- hasWeaponDamageStats
- heatLevelAtTime
- heatMetrics
- heatPerSecond
- identifyPreEngineeredVariant
- inspectSlef
- isPreEngineered
- mapDamageTypes
- mobilityCapacitorMetrics
- mobilityMetrics
- parseSlef
- parseSlotName
- powerBudget
- projectGunsight
- resolveBlueprintForModule
- secondsToHeatLevel
- shieldCapacitorMetrics
- shieldMassCurveMultiplier
- shieldMetrics
- shieldRecovery
- shieldStrength
- singleJumpRange
- sourcePurchaseFromLoadout
- splitDamage
- stackArmourResistance
- stackShieldResistance
- stringifySlef
- sumMaterials
- sumSourceModuleValues
- sumWeaponMetrics
- sustainedDamagePerSecond
- sustainedFireFactor
- systemsResistance
- thrusterMassCurveMultiplier
- toSlef
- totalRange
- unresolvedModifiers
- validateLoadout
- weaponMetrics
- weaponsCapacitorMetrics