ships.Interface.PowerConsumer

@elite-dangerous-almanac/core / ships / PowerConsumer

Interface: PowerConsumer

Defined in: src/ships/power.ts:47

One fitted module's claim on the power plant.

Properties

deployedOnly?

readonly optional deployedOnly?: boolean | null

Defined in: src/ships/power.ts:71

true for a module that only draws while the hardpoints are deployed — every weapon, and the utility fittings that are not always powered. Defaults to false. For a known draw, null preserves an unavailable classification and totals conservatively count that draw in both retracted and deployed states. A consumer with drawUnknown is excluded from every total regardless.

---

draw?

readonly optional draw?: number

Defined in: src/ships/power.ts:52

Power draw, in megawatts, post-engineering. Required and finite non-negative unless drawUnknown is true; ignored when the draw is unknown.

---

drawUnknown?

readonly optional drawUnknown?: boolean

Defined in: src/ships/power.ts:77

true when the module's power draw cannot be determined. Its draw is ignored and the consumer is named in PowerBudget.unknownDraws instead of being counted as 0.

---

enabled?

readonly optional enabled?: boolean

Defined in: src/ships/power.ts:62

Whether the module is switched on. Defaults to true; a module switched off draws nothing.

---

label?

readonly optional label?: string

Defined in: src/ships/power.ts:83

Optional label for the module — the journal slot key when ShipLoadout.powerBudget builds the consumer. Ignored by the maths, but it is how a consumer reported in PowerBudget.unknownDraws names itself.

---

priority?

readonly optional priority?: number

Defined in: src/ships/power.ts:60

Priority group, 1–5, as the outfitting panel numbers them. Defaults to 1.

Remarks

The journal's Priority field is zero-based — its 0 is this 1. Values outside 1–5 are clamped into range.

---

symbol?

readonly optional symbol?: string

Defined in: src/ships/power.ts:85

Optional module symbol retained in PowerBudget.consumers.