Documentation: 0.5.0 (source: v0.5.0).
# world

Markdown source of https://docs-v0-5-0.atlas-kit-docs.pages.dev/reference/world/ — see https://docs-v0-5-0.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

<a id="asteroidsnapshot"></a>

### AsteroidSnapshot

Defined in: [packages/sage/src/world/index.ts:99](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L99)

Immutable Asteroid projection over a CelestialBody account.

#### Example

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

#### Extends

- `Omit`\<`AsteroidAccountData`, `"system"`\>

#### Properties

<a id="address"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:100](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L100)

<a id="details"></a>

##### details

```ts
readonly details: WorldAsteroidData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:407](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L407)

###### Inherited from

```ts
Omit.details
```

<a id="game"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:393](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L393)

###### Inherited from

```ts
Omit.game
```

<a id="id"></a>

##### id

```ts
readonly id: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:391](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L391)

###### Inherited from

```ts
Omit.id
```

<a id="kind"></a>

##### kind

```ts
readonly kind: "asteroid";
```

Defined in: [packages/sage/src/internal/c4/world.ts:406](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L406)

###### Inherited from

```ts
Omit.kind
```

<a id="lastsyncatunixseconds"></a>

##### lastSyncAtUnixSeconds

```ts
readonly lastSyncAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:396](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L396)

###### Inherited from

```ts
Omit.lastSyncAtUnixSeconds
```

<a id="name"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:392](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L392)

###### Inherited from

```ts
Omit.name
```

<a id="system"></a>

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/world/index.ts:101](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L101)

<a id="systemsequenceid"></a>

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:395](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L395)

###### Inherited from

```ts
Omit.systemSequenceId
```

<a id="version"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:390](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L390)

###### Inherited from

```ts
Omit.version
```

#### Methods

<a id="tojson"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:102](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L102)

###### Returns

`unknown`

***

<a id="planetsnapshot"></a>

### PlanetSnapshot

Defined in: [packages/sage/src/world/index.ts:86](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L86)

Immutable Planet projection over a CelestialBody account.

#### Example

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

#### Extends

- `Omit`\<`PlanetAccountData`, `"system"`\>

#### Properties

<a id="address-1"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:87](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L87)

<a id="details-1"></a>

##### details

```ts
readonly details: WorldPlanetData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:403](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L403)

###### Inherited from

```ts
Omit.details
```

<a id="game-1"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:393](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L393)

###### Inherited from

```ts
Omit.game
```

<a id="id-1"></a>

##### id

```ts
readonly id: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:391](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L391)

###### Inherited from

```ts
Omit.id
```

<a id="kind-1"></a>

##### kind

```ts
readonly kind: "planet";
```

Defined in: [packages/sage/src/internal/c4/world.ts:402](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L402)

###### Inherited from

```ts
Omit.kind
```

<a id="lastsyncatunixseconds-1"></a>

##### lastSyncAtUnixSeconds

```ts
readonly lastSyncAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:396](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L396)

###### Inherited from

```ts
Omit.lastSyncAtUnixSeconds
```

<a id="name-1"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:392](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L392)

###### Inherited from

```ts
Omit.name
```

<a id="system-1"></a>

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/world/index.ts:88](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L88)

<a id="systemsequenceid-1"></a>

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:395](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L395)

###### Inherited from

```ts
Omit.systemSequenceId
```

<a id="version-1"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:390](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L390)

###### Inherited from

```ts
Omit.version
```

#### Methods

<a id="tojson-1"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:89](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L89)

###### Returns

`unknown`

***

<a id="starsystemaccountdata"></a>

### StarSystemAccountData

Defined in: [packages/sage/src/internal/c4/world.ts:308](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L308)

SDK-owned decoded StarSystem data.

#### Example

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

#### Extended by

- [`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)

#### Properties

<a id="celestialbodyaddresses"></a>

##### celestialBodyAddresses

```ts
readonly celestialBodyAddresses: readonly Address[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:317](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L317)

<a id="connections"></a>

##### connections

```ts
readonly connections: readonly WorldConnectionData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:316](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L316)

<a id="coordinates"></a>

##### coordinates

```ts
readonly coordinates: WorldCoordinates;
```

Defined in: [packages/sage/src/internal/c4/world.ts:314](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L314)

<a id="game-2"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:310](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L310)

<a id="name-2"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:312](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L312)

<a id="regionid"></a>

##### regionId?

```ts
readonly optional regionId?: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:313](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L313)

<a id="sequenceid"></a>

##### sequenceId

```ts
readonly sequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:315](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L315)

<a id="starbase"></a>

##### starbase?

```ts
readonly optional starbase?: WorldStarbaseData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:318](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L318)

<a id="systemid"></a>

##### systemId

```ts
readonly systemId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:311](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L311)

<a id="version-2"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:309](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L309)

***

<a id="starsystemsnapshot"></a>

### StarSystemSnapshot

Defined in: [packages/sage/src/world/index.ts:67](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L67)

Immutable, translated StarSystem snapshot including nested shared Starbase data.

#### Example

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

#### Extends

- [`StarSystemAccountData`](/reference/world/#starsystemaccountdata)

#### Extended by

- [`StarSystemView`](/reference/#starsystemview)

#### Properties

<a id="address-2"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L69)

<a id="celestialbodyaddresses-1"></a>

##### celestialBodyAddresses

```ts
readonly celestialBodyAddresses: readonly Address[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:317](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L317)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`celestialBodyAddresses`](/reference/world/#starsystemaccountdata)

<a id="connections-1"></a>

##### connections

```ts
readonly connections: readonly WorldConnectionData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:316](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L316)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`connections`](/reference/world/#starsystemaccountdata)

<a id="coordinates-1"></a>

##### coordinates

```ts
readonly coordinates: WorldCoordinates;
```

Defined in: [packages/sage/src/internal/c4/world.ts:314](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L314)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`coordinates`](/reference/world/#starsystemaccountdata)

<a id="game-3"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:310](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L310)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`game`](/reference/world/#starsystemaccountdata)

<a id="kind-2"></a>

##### kind

```ts
readonly kind: "starSystem";
```

Defined in: [packages/sage/src/world/index.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L68)

<a id="name-3"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:312](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L312)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`name`](/reference/world/#starsystemaccountdata)

<a id="regionid-1"></a>

##### regionId?

```ts
readonly optional regionId?: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:313](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L313)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`regionId`](/reference/world/#starsystemaccountdata)

<a id="sequenceid-1"></a>

##### sequenceId

```ts
readonly sequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:315](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L315)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`sequenceId`](/reference/world/#starsystemaccountdata)

<a id="starbase-1"></a>

##### starbase?

```ts
readonly optional starbase?: WorldStarbaseData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:318](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L318)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`starbase`](/reference/world/#starsystemaccountdata)

<a id="systemid-1"></a>

##### systemId

```ts
readonly systemId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:311](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L311)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`systemId`](/reference/world/#starsystemaccountdata)

<a id="version-3"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:309](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L309)

###### Inherited from

[`StarSystemAccountData`](/reference/world/#starsystemaccountdata).[`version`](/reference/world/#starsystemaccountdata)

#### Methods

<a id="tojson-2"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L70)

###### Returns

`unknown`

***

<a id="worldasteroiddata"></a>

### WorldAsteroidData

Defined in: [packages/sage/src/internal/c4/world.ts:385](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L385)

Fully translated Asteroid projection data.

#### Example

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

#### Properties

<a id="resources"></a>

##### resources

```ts
readonly resources: readonly WorldAsteroidResourceData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:386](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L386)

***

<a id="worldasteroidresourcedata"></a>

### WorldAsteroidResourceData

Defined in: [packages/sage/src/internal/c4/world.ts:371](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L371)

One translated Asteroid resource state.

#### Example

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

#### Properties

<a id="amountmined"></a>

##### amountMined

```ts
readonly amountMined: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:374](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L374)

<a id="cargoid"></a>

##### cargoId

```ts
readonly cargoId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:372](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L372)

<a id="miners"></a>

##### miners

```ts
readonly miners: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:375](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L375)

<a id="richness"></a>

##### richness

```ts
readonly richness: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:373](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L373)

***

<a id="worldclaimstakegroupdata"></a>

### WorldClaimStakeGroupData

Defined in: [packages/sage/src/internal/c4/world.ts:340](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L340)

One translated nested Claim Stake structure group.

#### Example

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

#### Properties

<a id="chronoaddresses"></a>

##### chronoAddresses

```ts
readonly chronoAddresses: readonly Address[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:343](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L343)

<a id="key"></a>

##### key

```ts
readonly key: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:341](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L341)

<a id="offset"></a>

##### offset

```ts
readonly offset: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:342](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L342)

<a id="structures"></a>

##### structures

```ts
readonly structures: readonly WorldStructureData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:344](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L344)

***

<a id="worldconnectioncosts"></a>

### WorldConnectionCosts

Defined in: [packages/sage/src/internal/c4/world.ts:157](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L157)

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

#### Example

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

#### Properties

<a id="cssatlas"></a>

##### cssAtlas

```ts
readonly cssAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:169](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L169)

<a id="cssraw"></a>

##### cssRaw

```ts
readonly cssRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:168](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L168)

<a id="level1atlas"></a>

##### level1Atlas

```ts
readonly level1Atlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:159](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L159)

<a id="level1raw"></a>

##### level1Raw

```ts
readonly level1Raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:158](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L158)

<a id="level2atlas"></a>

##### level2Atlas

```ts
readonly level2Atlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:161](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L161)

<a id="level2raw"></a>

##### level2Raw

```ts
readonly level2Raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:160](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L160)

<a id="level3atlas"></a>

##### level3Atlas

```ts
readonly level3Atlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:163](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L163)

<a id="level3raw"></a>

##### level3Raw

```ts
readonly level3Raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:162](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L162)

<a id="level4atlas"></a>

##### level4Atlas

```ts
readonly level4Atlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:165](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L165)

<a id="level4raw"></a>

##### level4Raw

```ts
readonly level4Raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:164](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L164)

<a id="level5atlas"></a>

##### level5Atlas

```ts
readonly level5Atlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:167](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L167)

<a id="level5raw"></a>

##### level5Raw

```ts
readonly level5Raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:166](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L166)

***

<a id="worldconnectiondata"></a>

### WorldConnectionData

Defined in: [packages/sage/src/internal/c4/world.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L179)

One StarSystem connection keyed by the connected system id.

#### Example

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

#### Properties

<a id="costs"></a>

##### costs

```ts
readonly costs: WorldConnectionCosts;
```

Defined in: [packages/sage/src/internal/c4/world.ts:181](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L181)

<a id="systemid-2"></a>

##### systemId

```ts
readonly systemId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L180)

***

<a id="worldcraftinghabdata"></a>

### WorldCraftingHabData

Defined in: [packages/sage/src/internal/c4/world.ts:265](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L265)

One nested Crafting Hab group retained as shared Starbase data.

#### Example

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

#### Properties

<a id="chronoaddresses-1"></a>

##### chronoAddresses

```ts
readonly chronoAddresses: readonly Address[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:268](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L268)

<a id="key-1"></a>

##### key

```ts
readonly key: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:266](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L266)

<a id="offset-1"></a>

##### offset

```ts
readonly offset: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:267](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L267)

<a id="structures-1"></a>

##### structures

```ts
readonly structures: readonly WorldStructureData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:269](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L269)

***

<a id="worldfixedvalue"></a>

### WorldFixedValue

Defined in: [packages/sage/src/internal/c4/world.ts:117](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L117)

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

#### Example

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

#### Properties

<a id="raw"></a>

##### raw

```ts
readonly raw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:118](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L118)

<a id="value"></a>

##### value

```ts
readonly value: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:119](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L119)

***

<a id="worldplanetdata"></a>

### WorldPlanetData

Defined in: [packages/sage/src/internal/c4/world.ts:354](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L354)

Fully translated Planet projection data.

#### Example

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

#### Properties

<a id="baseclaimstakeplacementfee"></a>

##### baseClaimStakePlacementFee

```ts
readonly baseClaimStakePlacementFee: readonly readonly WorldFixedValue[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:357](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L357)

<a id="baseclaimstakerentrate"></a>

##### baseClaimStakeRentRate

```ts
readonly baseClaimStakeRentRate: readonly readonly WorldFixedValue[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:356](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L356)

<a id="claimedplots"></a>

##### claimedPlots

```ts
readonly claimedPlots: readonly WorldClaimStakeGroupData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:361](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L361)

<a id="claimedplotsunsizedlength"></a>

##### claimedPlotsUnsizedLength

```ts
readonly claimedPlotsUnsizedLength: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:360](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L360)

<a id="claimstakeplots"></a>

##### claimStakePlots

```ts
readonly claimStakePlots: readonly readonly number[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:355](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L355)

<a id="providedtags"></a>

##### providedTags

```ts
readonly providedTags: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:359](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L359)

<a id="resources-1"></a>

##### resources

```ts
readonly resources: readonly WorldPlanetResourceData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:358](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L358)

***

<a id="worldplanetresourcedata"></a>

### WorldPlanetResourceData

Defined in: [packages/sage/src/internal/c4/world.ts:328](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L328)

One translated Planet resource richness value.

#### Example

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

#### Properties

<a id="cargoid-1"></a>

##### cargoId

```ts
readonly cargoId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:329](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L329)

<a id="richness-1"></a>

##### richness

```ts
readonly richness: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:330](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L330)

***

<a id="worldstarbasedata"></a>

### WorldStarbaseData

Defined in: [packages/sage/src/internal/c4/world.ts:279](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L279)

Fully translated nested shared Starbase data.

#### Example

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

#### Properties

<a id="basecraftinghabplacementfee"></a>

##### baseCraftingHabPlacementFee

```ts
readonly baseCraftingHabPlacementFee: readonly readonly WorldFixedValue[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:292](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L292)

<a id="basecraftinghabrentrate"></a>

##### baseCraftingHabRentRate

```ts
readonly baseCraftingHabRentRate: readonly readonly WorldFixedValue[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:291](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L291)

<a id="buildingtags"></a>

##### buildingTags

```ts
readonly buildingTags: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:295](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L295)

<a id="builtdestroyedatunixseconds"></a>

##### builtDestroyedAtUnixSeconds

```ts
readonly builtDestroyedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:289](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L289)

<a id="craftinghabplots"></a>

##### craftingHabPlots

```ts
readonly craftingHabPlots: readonly readonly number[][];
```

Defined in: [packages/sage/src/internal/c4/world.ts:290](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L290)

<a id="craftinghabs"></a>

##### craftingHabs

```ts
readonly craftingHabs: readonly WorldCraftingHabData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:298](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L298)

<a id="craftinghabsunsizedlength"></a>

##### craftingHabsUnsizedLength

```ts
readonly craftingHabsUnsizedLength: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:297](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L297)

<a id="hp"></a>

##### hp

```ts
readonly hp: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:284](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L284)

<a id="lastcombatupdateunixseconds"></a>

##### lastCombatUpdateUnixSeconds

```ts
readonly lastCombatUpdateUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:288](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L288)

<a id="level"></a>

##### level

```ts
readonly level: WorldStarbaseLevel;
```

Defined in: [packages/sage/src/internal/c4/world.ts:281](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L281)

<a id="localmarketenablelevel"></a>

##### localMarketEnableLevel

```ts
readonly localMarketEnableLevel: WorldStarbaseLevel;
```

Defined in: [packages/sage/src/internal/c4/world.ts:282](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L282)

<a id="locationtags"></a>

##### locationTags

```ts
readonly locationTags: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:294](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L294)

<a id="maxlevel"></a>

##### maxLevel

```ts
readonly maxLevel: WorldStarbaseMaxLevelData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:293](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L293)

<a id="owner"></a>

##### owner

```ts
readonly owner: WorldFaction;
```

Defined in: [packages/sage/src/internal/c4/world.ts:280](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L280)

<a id="pendinghp"></a>

##### pendingHp

```ts
readonly pendingHp: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:285](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L285)

<a id="repairenablelevel"></a>

##### repairEnableLevel

```ts
readonly repairEnableLevel: WorldStarbaseLevel;
```

Defined in: [packages/sage/src/internal/c4/world.ts:283](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L283)

<a id="shieldbreakdelayexpiresatunixseconds"></a>

##### shieldBreakDelayExpiresAtUnixSeconds

```ts
readonly shieldBreakDelayExpiresAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:287](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L287)

<a id="sp"></a>

##### sp

```ts
readonly sp: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:286](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L286)

<a id="validrecipeids"></a>

##### validRecipeIds

```ts
readonly validRecipeIds: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:296](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L296)

***

<a id="worldstarbaseleveldata"></a>

### WorldStarbaseLevelData

Defined in: [packages/sage/src/internal/c4/world.ts:228](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L228)

One translated level inside the Starbase maximum-level union.

#### Example

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

#### Properties

<a id="info"></a>

##### info

```ts
readonly info: WorldStarbaseLevelInfoData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:230](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L230)

<a id="level-1"></a>

##### level

```ts
readonly level: WorldStarbaseLevel;
```

Defined in: [packages/sage/src/internal/c4/world.ts:229](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L229)

<a id="upgrades"></a>

##### upgrades

```ts
readonly upgrades: readonly WorldStarbaseUpgradeData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:231](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L231)

***

<a id="worldstarbaselevelinfodata"></a>

### WorldStarbaseLevelInfoData

Defined in: [packages/sage/src/internal/c4/world.ts:191](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L191)

Fully translated combat/economy values for one Starbase level.

#### Example

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

#### Properties

<a id="damageperround"></a>

##### damagePerRound

```ts
readonly damagePerRound: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:203](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L203)

<a id="hp-1"></a>

##### hp

```ts
readonly hp: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:192](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L192)

<a id="repairability"></a>

##### repairAbility

```ts
readonly repairAbility: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:198](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L198)

<a id="repaircost"></a>

##### repairCost

```ts
readonly repairCost: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:200](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L200)

<a id="repairefficiency"></a>

##### repairEfficiency

```ts
readonly repairEfficiency: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:199](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L199)

<a id="repairfeeatlas"></a>

##### repairFeeAtlas

```ts
readonly repairFeeAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:202](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L202)

<a id="repairfeeraw"></a>

##### repairFeeRaw

```ts
readonly repairFeeRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:201](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L201)

<a id="repairrate"></a>

##### repairRate

```ts
readonly repairRate: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:197](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L197)

<a id="shieldbreakdelayseconds"></a>

##### shieldBreakDelaySeconds

```ts
readonly shieldBreakDelaySeconds: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:195](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L195)

<a id="shieldrechargerate"></a>

##### shieldRechargeRate

```ts
readonly shieldRechargeRate: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:196](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L196)

<a id="sp-1"></a>

##### sp

```ts
readonly sp: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:193](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L193)

<a id="xp"></a>

##### xp

```ts
readonly xp: WorldFixedValue;
```

Defined in: [packages/sage/src/internal/c4/world.ts:194](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L194)

***

<a id="worldstarbasemaxleveldata"></a>

### WorldStarbaseMaxLevelData

Defined in: [packages/sage/src/internal/c4/world.ts:241](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L241)

Plain replacement for the generated StarbaseMaxLevel union.

#### Example

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

#### Properties

<a id="kind-3"></a>

##### kind

```ts
readonly kind: WorldStarbaseLevel;
```

Defined in: [packages/sage/src/internal/c4/world.ts:242](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L242)

<a id="levels"></a>

##### levels

```ts
readonly levels: readonly WorldStarbaseLevelData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:243](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L243)

***

<a id="worldstarbaseupgradedata"></a>

### WorldStarbaseUpgradeData

Defined in: [packages/sage/src/internal/c4/world.ts:213](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L213)

One cargo deposit requirement for an intermediate Starbase level.

#### Example

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

#### Properties

<a id="cargoid-2"></a>

##### cargoId

```ts
readonly cargoId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:214](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L214)

<a id="crew"></a>

##### crew

```ts
readonly crew: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:217](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L217)

<a id="deposited"></a>

##### deposited

```ts
readonly deposited: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:216](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L216)

<a id="durationseconds"></a>

##### durationSeconds

```ts
readonly durationSeconds: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:218](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L218)

<a id="needed"></a>

##### needed

```ts
readonly needed: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:215](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L215)

***

<a id="worldstructuredata"></a>

### WorldStructureData

Defined in: [packages/sage/src/internal/c4/world.ts:253](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L253)

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

#### Example

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

#### Properties

<a id="address-3"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:254](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L254)

<a id="deactivationtimeunixseconds"></a>

##### deactivationTimeUnixSeconds

```ts
readonly deactivationTimeUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:255](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L255)

## Type Aliases

<a id="celestialbodysnapshot"></a>

### CelestialBodySnapshot

```ts
type CelestialBodySnapshot = 
  | PlanetSnapshot
  | AsteroidSnapshot;
```

Defined in: [packages/sage/src/world/index.ts:112](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L112)

A translated CelestialBody snapshot projected as a Planet or Asteroid.

#### Example

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

***

<a id="starsystemdiscoveryoptions"></a>

### StarSystemDiscoveryOptions

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

Defined in: [packages/sage/src/world/index.ts:55](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L55)

Options supported by galaxy-scale StarSystem discovery.

#### Example

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

***

<a id="worldfaction"></a>

### WorldFaction

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

Defined in: [packages/sage/src/internal/c4/world.ts:139](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L139)

Human-readable faction labels used by shared Starbase data.

#### Example

```ts
const faction: WorldFaction = 'mud';
```

***

<a id="worldstarbaselevel"></a>

### WorldStarbaseLevel

```ts
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](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/c4/world.ts#L147)

Human-readable Starbase level labels.

#### Example

```ts
const level: WorldStarbaseLevel = 'level-1';
```

## Functions

<a id="distancebetweenstarsystems"></a>

### distanceBetweenStarSystems()

```ts
function distanceBetweenStarSystems(from, to): number;
```

Defined in: [packages/sage/src/world/index.ts:523](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L523)

Returns Euclidean distance between two SAGE coordinates.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `from` | [`WorldCoordinates`](/reference/fleets/#worldcoordinates) |
| `to` | [`WorldCoordinates`](/reference/fleets/#worldcoordinates) |

#### Returns

`number`

#### Example

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

***

<a id="findcelestialbodypda"></a>

### findCelestialBodyPda()

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

Defined in: [packages/sage/src/world/index.ts:260](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L260)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `game` | [`Address`](/reference/#address-19) |
| `bodyId` | `number` |

#### Returns

`Promise`\<[`Address`](/reference/#address-19)\>

#### Example

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

***

<a id="findstarsystempda"></a>

### findStarSystemPda()

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

Defined in: [packages/sage/src/world/index.ts:246](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L246)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `game` | [`Address`](/reference/#address-19) |
| `systemId` | `number` |

#### Returns

`Promise`\<[`Address`](/reference/#address-19)\>

#### Example

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

***

<a id="getasteroids"></a>

### getAsteroids()

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

Defined in: [packages/sage/src/world/index.ts:502](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L502)

Returns only Asteroid projections in one StarSystem.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `systemAddress` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<readonly [`AsteroidSnapshot`](/reference/world/#asteroidsnapshot)[]\>

#### Example

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

***

<a id="getcelestialbodies"></a>

### getCelestialBodies()

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

Defined in: [packages/sage/src/world/index.ts:441](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L441)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `systemAddress` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<readonly [`CelestialBodySnapshot`](/reference/world/#celestialbodysnapshot)[]\>

#### Example

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

***

<a id="getcelestialbody"></a>

### getCelestialBody()

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

Defined in: [packages/sage/src/world/index.ts:369](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L369)

Reads a required CelestialBody by account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`CelestialBodySnapshot`](/reference/world/#celestialbodysnapshot)\>

#### Example

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

***

<a id="getcelestialbodybyid"></a>

### getCelestialBodyById()

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

Defined in: [packages/sage/src/world/index.ts:412](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L412)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `bodyId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`CelestialBodySnapshot`](/reference/world/#celestialbodysnapshot)\>

#### Example

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

***

<a id="getcelestialbodycoordinates"></a>

### getCelestialBodyCoordinates()

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

Defined in: [packages/sage/src/world/index.ts:538](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L538)

Resolves a CelestialBody's stored StarSystem relation to its coordinates.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `bodyAddress` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`WorldCoordinates`](/reference/fleets/#worldcoordinates)\>

#### Example

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

***

<a id="getplanets"></a>

### getPlanets()

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

Defined in: [packages/sage/src/world/index.ts:479](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L479)

Returns only Planet projections in one StarSystem.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `systemAddress` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<readonly [`PlanetSnapshot`](/reference/world/#planetsnapshot)[]\>

#### Example

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

***

<a id="getstarsystem"></a>

### getStarSystem()

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

Defined in: [packages/sage/src/world/index.ts:275](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L275)

Reads a required StarSystem by account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)\>

#### Example

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

***

<a id="getstarsystembyid"></a>

### getStarSystemById()

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

Defined in: [packages/sage/src/world/index.ts:318](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L318)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `systemId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)\>

#### Example

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

***

<a id="getstarsystems"></a>

### getStarSystems()

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

Defined in: [packages/sage/src/world/index.ts:344](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L344)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `options` | [`StarSystemDiscoveryOptions`](/reference/world/#starsystemdiscoveryoptions) |

#### Returns

`Promise`\<readonly [`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)[]\>

#### Example

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

***

<a id="maybegetcelestialbody"></a>

### maybeGetCelestialBody()

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

Defined in: [packages/sage/src/world/index.ts:389](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L389)

Reads an optional CelestialBody by account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`CelestialBodySnapshot`](/reference/world/#celestialbodysnapshot)
  \| `undefined`\>

#### Example

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

***

<a id="maybegetstarsystem"></a>

### maybeGetStarSystem()

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

Defined in: [packages/sage/src/world/index.ts:295](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/world/index.ts#L295)

Reads an optional StarSystem by account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)
  \| `undefined`\>

#### Example

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

## References

<a id="worldcoordinates"></a>

### WorldCoordinates

Re-exports [WorldCoordinates](/reference/fleets/#worldcoordinates)