# 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:112](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L112)

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:114](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L114)

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

##### bump

```ts
readonly bump: 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
FactionConfigAccountData.bump
```

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

##### dailyCap

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

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
FactionConfigAccountData.dailyCap
```

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

##### decayPerDay

```ts
readonly decayPerDay: 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
FactionConfigAccountData.decayPerDay
```

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

##### diminishingReturnsHalfLifeRaw

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

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
FactionConfigAccountData.diminishingReturnsHalfLifeRaw
```

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

##### diminishingReturnsScaleRaw

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

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
FactionConfigAccountData.diminishingReturnsScaleRaw
```

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

##### dockMinimumBand

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

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

###### Inherited from

```ts
FactionConfigAccountData.dockMinimumBand
```

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

##### game

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

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

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

##### kind

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

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

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

##### standingBps

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

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
FactionConfigAccountData.standingBps
```

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

##### standingEpochCap

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

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
FactionConfigAccountData.standingEpochCap
```

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

##### standingEpochLengthSeconds

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

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
FactionConfigAccountData.standingEpochLengthSeconds
```

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

##### territoryYieldPerTick

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

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

###### Inherited from

```ts
FactionConfigAccountData.territoryYieldPerTick
```

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

##### territoryYieldTickSeconds

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

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

###### Inherited from

```ts
FactionConfigAccountData.territoryYieldTickSeconds
```

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

##### version

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

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
FactionConfigAccountData.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionEconomicsSnapshot

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

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:132](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L132)

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

##### bump

```ts
readonly bump: 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.bump
```

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

##### captureCostAtlas

```ts
readonly captureCostAtlas: 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)

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:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L169)

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:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L172)

###### Inherited from

```ts
Omit.factionCaptureCooldownSeconds
```

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

##### game

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

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

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

##### kind

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

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

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

##### npcMintCostAtlas

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

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

###### Inherited from

```ts
Omit.npcMintCostAtlas
```

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

##### npcMintCostAtlasRaw

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

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

###### Inherited from

```ts
Omit.npcMintCostAtlasRaw
```

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

##### npcRespawnCostAtlas

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

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.npcRespawnCostAtlas
```

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

##### npcRespawnCostAtlasRaw

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

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.npcRespawnCostAtlasRaw
```

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionOwnershipSnapshot

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

Immutable dynamic ownership sidecar for one territory asset.

#### 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:220](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L220)

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

##### asset

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

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

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### capturedAtUnixSeconds

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

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

###### Inherited from

```ts
Omit.capturedAtUnixSeconds
```

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

##### capturedSystemSequenceId?

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

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

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

##### contestedUntilUnixSeconds?

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

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

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

##### controllingFactionId?

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

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

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

##### game

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

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

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

##### kind

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

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

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

##### lastYieldTickUnixSeconds?

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

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

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

##### previousControllerFactionId?

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

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

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

##### version

```ts
readonly version: 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.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionRelationsSnapshot

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

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:149](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L149)

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

##### alliedTollBps

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

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

###### Inherited from

```ts
Omit.alliedTollBps
```

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### ceasefireMinimumDurationSeconds

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

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

###### Inherited from

```ts
Omit.ceasefireMinimumDurationSeconds
```

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

##### combatGatingEnabled

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

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

###### Inherited from

```ts
Omit.combatGatingEnabled
```

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

##### contestedWindowSeconds

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

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

###### Inherited from

```ts
Omit.contestedWindowSeconds
```

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

##### crossFactionEconomicsEnabled

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

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

###### Inherited from

```ts
Omit.crossFactionEconomicsEnabled
```

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

##### dynamicCaptureEnabled

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

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

###### Inherited from

```ts
Omit.dynamicCaptureEnabled
```

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

##### game

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

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

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

##### kind

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

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

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

##### nemesisActive

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

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.nemesisActive
```

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

##### neutralTollBps

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

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

###### Inherited from

```ts
Omit.neutralTollBps
```

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

##### reCeasefireCooldownSeconds

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

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

###### 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:189](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L189)

###### Inherited from

```ts
Omit.relations
```

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

##### territoryAccessEnabled

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

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

###### Inherited from

```ts
Omit.territoryAccessEnabled
```

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionSnapshot

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

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:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L94)

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

##### alignment

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

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

###### Inherited from

```ts
Omit.alignment
```

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

##### authorityBump

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

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.authorityBump
```

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### capabilityFlags

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

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.capabilityFlags
```

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

##### contentUriHash?

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

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="controller"></a>

##### controller?

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

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="createdatunixseconds"></a>

##### createdAtUnixSeconds

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

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

###### Inherited from

```ts
Omit.createdAtUnixSeconds
```

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

##### factionId

```ts
readonly factionId: 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.factionId
```

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

##### game

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

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

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

##### homeRegionId?

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

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="kind-4"></a>

##### kind

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

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

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

##### lastCaptureAtUnixSeconds?

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

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="maxallies"></a>

##### maxAllies

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

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

###### Inherited from

```ts
Omit.maxAllies
```

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

##### maxNpcFleets

```ts
readonly maxNpcFleets: 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.maxNpcFleets
```

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

##### nameHash?

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

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="npcfleetcount"></a>

##### npcFleetCount

```ts
readonly npcFleetCount: 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.npcFleetCount
```

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

##### operatorProfile?

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

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

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

##### status

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

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.status
```

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

##### treasuryCount

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

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)

###### Inherited from

```ts
Omit.treasuryCount
```

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionStandingSnapshot

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

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:206](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L206)

###### Inherited from

```ts
Omit.accrualToday
```

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

##### address

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

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

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

##### bandFloor

```ts
readonly bandFloor: 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.bandFloor
```

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

##### bandFloorReachedAtUnixSeconds

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

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

###### Inherited from

```ts
Omit.bandFloorReachedAtUnixSeconds
```

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### dayAnchorUnixSeconds

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

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.dayAnchorUnixSeconds
```

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

##### factionId

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

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

###### Inherited from

```ts
Omit.factionId
```

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

##### game

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

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

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

##### kind

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

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

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

##### lastUpdateUnixSeconds

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

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

###### Inherited from

```ts
Omit.lastUpdateUnixSeconds
```

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

##### lifetimeEarnedRaw

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

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

###### Inherited from

```ts
Omit.lifetimeEarnedRaw
```

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

##### profile

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

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

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

##### standing

```ts
readonly standing: 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.standing
```

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

##### storylineActive

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

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

###### Inherited from

```ts
Omit.storylineActive
```

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

##### storylineExpiresAtUnixSeconds?

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

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="version-5"></a>

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### FactionTreasurySnapshot

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

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:185](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L185)

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

##### atlasBalance

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

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

###### Inherited from

```ts
Omit.atlasBalance
```

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

##### atlasBalanceRaw

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

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

###### Inherited from

```ts
Omit.atlasBalanceRaw
```

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

##### atlasOutCapPerEpoch

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

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

###### Inherited from

```ts
Omit.atlasOutCapPerEpoch
```

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

##### atlasOutCapPerEpochRaw

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

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

###### Inherited from

```ts
Omit.atlasOutCapPerEpochRaw
```

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

##### atlasOutThisEpoch

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

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

###### Inherited from

```ts
Omit.atlasOutThisEpoch
```

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

##### atlasOutThisEpochRaw

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

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

###### Inherited from

```ts
Omit.atlasOutThisEpochRaw
```

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### epochLengthSeconds

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

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

###### Inherited from

```ts
Omit.epochLengthSeconds
```

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

##### epochStartedAtUnixSeconds

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

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

###### Inherited from

```ts
Omit.epochStartedAtUnixSeconds
```

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

##### factionId

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

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

###### Inherited from

```ts
Omit.factionId
```

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

##### game

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

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

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

##### kind

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

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

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

##### reserves

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

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

###### Inherited from

```ts
Omit.reserves
```

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### KingSystemOwnership

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

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:241](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L241)

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

##### system

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

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

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

##### systemId

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

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

***

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

### KingSystemsSnapshot

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

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:256](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L256)

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

##### bump

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

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

###### Inherited from

```ts
Omit.bump
```

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

##### configuredAtUnixSeconds

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

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

###### Inherited from

```ts
Omit.configuredAtUnixSeconds
```

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

##### game

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

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

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

##### kind

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

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

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

##### majorFactionCounts

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

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

###### Inherited from

```ts
Omit.majorFactionCounts
```

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

##### systems

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

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

<a id="version-7"></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-7"></a>

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### TerritoryRegionsSnapshot

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

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-8"></a>

##### address

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

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

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

##### game

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

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

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

##### gridExponent

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

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

###### Inherited from

```ts
Omit.gridExponent
```

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

##### kind

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

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

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

##### regions

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

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

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

##### version

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

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

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### TerritoryRegionSummary

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

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:296](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L296)

###### 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:290](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L290)

###### 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:301](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L301)

###### Inherited from

```ts
Omit.connections
```

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

##### coreSystems

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

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

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

##### id

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

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

###### Inherited from

```ts
Omit.id
```

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

##### miningResearchRequirementTagIds

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

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

###### Inherited from

```ts
Omit.miningResearchRequirementTagIds
```

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

##### name

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

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

###### 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:300](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L300)

###### Inherited from

```ts
Omit.neighborsByEdge
```

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

##### owner

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

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

###### 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:286](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/factions.ts#L286)

###### Inherited from

```ts
Omit.risk
```

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

##### safety

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

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

###### Inherited from

```ts
Omit.safety
```

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

##### scanningResearchRequirementTagIds

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

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

###### Inherited from

```ts
Omit.scanningResearchRequirementTagIds
```

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

##### systems

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

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

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

##### xpMultiplier

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

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

###### Inherited from

```ts
Omit.xpMultiplier
```

***

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

### TerritoryRegionSystem

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

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"></a>

##### faction

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

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

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

##### system

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

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

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

##### systemId

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

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

## 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:69](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L69)

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:57](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L57)

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:197](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L197)

Typed ownership target retaining the underlying capability reference.

#### Example

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

## Functions

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

### getFaction()

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

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

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:636](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L636)

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="getfactionownerships"></a>

### getFactionOwnerships()

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

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

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:659](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L659)

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:717](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L717)

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:814](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L814)

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:846](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L846)

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:615](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L615)

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="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:683](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/factions/index.ts#L683)

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);
```