fleets/actions

Interfaces

PlanFleetCoordinateMovementOptions

Defined in: packages/sage/src/fleets/actions/index.ts:121

Inputs for planning one explicit coordinate-destination Fleet movement.

Example

declare const authorization: PlanAuthorization;
const options: PlanFleetCoordinateMovementOptions = {
  authorization,
  destination: { x: 12, y: -7 },
};

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/fleets/actions/index.ts:122

destination

readonly destination: WorldCoordinates;

Defined in: packages/sage/src/fleets/actions/index.ts:123

---

PlanFleetDockOptions

Defined in: packages/sage/src/fleets/actions/index.ts:106

Inputs for planning one idle-to-docked Fleet transition.

Example

declare const authorization: PlanAuthorization;
const options: PlanFleetDockOptions = { authorization };

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/fleets/actions/index.ts:107

---

PlanFleetSettleArrivalOptions

Defined in: packages/sage/src/fleets/actions/index.ts:154

Address-only input for settling one Fleet movement arrival.

The funder is the sole required signer. Reusing the later assembly fee payer is convenient, but the planner does not require the two addresses to match.

Example

declare const funder: Address;
const options: PlanFleetSettleArrivalOptions = { funder };

Properties

funder

readonly funder: Address;

Defined in: packages/sage/src/fleets/actions/index.ts:155

---

PlanFleetStopSubwarpOptions

Defined in: packages/sage/src/fleets/actions/index.ts:166

Inputs for stopping one Fleet subwarp early.

Example

declare const authorization: PlanAuthorization;
const options: PlanFleetStopSubwarpOptions = { authorization };

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/fleets/actions/index.ts:167

---

PlanFleetUndockOptions

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

Inputs for planning one docked-to-idle Fleet transition.

Example

declare const authorization: PlanAuthorization;
const options: PlanFleetUndockOptions = { authorization };

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/fleets/actions/index.ts:95

---

PlanFleetWarpLaneOptions

Defined in: packages/sage/src/fleets/actions/index.ts:138

Inputs for planning one explicit connected-system Fleet warp.

Example

declare const authorization: PlanAuthorization;
declare const destinationSystem: Address;
const options: PlanFleetWarpLaneOptions = {
  authorization,
  destinationSystem,
};

Properties

authorization

readonly authorization: PlanAuthorization;

Defined in: packages/sage/src/fleets/actions/index.ts:139

destinationSystem

readonly destinationSystem: Address;

Defined in: packages/sage/src/fleets/actions/index.ts:140

Functions

planFleetDock()

function planFleetDock(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1513

Plans one explicit Fleet dock without signing, simulation, or write RPC.

The planner accepts a loaded idle Fleet snapshot, resolves the only canonical Character, Star System at its current coordinate, and Starbase Player internally, and returns one inspectable idle-to-docked Plan.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetDockOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planFleetDock(ctx, fleet, { authorization });
console.log(plan.describe());

---

planFleetSettleArrival()

function planFleetSettleArrival(
   ctx,
   fleet,
input): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1277

Plans settlement of one Fleet warp or subwarp arrival.

Settlement is distinct from stopping subwarp early: the program completes an elapsed movement, while an in-transit call is a measured safe no-op. Subwarp settlement charges the fuel recorded when movement started; warp fuel was already charged up front. Settlement does not clear the independent warp cooldown, so an arrived Fleet can be idle but still unable to warp again.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
input	PlanFleetSettleArrivalOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const funder: Address;
const plan = await planFleetSettleArrival(ctx, fleet, { funder });
console.log(plan.describe());

---

planFleetStopSubwarp()

function planFleetStopSubwarp(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1326

Plans an early Fleet subwarp stop without signing, simulation, or write RPC.

This operation stops an in-progress subwarp before arrival. Use planFleetSettleArrival for a trip already known to have completed; callers should not deliberately stop a completed trip. An idle Fleet is still accepted so the program’s benign no-op handles the normal race where subwarp completes between planning and execution.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetStopSubwarpOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planFleetStopSubwarp(ctx, fleet, { authorization });
console.log(plan.describe());

---

planFleetSubwarp()

function planFleetSubwarp(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1231

Plans one explicit Fleet subwarp to a coordinate without movement estimates.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetCoordinateMovementOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planFleetSubwarp(ctx, fleet, {
  authorization,
  destination: { x: 12, y: -7 },
});

---

planFleetUndock()

function planFleetUndock(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1386

Plans one explicit Fleet undock without signing, simulation, or write RPC.

The planner accepts a loaded Fleet snapshot, resolves its canonical Character, docked Star System, and Starbase Player internally, and returns one inspectable docked-to-idle Plan.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetUndockOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planFleetUndock(ctx, fleet, { authorization });
console.log(plan.describe());

---

planFleetWarpLane()

function planFleetWarpLane(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1153

Plans one explicit connected-system Fleet warp without local economics estimates.

The planner resolves the source Star System from the idle Fleet coordinate, proves connectivity from that System’s decoded connections, and resolves all generated instruction accounts internally.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetWarpLaneOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const destinationSystem: Address;
declare const authorization: PlanAuthorization;
const plan = await planFleetWarpLane(ctx, fleet, {
  authorization,
  destinationSystem,
});

---

planFleetWarpToCoordinate()

function planFleetWarpToCoordinate(
   ctx,
   fleet,
options): Promise<Plan>;

Defined in: packages/sage/src/fleets/actions/index.ts:1252

Plans one explicit Fleet coordinate warp without movement estimates.

Parameters

Parameter	Type
ctx	SageContext
fleet	FleetSnapshot
options	PlanFleetCoordinateMovementOptions

Returns

Promise<Plan>

Example

declare const ctx: SageContext;
declare const fleet: FleetSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planFleetWarpToCoordinate(ctx, fleet, {
  authorization,
  destination: { x: 12, y: -7 },
});

References

PlanAuthorization

Re-exports PlanAuthorization