fleets

Interfaces

CapacitySummary

Defined in: packages/sage/src/internal/fleet.ts:23

Used/total Fleet capacity in the units of its on-chain capacity axis.

Example

declare const capacity: CapacitySummary;
const remaining = capacity.remaining;

Properties

overCapacity

readonly overCapacity: bigint;

Defined in: packages/sage/src/internal/fleet.ts:27

remaining

readonly remaining: bigint;

Defined in: packages/sage/src/internal/fleet.ts:26

total

readonly total: bigint;

Defined in: packages/sage/src/internal/fleet.ts:25

used

readonly used: bigint;

Defined in: packages/sage/src/internal/fleet.ts:24

FleetAccountData

Defined in: packages/sage/src/internal/c4/fleet.ts:325

SDK-owned decoded Fleet data before registry definition resolution.

Example

declare const fleet: FleetAccountData;
const owner = fleet.ownerProfile;

Properties

activeStimulants

readonly activeStimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  stat: number;
}[];

Defined in: packages/sage/src/internal/c4/fleet.ts:358

ammoBank

readonly ammoBank: FleetCargoAmountData;

Defined in: packages/sage/src/internal/c4/fleet.ts:340

ap

readonly ap: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:344

apReloadExpiresAt

readonly apReloadExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:349

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:327

cargoHold

readonly cargoHold: FleetCargoPodData;

Defined in: packages/sage/src/internal/c4/fleet.ts:357

components

readonly components: FleetCargoPodData;

Defined in: packages/sage/src/internal/c4/fleet.ts:356

crewCount

readonly crewCount: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:341

faction

readonly faction: "unaligned" | "mud" | "oni" | "ustur";

Defined in: packages/sage/src/internal/c4/fleet.ts:332

fleetShips

readonly fleetShips: readonly FleetShipAmountData[];

Defined in: packages/sage/src/internal/c4/fleet.ts:354

fuelTank

readonly fuelTank: FleetCargoAmountData;

Defined in: packages/sage/src/internal/c4/fleet.ts:339

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:328

hp

readonly hp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:346

lastCombatUpdate

readonly lastCombatUpdate: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:351

lastUpdateAt

readonly lastUpdateAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:353

location

readonly location: WorldCoordinates;

Defined in: packages/sage/src/internal/c4/fleet.ts:352

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/fleet.ts:334

npcFactionId

readonly npcFactionId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:333

ownerProfile

readonly ownerProfile: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:329

pendingHp

readonly pendingHp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:347

rentedCrew

readonly rentedCrew: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:342

respawningCargo

readonly respawningCargo: FleetCargoPodData;

Defined in: packages/sage/src/internal/c4/fleet.ts:355

scanCooldownExpiresAt

readonly scanCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:337

shieldBreakDelayExpiresAt

readonly shieldBreakDelayExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:350

shipCounts

readonly shipCounts: FleetShipCountsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:335

shipDefinitionsSeqId

readonly shipDefinitionsSeqId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:343

sp

readonly sp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:345

stance

readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};

Defined in: packages/sage/src/internal/c4/fleet.ts:348

ammoUsage

readonly ammoUsage: "none" | "light" | "heavy";

state

readonly state: FleetStateData;

Defined in: packages/sage/src/internal/c4/fleet.ts:363

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:338

subProfile

readonly subProfile: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:330

subProfileInvalidator

readonly subProfileInvalidator: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:331

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:326

warpCooldownExpiresAt

readonly warpCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:336

FleetCargoAmountData

Defined in: packages/sage/src/internal/c4/fleet.ts:83

One unresolved cargo amount decoded from Fleet account data.

Example

declare const cargo: FleetCargoAmountData;
const cargoId = cargo.cargoId;

Properties

amount

readonly amount: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:85

cargoId

readonly cargoId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:84

FleetCargoPodData

Defined in: packages/sage/src/internal/c4/fleet.ts:95

One immutable cargo pod decoded from Fleet account data.

Example

declare const pod: FleetCargoPodData;
const amounts = pod.amounts;

Properties

amounts

readonly amounts: readonly FleetCargoAmountData[];

Defined in: packages/sage/src/internal/c4/fleet.ts:98

seqId

readonly seqId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:96

storageCost

readonly storageCost: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:97

FleetCargoStatsData

Defined in: packages/sage/src/internal/c4/fleet.ts:215

Translated Fleet cargo statistics.

Example

declare const stats: FleetCargoStatsData;
const capacity = stats.cargoCapacity;

Properties

ammoCapacity

readonly ammoCapacity: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:218

ammoConsumptionRate

readonly ammoConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:219

cargoCapacity

readonly cargoCapacity: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:216

foodConsumptionRate

readonly foodConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:220

fuelCapacity

readonly fuelCapacity: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:217

loadRate

readonly loadRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:222

miningRate

readonly miningRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:221

FleetFixedValue

Defined in: packages/sage/src/internal/c4/fleet.ts:71

A translated fixed-point value retaining exact arithmetic source data.

Example

declare const fixed: FleetFixedValue;
const exact = fixed.raw;

Properties

raw

readonly raw: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:72

value

readonly value: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:73

FleetMiscStatsData

Defined in: packages/sage/src/internal/c4/fleet.ts:288

Translated miscellaneous Fleet statistics.

Example

declare const stats: FleetMiscStatsData;
const requiredCrew = stats.requiredCrew;

Properties

lpValue

readonly lpValue: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:299

medallionValue

readonly medallionValue: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:300

passengerCapacity

readonly passengerCapacity: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:290

requiredCrew

readonly requiredCrew: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:289

respawnFeeAtlas

readonly respawnFeeAtlas: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:294

respawnFeeRaw

readonly respawnFeeRaw: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:293

respawnTimeWithFeeSeconds

readonly respawnTimeWithFeeSeconds: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:292

respawnTimeWithoutFeeSeconds

readonly respawnTimeWithoutFeeSeconds: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:291

scanBonus

readonly scanBonus: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:298

scanCoolDownSeconds

readonly scanCoolDownSeconds: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:295

scanCost

readonly scanCost: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:297

scanPower

readonly scanPower: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:296

xpValue

readonly xpValue: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:301

FleetMovementStatsData

Defined in: packages/sage/src/internal/c4/fleet.ts:195

Translated Fleet movement statistics.

Example

declare const stats: FleetMovementStatsData;
const speed = stats.subwarpSpeed.value;

Properties

maxWarpDistance

readonly maxWarpDistance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:199

planetExitFuelAmount

readonly planetExitFuelAmount: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:203

subwarpFuelConsumptionRate

readonly subwarpFuelConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:201

subwarpSpeed

readonly subwarpSpeed: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:196

subwarpXpRate

readonly subwarpXpRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:205

warpCoolDownSeconds

readonly warpCoolDownSeconds: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:200

warpFuelConsumptionRate

readonly warpFuelConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:202

warpLaneSpeed

readonly warpLaneSpeed: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:198

warpSpeed

readonly warpSpeed: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:197

warpXpRate

readonly warpXpRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:204

FleetShipAmountData

Defined in: packages/sage/src/internal/c4/fleet.ts:108

One unresolved ship quantity decoded from Fleet account data.

Example

declare const ship: FleetShipAmountData;
const quantity = ship.quantity;

Properties

quantity

readonly quantity: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:110

shipId

readonly shipId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:109

FleetShipCountsData

Defined in: packages/sage/src/internal/c4/fleet.ts:120

Fleet ship counts by SAGE size class.

Example

declare const counts: FleetShipCountsData;
const total = counts.total;

Properties

capital

readonly capital: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:127

commander

readonly commander: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:128

large

readonly large: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:126

medium

readonly medium: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:125

small

readonly small: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:124

titan

readonly titan: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:129

total

readonly total: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:121

xSmall

readonly xSmall: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:123

xxSmall

readonly xxSmall: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:122

FleetSnapshot

Defined in: packages/sage/src/fleets/index.ts:87

Immutable, translated Fleet snapshot with registry-resolved definitions.

Example

declare const ctx: SageContext;
declare const fleetAddress: Address;
const fleet: FleetSnapshot = await getFleet(ctx, fleetAddress);
console.log(fleet.name, fleet.ships);

Extends

Omit<ResolvedFleetAccountData, "ownerProfile">

Extended by

FleetView

Properties

activeStimulants

readonly activeStimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  stat: number;
}[];

Defined in: packages/sage/src/internal/c4/fleet.ts:358

Inherited from

FleetAccountData.activeStimulants

address

readonly address: Address;

Defined in: packages/sage/src/fleets/index.ts:92

ammo

readonly ammo: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:102

Inherited from

ResolvedFleetAccountData.ammo

ap

readonly ap: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:344

Inherited from

FleetAccountData.ap

apReloadExpiresAt

readonly apReloadExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:349

Inherited from

FleetAccountData.apReloadExpiresAt

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:327

Inherited from

FleetAccountData.bump

capacities

readonly capacities: {
  ammo: CapacitySummary;
  cargo: CapacitySummary;
  fuel: CapacitySummary;
};

Defined in: packages/sage/src/internal/fleet.ts:118

ammo

readonly ammo: CapacitySummary;

cargo

readonly cargo: CapacitySummary;

fuel

readonly fuel: CapacitySummary;

Inherited from

Omit.capacities

cargoHold

readonly cargoHold: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:103

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

Omit.cargoHold

components

readonly components: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:108

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

Omit.components

crewCount

readonly crewCount: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:341

Inherited from

FleetAccountData.crewCount

faction

readonly faction: "unaligned" | "mud" | "oni" | "ustur";

Defined in: packages/sage/src/internal/c4/fleet.ts:332

Inherited from

FleetAccountData.faction

fuel

readonly fuel: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:101

Inherited from

ResolvedFleetAccountData.fuel

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:328

Inherited from

FleetAccountData.game

hp

readonly hp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:346

Inherited from

FleetAccountData.hp

kind

readonly kind: "fleet";

Defined in: packages/sage/src/fleets/index.ts:91

lastCombatUpdate

readonly lastCombatUpdate: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:351

Inherited from

FleetAccountData.lastCombatUpdate

lastUpdateAt

readonly lastUpdateAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:353

Inherited from

FleetAccountData.lastUpdateAt

location

readonly location: WorldCoordinates;

Defined in: packages/sage/src/internal/c4/fleet.ts:352

Inherited from

FleetAccountData.location

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/fleet.ts:334

Inherited from

FleetAccountData.name

npcFactionId

readonly npcFactionId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:333

Inherited from

FleetAccountData.npcFactionId

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/fleets/index.ts:93

pendingHp

readonly pendingHp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:347

Inherited from

FleetAccountData.pendingHp

rentedCrew

readonly rentedCrew: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:342

Inherited from

FleetAccountData.rentedCrew

respawningCargo

readonly respawningCargo: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:113

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

Omit.respawningCargo

scanCooldownExpiresAt

readonly scanCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:337

Inherited from

FleetAccountData.scanCooldownExpiresAt

shieldBreakDelayExpiresAt

readonly shieldBreakDelayExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:350

Inherited from

FleetAccountData.shieldBreakDelayExpiresAt

shipCounts

readonly shipCounts: FleetShipCountsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:335

Inherited from

FleetAccountData.shipCounts

shipDefinitionsSeqId

readonly shipDefinitionsSeqId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:343

Inherited from

FleetAccountData.shipDefinitionsSeqId

ships

readonly ships: readonly ResolvedShipAmount[];

Defined in: packages/sage/src/internal/fleet.ts:100

Inherited from

Omit.ships

sp

readonly sp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:345

Inherited from

FleetAccountData.sp

stance

readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};

Defined in: packages/sage/src/internal/c4/fleet.ts:348

ammoUsage

readonly ammoUsage: "none" | "light" | "heavy";

Inherited from

FleetAccountData.stance

state

readonly state: ResolvedFleetState;

Defined in: packages/sage/src/internal/fleet.ts:123

Inherited from

ResolvedFleetAccountData.state

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:338

Inherited from

FleetAccountData.stats

subProfile?

readonly optional subProfile?: Address;

Defined in: packages/sage/src/internal/fleet.ts:98

Inherited from

Omit.subProfile

subProfileInvalidator?

readonly optional subProfileInvalidator?: Address;

Defined in: packages/sage/src/internal/fleet.ts:99

Inherited from

Omit.subProfileInvalidator

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:326

Inherited from

FleetAccountData.version

warpCooldownExpiresAt

readonly warpCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:336

Inherited from

FleetAccountData.warpCooldownExpiresAt

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/fleets/index.ts:94

Returns

unknown

FleetStatsData

Defined in: packages/sage/src/internal/c4/fleet.ts:311

Grouped translated Fleet statistics.

Example

declare const stats: FleetStatsData;
const movement = stats.movement;

Properties

cargo

readonly cargo: FleetCargoStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:313

combat

readonly combat: FleetCombatStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:314

misc

readonly misc: FleetMiscStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:315

movement

readonly movement: FleetMovementStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:312

FleetSubscriptionObserver

Defined in: packages/sage/src/fleets/index.ts:108

Observer for live, fully translated Fleet snapshots.

Example

const observer: FleetSubscriptionObserver = {
  onSnapshot: fleet => console.log(fleet.name),
  onError: error => console.error(error.code),
  onDiagnostic: event => console.debug(event.kind, event.coalescedCount),
};

Properties

onDiagnostic?

readonly optional onDiagnostic?: (event) => void;

Defined in: packages/sage/src/fleets/index.ts:111

Parameters

Parameter	Type
`event`	`SubscriptionDiagnosticEvent`

Returns

void

onError

readonly onError: (error) => void | Promise<void>;

Defined in: packages/sage/src/fleets/index.ts:110

Parameters

Parameter	Type
`error`	`SageSdkError`

Returns

void | Promise<void>

onSnapshot

readonly onSnapshot: (fleet) => void | Promise<void>;

Defined in: packages/sage/src/fleets/index.ts:109

Parameters

Parameter	Type
`fleet`	`FleetSnapshot`

Returns

void | Promise<void>

FleetTimers

Defined in: packages/sage/src/internal/fleet.ts:288

Date-valued timers derived from Fleet account sentinels and lifecycle state.

Fleet snapshots retain their exact bigint unix-second fields; these values are an ergonomic projection for UI scheduling and display.

Example

declare const timers: FleetTimers;
console.log(
  timers.arrivesAt?.toISOString(),
  timers.transferEndsAt?.toISOString(),
);

Properties

abilityPowerReloadsAt?

readonly optional abilityPowerReloadsAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:291

arrivesAt?

readonly optional arrivesAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:293

recoversAt?

readonly optional recoversAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:294

scanCooldownEndsAt?

readonly optional scanCooldownEndsAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:290

shieldRegenerationResumesAt?

readonly optional shieldRegenerationResumesAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:292

transferEndsAt?

readonly optional transferEndsAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:295

warpCooldownEndsAt?

readonly optional warpCooldownEndsAt?: Date;

Defined in: packages/sage/src/internal/fleet.ts:289

ResolvedFleetAccountData

Defined in: packages/sage/src/internal/fleet.ts:86

Fleet data after joining account ids against the lazy definitions registry.

Example

declare const fleet: ResolvedFleetAccountData;
const shipName = fleet.ships[0]?.name;

Extends

Omit<FleetAccountData, | "fleetShips" | "fuelTank" | "ammoBank" | "cargoHold" | "components" | "respawningCargo" | "state" | "subProfile" | "subProfileInvalidator">

Properties

activeStimulants

readonly activeStimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  stat: number;
}[];

Defined in: packages/sage/src/internal/c4/fleet.ts:358

Inherited from

FleetAccountData.activeStimulants

ammo

readonly ammo: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:102

ap

readonly ap: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:344

Inherited from

FleetAccountData.ap

apReloadExpiresAt

readonly apReloadExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:349

Inherited from

FleetAccountData.apReloadExpiresAt

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:327

Inherited from

FleetAccountData.bump

capacities

readonly capacities: {
  ammo: CapacitySummary;
  cargo: CapacitySummary;
  fuel: CapacitySummary;
};

Defined in: packages/sage/src/internal/fleet.ts:118

ammo

readonly ammo: CapacitySummary;

cargo

readonly cargo: CapacitySummary;

fuel

readonly fuel: CapacitySummary;

cargoHold

readonly cargoHold: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:103

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

components

readonly components: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:108

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

crewCount

readonly crewCount: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:341

Inherited from

FleetAccountData.crewCount

faction

readonly faction: "unaligned" | "mud" | "oni" | "ustur";

Defined in: packages/sage/src/internal/c4/fleet.ts:332

Inherited from

FleetAccountData.faction

fuel

readonly fuel: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:101

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:328

Inherited from

FleetAccountData.game

hp

readonly hp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:346

Inherited from

FleetAccountData.hp

lastCombatUpdate

readonly lastCombatUpdate: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:351

Inherited from

FleetAccountData.lastCombatUpdate

lastUpdateAt

readonly lastUpdateAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:353

Inherited from

FleetAccountData.lastUpdateAt

location

readonly location: WorldCoordinates;

Defined in: packages/sage/src/internal/c4/fleet.ts:352

Inherited from

FleetAccountData.location

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/fleet.ts:334

Inherited from

FleetAccountData.name

npcFactionId

readonly npcFactionId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:333

Inherited from

FleetAccountData.npcFactionId

ownerProfile

readonly ownerProfile: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:329

Inherited from

FleetAccountData.ownerProfile

pendingHp

readonly pendingHp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:347

Inherited from

FleetAccountData.pendingHp

rentedCrew

readonly rentedCrew: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:342

Inherited from

FleetAccountData.rentedCrew

respawningCargo

readonly respawningCargo: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:113

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

scanCooldownExpiresAt

readonly scanCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:337

Inherited from

FleetAccountData.scanCooldownExpiresAt

shieldBreakDelayExpiresAt

readonly shieldBreakDelayExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:350

Inherited from

FleetAccountData.shieldBreakDelayExpiresAt

shipCounts

readonly shipCounts: FleetShipCountsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:335

Inherited from

FleetAccountData.shipCounts

shipDefinitionsSeqId

readonly shipDefinitionsSeqId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:343

Inherited from

FleetAccountData.shipDefinitionsSeqId

ships

readonly ships: readonly ResolvedShipAmount[];

Defined in: packages/sage/src/internal/fleet.ts:100

sp

readonly sp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:345

Inherited from

FleetAccountData.sp

stance

readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};

Defined in: packages/sage/src/internal/c4/fleet.ts:348

ammoUsage

readonly ammoUsage: "none" | "light" | "heavy";

Inherited from

FleetAccountData.stance

state

readonly state: ResolvedFleetState;

Defined in: packages/sage/src/internal/fleet.ts:123

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:338

Inherited from

FleetAccountData.stats

subProfile?

readonly optional subProfile?: Address;

Defined in: packages/sage/src/internal/fleet.ts:98

subProfileInvalidator?

readonly optional subProfileInvalidator?: Address;

Defined in: packages/sage/src/internal/fleet.ts:99

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:326

Inherited from

FleetAccountData.version

warpCooldownExpiresAt

readonly warpCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:336

Inherited from

FleetAccountData.warpCooldownExpiresAt

SubwarpPosition

Defined in: packages/sage/src/internal/fleet.ts:381

Display-only interpolation matching incremental on-chain subwarp settlement.

Example

declare const subwarp: SubwarpPosition;
if (subwarp.displayOnly) console.log(subwarp.position, subwarp.progress);

Properties

displayOnly

readonly displayOnly: true;

Defined in: packages/sage/src/internal/fleet.ts:382

position

readonly position: WorldCoordinates;

Defined in: packages/sage/src/internal/fleet.ts:383

progress

readonly progress: number;

Defined in: packages/sage/src/internal/fleet.ts:384

WorldCoordinates

Defined in: packages/sage/src/internal/c4/world.ts:128

A position in the shared SAGE coordinate space, in gameplay units.

Example

const coordinates: WorldCoordinates = { x: 1, y: 2 };

Properties

x

readonly x: number;

Defined in: packages/sage/src/internal/c4/world.ts:129

y

readonly y: number;

Defined in: packages/sage/src/internal/c4/world.ts:130

Type Aliases

FleetDiscoveryOptions

type FleetDiscoveryOptions = Omit<DiscoveryRequest, "filters" | "strategy">;

Defined in: packages/sage/src/fleets/index.ts:72

Options supported by targeted Fleet discovery.

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const options: FleetDiscoveryOptions = {
  commitment: 'confirmed',
  policy: 'no-store',
};
const fleets = await getFleetsByOwner(ctx, profileAddress, options);

FleetStateData

type FleetStateData =
  | {
  kind: "idle";
}
  | {
  claimStake: Address;
  endAtUnixSeconds: bigint;
  kind: "claimStakeTransfer";
  load: readonly FleetCargoAmountData[];
  planet: Address;
  unload: readonly FleetCargoAmountData[];
}
  | {
  kind: "destroyed";
}
  | {
  kind: "docked";
  system: Address;
  systemSeqId: bigint;
}
  | {
  asteroid: Address;
  kind: "mining";
  regionXpModifier: number;
  regionXpModifierRaw: bigint;
  resourceIds: readonly number[];
}
  | {
  arrivesAtUnixSeconds: bigint;
  departsAtUnixSeconds: bigint;
  kind: "warp";
  to: WorldCoordinates;
}
  | {
  arrivesAtUnixSeconds: bigint;
  departsAtUnixSeconds: bigint;
  durationSeconds: number;
  durationSecondsRaw: bigint;
  from: WorldCoordinates;
  kind: "subwarp";
  to: WorldCoordinates;
  totalFuelExpenditure: number;
  totalFuelExpenditureRaw: bigint;
  totalXp: number;
  totalXpRaw: bigint;
}
  | {
  kind: "respawn";
  recoversAtUnixSeconds: bigint;
  startedAtUnixSeconds: bigint;
  wasInLowRiskZone: boolean;
};

Defined in: packages/sage/src/internal/c4/fleet.ts:139

Stable translated Fleet movement state, exhaustive for the pinned bindings.

Example

declare const state: FleetStateData;
if (state.kind === 'docked') console.log(state.system);

Functions

deriveFleetTimers()

function deriveFleetTimers<TState>(fleet): FleetTimers;

Defined in: packages/sage/src/internal/fleet.ts:331

Derives only active Fleet timers; non-positive sentinels and values outside JavaScript’s supported Date range stay absent.

Type Parameters

Type Parameter
`TState` extends `FleetTimerState`

Parameters

Parameter	Type
`fleet`	`Pick`<`FleetAccountData`, \| `"warpCooldownExpiresAt"` \| `"scanCooldownExpiresAt"` \| `"apReloadExpiresAt"` \| `"shieldBreakDelayExpiresAt"`> & { `state`: `TState`; }

Returns

FleetTimers

Example

declare const fleet: FleetSnapshot;
const timers = deriveFleetTimers(fleet);
console.log(
  timers.warpCooldownEndsAt?.toISOString(),
  timers.transferEndsAt?.toISOString(),
);

getFleet()

function getFleet(
   ctx,
   address,
options?): Promise<FleetSnapshot>;

Defined in: packages/sage/src/fleets/index.ts:191

Reads a required Fleet by account address.

Parameters

Parameter	Type
`ctx`	`SageContext`
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FleetSnapshot>

Example

declare const ctx: SageContext;
declare const fleetAddress: Address;
const fleet = await getFleet(ctx, fleetAddress);

getFleetsByOwner()

function getFleetsByOwner(
   ctx,
   profileAddress,
options?): Promise<readonly FleetSnapshot[]>;

Defined in: packages/sage/src/fleets/index.ts:286

Discovers Fleets owned by a known Player Profile using targeted stable filters.

Parameters

Parameter	Type
`ctx`	`SageContext`
`profileAddress`	`Address`
`options?`	`FleetDiscoveryOptions`

Returns

Promise<readonly FleetSnapshot[]>

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const fleets = await getFleetsByOwner(ctx, profileAddress);

interpolateSubwarpPosition()

function interpolateSubwarpPosition(state, atUnixSeconds): SubwarpPosition;

Defined in: packages/sage/src/internal/fleet.ts:398

Interpolates a display-only subwarp position, clamped to both endpoints.

The result must not be used as authoritative on-chain position state.

Parameters

Parameter	Type
`state`	{ `arrivesAtUnixSeconds`: `bigint`; `departsAtUnixSeconds`: `bigint`; `durationSeconds`: `number`; `durationSecondsRaw`: `bigint`; `from`: `WorldCoordinates`; `kind`: `"subwarp"`; `to`: `WorldCoordinates`; `totalFuelExpenditure`: `number`; `totalFuelExpenditureRaw`: `bigint`; `totalXp`: `number`; `totalXpRaw`: `bigint`; }
`state.arrivesAtUnixSeconds`	`bigint`
`state.departsAtUnixSeconds`	`bigint`
`state.durationSeconds`	`number`
`state.durationSecondsRaw`	`bigint`
`state.from`	`WorldCoordinates`
`state.kind`	`"subwarp"`
`state.to`	`WorldCoordinates`
`state.totalFuelExpenditure`	`number`
`state.totalFuelExpenditureRaw`	`bigint`
`state.totalXp`	`number`
`state.totalXpRaw`	`bigint`
`atUnixSeconds`	`bigint`

Returns

SubwarpPosition

Example

declare const state: Extract<FleetStateData, { readonly kind: 'subwarp' }>;
const position = interpolateSubwarpPosition(state, 1_700_000_000n);
console.log(position.position, position.progress);

maybeGetFleet()

function maybeGetFleet(
   ctx,
   address,
options?): Promise<FleetSnapshot | undefined>;

Defined in: packages/sage/src/fleets/index.ts:214

Reads an optional Fleet by account address.

Parameters

Parameter	Type
`ctx`	`SageContext`
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FleetSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const fleetAddress: Address;
const fleet = await maybeGetFleet(ctx, fleetAddress);

watchFleet()

function watchFleet(
   ctx,
   address,
   observer,
options?): Promise<SageSubscription>;

Defined in: packages/sage/src/fleets/index.ts:244

Watches one Fleet through its context-owned WebSocket subscription.

Registration emits the current validated Fleet first, then only selected slot/commitment advances. Unsubscribe explicitly or dispose the context.

Parameters

Parameter	Type
`ctx`	`SageContext`
`address`	`Address`
`observer`	`FleetSubscriptionObserver`
`options?`	`ReadAccountOptions`

Returns

Promise<SageSubscription>

Example

declare const ctx: SageContext;
declare const fleetAddress: Address;
const subscription = await watchFleet(ctx, fleetAddress, {
  onSnapshot: fleet => console.log(fleet.name),
  onError: error => console.error(error.code),
});
await subscription.unsubscribe();

References

FleetCombatStatsData

Re-exports FleetCombatStatsData