combat

Interfaces

CombatConfigurationSnapshot

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

Immutable Game combat configuration and stimulant catalog.

Example

declare const configuration: CombatConfigurationSnapshot;
console.log(configuration.globalCeasefire, configuration.maxFleetSize);

Extends

• Omit<GameCombatConfigurationData, "stimulantDefinitions">

Properties

address

readonly address: Address;

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

cargoRespawnTimeSeconds

readonly cargoRespawnTimeSeconds: bigint;

Defined in: packages/sage/src/internal/c4/game.ts:261

Inherited from

GameCombatConfigurationData.cargoRespawnTimeSeconds

crewRespawnTimeSeconds

readonly crewRespawnTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.crewRespawnTimeSeconds

globalCeasefire

readonly globalCeasefire: boolean;

Defined in: packages/sage/src/internal/c4/game.ts:255

Inherited from

GameCombatConfigurationData.globalCeasefire

interactionRange

readonly interactionRange: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.interactionRange

kind

readonly kind: "combatConfiguration";

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

lootExclusivityTimeSeconds

readonly lootExclusivityTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.lootExclusivityTimeSeconds

maxFleetSize

readonly maxFleetSize: number;

Defined in: packages/sage/src/internal/c4/game.ts:263

Inherited from

GameCombatConfigurationData.maxFleetSize

maxLootRate

readonly maxLootRate: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.maxLootRate

rawShipsRespawnTimeSeconds

readonly rawShipsRespawnTimeSeconds: bigint;

Defined in: packages/sage/src/internal/c4/game.ts:262

Inherited from

GameCombatConfigurationData.rawShipsRespawnTimeSeconds

starbaseUpgradeProgressContinuation

readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.starbaseUpgradeProgressContinuation

stimulantDefinitions

readonly stimulantDefinitions: {
  definitions: readonly CombatStimulantDefinition[];
  sequenceId: number;
};

Defined in: packages/sage/src/combat/index.ts:175

definitions

readonly definitions: readonly CombatStimulantDefinition[];

sequenceId

readonly sequenceId: number;

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/combat/index.ts:179

Returns

unknown

---

CombatStimulantDefinition

Defined in: packages/sage/src/combat/index.ts:157

One cargo-backed combat stimulant definition.

Example

declare const stimulant: CombatStimulantDefinition;
console.log(stimulant.cargo.name, stimulant.effects.length);

Properties

cargo

readonly cargo: CargoDefinitionSummary;

Defined in: packages/sage/src/combat/index.ts:158

effects

readonly effects: readonly GameStimulantEffectData[];

Defined in: packages/sage/src/combat/index.ts:159

---

FleetCombatStatsData

Defined in: packages/sage/src/internal/c4/fleet.ts:212

Translated Fleet combat statistics.

Example

declare const stats: FleetCombatStatsData;
const hitPoints = stats.hp;

Properties

aimAbility

readonly aimAbility: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:264

U26F6 fixed-point client display value; exact encoded integer retained in raw.

ammoConsumptionRate

readonly ammoConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:216

ap

readonly ap: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:213

apRegenRate

readonly apRegenRate: FleetFixedValue;

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

counterDecoy

readonly counterDecoy: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:250

counterEnergyCapacitor

readonly counterEnergyCapacitor: number;

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

counterFaradayShielding

readonly counterFaradayShielding: number;

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

counterFireSuppressor

readonly counterFireSuppressor: number;

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

counterFlare

readonly counterFlare: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:253

counterHealingNanobots

readonly counterHealingNanobots: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:254

counterMine

readonly counterMine: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:255

counterNegativeRemPlating

readonly counterNegativeRemPlating: number;

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

counterWarmingPlates

readonly counterWarmingPlates: number;

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

critChance

readonly critChance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:266

U26F6 fixed-point critical-hit value; no probability or percentage interpretation is implied.

critMultiplier

readonly critMultiplier: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:268

U26F6 fixed-point critical multiplier.

damageBomb

readonly damageBomb: number;

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

damageBombVariance

readonly damageBombVariance: FleetFixedValue;

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

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageEmp

readonly damageEmp: number;

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

damageEmpVariance

readonly damageEmpVariance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:234

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageEnergy

readonly damageEnergy: number;

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

damageEnergyVariance

readonly damageEnergyVariance: FleetFixedValue;

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

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageGraygoo

readonly damageGraygoo: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:241

damageGraygooVariance

readonly damageGraygooVariance: FleetFixedValue;

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

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageHeat

readonly damageHeat: number;

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

damageHeatVariance

readonly damageHeatVariance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:246

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageKinetic

readonly damageKinetic: number;

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

damageKineticVariance

readonly damageKineticVariance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:228

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageShockwave

readonly damageShockwave: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:238

damageShockwaveVariance

readonly damageShockwaveVariance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:240

U26F6 fixed-point client display value; exact encoded integer retained in raw.

damageSuperchill

readonly damageSuperchill: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:235

damageSuperchillVariance

readonly damageSuperchillVariance: FleetFixedValue;

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

U26F6 fixed-point client display value; exact encoded integer retained in raw.

fuelConsumptionRate

readonly fuelConsumptionRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:270

U26F6 fixed-point client display value; exact encoded integer retained in raw.

hitChance

readonly hitChance: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:262

U26F6 fixed-point hit value; no probability or percentage interpretation is implied.

hp

readonly hp: number;

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

lootRate

readonly lootRate: FleetFixedValue;

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

missileDamage

readonly missileDamage: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:272

U26F6 fixed-point client display value; exact encoded integer retained in raw.

missileFireRate

readonly missileFireRate: FleetFixedValue;

Defined in: packages/sage/src/internal/c4/fleet.ts:274

U26F6 fixed-point client display value; exact encoded integer retained in raw.

repairAbility

readonly repairAbility: FleetFixedValue;

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

repairCost

readonly repairCost: FleetFixedValue;

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

repairEfficiency

readonly repairEfficiency: FleetFixedValue;

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

repairRate

readonly repairRate: FleetFixedValue;

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

shieldBreakDelaySeconds

readonly shieldBreakDelaySeconds: number;

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

shieldRechargeRate

readonly shieldRechargeRate: FleetFixedValue;

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

sp

readonly sp: number;

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

stealthPower

readonly stealthPower: FleetFixedValue;

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

U26F6 fixed-point client display value; exact encoded integer retained in raw.

warpSpoolTimeSeconds

readonly warpSpoolTimeSeconds: number;

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

---

FleetCombatStatusSnapshot

Defined in: packages/sage/src/combat/index.ts:192

Immutable focused combat projection of one Fleet.

Example

declare const status: FleetCombatStatusSnapshot;
console.log(
  status.current.abilityPowerPoints,
  status.timing.abilityPowerReloadAtUnixSeconds,
);

Properties

current

readonly current: {
  abilityPowerPoints: number;
  hullPoints: number;
  pendingHullPoints: number;
  shieldPoints: number;
};

Defined in: packages/sage/src/combat/index.ts:200

abilityPowerPoints

readonly abilityPowerPoints: number;

hullPoints

readonly hullPoints: number;

pendingHullPoints

readonly pendingHullPoints: number;

shieldPoints

readonly shieldPoints: number;

faction

readonly faction: CombatFaction;

Defined in: packages/sage/src/combat/index.ts:196

fleet

readonly fleet: EntityRef<"fleet">;

Defined in: packages/sage/src/combat/index.ts:194

kind

readonly kind: "fleetCombatStatus";

Defined in: packages/sage/src/combat/index.ts:193

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/combat/index.ts:195

participant

readonly participant:
  | {
  kind: "player";
}
  | {
  factionId: number;
  kind: "npc";
};

Defined in: packages/sage/src/combat/index.ts:197

stance

readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};

Defined in: packages/sage/src/combat/index.ts:206

ammoUsage

readonly ammoUsage: "none" | "light" | "heavy";

stats

readonly stats: FleetCombatStatsData;

Defined in: packages/sage/src/combat/index.ts:217

stimulants

readonly stimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  stat:   | "damageKinetic"
     | "damageEnergy"
     | "damageEmp"
     | "damageSuperchill"
     | "damageShockwave"
     | "damageGraygoo"
     | "damageHeat"
     | "counterFlare"
     | "counterEnergyCapacitor"
     | "counterFaradayShielding"
     | "counterWarmingPlates"
     | "counterNegativeRemPlating"
     | "counterHealingNanobots"
     | "counterFireSuppressor"
     | "hitChance"
     | "aimAbility"
     | "critChance"
     | "critMultiplier"
     | "stealthPower";
}[];

Defined in: packages/sage/src/combat/index.ts:212

timing

readonly timing: {
  abilityPowerReloadAtUnixSeconds: bigint;
  lastCombatUpdateAtUnixSeconds: bigint;
  shieldBreakDelayEndsAtUnixSeconds: bigint;
};

Defined in: packages/sage/src/combat/index.ts:207

abilityPowerReloadAtUnixSeconds

readonly abilityPowerReloadAtUnixSeconds: bigint;

lastCombatUpdateAtUnixSeconds

readonly lastCombatUpdateAtUnixSeconds: bigint;

shieldBreakDelayEndsAtUnixSeconds

readonly shieldBreakDelayEndsAtUnixSeconds: bigint;

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

GameCombatConfigurationData

Defined in: packages/sage/src/internal/c4/game.ts:254

Translated Game combat configuration before cargo resolution.

Example

declare const configuration: GameCombatConfigurationData;
console.log(configuration.maxFleetSize);

Properties

cargoRespawnTimeSeconds

readonly cargoRespawnTimeSeconds: bigint;

Defined in: packages/sage/src/internal/c4/game.ts:261

crewRespawnTimeSeconds

readonly crewRespawnTimeSeconds: bigint;

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

globalCeasefire

readonly globalCeasefire: boolean;

Defined in: packages/sage/src/internal/c4/game.ts:255

interactionRange

readonly interactionRange: GameCombatFixedValueData;

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

lootExclusivityTimeSeconds

readonly lootExclusivityTimeSeconds: bigint;

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

maxFleetSize

readonly maxFleetSize: number;

Defined in: packages/sage/src/internal/c4/game.ts:263

maxLootRate

readonly maxLootRate: GameCombatFixedValueData;

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

rawShipsRespawnTimeSeconds

readonly rawShipsRespawnTimeSeconds: bigint;

Defined in: packages/sage/src/internal/c4/game.ts:262

starbaseUpgradeProgressContinuation

readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;

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

stimulantDefinitions

readonly stimulantDefinitions: {
  definitions: readonly GameStimulantDefinitionData[];
  sequenceId: number;
};

Defined in: packages/sage/src/internal/c4/game.ts:264

definitions

readonly definitions: readonly GameStimulantDefinitionData[];

sequenceId

readonly sequenceId: number;

---

GameStimulantEffectData

Defined in: packages/sage/src/internal/c4/game.ts:242

One translated combat stimulant effect.

Example

const effect: GameStimulantEffectData = {
  charges: 1,
  deltaBps: 250,
  stackRule: 'refresh',
  stat: 'damageEmp',
};

Properties

charges

readonly charges: number;

Defined in: packages/sage/src/internal/c4/game.ts:245

deltaBps

readonly deltaBps: number;

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

stackRule

readonly stackRule: "refresh" | "stack-to-max" | "additive";

Defined in: packages/sage/src/internal/c4/game.ts:246

stat

readonly stat:
  | "damageKinetic"
  | "damageEnergy"
  | "damageEmp"
  | "damageSuperchill"
  | "damageShockwave"
  | "damageGraygoo"
  | "damageHeat"
  | "counterFlare"
  | "counterEnergyCapacitor"
  | "counterFaradayShielding"
  | "counterWarmingPlates"
  | "counterNegativeRemPlating"
  | "counterHealingNanobots"
  | "counterFireSuppressor"
  | "hitChance"
  | "aimAbility"
  | "critChance"
  | "critMultiplier"
  | "stealthPower";

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

---

LootCargoItem

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

One resolved cargo quantity inside Loot.

Example

declare const item: LootCargoItem;
console.log(item.cargo.name, item.quantityRaw);

Properties

cargo

readonly cargo: CargoDefinitionSummary;

Defined in: packages/sage/src/combat/index.ts:229

quantityRaw

readonly quantityRaw: bigint;

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

---

LootInventory

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

Resolved inventory for one Loot leg.

Example

declare const inventory: LootInventory;
console.log(inventory.items.length);

Properties

items

readonly items: readonly LootCargoItem[];

Defined in: packages/sage/src/combat/index.ts:243

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

Defined in: packages/sage/src/combat/index.ts:242

---

LootItem

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

One translated Loot item group.

destroyer is the controlling Profile of the Fleet that destroyed the source, which holds exclusive access until exclusivityUnlockAtUnixSeconds and is the only Profile that may take reward cargo. Loot left by a Starbase kill has no destroyer.

Example

declare const item: LootItem;
console.log(item.destroyer?.address, item.exclusivityUnlockAtUnixSeconds);

Properties

destroyer?

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

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

exclusivityUnlockAtUnixSeconds

readonly exclusivityUnlockAtUnixSeconds: bigint;

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

inventory

readonly inventory: LootInventory;

Defined in: packages/sage/src/combat/index.ts:262

rewardReclaimAtUnixSeconds

readonly rewardReclaimAtUnixSeconds: bigint;

Defined in: packages/sage/src/combat/index.ts:261

---

LootRewardLeg

Defined in: packages/sage/src/internal/c4/loot.ts:80

One reward leg as combat and rewards both expose it.

Properties

medallionsRaw

readonly medallionsRaw: bigint;

Defined in: packages/sage/src/internal/c4/loot.ts:82

recipient

readonly recipient: EntityRef<"profile">;

Defined in: packages/sage/src/internal/c4/loot.ts:81

salvageTargetValueAtlasRaw

readonly salvageTargetValueAtlasRaw: bigint;

Defined in: packages/sage/src/internal/c4/loot.ts:83

---

LootSnapshot

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

Immutable Loot snapshot with resolved cargo inventory.

Example

declare const loot: LootSnapshot;
console.log(loot.reward.kind, loot.items.length);

Properties

address

readonly address: Address;

Defined in: packages/sage/src/combat/index.ts:274

coordinates

readonly coordinates: {
  x: number;
  y: number;
};

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

x

readonly x: number;

y

readonly y: number;

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/combat/index.ts:276

items

readonly items: readonly LootItem[];

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

kind

readonly kind: "loot";

Defined in: packages/sage/src/combat/index.ts:273

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/combat/index.ts:277

reward

readonly reward: LootRewardData;

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

version

readonly version: number;

Defined in: packages/sage/src/combat/index.ts:275

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/combat/index.ts:281

Returns

unknown

---

OutlawFlagAccountData

Defined in: packages/sage/src/internal/c4/combat.ts:20

Fully translated OutlawFlag account data.

Properties

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/combat.ts:27

declaredAtUnixSeconds

readonly declaredAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/combat.ts:25

faction

readonly faction: CombatFaction;

Defined in: packages/sage/src/internal/c4/combat.ts:23

isOutlaw

readonly isOutlaw: boolean;

Defined in: packages/sage/src/internal/c4/combat.ts:24

profile

readonly profile: Address;

Defined in: packages/sage/src/internal/c4/combat.ts:22

pvpUntilUnixSeconds

readonly pvpUntilUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/combat.ts:26

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/combat.ts:21

---

OutlawFlagSnapshot

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

Immutable optional outlaw declaration derived from Profile and faction.

Example

declare const flag: OutlawFlagSnapshot;
console.log(flag.isOutlaw, flag.pvpUntilUnixSeconds);

Extends

• Omit<OutlawFlagAccountData, "profile">

Properties

address

readonly address: Address;

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

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/combat.ts:27

Inherited from

OutlawFlagAccountData.bump

declaredAtUnixSeconds

readonly declaredAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/combat.ts:25

Inherited from

OutlawFlagAccountData.declaredAtUnixSeconds

faction

readonly faction: CombatFaction;

Defined in: packages/sage/src/internal/c4/combat.ts:23

Inherited from

OutlawFlagAccountData.faction

isOutlaw

readonly isOutlaw: boolean;

Defined in: packages/sage/src/internal/c4/combat.ts:24

Inherited from

OutlawFlagAccountData.isOutlaw

kind

readonly kind: "outlawFlag";

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

profile

readonly profile: EntityRef<"profile">;

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

pvpUntilUnixSeconds

readonly pvpUntilUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/combat.ts:26

Inherited from

OutlawFlagAccountData.pvpUntilUnixSeconds

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/combat.ts:21

Inherited from

OutlawFlagAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/combat/index.ts:298

Returns

unknown

Type Aliases

CombatFaction

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

Defined in: packages/sage/src/internal/c4/combat.ts:17

Faction identifier accepted by combat reads.

Example

const faction: CombatFaction = 'mud';

---

CombatStimulantStackRule

type CombatStimulantStackRule = typeof STACK_RULES[number];

Defined in: packages/sage/src/internal/c4/stimulant.ts:41

How a stimulant effect combines with an active one on the same stat. The game currently applies only refresh; the others are refused.

Example

const rule: CombatStimulantStackRule = 'refresh';

---

CombatStimulantStat

type CombatStimulantStat = typeof STIMULANT_STATS[number];

Defined in: packages/sage/src/internal/c4/stimulant.ts:30

The Fleet combat stat a stimulant effect modifies.

Example

const stat: CombatStimulantStat = 'damageEmp';

---

LootDiscoveryOptions

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

Defined in: packages/sage/src/combat/index.ts:145

Options supported by targeted Loot discovery.

Example

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

---

LootRewardData

type LootRewardData =
  | {
  kind: "none";
}
  | {
  committedAtUnixSeconds: bigint;
  configVersion: number;
  kind: "committed" | "resolved";
  legs: readonly LootRewardLeg[];
  slot: bigint;
}
  | {
  committedAtUnixSeconds: bigint;
  configVersion: number;
  kind: "unknown";
  legs: readonly LootRewardLeg[];
  rawStatus: number;
  slot: bigint;
};

Defined in: packages/sage/src/internal/c4/loot.ts:87

Public reward state; leg recipients are Profile references.

Functions

getCombatConfiguration()

function getCombatConfiguration(context, options?): Promise<CombatConfigurationSnapshot>;

Defined in: packages/sage/src/combat/index.ts:352

Reads the configured Game’s combat settings and stimulant catalog.

Parameters

Parameter	Type
context	SageContext
options?	ReadOptions

Returns

Promise<CombatConfigurationSnapshot>

Example

declare const ctx: SageContext;
const configuration = await getCombatConfiguration(ctx);

---

getFleetCombatStatus()

function getFleetCombatStatus(
   context,
   address,
options?): Promise<FleetCombatStatusSnapshot>;

Defined in: packages/sage/src/combat/index.ts:418

Reads one Fleet and returns only its translated combat state.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<FleetCombatStatusSnapshot>

Example

declare const ctx: SageContext;
declare const fleet: Address;
const status = await getFleetCombatStatus(ctx, fleet);

---

getLoot()

function getLoot(
   context,
   address,
options?): Promise<LootSnapshot>;

Defined in: packages/sage/src/combat/index.ts:516

Reads required Loot by its signer-created account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<LootSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const loot = await getLoot(ctx, address);

---

getLootByProfile()

function getLootByProfile(
   context,
   profile,
options?): Promise<readonly LootSnapshot[]>;

Defined in: packages/sage/src/combat/index.ts:558

Discovers Loot created by one Profile using stable targeted filters.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	LootDiscoveryOptions

Returns

Promise<readonly LootSnapshot[]>

Example

declare const ctx: SageContext;
declare const profile: Address;
const loot = await getLootByProfile(ctx, profile);

---

getOutlawFlag()

function getOutlawFlag(
   context,
   profile,
   againstFaction,
   options?): Promise<
  | OutlawFlagSnapshot
| undefined>;

Defined in: packages/sage/src/combat/index.ts:600

Derives and reads an optional OutlawFlag for a Profile/faction pair.

Parameters

Parameter	Type
context	SageContext
profile	Address
againstFaction	CombatFaction
options?	ReadOptions

Returns

Promise< | OutlawFlagSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const profile: Address;
const flag = await getOutlawFlag(ctx, profile, 'mud');

---

maybeGetLoot()

function maybeGetLoot(
   context,
   address,
options?): Promise<LootSnapshot | undefined>;

Defined in: packages/sage/src/combat/index.ts:536

Reads optional Loot by account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<LootSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const loot = await maybeGetLoot(ctx, address);