# factions
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

Markdown source of https://develop.atlas-kit-docs.pages.dev/reference/factions/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

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

### FactionConfigSnapshot

Defined in: [packages/sage/src/factions/index.ts:116](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L116)

Immutable optional standing and territory-yield configuration.

#### Example

```ts
declare const config: FactionConfigSnapshot;
console.log(config.standingBps);
```

#### Extends

- `FactionConfigAccountData`

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:118](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L118)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:112](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L112)

###### Inherited from

```ts
FactionConfigAccountData.bump
```

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

##### dailyCap

```ts
readonly dailyCap: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:114](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L114)

###### Inherited from

```ts
FactionConfigAccountData.dailyCap
```

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

##### decayPerDay

```ts
readonly decayPerDay: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:113](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L113)

###### Inherited from

```ts
FactionConfigAccountData.decayPerDay
```

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

##### diminishingReturnsHalfLifeRaw

```ts
readonly diminishingReturnsHalfLifeRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:116](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L116)

###### Inherited from

```ts
FactionConfigAccountData.diminishingReturnsHalfLifeRaw
```

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

##### diminishingReturnsScaleRaw

```ts
readonly diminishingReturnsScaleRaw: bigint;
```

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

###### Inherited from

```ts
FactionConfigAccountData.diminishingReturnsScaleRaw
```

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

##### dockMinimumBand

```ts
readonly dockMinimumBand: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:120](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L120)

###### Inherited from

```ts
FactionConfigAccountData.dockMinimumBand
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:119](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L119)

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

##### kind

```ts
readonly kind: "factionConfig";
```

Defined in: [packages/sage/src/factions/index.ts:117](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L117)

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

##### standingBps

```ts
readonly standingBps: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:115](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L115)

###### Inherited from

```ts
FactionConfigAccountData.standingBps
```

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

##### standingEpochCap

```ts
readonly standingEpochCap: number;
```

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

###### Inherited from

```ts
FactionConfigAccountData.standingEpochCap
```

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

##### standingEpochLengthSeconds

```ts
readonly standingEpochLengthSeconds: bigint;
```

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

###### Inherited from

```ts
FactionConfigAccountData.standingEpochLengthSeconds
```

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

##### territoryYieldPerTick

```ts
readonly territoryYieldPerTick: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L121)

###### Inherited from

```ts
FactionConfigAccountData.territoryYieldPerTick
```

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

##### territoryYieldTickSeconds

```ts
readonly territoryYieldTickSeconds: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L122)

###### Inherited from

```ts
FactionConfigAccountData.territoryYieldTickSeconds
```

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:111](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L111)

###### Inherited from

```ts
FactionConfigAccountData.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:120](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L120)

###### Returns

`unknown`

***

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

### FactionEconomicsSnapshot

Defined in: [packages/sage/src/factions/index.ts:131](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L131)

Immutable per-Game NPC and capture economics.

#### Example

```ts
declare const economics: FactionEconomicsSnapshot;
console.log(economics.captureCostAtlas); // ATLAS for display
console.log(economics.captureCostAtlasRaw); // exact Floyds for arithmetic
```

#### Extends

- `Omit`\<`FactionEconomicsConfigAccountData`, `"game"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:136](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L136)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:127](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L127)

###### Inherited from

```ts
Omit.bump
```

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

##### captureCostAtlas

```ts
readonly captureCostAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:136](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L136)

Dynamic-capture cost in ATLAS.

###### Inherited from

```ts
Omit.captureCostAtlas
```

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

##### captureCostAtlasRaw

```ts
readonly captureCostAtlasRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:134](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L134)

Exact dynamic-capture cost in ATLAS Floyds.

###### Inherited from

```ts
Omit.captureCostAtlasRaw
```

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

##### factionCaptureCooldownSeconds

```ts
readonly factionCaptureCooldownSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:137](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L137)

###### Inherited from

```ts
Omit.factionCaptureCooldownSeconds
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:137](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L137)

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

##### kind

```ts
readonly kind: "factionEconomicsConfig";
```

Defined in: [packages/sage/src/factions/index.ts:135](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L135)

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

##### npcMintCostAtlas

```ts
readonly npcMintCostAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:130](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L130)

###### Inherited from

```ts
Omit.npcMintCostAtlas
```

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

##### npcMintCostAtlasRaw

```ts
readonly npcMintCostAtlasRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L129)

###### Inherited from

```ts
Omit.npcMintCostAtlasRaw
```

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

##### npcRespawnCostAtlas

```ts
readonly npcRespawnCostAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:132](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L132)

###### Inherited from

```ts
Omit.npcRespawnCostAtlas
```

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

##### npcRespawnCostAtlasRaw

```ts
readonly npcRespawnCostAtlasRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:131](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L131)

###### Inherited from

```ts
Omit.npcRespawnCostAtlasRaw
```

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:126](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L126)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:138](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L138)

###### Returns

`unknown`

***

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

### FactionOwnershipSnapshot

Defined in: [packages/sage/src/factions/index.ts:218](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L218)

Immutable dynamic ownership sidecar for one territory asset.
A Starbase sidecar always carries `capturedSystemSequenceId`, the Star
System generation at capture; generation 0 is valid. A sidecar is current
only while that equals the System's `sequenceId`. Fleet and Region sidecars
omit it. An absent `controllingFactionId` means the legacy Starbase owner
controls.

#### Example

```ts
declare const ownership: FactionOwnershipSnapshot;
console.log(ownership.asset.kind, ownership.controllingFactionId);
```

#### Extends

- `Omit`\<`FactionOwnershipAccountData`, 
  \| `"game"`
  \| `"asset"`
  \| `"controllingFactionId"`
  \| `"previousControllerFactionId"`
  \| `"contestedUntilUnixSeconds"`
  \| `"capturedSystemSequenceId"`
  \| `"lastYieldTickUnixSeconds"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:229](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L229)

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

##### asset

```ts
readonly asset: FactionOwnershipTarget;
```

Defined in: [packages/sage/src/factions/index.ts:231](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L231)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:189](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L189)

###### Inherited from

```ts
Omit.bump
```

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

##### capturedAtUnixSeconds

```ts
readonly capturedAtUnixSeconds: bigint;
```

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

###### Inherited from

```ts
Omit.capturedAtUnixSeconds
```

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

##### capturedSystemSequenceId?

```ts
readonly optional capturedSystemSequenceId?: bigint;
```

Defined in: [packages/sage/src/factions/index.ts:235](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L235)

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

##### contestedUntilUnixSeconds?

```ts
readonly optional contestedUntilUnixSeconds?: bigint;
```

Defined in: [packages/sage/src/factions/index.ts:234](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L234)

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

##### controllingFactionId?

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

Defined in: [packages/sage/src/factions/index.ts:232](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L232)

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:230](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L230)

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

##### kind

```ts
readonly kind: "factionOwnership";
```

Defined in: [packages/sage/src/factions/index.ts:228](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L228)

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

##### lastYieldTickUnixSeconds?

```ts
readonly optional lastYieldTickUnixSeconds?: bigint;
```

Defined in: [packages/sage/src/factions/index.ts:236](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L236)

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

##### previousControllerFactionId?

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

Defined in: [packages/sage/src/factions/index.ts:233](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L233)

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:188](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L188)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:237](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L237)

###### Returns

`unknown`

***

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

### FactionRelationsSnapshot

Defined in: [packages/sage/src/factions/index.ts:148](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L148)

Immutable diplomacy and territory-gating configuration.

#### Example

```ts
declare const relations: FactionRelationsSnapshot;
console.log(relations.dynamicCaptureEnabled);
```

#### Extends

- `Omit`\<`FactionRelationTrackerAccountData`, `"game"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L153)

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

##### alliedTollBps

```ts
readonly alliedTollBps: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:147](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L147)

###### Inherited from

```ts
Omit.alliedTollBps
```

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:142](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L142)

###### Inherited from

```ts
Omit.bump
```

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

##### ceasefireMinimumDurationSeconds

```ts
readonly ceasefireMinimumDurationSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:149](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L149)

###### Inherited from

```ts
Omit.ceasefireMinimumDurationSeconds
```

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

##### combatGatingEnabled

```ts
readonly combatGatingEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:144](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L144)

###### Inherited from

```ts
Omit.combatGatingEnabled
```

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

##### contestedWindowSeconds

```ts
readonly contestedWindowSeconds: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:152](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L152)

###### Inherited from

```ts
Omit.contestedWindowSeconds
```

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

##### crossFactionEconomicsEnabled

```ts
readonly crossFactionEconomicsEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:146](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L146)

###### Inherited from

```ts
Omit.crossFactionEconomicsEnabled
```

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

##### dynamicCaptureEnabled

```ts
readonly dynamicCaptureEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L151)

###### Inherited from

```ts
Omit.dynamicCaptureEnabled
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L154)

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

##### kind

```ts
readonly kind: "factionRelationTracker";
```

Defined in: [packages/sage/src/factions/index.ts:152](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L152)

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

##### nemesisActive

```ts
readonly nemesisActive: boolean;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L153)

###### Inherited from

```ts
Omit.nemesisActive
```

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

##### neutralTollBps

```ts
readonly neutralTollBps: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:148](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L148)

###### Inherited from

```ts
Omit.neutralTollBps
```

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

##### reCeasefireCooldownSeconds

```ts
readonly reCeasefireCooldownSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:150](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L150)

###### Inherited from

```ts
Omit.reCeasefireCooldownSeconds
```

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

##### relations

```ts
readonly relations: readonly {
  ceasefireUntilUnixSeconds: bigint | null;
  factions: readonly [number, number];
  relationship: FactionRelationship;
}[];
```

Defined in: [packages/sage/src/internal/c4/factions.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L154)

###### Inherited from

```ts
Omit.relations
```

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

##### territoryAccessEnabled

```ts
readonly territoryAccessEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:145](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L145)

###### Inherited from

```ts
Omit.territoryAccessEnabled
```

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:141](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L141)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:155](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L155)

###### Returns

`unknown`

***

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

### FactionSnapshot

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

Immutable faction identity, lifecycle, and NPC capacity state.

#### Example

```ts
declare const faction: FactionSnapshot;
console.log(faction.factionId, faction.status);
```

#### Extends

- `Omit`\<`FactionAccountData`, 
  \| `"game"`
  \| `"operatorProfile"`
  \| `"controller"`
  \| `"homeRegionId"`
  \| `"nameHash"`
  \| `"contentUriHash"`
  \| `"lastCaptureAtUnixSeconds"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:98](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L98)

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

##### alignment

```ts
readonly alignment: FactionAlignment;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:93](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L93)

###### Inherited from

```ts
Omit.alignment
```

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

##### authorityBump

```ts
readonly authorityBump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:96](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L96)

###### Inherited from

```ts
Omit.authorityBump
```

<a id="bump-4"></a>

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:90](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L90)

###### Inherited from

```ts
Omit.bump
```

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

##### capabilityFlags

```ts
readonly capabilityFlags: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L94)

###### Inherited from

```ts
Omit.capabilityFlags
```

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

##### contentUriHash?

```ts
readonly optional contentUriHash?: readonly number[];
```

Defined in: [packages/sage/src/factions/index.ts:104](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L104)

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

##### controller?

```ts
readonly optional controller?: Address;
```

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

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

##### createdAtUnixSeconds

```ts
readonly createdAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:103](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L103)

###### Inherited from

```ts
Omit.createdAtUnixSeconds
```

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

##### factionId

```ts
readonly factionId: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:92](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L92)

###### Inherited from

```ts
Omit.factionId
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

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

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

##### homeRegionId?

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

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

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

##### kind

```ts
readonly kind: "faction";
```

Defined in: [packages/sage/src/factions/index.ts:97](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L97)

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

##### lastCaptureAtUnixSeconds?

```ts
readonly optional lastCaptureAtUnixSeconds?: bigint;
```

Defined in: [packages/sage/src/factions/index.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L105)

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

##### maxAllies

```ts
readonly maxAllies: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:98](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L98)

###### Inherited from

```ts
Omit.maxAllies
```

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

##### maxNpcFleets

```ts
readonly maxNpcFleets: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L107)

###### Inherited from

```ts
Omit.maxNpcFleets
```

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

##### nameHash?

```ts
readonly optional nameHash?: readonly number[];
```

Defined in: [packages/sage/src/factions/index.ts:103](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L103)

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

##### npcFleetCount

```ts
readonly npcFleetCount: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L106)

###### Inherited from

```ts
Omit.npcFleetCount
```

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

##### operatorProfile?

```ts
readonly optional operatorProfile?: EntityRef<"profile">;
```

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

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

##### status

```ts
readonly status: FactionLifecycleStatus;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:95](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L95)

###### Inherited from

```ts
Omit.status
```

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

##### treasuryCount

```ts
readonly treasuryCount: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:99](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L99)

###### Inherited from

```ts
Omit.treasuryCount
```

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:89](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L89)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L106)

###### Returns

`unknown`

***

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

### FactionStandingSnapshot

Defined in: [packages/sage/src/factions/index.ts:165](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L165)

Immutable optional Profile standing with one faction.

#### Example

```ts
declare const standing: FactionStandingSnapshot;
console.log(standing.profile.address, standing.standing);
```

#### Extends

- `Omit`\<`FactionStandingAccountData`, `"game"` \| `"profile"` \| `"storylineExpiresAtUnixSeconds"`\>

#### Properties

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

##### accrualToday

```ts
readonly accrualToday: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:171](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L171)

###### Inherited from

```ts
Omit.accrualToday
```

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:170](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L170)

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

##### bandFloor

```ts
readonly bandFloor: number;
```

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

###### Inherited from

```ts
Omit.bandFloor
```

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

##### bandFloorReachedAtUnixSeconds

```ts
readonly bandFloorReachedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:174](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L174)

###### Inherited from

```ts
Omit.bandFloorReachedAtUnixSeconds
```

<a id="bump-5"></a>

##### bump

```ts
readonly bump: number;
```

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

###### Inherited from

```ts
Omit.bump
```

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

##### dayAnchorUnixSeconds

```ts
readonly dayAnchorUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L172)

###### Inherited from

```ts
Omit.dayAnchorUnixSeconds
```

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

##### factionId

```ts
readonly factionId: number;
```

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

###### Inherited from

```ts
Omit.factionId
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:171](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L171)

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

##### kind

```ts
readonly kind: "factionStanding";
```

Defined in: [packages/sage/src/factions/index.ts:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L169)

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

##### lastUpdateUnixSeconds

```ts
readonly lastUpdateUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:173](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L173)

###### Inherited from

```ts
Omit.lastUpdateUnixSeconds
```

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

##### lifetimeEarnedRaw

```ts
readonly lifetimeEarnedRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:170](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L170)

###### Inherited from

```ts
Omit.lifetimeEarnedRaw
```

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

##### profile

```ts
readonly profile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/factions/index.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L172)

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

##### standing

```ts
readonly standing: number;
```

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

###### Inherited from

```ts
Omit.standing
```

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

##### storylineActive

```ts
readonly storylineActive: boolean;
```

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

###### Inherited from

```ts
Omit.storylineActive
```

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

##### storylineExpiresAtUnixSeconds?

```ts
readonly optional storylineExpiresAtUnixSeconds?: bigint;
```

Defined in: [packages/sage/src/factions/index.ts:173](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L173)

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:174](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L174)

###### Returns

`unknown`

***

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

### FactionTreasurySnapshot

Defined in: [packages/sage/src/factions/index.ts:184](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L184)

Immutable faction ATLAS and cargo reserve state.

#### Example

```ts
declare const treasury: FactionTreasurySnapshot;
console.log(treasury.atlasBalance, treasury.reserves.length);
```

#### Extends

- `Omit`\<`FactionTreasuryAccountData`, `"game"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:189](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L189)

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

##### atlasBalance

```ts
readonly atlasBalance: number;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:23](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L23)

###### Inherited from

```ts
Omit.atlasBalance
```

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

##### atlasBalanceRaw

```ts
readonly atlasBalanceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:22](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L22)

###### Inherited from

```ts
Omit.atlasBalanceRaw
```

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

##### atlasOutCapPerEpoch

```ts
readonly atlasOutCapPerEpoch: number;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:29](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L29)

###### Inherited from

```ts
Omit.atlasOutCapPerEpoch
```

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

##### atlasOutCapPerEpochRaw

```ts
readonly atlasOutCapPerEpochRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:28](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L28)

###### Inherited from

```ts
Omit.atlasOutCapPerEpochRaw
```

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

##### atlasOutThisEpoch

```ts
readonly atlasOutThisEpoch: number;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:27](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L27)

###### Inherited from

```ts
Omit.atlasOutThisEpoch
```

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

##### atlasOutThisEpochRaw

```ts
readonly atlasOutThisEpochRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:26](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L26)

###### Inherited from

```ts
Omit.atlasOutThisEpochRaw
```

<a id="bump-6"></a>

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:19](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L19)

###### Inherited from

```ts
Omit.bump
```

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

##### epochLengthSeconds

```ts
readonly epochLengthSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:25](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L25)

###### Inherited from

```ts
Omit.epochLengthSeconds
```

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

##### epochStartedAtUnixSeconds

```ts
readonly epochStartedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:24](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L24)

###### Inherited from

```ts
Omit.epochStartedAtUnixSeconds
```

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

##### factionId

```ts
readonly factionId: number;
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:21](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L21)

###### Inherited from

```ts
Omit.factionId
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:190](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L190)

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

##### kind

```ts
readonly kind: "factionTreasury";
```

Defined in: [packages/sage/src/factions/index.ts:188](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L188)

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

##### reserves

```ts
readonly reserves: readonly {
  cargoId: number;
  floorRaw: bigint;
  quantityRaw: bigint;
}[];
```

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:30](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L30)

###### Inherited from

```ts
Omit.reserves
```

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

##### version

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

Defined in: [packages/sage/src/internal/c4/faction-treasury.ts:18](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/faction-treasury.ts#L18)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:191](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L191)

###### Returns

`unknown`

***

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

### KingSystemOwnership

Defined in: [packages/sage/src/factions/index.ts:247](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L247)

One King system with its current effective faction owner.

#### Example

```ts
declare const system: KingSystemOwnership;
console.log(system.system.address, system.factionId);
```

#### Properties

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

##### factionId?

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

Defined in: [packages/sage/src/factions/index.ts:250](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L250)

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

##### system

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

Defined in: [packages/sage/src/factions/index.ts:249](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L249)

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

##### systemId

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

Defined in: [packages/sage/src/factions/index.ts:248](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L248)

***

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

### KingSystemsSnapshot

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

Immutable King-system ownership catalog.

#### Example

```ts
declare const tracker: KingSystemsSnapshot;
console.log(tracker.systems.length);
```

#### Extends

- `Omit`\<`KingSystemTrackerAccountData`, `"game"` \| `"systems"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:265](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L265)

<a id="bump-7"></a>

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:204](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L204)

###### Inherited from

```ts
Omit.bump
```

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

##### configuredAtUnixSeconds

```ts
readonly configuredAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:206](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L206)

###### Inherited from

```ts
Omit.configuredAtUnixSeconds
```

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:266](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L266)

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

##### kind

```ts
readonly kind: "kingSystemTracker";
```

Defined in: [packages/sage/src/factions/index.ts:264](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L264)

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

##### majorFactionCounts

```ts
readonly majorFactionCounts: Readonly<{
  mud: number;
  oni: number;
  ustur: number;
}>;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:207](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L207)

###### Inherited from

```ts
Omit.majorFactionCounts
```

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

##### systems

```ts
readonly systems: readonly KingSystemOwnership[];
```

Defined in: [packages/sage/src/factions/index.ts:267](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L267)

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:268](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L268)

###### Returns

`unknown`

***

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

### ProfileFactionSnapshot

Defined in: [packages/sage/src/factions/profile-faction.ts:33](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L33)

Immutable faction enrollment associated with a Profile across Games.

#### Example

```ts
declare const enrollment: ProfileFactionSnapshot;
console.log(enrollment.profile.address, enrollment.faction);
```

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/profile-faction.ts:35](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L35)

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

##### faction

```ts
readonly faction: ProfileFactionAlignment;
```

Defined in: [packages/sage/src/factions/profile-faction.ts:37](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L37)

<a id="factionid-4"></a>

##### factionId

```ts
readonly factionId: number;
```

Defined in: [packages/sage/src/factions/profile-faction.ts:38](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L38)

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

##### kind

```ts
readonly kind: "profileFaction";
```

Defined in: [packages/sage/src/factions/profile-faction.ts:34](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L34)

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

##### profile

```ts
readonly profile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/factions/profile-faction.ts:36](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L36)

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

##### version

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

Defined in: [packages/sage/src/factions/profile-faction.ts:39](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L39)

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/profile-faction.ts:40](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L40)

###### Returns

`unknown`

***

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

### TerritoryRegionsSnapshot

Defined in: [packages/sage/src/factions/index.ts:306](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L306)

Immutable nested RegionTracker ownership catalog.

#### Example

```ts
declare const tracker: TerritoryRegionsSnapshot;
console.log(tracker.regions.length);
```

#### Extends

- `Omit`\<`RegionTrackerAccountData`, `"game"` \| `"regions"`\>

#### Properties

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

##### address

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

Defined in: [packages/sage/src/factions/index.ts:311](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L311)

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/factions/index.ts:312](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L312)

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

##### gridExponent

```ts
readonly gridExponent: number;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:258](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L258)

###### Inherited from

```ts
Omit.gridExponent
```

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

##### kind

```ts
readonly kind: "regionTracker";
```

Defined in: [packages/sage/src/factions/index.ts:310](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L310)

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

##### regions

```ts
readonly regions: readonly TerritoryRegionSummary[];
```

Defined in: [packages/sage/src/factions/index.ts:313](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L313)

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

##### version

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

Defined in: [packages/sage/src/internal/c4/factions.ts:256](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L256)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

Defined in: [packages/sage/src/factions/index.ts:314](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L314)

###### Returns

`unknown`

***

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

### TerritoryRegionSummary

Defined in: [packages/sage/src/factions/index.ts:291](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L291)

Region ownership and geometry summary with edge-aligned neighbor ids.

#### Example

```ts
declare const region: TerritoryRegionSummary;
console.log(region.id, region.owner);
```

#### Extends

- `Omit`\<`FactionRegionData`, `"systems"` \| `"coreSystems"`\>

#### Properties

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

##### border

```ts
readonly border: readonly {
  x: number;
  y: number;
}[];
```

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

###### Inherited from

```ts
Omit.border
```

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

##### boundingBox

```ts
readonly boundingBox: {
  maxX: number;
  maxY: number;
  minX: number;
  minY: number;
};
```

Defined in: [packages/sage/src/internal/c4/factions.ts:237](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L237)

###### maxX

```ts
readonly maxX: number;
```

###### maxY

```ts
readonly maxY: number;
```

###### minX

```ts
readonly minX: number;
```

###### minY

```ts
readonly minY: number;
```

###### Inherited from

```ts
Omit.boundingBox
```

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

##### connections

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

Defined in: [packages/sage/src/internal/c4/factions.ts:248](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L248)

###### Inherited from

```ts
Omit.connections
```

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

##### coreSystems

```ts
readonly coreSystems: readonly TerritoryRegionSystem[];
```

Defined in: [packages/sage/src/factions/index.ts:296](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L296)

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

##### id

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

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

###### Inherited from

```ts
Omit.id
```

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

##### miningResearchRequirementTagIds

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

Defined in: [packages/sage/src/internal/c4/factions.ts:252](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L252)

###### Inherited from

```ts
Omit.miningResearchRequirementTagIds
```

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

##### name

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

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

###### Inherited from

```ts
Omit.name
```

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

##### neighborsByEdge

```ts
readonly neighborsByEdge: readonly (number | null)[];
```

Defined in: [packages/sage/src/internal/c4/factions.ts:247](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L247)

###### Inherited from

```ts
Omit.neighborsByEdge
```

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

##### owner

```ts
readonly owner: FactionAlignment;
```

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

###### Inherited from

```ts
Omit.owner
```

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

##### risk

```ts
readonly risk: 
  | {
  faction: FactionAlignment;
  kind: "low";
}
  | {
  kind: "medium" | "high";
};
```

Defined in: [packages/sage/src/internal/c4/factions.ts:233](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L233)

###### Inherited from

```ts
Omit.risk
```

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

##### safety

```ts
readonly safety: "safe" | "border";
```

Defined in: [packages/sage/src/internal/c4/factions.ts:232](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L232)

###### Inherited from

```ts
Omit.safety
```

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

##### scanningResearchRequirementTagIds

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

Defined in: [packages/sage/src/internal/c4/factions.ts:251](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L251)

###### Inherited from

```ts
Omit.scanningResearchRequirementTagIds
```

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

##### systems

```ts
readonly systems: readonly TerritoryRegionSystem[];
```

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

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

##### xpMultiplier

```ts
readonly xpMultiplier: FactionFixedValueData;
```

Defined in: [packages/sage/src/internal/c4/factions.ts:236](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L236)

###### Inherited from

```ts
Omit.xpMultiplier
```

***

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

### TerritoryRegionSystem

Defined in: [packages/sage/src/factions/index.ts:278](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L278)

Compact region system ownership linked to a StarSystem reference.

#### Example

```ts
declare const system: TerritoryRegionSystem;
console.log(system.systemId, system.faction);
```

#### Properties

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

##### faction

```ts
readonly faction: FactionAlignment;
```

Defined in: [packages/sage/src/factions/index.ts:281](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L281)

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

##### system

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

Defined in: [packages/sage/src/factions/index.ts:280](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L280)

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

##### systemId

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

Defined in: [packages/sage/src/factions/index.ts:279](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L279)

## Type Aliases

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

### FactionOwnershipAsset

```ts
type FactionOwnershipAsset = 
  | {
  address: Address;
  kind: Exclude<FactionOwnershipKind, "region">;
}
  | {
  kind: "region";
  regionId: number;
};
```

Defined in: [packages/sage/src/factions/index.ts:73](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L73)

A requested asset whose optional ownership sidecar can be derived.

#### Example

```ts
declare const address: Address;
const asset: FactionOwnershipAsset = { kind: 'fleet', address };
```

***

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

### FactionOwnershipDiscoveryOptions

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

Defined in: [packages/sage/src/factions/index.ts:61](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L61)

Options accepted by targeted FactionOwnership discovery.

#### Example

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

***

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

### FactionOwnershipTarget

```ts
type FactionOwnershipTarget = 
  | {
  kind: "starbase";
  system: EntityRef<"starSystem">;
}
  | {
  fleet: EntityRef<"fleet">;
  kind: "fleet";
}
  | {
  kind: "region";
  regionId: number;
};
```

Defined in: [packages/sage/src/factions/index.ts:201](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L201)

Typed ownership target retaining the underlying capability reference.

#### Example

```ts
declare const asset: FactionOwnershipTarget;
console.log(asset.kind);
```

***

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

### ProfileFactionAlignment

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

Defined in: [packages/sage/src/factions/profile-faction.ts:24](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L24)

Stored Profile enrollment, including unaligned state that the initial-choice planner does not offer.

#### Example

```ts
const alignment: ProfileFactionAlignment = 'ustur';
```

## Functions

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

### getFaction()

```ts
function getFaction(
   context, 
   factionId, 
options?): Promise<FactionSnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:583](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L583)

Derives and reads one faction identity.

#### Parameters

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

#### Returns

`Promise`\<[`FactionSnapshot`](/reference/factions/#factionsnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
const faction = await getFaction(ctx, 4);
```

***

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

### getFactionEconomics()

```ts
function getFactionEconomics(context, options?): Promise<FactionEconomicsSnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:634](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L634)

Derives and reads per-Game faction economics.

#### Parameters

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

#### Returns

`Promise`\<[`FactionEconomicsSnapshot`](/reference/factions/#factioneconomicssnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
const economics = await getFactionEconomics(ctx);
```

***

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

### getFactionForProfile()

```ts
function getFactionForProfile(
   ctx, 
   profile, 
options?): Promise<ProfileFactionSnapshot>;
```

Defined in: [packages/sage/src/factions/profile-faction.ts:89](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L89)

Derives and reads a Profile's faction enrollment independently of Game.

Returns the ProfileFaction enrollment snapshot (unaligned, MUD, ONI, or Ustur).
This does not read a Game or its dynamic FactionAccount; use `getFaction`
with a Game-scoped faction id for that state. Missing enrollment throws
`ACCOUNT_NOT_FOUND`; use `maybeGetFactionForProfile` when absence is expected.

#### Parameters

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

#### Returns

`Promise`\<[`ProfileFactionSnapshot`](/reference/factions/#profilefactionsnapshot)\>

#### Example

**Illustrative: supply a context and an existing Profile address.**

```ts
declare const ctx: SageContext;
declare const profile: Address;
const enrollment = await getFactionForProfile(ctx, profile);
console.log(enrollment.faction);
```

***

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

### getFactionOwnerships()

```ts
function getFactionOwnerships(
   context, 
   kind, 
options?): Promise<readonly FactionOwnershipSnapshot[]>;
```

Defined in: [packages/sage/src/factions/index.ts:798](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L798)

Discovers validated ownership sidecars for one asset kind.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `kind` | `FactionOwnershipKind` |
| `options?` | [`FactionOwnershipDiscoveryOptions`](/reference/factions/#factionownershipdiscoveryoptions) |

#### Returns

`Promise`\<readonly [`FactionOwnershipSnapshot`](/reference/factions/#factionownershipsnapshot)[]\>

#### Example

```ts
declare const ctx: SageContext;
const fleets = await getFactionOwnerships(ctx, 'fleet');
```

***

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

### getFactionRelations()

```ts
function getFactionRelations(context, options?): Promise<FactionRelationsSnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:657](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L657)

Derives and reads the diplomacy relation tracker.

#### Parameters

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

#### Returns

`Promise`\<[`FactionRelationsSnapshot`](/reference/factions/#factionrelationssnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
const relations = await getFactionRelations(ctx);
```

***

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

### getFactionTreasury()

```ts
function getFactionTreasury(
   context, 
   factionId, 
options?): Promise<FactionTreasurySnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:716](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L716)

Derives and reads one faction treasury.

#### Parameters

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

#### Returns

`Promise`\<[`FactionTreasurySnapshot`](/reference/factions/#factiontreasurysnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
const treasury = await getFactionTreasury(ctx, 4);
```

***

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

### getKingSystems()

```ts
function getKingSystems(context, options?): Promise<KingSystemsSnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:821](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L821)

Derives and reads current King-system ownership.

#### Parameters

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

#### Returns

`Promise`\<[`KingSystemsSnapshot`](/reference/factions/#kingsystemssnapshot)\>

#### Example

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

***

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

### getTerritoryRegions()

```ts
function getTerritoryRegions(context, options?): Promise<TerritoryRegionsSnapshot>;
```

Defined in: [packages/sage/src/factions/index.ts:853](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L853)

Derives and reads compact nested region ownership summaries.

#### Parameters

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

#### Returns

`Promise`\<[`TerritoryRegionsSnapshot`](/reference/factions/#territoryregionssnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
const regions = await getTerritoryRegions(ctx);
```

***

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

### maybeGetFactionConfig()

```ts
function maybeGetFactionConfig(context, options?): Promise<
  | FactionConfigSnapshot
| undefined>;
```

Defined in: [packages/sage/src/factions/index.ts:613](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L613)

Derives and reads the optional per-Game standing configuration.

#### Parameters

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

#### Returns

`Promise`\<
  \| [`FactionConfigSnapshot`](/reference/factions/#factionconfigsnapshot)
  \| `undefined`\>

#### Example

```ts
declare const ctx: SageContext;
const config = await maybeGetFactionConfig(ctx);
```

***

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

### maybeGetFactionForProfile()

```ts
function maybeGetFactionForProfile(
   ctx, 
   profile, 
   options?): Promise<
  | ProfileFactionSnapshot
| undefined>;
```

Defined in: [packages/sage/src/factions/profile-faction.ts:115](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/profile-faction.ts#L115)

Reads optional Profile faction enrollment independently of Game.

Returns the ProfileFaction enrollment snapshot, or `undefined` when the
Profile is not enrolled. Malformed accounts still fail validation. This does
not load Game or resolve its dynamic FactionAccount; use `getFaction` with a
Game-scoped faction id for that state.

#### Parameters

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

#### Returns

`Promise`\<
  \| [`ProfileFactionSnapshot`](/reference/factions/#profilefactionsnapshot)
  \| `undefined`\>

#### Example

**Illustrative: supply a context and an existing Profile address.**

```ts
declare const ctx: SageContext;
declare const profile: Address;
const enrollment = await maybeGetFactionForProfile(ctx, profile);
console.log(enrollment?.faction ?? 'not enrolled');
```

***

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

### maybeGetFactionOwnership()

```ts
function maybeGetFactionOwnership(
   context, 
   asset, 
   options?): Promise<
  | FactionOwnershipSnapshot
| undefined>;
```

Defined in: [packages/sage/src/factions/index.ts:747](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L747)

Derives and reads an optional ownership sidecar for one asset.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `asset` | [`FactionOwnershipAsset`](/reference/factions/#factionownershipasset) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`FactionOwnershipSnapshot`](/reference/factions/#factionownershipsnapshot)
  \| `undefined`\>

#### Example

```ts
declare const ctx: SageContext;
declare const address: Address;
const ownership = await maybeGetFactionOwnership(ctx, { kind: 'fleet', address });
```

***

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

### maybeGetFactionStanding()

```ts
function maybeGetFactionStanding(
   context, 
   profile, 
   factionId, 
   options?): Promise<
  | FactionStandingSnapshot
| undefined>;
```

Defined in: [packages/sage/src/factions/index.ts:681](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L681)

Derives and reads optional standing for one Profile/faction pair.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `profile` | [`Address`](/reference/#address-20) |
| `factionId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`FactionStandingSnapshot`](/reference/factions/#factionstandingsnapshot)
  \| `undefined`\>

#### Example

```ts
declare const ctx: SageContext;
declare const profile: Address;
const standing = await maybeGetFactionStanding(ctx, profile, 4);
```