combat

Interfaces

CombatConfigurationSnapshot

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

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

cargoRespawnTimeSeconds

readonly cargoRespawnTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.cargoRespawnTimeSeconds

crewRespawnTimeSeconds

readonly crewRespawnTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.crewRespawnTimeSeconds

globalCeasefire

readonly globalCeasefire: boolean;

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

Inherited from

GameCombatConfigurationData.globalCeasefire

interactionRange

readonly interactionRange: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.interactionRange

kind

readonly kind: "combatConfiguration";

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

lootExclusivityTimeSeconds

readonly lootExclusivityTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.lootExclusivityTimeSeconds

maxFleetSize

readonly maxFleetSize: number;

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

Inherited from

GameCombatConfigurationData.maxFleetSize

maxLootRate

readonly maxLootRate: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.maxLootRate

rawShipsRespawnTimeSeconds

readonly rawShipsRespawnTimeSeconds: bigint;

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

Inherited from

GameCombatConfigurationData.rawShipsRespawnTimeSeconds

starbaseUpgradeProgressContinuation

readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;

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

Inherited from

GameCombatConfigurationData.starbaseUpgradeProgressContinuation

stimulantDefinitions

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

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

definitions

readonly definitions: readonly CombatStimulantDefinition[];

sequenceId

readonly sequenceId: number;

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

CombatStimulantDefinition

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

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

effects

readonly effects: readonly GameStimulantEffectData[];

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

---

FleetCombatStatsData

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

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

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

ap

readonly ap: number;

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

apRegenRate

readonly apRegenRate: FleetFixedValue;

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

counterDecoy

readonly counterDecoy: number;

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

counterEnergyCapacitor

readonly counterEnergyCapacitor: number;

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

counterFaradayShielding

readonly counterFaradayShielding: number;

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

counterFireSuppressor

readonly counterFireSuppressor: number;

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

counterFlare

readonly counterFlare: number;

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

counterHealingNanobots

readonly counterHealingNanobots: number;

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

counterMine

readonly counterMine: number;

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

counterNegativeRemPlating

readonly counterNegativeRemPlating: number;

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

counterWarmingPlates

readonly counterWarmingPlates: number;

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

critChance

readonly critChance: FleetFixedValue;

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

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

U26F6 fixed-point critical multiplier.

damageBomb

readonly damageBomb: number;

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

damageBombVariance

readonly damageBombVariance: FleetFixedValue;

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

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

damageEmpVariance

readonly damageEmpVariance: FleetFixedValue;

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

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

damageEnergyVariance

readonly damageEnergyVariance: FleetFixedValue;

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

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

damageGraygooVariance

readonly damageGraygooVariance: FleetFixedValue;

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

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

damageHeatVariance

readonly damageHeatVariance: FleetFixedValue;

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

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

damageKineticVariance

readonly damageKineticVariance: FleetFixedValue;

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

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

damageShockwaveVariance

readonly damageShockwaveVariance: FleetFixedValue;

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

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

damageSuperchillVariance

readonly damageSuperchillVariance: FleetFixedValue;

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

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

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

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

lootRate

readonly lootRate: FleetFixedValue;

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

missileDamage

readonly missileDamage: FleetFixedValue;

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

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

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

repairCost

readonly repairCost: FleetFixedValue;

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

repairEfficiency

readonly repairEfficiency: FleetFixedValue;

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

repairRate

readonly repairRate: FleetFixedValue;

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

shieldBreakDelaySeconds

readonly shieldBreakDelaySeconds: number;

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

shieldRechargeRate

readonly shieldRechargeRate: FleetFixedValue;

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

sp

readonly sp: number;

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

stealthPower

readonly stealthPower: FleetFixedValue;

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

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

---

FleetCombatStatusSnapshot

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

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

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

fleet

readonly fleet: EntityRef<"fleet">;

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

kind

readonly kind: "fleetCombatStatus";

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

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

participant

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

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

stance

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

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

ammoUsage

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

stats

readonly stats: FleetCombatStatsData;

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

stimulants

readonly stimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  statId: number;
}[];

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

timing

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

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

abilityPowerReloadAtUnixSeconds

readonly abilityPowerReloadAtUnixSeconds: bigint;

lastCombatUpdateAtUnixSeconds

readonly lastCombatUpdateAtUnixSeconds: bigint;

shieldBreakDelayEndsAtUnixSeconds

readonly shieldBreakDelayEndsAtUnixSeconds: bigint;

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

GameCombatConfigurationData

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

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

crewRespawnTimeSeconds

readonly crewRespawnTimeSeconds: bigint;

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

globalCeasefire

readonly globalCeasefire: boolean;

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

interactionRange

readonly interactionRange: GameCombatFixedValueData;

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

lootExclusivityTimeSeconds

readonly lootExclusivityTimeSeconds: bigint;

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

maxFleetSize

readonly maxFleetSize: number;

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

maxLootRate

readonly maxLootRate: GameCombatFixedValueData;

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

rawShipsRespawnTimeSeconds

readonly rawShipsRespawnTimeSeconds: bigint;

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

starbaseUpgradeProgressContinuation

readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;

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

stimulantDefinitions

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

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

definitions

readonly definitions: readonly GameStimulantDefinitionData[];

sequenceId

readonly sequenceId: number;

---

GameStimulantEffectData

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

One translated combat stimulant effect.

Example

const effect: GameStimulantEffectData = {
  charges: 1,
  deltaBps: 250,
  stackRuleId: 0,
  statId: 2,
};

Properties

charges

readonly charges: number;

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

deltaBps

readonly deltaBps: number;

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

stackRuleId

readonly stackRuleId: number;

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

statId

readonly statId: number;

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

---

LootCargoItem

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

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

quantityRaw

readonly quantityRaw: bigint;

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

---

LootInventory

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

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

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

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

---

LootItem

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

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

exclusivityUnlockAtUnixSeconds

readonly exclusivityUnlockAtUnixSeconds: bigint;

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

inventory

readonly inventory: LootInventory;

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

rewardReclaimAtUnixSeconds

readonly rewardReclaimAtUnixSeconds: bigint;

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

---

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

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

coordinates

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

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

x

readonly x: number;

y

readonly y: number;

game

readonly game: EntityRef<"game">;

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

items

readonly items: readonly LootItem[];

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

kind

readonly kind: "loot";

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

profile

readonly profile: EntityRef<"profile">;

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

reward

readonly reward: LootRewardData;

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

version

readonly version: number;

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

Methods

toJSON()

toJSON(): unknown;

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

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

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

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

profile

readonly profile: EntityRef<"profile">;

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

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

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

---

LootDiscoveryOptions

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

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

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

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

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

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

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

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

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