factions

Interfaces

FactionConfigSnapshot

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

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:118

bump

readonly bump: number;

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

Inherited from

FactionConfigAccountData.bump

dailyCap

readonly dailyCap: number;

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

Inherited from

FactionConfigAccountData.dailyCap

decayPerDay

readonly decayPerDay: number;

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

Inherited from

FactionConfigAccountData.decayPerDay

diminishingReturnsHalfLifeRaw

readonly diminishingReturnsHalfLifeRaw: bigint;

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

Inherited from

FactionConfigAccountData.diminishingReturnsHalfLifeRaw

diminishingReturnsScaleRaw

readonly diminishingReturnsScaleRaw: bigint;

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

Inherited from

FactionConfigAccountData.diminishingReturnsScaleRaw

dockMinimumBand

readonly dockMinimumBand: number;

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

Inherited from

FactionConfigAccountData.dockMinimumBand

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionConfig";

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

standingBps

readonly standingBps: number;

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

Inherited from

FactionConfigAccountData.standingBps

standingEpochCap

readonly standingEpochCap: number;

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

Inherited from

FactionConfigAccountData.standingEpochCap

standingEpochLengthSeconds

readonly standingEpochLengthSeconds: bigint;

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

Inherited from

FactionConfigAccountData.standingEpochLengthSeconds

territoryYieldPerTick

readonly territoryYieldPerTick: number;

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

Inherited from

FactionConfigAccountData.territoryYieldPerTick

territoryYieldTickSeconds

readonly territoryYieldTickSeconds: number;

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

Inherited from

FactionConfigAccountData.territoryYieldTickSeconds

version

readonly version: number;

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

Inherited from

FactionConfigAccountData.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionEconomicsSnapshot

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

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:136

bump

readonly bump: number;

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

Inherited from

Omit.bump

captureCostAtlas

readonly captureCostAtlas: number;

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

Dynamic-capture cost in ATLAS.

Inherited from

Omit.captureCostAtlas

captureCostAtlasRaw

readonly captureCostAtlasRaw: bigint;

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

Exact dynamic-capture cost in ATLAS Floyds.

Inherited from

Omit.captureCostAtlasRaw

factionCaptureCooldownSeconds

readonly factionCaptureCooldownSeconds: bigint;

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

Inherited from

Omit.factionCaptureCooldownSeconds

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionEconomicsConfig";

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

npcMintCostAtlas

readonly npcMintCostAtlas: number;

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

Inherited from

Omit.npcMintCostAtlas

npcMintCostAtlasRaw

readonly npcMintCostAtlasRaw: bigint;

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

Inherited from

Omit.npcMintCostAtlasRaw

npcRespawnCostAtlas

readonly npcRespawnCostAtlas: number;

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

Inherited from

Omit.npcRespawnCostAtlas

npcRespawnCostAtlasRaw

readonly npcRespawnCostAtlasRaw: bigint;

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

Inherited from

Omit.npcRespawnCostAtlasRaw

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionOwnershipSnapshot

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

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

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:229

asset

readonly asset: FactionOwnershipTarget;

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

bump

readonly bump: number;

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

Inherited from

Omit.bump

capturedAtUnixSeconds

readonly capturedAtUnixSeconds: bigint;

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

Inherited from

Omit.capturedAtUnixSeconds

capturedSystemSequenceId?

readonly optional capturedSystemSequenceId?: bigint;

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

contestedUntilUnixSeconds?

readonly optional contestedUntilUnixSeconds?: bigint;

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

controllingFactionId?

readonly optional controllingFactionId?: number;

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

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionOwnership";

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

lastYieldTickUnixSeconds?

readonly optional lastYieldTickUnixSeconds?: bigint;

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

previousControllerFactionId?

readonly optional previousControllerFactionId?: number;

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionRelationsSnapshot

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

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:153

alliedTollBps

readonly alliedTollBps: number;

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

Inherited from

Omit.alliedTollBps

bump

readonly bump: number;

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

Inherited from

Omit.bump

ceasefireMinimumDurationSeconds

readonly ceasefireMinimumDurationSeconds: bigint;

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

Inherited from

Omit.ceasefireMinimumDurationSeconds

combatGatingEnabled

readonly combatGatingEnabled: boolean;

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

Inherited from

Omit.combatGatingEnabled

contestedWindowSeconds

readonly contestedWindowSeconds: number;

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

Inherited from

Omit.contestedWindowSeconds

crossFactionEconomicsEnabled

readonly crossFactionEconomicsEnabled: boolean;

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

Inherited from

Omit.crossFactionEconomicsEnabled

dynamicCaptureEnabled

readonly dynamicCaptureEnabled: boolean;

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

Inherited from

Omit.dynamicCaptureEnabled

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionRelationTracker";

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

nemesisActive

readonly nemesisActive: boolean;

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

Inherited from

Omit.nemesisActive

neutralTollBps

readonly neutralTollBps: number;

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

Inherited from

Omit.neutralTollBps

reCeasefireCooldownSeconds

readonly reCeasefireCooldownSeconds: bigint;

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

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:154

Inherited from

Omit.relations

territoryAccessEnabled

readonly territoryAccessEnabled: boolean;

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

Inherited from

Omit.territoryAccessEnabled

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionSnapshot

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

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:98

alignment

readonly alignment: FactionAlignment;

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

Inherited from

Omit.alignment

authorityBump

readonly authorityBump: number;

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

Inherited from

Omit.authorityBump

bump

readonly bump: number;

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

Inherited from

Omit.bump

capabilityFlags

readonly capabilityFlags: number;

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

Inherited from

Omit.capabilityFlags

contentUriHash?

readonly optional contentUriHash?: readonly number[];

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

controller?

readonly optional controller?: Address;

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

createdAtUnixSeconds

readonly createdAtUnixSeconds: bigint;

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

Inherited from

Omit.createdAtUnixSeconds

factionId

readonly factionId: number;

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

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

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

homeRegionId?

readonly optional homeRegionId?: number;

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

kind

readonly kind: "faction";

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

lastCaptureAtUnixSeconds?

readonly optional lastCaptureAtUnixSeconds?: bigint;

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

maxAllies

readonly maxAllies: number;

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

Inherited from

Omit.maxAllies

maxNpcFleets

readonly maxNpcFleets: number;

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

Inherited from

Omit.maxNpcFleets

nameHash?

readonly optional nameHash?: readonly number[];

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

npcFleetCount

readonly npcFleetCount: number;

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

Inherited from

Omit.npcFleetCount

operatorProfile?

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

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

status

readonly status: FactionLifecycleStatus;

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

Inherited from

Omit.status

treasuryCount

readonly treasuryCount: number;

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

Inherited from

Omit.treasuryCount

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionStandingSnapshot

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

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:171

Inherited from

Omit.accrualToday

address

readonly address: Address;

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

bandFloor

readonly bandFloor: number;

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

Inherited from

Omit.bandFloor

bandFloorReachedAtUnixSeconds

readonly bandFloorReachedAtUnixSeconds: bigint;

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

Inherited from

Omit.bandFloorReachedAtUnixSeconds

bump

readonly bump: number;

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

Inherited from

Omit.bump

dayAnchorUnixSeconds

readonly dayAnchorUnixSeconds: bigint;

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

Inherited from

Omit.dayAnchorUnixSeconds

factionId

readonly factionId: number;

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

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionStanding";

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

lastUpdateUnixSeconds

readonly lastUpdateUnixSeconds: bigint;

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

Inherited from

Omit.lastUpdateUnixSeconds

lifetimeEarnedRaw

readonly lifetimeEarnedRaw: bigint;

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

Inherited from

Omit.lifetimeEarnedRaw

profile

readonly profile: EntityRef<"profile">;

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

standing

readonly standing: number;

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

Inherited from

Omit.standing

storylineActive

readonly storylineActive: boolean;

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

Inherited from

Omit.storylineActive

storylineExpiresAtUnixSeconds?

readonly optional storylineExpiresAtUnixSeconds?: bigint;

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

FactionTreasurySnapshot

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

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:189

atlasBalance

readonly atlasBalance: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:23

Inherited from

Omit.atlasBalance

atlasBalanceRaw

readonly atlasBalanceRaw: bigint;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:22

Inherited from

Omit.atlasBalanceRaw

atlasOutCapPerEpoch

readonly atlasOutCapPerEpoch: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:29

Inherited from

Omit.atlasOutCapPerEpoch

atlasOutCapPerEpochRaw

readonly atlasOutCapPerEpochRaw: bigint;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:28

Inherited from

Omit.atlasOutCapPerEpochRaw

atlasOutThisEpoch

readonly atlasOutThisEpoch: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:27

Inherited from

Omit.atlasOutThisEpoch

atlasOutThisEpochRaw

readonly atlasOutThisEpochRaw: bigint;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:26

Inherited from

Omit.atlasOutThisEpochRaw

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:19

Inherited from

Omit.bump

epochLengthSeconds

readonly epochLengthSeconds: bigint;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:25

Inherited from

Omit.epochLengthSeconds

epochStartedAtUnixSeconds

readonly epochStartedAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:24

Inherited from

Omit.epochStartedAtUnixSeconds

factionId

readonly factionId: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:21

Inherited from

Omit.factionId

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "factionTreasury";

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

reserves

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

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:30

Inherited from

Omit.reserves

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/faction-treasury.ts:18

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

KingSystemOwnership

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

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:250

system

readonly system: EntityRef<"starSystem">;

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

systemId

readonly systemId: number;

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

---

KingSystemsSnapshot

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

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:265

bump

readonly bump: number;

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

Inherited from

Omit.bump

configuredAtUnixSeconds

readonly configuredAtUnixSeconds: bigint;

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

Inherited from

Omit.configuredAtUnixSeconds

game

readonly game: EntityRef<"game">;

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

kind

readonly kind: "kingSystemTracker";

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

majorFactionCounts

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

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

Inherited from

Omit.majorFactionCounts

systems

readonly systems: readonly KingSystemOwnership[];

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

ProfileFactionSnapshot

Defined in: packages/sage/src/factions/profile-faction.ts:33

Immutable faction enrollment associated with a Profile across Games.

Example

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

Properties

address

readonly address: Address;

Defined in: packages/sage/src/factions/profile-faction.ts:35

faction

readonly faction: ProfileFactionAlignment;

Defined in: packages/sage/src/factions/profile-faction.ts:37

factionId

readonly factionId: number;

Defined in: packages/sage/src/factions/profile-faction.ts:38

kind

readonly kind: "profileFaction";

Defined in: packages/sage/src/factions/profile-faction.ts:34

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/factions/profile-faction.ts:36

version

readonly version: number;

Defined in: packages/sage/src/factions/profile-faction.ts:39

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/factions/profile-faction.ts:40

Returns

unknown

---

TerritoryRegionsSnapshot

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

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:311

game

readonly game: EntityRef<"game">;

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

gridExponent

readonly gridExponent: number;

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

Inherited from

Omit.gridExponent

kind

readonly kind: "regionTracker";

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

regions

readonly regions: readonly TerritoryRegionSummary[];

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

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:314

Returns

unknown

---

TerritoryRegionSummary

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

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:243

Inherited from

Omit.border

boundingBox

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

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

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:248

Inherited from

Omit.connections

coreSystems

readonly coreSystems: readonly TerritoryRegionSystem[];

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

id

readonly id: number;

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

Inherited from

Omit.id

miningResearchRequirementTagIds

readonly miningResearchRequirementTagIds: readonly number[];

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

Inherited from

Omit.miningResearchRequirementTagIds

name

readonly name: string;

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

Inherited from

Omit.name

neighborsByEdge

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

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

Inherited from

Omit.neighborsByEdge

owner

readonly owner: FactionAlignment;

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

Inherited from

Omit.owner

risk

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

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

Inherited from

Omit.risk

safety

readonly safety: "safe" | "border";

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

Inherited from

Omit.safety

scanningResearchRequirementTagIds

readonly scanningResearchRequirementTagIds: readonly number[];

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

Inherited from

Omit.scanningResearchRequirementTagIds

systems

readonly systems: readonly TerritoryRegionSystem[];

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

xpMultiplier

readonly xpMultiplier: FactionFixedValueData;

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

Inherited from

Omit.xpMultiplier

---

TerritoryRegionSystem

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

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:281

system

readonly system: EntityRef<"starSystem">;

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

systemId

readonly systemId: number;

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

Type Aliases

FactionOwnershipAsset

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

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

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:61

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:201

Typed ownership target retaining the underlying capability reference.

Example

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

---

ProfileFactionAlignment

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

Defined in: packages/sage/src/factions/profile-faction.ts:24

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

Example

const alignment: ProfileFactionAlignment = 'ustur';

Functions

getFaction()

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

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

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:634

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

---

getFactionForProfile()

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

Defined in: packages/sage/src/factions/profile-faction.ts:89

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
profile	Address
options?	ReadOptions

Returns

Promise<ProfileFactionSnapshot>

Example

Illustrative: supply a context and an existing Profile address.

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

---

getFactionOwnerships()

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

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

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:657

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:716

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:821

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:853

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:613

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

---

maybeGetFactionForProfile()

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

Defined in: packages/sage/src/factions/profile-faction.ts:115

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
profile	Address
options?	ReadOptions

Returns

Promise< | ProfileFactionSnapshot | undefined>

Example

Illustrative: supply a context and an existing Profile address.

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

---

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:681

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