factions

Interfaces

FactionConfigSnapshot

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

Immutable optional standing and territory-yield configuration.

Example

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

Extends

• FactionConfigAccountData

Properties

address

readonly address: Address;

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

bump

readonly bump: number;

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

Inherited from

FactionConfigAccountData.bump

dailyCap

readonly dailyCap: number;

Defined in: packages/sage/src/internal/c4/factions.ts:149

Inherited from

FactionConfigAccountData.dailyCap

decayPerDay

readonly decayPerDay: number;

Defined in: packages/sage/src/internal/c4/factions.ts:148

Inherited from

FactionConfigAccountData.decayPerDay

diminishingReturnsHalfLifeRaw

readonly diminishingReturnsHalfLifeRaw: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:151

Inherited from

FactionConfigAccountData.diminishingReturnsHalfLifeRaw

diminishingReturnsScaleRaw

readonly diminishingReturnsScaleRaw: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:152

Inherited from

FactionConfigAccountData.diminishingReturnsScaleRaw

dockMinimumBand

readonly dockMinimumBand: number;

Defined in: packages/sage/src/internal/c4/factions.ts:155

Inherited from

FactionConfigAccountData.dockMinimumBand

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionConfig";

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

standingBps

readonly standingBps: number;

Defined in: packages/sage/src/internal/c4/factions.ts:150

Inherited from

FactionConfigAccountData.standingBps

standingEpochCap

readonly standingEpochCap: number;

Defined in: packages/sage/src/internal/c4/factions.ts:153

Inherited from

FactionConfigAccountData.standingEpochCap

standingEpochLengthSeconds

readonly standingEpochLengthSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:154

Inherited from

FactionConfigAccountData.standingEpochLengthSeconds

territoryYieldPerTick

readonly territoryYieldPerTick: number;

Defined in: packages/sage/src/internal/c4/factions.ts:156

Inherited from

FactionConfigAccountData.territoryYieldPerTick

territoryYieldTickSeconds

readonly territoryYieldTickSeconds: number;

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

Inherited from

FactionConfigAccountData.territoryYieldTickSeconds

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/factions.ts:146

Inherited from

FactionConfigAccountData.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionEconomicsSnapshot

Defined in: packages/sage/src/factions/index.ts:127

Immutable per-Game NPC and capture economics.

Example

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

Extends

• Omit<FactionEconomicsConfigAccountData, "game">

Properties

address

readonly address: Address;

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

bump

readonly bump: number;

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

Inherited from

Omit.bump

captureCostAtlas

readonly captureCostAtlas: number;

Defined in: packages/sage/src/internal/c4/factions.ts:171

Dynamic-capture cost in ATLAS.

Inherited from

Omit.captureCostAtlas

captureCostAtlasRaw

readonly captureCostAtlasRaw: bigint;

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

Exact dynamic-capture cost in ATLAS Floyds.

Inherited from

Omit.captureCostAtlasRaw

factionCaptureCooldownSeconds

readonly factionCaptureCooldownSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:172

Inherited from

Omit.factionCaptureCooldownSeconds

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionEconomicsConfig";

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

npcMintCostAtlas

readonly npcMintCostAtlas: number;

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

Inherited from

Omit.npcMintCostAtlas

npcMintCostAtlasRaw

readonly npcMintCostAtlasRaw: bigint;

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

Inherited from

Omit.npcMintCostAtlasRaw

npcRespawnCostAtlas

readonly npcRespawnCostAtlas: number;

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

Inherited from

Omit.npcRespawnCostAtlas

npcRespawnCostAtlasRaw

readonly npcRespawnCostAtlasRaw: bigint;

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

Inherited from

Omit.npcRespawnCostAtlasRaw

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:134

Returns

unknown

---

FactionOwnershipSnapshot

Defined in: packages/sage/src/factions/index.ts:209

Immutable dynamic ownership sidecar for one territory asset.

Example

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

Extends

• Omit<FactionOwnershipAccountData, | "game" | "asset" | "controllingFactionId" | "previousControllerFactionId" | "contestedUntilUnixSeconds" | "capturedSystemSequenceId" | "lastYieldTickUnixSeconds">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:220

asset

readonly asset: FactionOwnershipTarget;

Defined in: packages/sage/src/factions/index.ts:222

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/factions.ts:244

Inherited from

Omit.bump

capturedAtUnixSeconds

readonly capturedAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:249

Inherited from

Omit.capturedAtUnixSeconds

capturedSystemSequenceId?

readonly optional capturedSystemSequenceId?: bigint;

Defined in: packages/sage/src/factions/index.ts:226

contestedUntilUnixSeconds?

readonly optional contestedUntilUnixSeconds?: bigint;

Defined in: packages/sage/src/factions/index.ts:225

controllingFactionId?

readonly optional controllingFactionId?: number;

Defined in: packages/sage/src/factions/index.ts:223

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:221

kind

readonly kind: "factionOwnership";

Defined in: packages/sage/src/factions/index.ts:219

lastYieldTickUnixSeconds?

readonly optional lastYieldTickUnixSeconds?: bigint;

Defined in: packages/sage/src/factions/index.ts:227

previousControllerFactionId?

readonly optional previousControllerFactionId?: number;

Defined in: packages/sage/src/factions/index.ts:224

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:228

Returns

unknown

---

FactionRelationsSnapshot

Defined in: packages/sage/src/factions/index.ts:144

Immutable diplomacy and territory-gating configuration.

Example

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

Extends

• Omit<FactionRelationTrackerAccountData, "game">

Properties

address

readonly address: Address;

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

alliedTollBps

readonly alliedTollBps: number;

Defined in: packages/sage/src/internal/c4/factions.ts:182

Inherited from

Omit.alliedTollBps

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/factions.ts:177

Inherited from

Omit.bump

ceasefireMinimumDurationSeconds

readonly ceasefireMinimumDurationSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:184

Inherited from

Omit.ceasefireMinimumDurationSeconds

combatGatingEnabled

readonly combatGatingEnabled: boolean;

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

Inherited from

Omit.combatGatingEnabled

contestedWindowSeconds

readonly contestedWindowSeconds: number;

Defined in: packages/sage/src/internal/c4/factions.ts:187

Inherited from

Omit.contestedWindowSeconds

crossFactionEconomicsEnabled

readonly crossFactionEconomicsEnabled: boolean;

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

Inherited from

Omit.crossFactionEconomicsEnabled

dynamicCaptureEnabled

readonly dynamicCaptureEnabled: boolean;

Defined in: packages/sage/src/internal/c4/factions.ts:186

Inherited from

Omit.dynamicCaptureEnabled

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionRelationTracker";

Defined in: packages/sage/src/factions/index.ts:148

nemesisActive

readonly nemesisActive: boolean;

Defined in: packages/sage/src/internal/c4/factions.ts:188

Inherited from

Omit.nemesisActive

neutralTollBps

readonly neutralTollBps: number;

Defined in: packages/sage/src/internal/c4/factions.ts:183

Inherited from

Omit.neutralTollBps

reCeasefireCooldownSeconds

readonly reCeasefireCooldownSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:185

Inherited from

Omit.reCeasefireCooldownSeconds

relations

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

Defined in: packages/sage/src/internal/c4/factions.ts:189

Inherited from

Omit.relations

territoryAccessEnabled

readonly territoryAccessEnabled: boolean;

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

Inherited from

Omit.territoryAccessEnabled

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/factions.ts:176

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionSnapshot

Defined in: packages/sage/src/factions/index.ts:83

Immutable faction identity, lifecycle, and NPC capacity state.

Example

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

Extends

• Omit<FactionAccountData, | "game" | "operatorProfile" | "controller" | "homeRegionId" | "nameHash" | "contentUriHash" | "lastCaptureAtUnixSeconds">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:94

alignment

readonly alignment: FactionAlignment;

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

Inherited from

Omit.alignment

authorityBump

readonly authorityBump: number;

Defined in: packages/sage/src/internal/c4/factions.ts:131

Inherited from

Omit.authorityBump

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/factions.ts:125

Inherited from

Omit.bump

capabilityFlags

readonly capabilityFlags: number;

Defined in: packages/sage/src/internal/c4/factions.ts:129

Inherited from

Omit.capabilityFlags

contentUriHash?

readonly optional contentUriHash?: readonly number[];

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

controller?

readonly optional controller?: Address;

Defined in: packages/sage/src/factions/index.ts:97

createdAtUnixSeconds

readonly createdAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:138

Inherited from

Omit.createdAtUnixSeconds

factionId

readonly factionId: number;

Defined in: packages/sage/src/internal/c4/factions.ts:127

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:95

homeRegionId?

readonly optional homeRegionId?: number;

Defined in: packages/sage/src/factions/index.ts:98

kind

readonly kind: "faction";

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

lastCaptureAtUnixSeconds?

readonly optional lastCaptureAtUnixSeconds?: bigint;

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

maxAllies

readonly maxAllies: number;

Defined in: packages/sage/src/internal/c4/factions.ts:133

Inherited from

Omit.maxAllies

maxNpcFleets

readonly maxNpcFleets: number;

Defined in: packages/sage/src/internal/c4/factions.ts:142

Inherited from

Omit.maxNpcFleets

nameHash?

readonly optional nameHash?: readonly number[];

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

npcFleetCount

readonly npcFleetCount: number;

Defined in: packages/sage/src/internal/c4/factions.ts:141

Inherited from

Omit.npcFleetCount

operatorProfile?

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

Defined in: packages/sage/src/factions/index.ts:96

status

readonly status: FactionLifecycleStatus;

Defined in: packages/sage/src/internal/c4/factions.ts:130

Inherited from

Omit.status

treasuryCount

readonly treasuryCount: number;

Defined in: packages/sage/src/internal/c4/factions.ts:134

Inherited from

Omit.treasuryCount

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/factions.ts:124

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionStandingSnapshot

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

Immutable optional Profile standing with one faction.

Example

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

Extends

• Omit<FactionStandingAccountData, "game" | "profile" | "storylineExpiresAtUnixSeconds">

Properties

accrualToday

readonly accrualToday: number;

Defined in: packages/sage/src/internal/c4/factions.ts:206

Inherited from

Omit.accrualToday

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:166

bandFloor

readonly bandFloor: number;

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

Inherited from

Omit.bandFloor

bandFloorReachedAtUnixSeconds

readonly bandFloorReachedAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:209

Inherited from

Omit.bandFloorReachedAtUnixSeconds

bump

readonly bump: number;

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

Inherited from

Omit.bump

dayAnchorUnixSeconds

readonly dayAnchorUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:207

Inherited from

Omit.dayAnchorUnixSeconds

factionId

readonly factionId: number;

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

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:167

kind

readonly kind: "factionStanding";

Defined in: packages/sage/src/factions/index.ts:165

lastUpdateUnixSeconds

readonly lastUpdateUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:208

Inherited from

Omit.lastUpdateUnixSeconds

lifetimeEarnedRaw

readonly lifetimeEarnedRaw: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:205

Inherited from

Omit.lifetimeEarnedRaw

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/factions/index.ts:168

standing

readonly standing: number;

Defined in: packages/sage/src/internal/c4/factions.ts:204

Inherited from

Omit.standing

storylineActive

readonly storylineActive: boolean;

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

Inherited from

Omit.storylineActive

storylineExpiresAtUnixSeconds?

readonly optional storylineExpiresAtUnixSeconds?: bigint;

Defined in: packages/sage/src/factions/index.ts:169

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:170

Returns

unknown

---

FactionTreasurySnapshot

Defined in: packages/sage/src/factions/index.ts:180

Immutable faction ATLAS and cargo reserve state.

Example

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

Extends

• Omit<FactionTreasuryAccountData, "game">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:185

atlasBalance

readonly atlasBalance: number;

Defined in: packages/sage/src/internal/c4/factions.ts:219

Inherited from

Omit.atlasBalance

atlasBalanceRaw

readonly atlasBalanceRaw: bigint;

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

Inherited from

Omit.atlasBalanceRaw

atlasOutCapPerEpoch

readonly atlasOutCapPerEpoch: number;

Defined in: packages/sage/src/internal/c4/factions.ts:225

Inherited from

Omit.atlasOutCapPerEpoch

atlasOutCapPerEpochRaw

readonly atlasOutCapPerEpochRaw: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:224

Inherited from

Omit.atlasOutCapPerEpochRaw

atlasOutThisEpoch

readonly atlasOutThisEpoch: number;

Defined in: packages/sage/src/internal/c4/factions.ts:223

Inherited from

Omit.atlasOutThisEpoch

atlasOutThisEpochRaw

readonly atlasOutThisEpochRaw: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:222

Inherited from

Omit.atlasOutThisEpochRaw

bump

readonly bump: number;

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

Inherited from

Omit.bump

epochLengthSeconds

readonly epochLengthSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:221

Inherited from

Omit.epochLengthSeconds

epochStartedAtUnixSeconds

readonly epochStartedAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:220

Inherited from

Omit.epochStartedAtUnixSeconds

factionId

readonly factionId: number;

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

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:186

kind

readonly kind: "factionTreasury";

Defined in: packages/sage/src/factions/index.ts:184

reserves

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

Defined in: packages/sage/src/internal/c4/factions.ts:226

Inherited from

Omit.reserves

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:187

Returns

unknown

---

KingSystemOwnership

Defined in: packages/sage/src/factions/index.ts:238

One King system with its current effective faction owner.

Example

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

Properties

factionId?

readonly optional factionId?: number;

Defined in: packages/sage/src/factions/index.ts:241

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/factions/index.ts:240

systemId

readonly systemId: number;

Defined in: packages/sage/src/factions/index.ts:239

---

KingSystemsSnapshot

Defined in: packages/sage/src/factions/index.ts:251

Immutable King-system ownership catalog.

Example

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

Extends

• Omit<KingSystemTrackerAccountData, "game" | "systems">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:256

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/factions.ts:257

Inherited from

Omit.bump

configuredAtUnixSeconds

readonly configuredAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/factions.ts:259

Inherited from

Omit.configuredAtUnixSeconds

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:257

kind

readonly kind: "kingSystemTracker";

Defined in: packages/sage/src/factions/index.ts:255

majorFactionCounts

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

Defined in: packages/sage/src/internal/c4/factions.ts:260

Inherited from

Omit.majorFactionCounts

systems

readonly systems: readonly KingSystemOwnership[];

Defined in: packages/sage/src/factions/index.ts:258

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/factions.ts:256

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:259

Returns

unknown

---

TerritoryRegionsSnapshot

Defined in: packages/sage/src/factions/index.ts:297

Immutable nested RegionTracker ownership catalog.

Example

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

Extends

• Omit<RegionTrackerAccountData, "game" | "regions">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/index.ts:302

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/factions/index.ts:303

gridExponent

readonly gridExponent: number;

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

Inherited from

Omit.gridExponent

kind

readonly kind: "regionTracker";

Defined in: packages/sage/src/factions/index.ts:301

regions

readonly regions: readonly TerritoryRegionSummary[];

Defined in: packages/sage/src/factions/index.ts:304

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/index.ts:305

Returns

unknown

---

TerritoryRegionSummary

Defined in: packages/sage/src/factions/index.ts:282

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

Example

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

Extends

• Omit<FactionRegionData, "systems" | "coreSystems">

Properties

border

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

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

Inherited from

Omit.border

boundingBox

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

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

maxX

readonly maxX: number;

maxY

readonly maxY: number;

minX

readonly minX: number;

minY

readonly minY: number;

Inherited from

Omit.boundingBox

connections

readonly connections: readonly number[];

Defined in: packages/sage/src/internal/c4/factions.ts:301

Inherited from

Omit.connections

coreSystems

readonly coreSystems: readonly TerritoryRegionSystem[];

Defined in: packages/sage/src/factions/index.ts:287

id

readonly id: number;

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

Inherited from

Omit.id

miningResearchRequirementTagIds

readonly miningResearchRequirementTagIds: readonly number[];

Defined in: packages/sage/src/internal/c4/factions.ts:305

Inherited from

Omit.miningResearchRequirementTagIds

name

readonly name: string;

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

Inherited from

Omit.name

neighborsByEdge

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

Defined in: packages/sage/src/internal/c4/factions.ts:300

Inherited from

Omit.neighborsByEdge

owner

readonly owner: FactionAlignment;

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

Inherited from

Omit.owner

risk

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

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

Inherited from

Omit.risk

safety

readonly safety: "safe" | "border";

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

Inherited from

Omit.safety

scanningResearchRequirementTagIds

readonly scanningResearchRequirementTagIds: readonly number[];

Defined in: packages/sage/src/internal/c4/factions.ts:304

Inherited from

Omit.scanningResearchRequirementTagIds

systems

readonly systems: readonly TerritoryRegionSystem[];

Defined in: packages/sage/src/factions/index.ts:286

xpMultiplier

readonly xpMultiplier: FactionFixedValueData;

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

Inherited from

Omit.xpMultiplier

---

TerritoryRegionSystem

Defined in: packages/sage/src/factions/index.ts:269

Compact region system ownership linked to a StarSystem reference.

Example

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

Properties

faction

readonly faction: FactionAlignment;

Defined in: packages/sage/src/factions/index.ts:272

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/factions/index.ts:271

systemId

readonly systemId: number;

Defined in: packages/sage/src/factions/index.ts:270

Type Aliases

FactionOwnershipAsset

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

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

A requested asset whose optional ownership sidecar can be derived.

Example

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

---

FactionOwnershipDiscoveryOptions

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

Defined in: packages/sage/src/factions/index.ts:57

Options accepted by targeted FactionOwnership discovery.

Example

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

---

FactionOwnershipTarget

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

Typed ownership target retaining the underlying capability reference.

Example

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

Functions

getFaction()

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

Defined in: packages/sage/src/factions/index.ts:586

Derives and reads one faction identity.

Parameters

Parameter	Type
context	SageContext
factionId	number
options?	ReadOptions

Returns

Promise<FactionSnapshot>

Example

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

---

getFactionEconomics()

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

Defined in: packages/sage/src/factions/index.ts:636

Derives and reads per-Game faction economics.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<FactionEconomicsSnapshot>

Example

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

---

getFactionOwnerships()

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

Defined in: packages/sage/src/factions/index.ts:791

Discovers validated ownership sidecars for one asset kind.

Parameters

Parameter	Type
context	SageContext
kind	FactionOwnershipKind
options?	FactionOwnershipDiscoveryOptions

Returns

Promise<readonly FactionOwnershipSnapshot[]>

Example

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

---

getFactionRelations()

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

Defined in: packages/sage/src/factions/index.ts:659

Derives and reads the diplomacy relation tracker.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<FactionRelationsSnapshot>

Example

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

---

getFactionTreasury()

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

Defined in: packages/sage/src/factions/index.ts:717

Derives and reads one faction treasury.

Parameters

Parameter	Type
context	SageContext
factionId	number
options?	ReadOptions

Returns

Promise<FactionTreasurySnapshot>

Example

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

---

getKingSystems()

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

Defined in: packages/sage/src/factions/index.ts:814

Derives and reads current King-system ownership.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<KingSystemsSnapshot>

Example

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

---

getTerritoryRegions()

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

Defined in: packages/sage/src/factions/index.ts:846

Derives and reads compact nested region ownership summaries.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<TerritoryRegionsSnapshot>

Example

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

---

maybeGetFactionConfig()

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

Defined in: packages/sage/src/factions/index.ts:615

Derives and reads the optional per-Game standing configuration.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise< | FactionConfigSnapshot | undefined>

Example

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

---

maybeGetFactionOwnership()

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

Defined in: packages/sage/src/factions/index.ts:747

Derives and reads an optional ownership sidecar for one asset.

Parameters

Parameter	Type
context	SageContext
asset	FactionOwnershipAsset
options?	ReadOptions

Returns

Promise< | FactionOwnershipSnapshot | undefined>

Example

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

---

maybeGetFactionStanding()

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

Defined in: packages/sage/src/factions/index.ts:683

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

Parameters

Parameter	Type
context	SageContext
profile	Address
factionId	number
options?	ReadOptions

Returns

Promise< | FactionStandingSnapshot | undefined>

Example

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