world

Interfaces

AsteroidSnapshot

Defined in: packages/sage/src/world/index.ts:99

Immutable Asteroid projection over a CelestialBody account.

Example

declare const asteroid: AsteroidSnapshot;
console.log(asteroid.details.resources);

Extends

• Omit<AsteroidAccountData, "system">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/world/index.ts:100

details

readonly details: WorldAsteroidData;

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

Inherited from

Omit.details

game

readonly game: Address;

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

Inherited from

Omit.game

id

readonly id: number;

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

Inherited from

Omit.id

kind

readonly kind: "asteroid";

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

Inherited from

Omit.kind

lastSyncAtUnixSeconds

readonly lastSyncAtUnixSeconds: bigint;

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

Inherited from

Omit.lastSyncAtUnixSeconds

name

readonly name: string;

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

Inherited from

Omit.name

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/world/index.ts:101

systemSequenceId

readonly systemSequenceId: bigint;

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

Inherited from

Omit.systemSequenceId

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/world/index.ts:102

Returns

unknown

---

PlanetSnapshot

Defined in: packages/sage/src/world/index.ts:86

Immutable Planet projection over a CelestialBody account.

Example

declare const planet: PlanetSnapshot;
console.log(planet.details.resources);

Extends

• Omit<PlanetAccountData, "system">

Properties

address

readonly address: Address;

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

details

readonly details: WorldPlanetData;

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

Inherited from

Omit.details

game

readonly game: Address;

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

Inherited from

Omit.game

id

readonly id: number;

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

Inherited from

Omit.id

kind

readonly kind: "planet";

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

Inherited from

Omit.kind

lastSyncAtUnixSeconds

readonly lastSyncAtUnixSeconds: bigint;

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

Inherited from

Omit.lastSyncAtUnixSeconds

name

readonly name: string;

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

Inherited from

Omit.name

system

readonly system: EntityRef<"starSystem">;

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

systemSequenceId

readonly systemSequenceId: bigint;

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

Inherited from

Omit.systemSequenceId

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

StarSystemAccountData

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

SDK-owned decoded StarSystem data.

Example

declare const system: StarSystemAccountData;
console.log(system.coordinates);

Extended by

• StarSystemSnapshot

Properties

celestialBodyAddresses

readonly celestialBodyAddresses: readonly Address[];

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

connections

readonly connections: readonly WorldConnectionData[];

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

coordinates

readonly coordinates: WorldCoordinates;

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

game

readonly game: Address;

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

name

readonly name: string;

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

regionId?

readonly optional regionId?: number;

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

sequenceId

readonly sequenceId: bigint;

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

starbase?

readonly optional starbase?: WorldStarbaseData;

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

systemId

readonly systemId: number;

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

version

readonly version: number;

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

---

StarSystemSnapshot

Defined in: packages/sage/src/world/index.ts:67

Immutable, translated StarSystem snapshot including nested shared Starbase data.

Example

declare const system: StarSystemSnapshot;
console.log(system.name, system.coordinates);

Extends

• StarSystemAccountData

Extended by

• StarSystemView

Properties

address

readonly address: Address;

Defined in: packages/sage/src/world/index.ts:69

celestialBodyAddresses

readonly celestialBodyAddresses: readonly Address[];

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

Inherited from

StarSystemAccountData.celestialBodyAddresses

connections

readonly connections: readonly WorldConnectionData[];

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

Inherited from

StarSystemAccountData.connections

coordinates

readonly coordinates: WorldCoordinates;

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

Inherited from

StarSystemAccountData.coordinates

game

readonly game: Address;

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

Inherited from

StarSystemAccountData.game

kind

readonly kind: "starSystem";

Defined in: packages/sage/src/world/index.ts:68

name

readonly name: string;

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

Inherited from

StarSystemAccountData.name

regionId?

readonly optional regionId?: number;

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

Inherited from

StarSystemAccountData.regionId

sequenceId

readonly sequenceId: bigint;

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

Inherited from

StarSystemAccountData.sequenceId

starbase?

readonly optional starbase?: WorldStarbaseData;

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

Inherited from

StarSystemAccountData.starbase

systemId

readonly systemId: number;

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

Inherited from

StarSystemAccountData.systemId

version

readonly version: number;

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

Inherited from

StarSystemAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/world/index.ts:70

Returns

unknown

---

WorldAsteroidData

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

Fully translated Asteroid projection data.

Example

declare const asteroid: WorldAsteroidData;
console.log(asteroid.resources);

Properties

resources

readonly resources: readonly WorldAsteroidResourceData[];

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

---

WorldAsteroidResourceData

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

One translated Asteroid resource state.

Example

declare const resource: WorldAsteroidResourceData;
console.log(resource.amountMined);

Properties

amountMined

readonly amountMined: bigint;

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

cargoId

readonly cargoId: number;

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

miners

readonly miners: bigint;

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

richness

readonly richness: WorldFixedValue;

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

---

WorldClaimStakeGroupData

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

One translated nested Claim Stake structure group.

Example

declare const group: WorldClaimStakeGroupData;
console.log(group.structures);

Properties

chronoAddresses

readonly chronoAddresses: readonly Address[];

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

key

readonly key: number;

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

offset

readonly offset: number;

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

structures

readonly structures: readonly WorldStructureData[];

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

---

WorldConnectionCosts

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

Unit-explicit warp-lane costs for one connected system.

Example

declare const costs: WorldConnectionCosts;
console.log(costs.level1Atlas);

Properties

cssAtlas

readonly cssAtlas: number;

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

cssRaw

readonly cssRaw: bigint;

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

level1Atlas

readonly level1Atlas: number;

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

level1Raw

readonly level1Raw: bigint;

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

level2Atlas

readonly level2Atlas: number;

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

level2Raw

readonly level2Raw: bigint;

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

level3Atlas

readonly level3Atlas: number;

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

level3Raw

readonly level3Raw: bigint;

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

level4Atlas

readonly level4Atlas: number;

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

level4Raw

readonly level4Raw: bigint;

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

level5Atlas

readonly level5Atlas: number;

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

level5Raw

readonly level5Raw: bigint;

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

---

WorldConnectionData

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

One StarSystem connection keyed by the connected system id.

Example

declare const connection: WorldConnectionData;
console.log(connection.systemId);

Properties

costs

readonly costs: WorldConnectionCosts;

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

systemId

readonly systemId: number;

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

---

WorldCoordinates

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

Coordinates in SAGE sector 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

---

WorldCraftingHabData

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

One nested Crafting Hab group retained as shared Starbase data.

Example

declare const hab: WorldCraftingHabData;
console.log(hab.structures);

Properties

chronoAddresses

readonly chronoAddresses: readonly Address[];

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

key

readonly key: number;

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

offset

readonly offset: number;

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

structures

readonly structures: readonly WorldStructureData[];

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

---

WorldFixedValue

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

A translated fixed-point world value retaining its exact source integer.

Example

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

Properties

raw

readonly raw: bigint;

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

value

readonly value: number;

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

---

WorldPlanetData

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

Fully translated Planet projection data.

Example

declare const planet: WorldPlanetData;
console.log(planet.resources);

Properties

baseClaimStakePlacementFee

readonly baseClaimStakePlacementFee: readonly readonly WorldFixedValue[][];

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

baseClaimStakeRentRate

readonly baseClaimStakeRentRate: readonly readonly WorldFixedValue[][];

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

claimedPlots

readonly claimedPlots: readonly WorldClaimStakeGroupData[];

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

claimedPlotsUnsizedLength

readonly claimedPlotsUnsizedLength: number;

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

claimStakePlots

readonly claimStakePlots: readonly readonly number[][];

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

providedTags

readonly providedTags: readonly number[];

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

resources

readonly resources: readonly WorldPlanetResourceData[];

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

---

WorldPlanetResourceData

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

One translated Planet resource richness value.

Example

declare const resource: WorldPlanetResourceData;
console.log(resource.richness.value);

Properties

cargoId

readonly cargoId: number;

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

richness

readonly richness: WorldFixedValue;

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

---

WorldStarbaseData

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

Fully translated nested shared Starbase data.

Example

declare const starbase: WorldStarbaseData;
console.log(starbase.owner, starbase.level);

Properties

baseCraftingHabPlacementFee

readonly baseCraftingHabPlacementFee: readonly readonly WorldFixedValue[][];

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

baseCraftingHabRentRate

readonly baseCraftingHabRentRate: readonly readonly WorldFixedValue[][];

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

buildingTags

readonly buildingTags: readonly number[];

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

builtDestroyedAtUnixSeconds

readonly builtDestroyedAtUnixSeconds: bigint;

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

craftingHabPlots

readonly craftingHabPlots: readonly readonly number[][];

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

craftingHabs

readonly craftingHabs: readonly WorldCraftingHabData[];

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

craftingHabsUnsizedLength

readonly craftingHabsUnsizedLength: number;

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

hp

readonly hp: number;

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

lastCombatUpdateUnixSeconds

readonly lastCombatUpdateUnixSeconds: bigint;

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

level

readonly level: WorldStarbaseLevel;

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

localMarketEnableLevel

readonly localMarketEnableLevel: WorldStarbaseLevel;

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

locationTags

readonly locationTags: readonly number[];

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

maxLevel

readonly maxLevel: WorldStarbaseMaxLevelData;

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

owner

readonly owner: WorldFaction;

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

pendingHp

readonly pendingHp: number;

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

repairEnableLevel

readonly repairEnableLevel: WorldStarbaseLevel;

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

shieldBreakDelayExpiresAtUnixSeconds

readonly shieldBreakDelayExpiresAtUnixSeconds: bigint;

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

sp

readonly sp: number;

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

validRecipeIds

readonly validRecipeIds: readonly number[];

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

---

WorldStarbaseLevelData

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

One translated level inside the Starbase maximum-level union.

Example

declare const level: WorldStarbaseLevelData;
console.log(level.upgrades);

Properties

info

readonly info: WorldStarbaseLevelInfoData;

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

level

readonly level: WorldStarbaseLevel;

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

upgrades

readonly upgrades: readonly WorldStarbaseUpgradeData[];

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

---

WorldStarbaseLevelInfoData

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

Fully translated combat/economy values for one Starbase level.

Example

declare const info: WorldStarbaseLevelInfoData;
console.log(info.repairFeeAtlas);

Properties

damagePerRound

readonly damagePerRound: number;

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

hp

readonly hp: number;

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

repairAbility

readonly repairAbility: WorldFixedValue;

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

repairCost

readonly repairCost: WorldFixedValue;

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

repairEfficiency

readonly repairEfficiency: WorldFixedValue;

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

repairFeeAtlas

readonly repairFeeAtlas: number;

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

repairFeeRaw

readonly repairFeeRaw: bigint;

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

repairRate

readonly repairRate: WorldFixedValue;

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

shieldBreakDelaySeconds

readonly shieldBreakDelaySeconds: number;

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

shieldRechargeRate

readonly shieldRechargeRate: WorldFixedValue;

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

sp

readonly sp: number;

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

xp

readonly xp: WorldFixedValue;

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

---

WorldStarbaseMaxLevelData

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

Plain replacement for the generated StarbaseMaxLevel union.

Example

declare const maximum: WorldStarbaseMaxLevelData;
console.log(maximum.kind);

Properties

kind

readonly kind: WorldStarbaseLevel;

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

levels

readonly levels: readonly WorldStarbaseLevelData[];

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

---

WorldStarbaseUpgradeData

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

One cargo deposit requirement for an intermediate Starbase level.

Example

declare const upgrade: WorldStarbaseUpgradeData;
console.log(upgrade.cargoId);

Properties

cargoId

readonly cargoId: number;

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

crew

readonly crew: number;

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

deposited

readonly deposited: bigint;

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

durationSeconds

readonly durationSeconds: number;

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

needed

readonly needed: bigint;

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

---

WorldStructureData

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

One nested shared structure value from Starbase crafting-hab data.

Example

declare const structure: WorldStructureData;
console.log(structure.address);

Properties

address

readonly address: Address;

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

deactivationTimeUnixSeconds

readonly deactivationTimeUnixSeconds: bigint;

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

Type Aliases

CelestialBodySnapshot

type CelestialBodySnapshot =
  | PlanetSnapshot
  | AsteroidSnapshot;

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

A translated CelestialBody snapshot projected as a Planet or Asteroid.

Example

declare const body: CelestialBodySnapshot;
if (body.kind === 'planet') console.log(body.details.claimStakePlots);

---

StarSystemDiscoveryOptions

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

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

Options supported by galaxy-scale StarSystem discovery.

Example

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

---

WorldFaction

type WorldFaction = "unaligned" | "mud" | "oni" | "ustur";

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

Human-readable faction labels used by shared Starbase data.

Example

const faction: WorldFaction = 'mud';

---

WorldStarbaseLevel

type WorldStarbaseLevel =
  | "level-0"
  | "level-1"
  | "level-2"
  | "level-3"
  | "level-4"
  | "level-5"
  | "css";

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

Human-readable Starbase level labels.

Example

const level: WorldStarbaseLevel = 'level-1';

Functions

distanceBetweenStarSystems()

function distanceBetweenStarSystems(from, to): number;

Defined in: packages/sage/src/world/index.ts:523

Returns Euclidean distance between two SAGE sector coordinates.

Parameters

Parameter	Type
from	WorldCoordinates
to	WorldCoordinates

Returns

number

Example

const distance = distanceBetweenStarSystems({ x: 0, y: 0 }, { x: 3, y: 4 });

---

findCelestialBodyPda()

function findCelestialBodyPda(game, bodyId): Promise<Address>;

Defined in: packages/sage/src/world/index.ts:260

Derives the CelestialBody PDA for a Game and numeric body id.

Parameters

Parameter	Type
game	Address
bodyId	number

Returns

Promise<Address>

Example

declare const game: Address;
const address = await findCelestialBodyPda(game, 11);

---

findStarSystemPda()

function findStarSystemPda(game, systemId): Promise<Address>;

Defined in: packages/sage/src/world/index.ts:246

Derives the StarSystem PDA for a Game and numeric system id.

Parameters

Parameter	Type
game	Address
systemId	number

Returns

Promise<Address>

Example

declare const game: Address;
const address = await findStarSystemPda(game, 1);

---

getAsteroids()

function getAsteroids(
   ctx,
   systemAddress,
options?): Promise<readonly AsteroidSnapshot[]>;

Defined in: packages/sage/src/world/index.ts:502

Returns only Asteroid projections in one StarSystem.

Parameters

Parameter	Type
ctx	SageContext
systemAddress	Address
options?	ReadOptions

Returns

Promise<readonly AsteroidSnapshot[]>

Example

declare const ctx: SageContext;
declare const systemAddress: Address;
const asteroids = await getAsteroids(ctx, systemAddress);

---

getCelestialBodies()

function getCelestialBodies(
   ctx,
   systemAddress,
options?): Promise<readonly CelestialBodySnapshot[]>;

Defined in: packages/sage/src/world/index.ts:441

Traverses a StarSystem’s stored CelestialBody addresses with explicit reads.

Parameters

Parameter	Type
ctx	SageContext
systemAddress	Address
options?	ReadOptions

Returns

Promise<readonly CelestialBodySnapshot[]>

Example

declare const ctx: SageContext;
declare const systemAddress: Address;
const bodies = await getCelestialBodies(ctx, systemAddress);

---

getCelestialBody()

function getCelestialBody(
   ctx,
   address,
options?): Promise<CelestialBodySnapshot>;

Defined in: packages/sage/src/world/index.ts:369

Reads a required CelestialBody by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise<CelestialBodySnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const body = await getCelestialBody(ctx, address);

---

getCelestialBodyById()

function getCelestialBodyById(
   ctx,
   bodyId,
options?): Promise<CelestialBodySnapshot>;

Defined in: packages/sage/src/world/index.ts:412

Derives and reads a CelestialBody by its Game-scoped numeric id.

Parameters

Parameter	Type
ctx	SageContext
bodyId	number
options?	ReadOptions

Returns

Promise<CelestialBodySnapshot>

Example

declare const ctx: SageContext;
const body = await getCelestialBodyById(ctx, 11);

---

getCelestialBodyCoordinates()

function getCelestialBodyCoordinates(
   ctx,
   bodyAddress,
options?): Promise<WorldCoordinates>;

Defined in: packages/sage/src/world/index.ts:538

Resolves a CelestialBody’s stored StarSystem relation to sector coordinates.

Parameters

Parameter	Type
ctx	SageContext
bodyAddress	Address
options?	ReadOptions

Returns

Promise<WorldCoordinates>

Example

declare const ctx: SageContext;
declare const bodyAddress: Address;
const coordinates = await getCelestialBodyCoordinates(ctx, bodyAddress);

---

getPlanets()

function getPlanets(
   ctx,
   systemAddress,
options?): Promise<readonly PlanetSnapshot[]>;

Defined in: packages/sage/src/world/index.ts:479

Returns only Planet projections in one StarSystem.

Parameters

Parameter	Type
ctx	SageContext
systemAddress	Address
options?	ReadOptions

Returns

Promise<readonly PlanetSnapshot[]>

Example

declare const ctx: SageContext;
declare const systemAddress: Address;
const planets = await getPlanets(ctx, systemAddress);

---

getStarSystem()

function getStarSystem(
   ctx,
   address,
options?): Promise<StarSystemSnapshot>;

Defined in: packages/sage/src/world/index.ts:275

Reads a required StarSystem by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise<StarSystemSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const system = await getStarSystem(ctx, address);

---

getStarSystemById()

function getStarSystemById(
   ctx,
   systemId,
options?): Promise<StarSystemSnapshot>;

Defined in: packages/sage/src/world/index.ts:318

Derives and reads a StarSystem by its Game-scoped numeric id.

Parameters

Parameter	Type
ctx	SageContext
systemId	number
options?	ReadOptions

Returns

Promise<StarSystemSnapshot>

Example

declare const ctx: SageContext;
const system = await getStarSystemById(ctx, 1);

---

getStarSystems()

function getStarSystems(ctx, options?): Promise<readonly StarSystemSnapshot[]>;

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

Discovers all StarSystems for the configured Game with stable targeted filters.

Parameters

Parameter	Type
ctx	SageContext
options	StarSystemDiscoveryOptions

Returns

Promise<readonly StarSystemSnapshot[]>

Example

declare const ctx: SageContext;
const systems = await getStarSystems(ctx);

---

maybeGetCelestialBody()

function maybeGetCelestialBody(
   ctx,
   address,
   options?): Promise<
  | CelestialBodySnapshot
| undefined>;

Defined in: packages/sage/src/world/index.ts:389

Reads an optional CelestialBody by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | CelestialBodySnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const body = await maybeGetCelestialBody(ctx, address);

---

maybeGetStarSystem()

function maybeGetStarSystem(
   ctx,
   address,
   options?): Promise<
  | StarSystemSnapshot
| undefined>;

Defined in: packages/sage/src/world/index.ts:295

Reads an optional StarSystem by account address.

Parameters

Parameter	Type
ctx	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | StarSystemSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const system = await maybeGetStarSystem(ctx, address);