scanning

Interfaces

CharacterScanningStateSnapshot

Defined in: packages/sage/src/scanning/index.ts:149

Focused read-only scanning projection of one derived Character.

Example

declare const state: CharacterScanningStateSnapshot;
console.log(state.dataRunnerXp.level, state.modifiers.power.value);

Properties

character

readonly character: EntityRef<"character">;

Defined in: packages/sage/src/scanning/index.ts:151

dataRunnerXp

readonly dataRunnerXp: CharacterXpCategoryData & {
  sequenceId: number;
};

Defined in: packages/sage/src/scanning/index.ts:153

Type Declaration

sequenceId

readonly sequenceId: number;

kind

readonly kind: "characterScanningState";

Defined in: packages/sage/src/scanning/index.ts:150

modifiers

readonly modifiers: {
  cooldown: ScanFixedValueData;
  power: ScanFixedValueData;
  sequenceId: number;
};

Defined in: packages/sage/src/scanning/index.ts:156

cooldown

readonly cooldown: ScanFixedValueData;

power

readonly power: ScanFixedValueData;

sequenceId

readonly sequenceId: number;

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/scanning/index.ts:152

researchTagIds

readonly researchTagIds: readonly number[];

Defined in: packages/sage/src/scanning/index.ts:161

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/scanning/index.ts:162

Returns

unknown

---

FleetScanningStateSnapshot

Defined in: packages/sage/src/scanning/index.ts:128

Focused read-only scanning projection of one Fleet.

Example

declare const state: FleetScanningStateSnapshot;
console.log(state.stats.power, state.cooldownEndsAtUnixSeconds);

Properties

cooldownEndsAtUnixSeconds

readonly cooldownEndsAtUnixSeconds: bigint;

Defined in: packages/sage/src/scanning/index.ts:132

fleet

readonly fleet: EntityRef<"fleet">;

Defined in: packages/sage/src/scanning/index.ts:130

kind

readonly kind: "fleetScanningState";

Defined in: packages/sage/src/scanning/index.ts:129

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/scanning/index.ts:131

stats

readonly stats: {
  bonus: number;
  cooldownSeconds: number;
  cost: number;
  power: number;
};

Defined in: packages/sage/src/scanning/index.ts:133

bonus

readonly bonus: number;

cooldownSeconds

readonly cooldownSeconds: number;

cost

readonly cost: number;

power

readonly power: number;

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/scanning/index.ts:139

Returns

unknown

---

ScanPatternCost

Defined in: packages/sage/src/scanning/index.ts:75

One cargo-backed scan cost.

Example

declare const cost: ScanPatternCost;
console.log(cost.cargo.name, cost.multiplier.value);

Properties

cargo

readonly cargo: CargoDefinitionSummary;

Defined in: packages/sage/src/scanning/index.ts:76

multiplier

readonly multiplier: ScanFixedValueData;

Defined in: packages/sage/src/scanning/index.ts:77

---

ScanPatternLootOutcome

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

One cargo-backed scan outcome and its research-tag requirements.

Example

declare const outcome: ScanPatternLootOutcome;
console.log(outcome.output.name, outcome.researchRequirementTagIds);

Properties

output

readonly output: CargoDefinitionSummary;

Defined in: packages/sage/src/scanning/index.ts:88

outputAmountRaw

readonly outputAmountRaw: bigint;

Defined in: packages/sage/src/scanning/index.ts:89

researchRequirementTagIds

readonly researchRequirementTagIds: readonly number[];

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

rollWeight

readonly rollWeight: ScanFixedValueData;

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

threshold

readonly threshold: ScanFixedValueData;

Defined in: packages/sage/src/scanning/index.ts:90

xpValue

readonly xpValue: ScanFixedValueData;

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

---

ScanPatternSnapshot

Defined in: packages/sage/src/scanning/index.ts:103

Immutable, definition-resolved ScanPattern catalog entry.

Example

declare const pattern: ScanPatternSnapshot;
console.log(pattern.name, pattern.loot.length);

Properties

address

readonly address: Address;

Defined in: packages/sage/src/scanning/index.ts:105

blankWeight

readonly blankWeight: ScanFixedValueData;

Defined in: packages/sage/src/scanning/index.ts:112

blankXpValue

readonly blankXpValue: ScanFixedValueData;

Defined in: packages/sage/src/scanning/index.ts:113

bump

readonly bump: number;

Defined in: packages/sage/src/scanning/index.ts:107

cooldownMultiplier

readonly cooldownMultiplier: ScanFixedValueData;

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

costs

readonly costs: readonly ScanPatternCost[];

Defined in: packages/sage/src/scanning/index.ts:115

game

readonly game: EntityRef<"game">;

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

id

readonly id: number;

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

kind

readonly kind: "scanPattern";

Defined in: packages/sage/src/scanning/index.ts:104

loot

readonly loot: readonly ScanPatternLootOutcome[];

Defined in: packages/sage/src/scanning/index.ts:116

name

readonly name: string;

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

noiseMaps

readonly noiseMaps: readonly ScanNoiseMapData[];

Defined in: packages/sage/src/scanning/index.ts:117

status

readonly status: "active" | "draft";

Defined in: packages/sage/src/scanning/index.ts:114

version

readonly version: number;

Defined in: packages/sage/src/scanning/index.ts:106

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/scanning/index.ts:118

Returns

unknown

Type Aliases

ScanCooldownState

type ScanCooldownState =
  | {
  kind: "ready";
}
  | {
  kind: "cooldown";
  remainingSeconds: bigint;
};

Defined in: packages/sage/src/scanning/index.ts:175

Pure Fleet cooldown state at one explicit Unix timestamp.

Example

declare const fleet: FleetScanningStateSnapshot;
const state: ScanCooldownState = deriveScanCooldownState(
  fleet,
  1_700_000_000n,
);

---

ScanFixedValue

type ScanFixedValue = ScanFixedValueData;

Defined in: packages/sage/src/scanning/index.ts:46

Fixed-point scanning value with exact raw storage.

Example

const value: ScanFixedValue = { raw: 65_536n, value: 1 };

---

ScanNoiseMap

type ScanNoiseMap = ScanNoiseMapData;

Defined in: packages/sage/src/scanning/index.ts:55

One translated noise-map row used by a ScanPattern.

Example

declare const noise: ScanNoiseMap;
console.log(noise.seedOffset, noise.weight.value);

---

ScanPatternDiscoveryOptions

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

Defined in: packages/sage/src/scanning/index.ts:63

Options supported by targeted ScanPattern catalog discovery.

Example

const options: ScanPatternDiscoveryOptions = { commitment: 'confirmed' };

Functions

deriveScanCooldownState()

function deriveScanCooldownState(fleet, atUnixSeconds): ScanCooldownState;

Defined in: packages/sage/src/scanning/index.ts:478

Derives whether a Fleet scan cooldown is ready at an explicit timestamp.

Parameters

Parameter	Type
fleet	FleetScanningStateSnapshot
atUnixSeconds	bigint

Returns

ScanCooldownState

Example

declare const fleet: FleetScanningStateSnapshot;
const state = deriveScanCooldownState(fleet, 1_700_000_000n);

---

getCharacterScanningState()

function getCharacterScanningState(
   context,
   profile,
options?): Promise<CharacterScanningStateSnapshot>;

Defined in: packages/sage/src/scanning/index.ts:418

Derives one Character from Profile and returns focused scanning progression.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	ReadOptions

Returns

Promise<CharacterScanningStateSnapshot>

Example

declare const ctx: SageContext;
declare const profile: Address;
const state = await getCharacterScanningState(ctx, profile);

---

getFleetScanningState()

function getFleetScanningState(
   context,
   address,
options?): Promise<FleetScanningStateSnapshot>;

Defined in: packages/sage/src/scanning/index.ts:366

Reads one Fleet and returns only its translated scanning state.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<FleetScanningStateSnapshot>

Example

declare const ctx: SageContext;
declare const fleet: Address;
const state = await getFleetScanningState(ctx, fleet);

---

getScanPattern()

function getScanPattern(
   context,
   patternId,
options?): Promise<ScanPatternSnapshot>;

Defined in: packages/sage/src/scanning/index.ts:284

Derives and reads one required ScanPattern for the configured Game.

Parameters

Parameter	Type
context	SageContext
patternId	number
options?	ReadOptions

Returns

Promise<ScanPatternSnapshot>

Example

declare const ctx: SageContext;
const pattern = await getScanPattern(ctx, 2);

---

getScanPatterns()

function getScanPatterns(context, options?): Promise<readonly ScanPatternSnapshot[]>;

Defined in: packages/sage/src/scanning/index.ts:344

Discovers the configured Game’s ScanPattern catalog with targeted filters.

Parameters

Parameter	Type
context	SageContext
options?	ScanPatternDiscoveryOptions

Returns

Promise<readonly ScanPatternSnapshot[]>

Example

declare const ctx: SageContext;
const patterns = await getScanPatterns(ctx);

---

maybeGetScanPattern()

function maybeGetScanPattern(
   context,
   patternId,
   options?): Promise<
  | ScanPatternSnapshot
| undefined>;

Defined in: packages/sage/src/scanning/index.ts:314

Derives and reads one optional ScanPattern for the configured Game.

Parameters

Parameter	Type
context	SageContext
patternId	number
options?	ReadOptions

Returns

Promise< | ScanPatternSnapshot | undefined>

Example

declare const ctx: SageContext;
const pattern = await maybeGetScanPattern(ctx, 2);