# combat
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

Markdown source of https://develop.atlas-kit-docs.pages.dev/reference/combat/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

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

### CombatConfigurationSnapshot

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

Immutable Game combat configuration and stimulant catalog.

#### Example

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

#### Extends

- `Omit`\<[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata), `"stimulantDefinitions"`\>

#### Properties

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

##### address

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

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

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

##### cargoRespawnTimeSeconds

```ts
readonly cargoRespawnTimeSeconds: bigint;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`cargoRespawnTimeSeconds`](/reference/combat/#gamecombatconfigurationdata)

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

##### crewRespawnTimeSeconds

```ts
readonly crewRespawnTimeSeconds: bigint;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`crewRespawnTimeSeconds`](/reference/combat/#gamecombatconfigurationdata)

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

##### globalCeasefire

```ts
readonly globalCeasefire: boolean;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`globalCeasefire`](/reference/combat/#gamecombatconfigurationdata)

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

##### interactionRange

```ts
readonly interactionRange: GameCombatFixedValueData;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`interactionRange`](/reference/combat/#gamecombatconfigurationdata)

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

##### kind

```ts
readonly kind: "combatConfiguration";
```

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

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

##### lootExclusivityTimeSeconds

```ts
readonly lootExclusivityTimeSeconds: bigint;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`lootExclusivityTimeSeconds`](/reference/combat/#gamecombatconfigurationdata)

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

##### maxFleetSize

```ts
readonly maxFleetSize: number;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`maxFleetSize`](/reference/combat/#gamecombatconfigurationdata)

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

##### maxLootRate

```ts
readonly maxLootRate: GameCombatFixedValueData;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`maxLootRate`](/reference/combat/#gamecombatconfigurationdata)

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

##### rawShipsRespawnTimeSeconds

```ts
readonly rawShipsRespawnTimeSeconds: bigint;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`rawShipsRespawnTimeSeconds`](/reference/combat/#gamecombatconfigurationdata)

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

##### starbaseUpgradeProgressContinuation

```ts
readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;
```

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

###### Inherited from

[`GameCombatConfigurationData`](/reference/combat/#gamecombatconfigurationdata).[`starbaseUpgradeProgressContinuation`](/reference/combat/#gamecombatconfigurationdata)

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

##### stimulantDefinitions

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

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

###### definitions

```ts
readonly definitions: readonly CombatStimulantDefinition[];
```

###### sequenceId

```ts
readonly sequenceId: number;
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### CombatStimulantDefinition

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

One cargo-backed combat stimulant definition.

#### Example

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

#### Properties

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

##### cargo

```ts
readonly cargo: CargoDefinitionSummary;
```

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

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

##### effects

```ts
readonly effects: readonly GameStimulantEffectData[];
```

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

***

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

### FleetCombatStatsData

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

Translated Fleet combat statistics.

#### Example

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

#### Properties

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

##### aimAbility

```ts
readonly aimAbility: FleetFixedValue;
```

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

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

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

##### ammoConsumptionRate

```ts
readonly ammoConsumptionRate: FleetFixedValue;
```

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

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

##### ap

```ts
readonly ap: number;
```

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

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

##### apRegenRate

```ts
readonly apRegenRate: FleetFixedValue;
```

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

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

##### counterDecoy

```ts
readonly counterDecoy: number;
```

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

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

##### counterEnergyCapacitor

```ts
readonly counterEnergyCapacitor: number;
```

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

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

##### counterFaradayShielding

```ts
readonly counterFaradayShielding: number;
```

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

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

##### counterFireSuppressor

```ts
readonly counterFireSuppressor: number;
```

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

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

##### counterFlare

```ts
readonly counterFlare: number;
```

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

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

##### counterHealingNanobots

```ts
readonly counterHealingNanobots: number;
```

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

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

##### counterMine

```ts
readonly counterMine: number;
```

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

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

##### counterNegativeRemPlating

```ts
readonly counterNegativeRemPlating: number;
```

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

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

##### counterWarmingPlates

```ts
readonly counterWarmingPlates: number;
```

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

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

##### critChance

```ts
readonly critChance: FleetFixedValue;
```

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

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

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

##### critMultiplier

```ts
readonly critMultiplier: FleetFixedValue;
```

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

U26F6 fixed-point critical multiplier.

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

##### damageBomb

```ts
readonly damageBomb: number;
```

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

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

##### damageBombVariance

```ts
readonly damageBombVariance: FleetFixedValue;
```

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

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

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

##### damageEmp

```ts
readonly damageEmp: number;
```

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

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

##### damageEmpVariance

```ts
readonly damageEmpVariance: FleetFixedValue;
```

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

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

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

##### damageEnergy

```ts
readonly damageEnergy: number;
```

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

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

##### damageEnergyVariance

```ts
readonly damageEnergyVariance: FleetFixedValue;
```

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

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

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

##### damageGraygoo

```ts
readonly damageGraygoo: number;
```

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

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

##### damageGraygooVariance

```ts
readonly damageGraygooVariance: FleetFixedValue;
```

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

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

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

##### damageHeat

```ts
readonly damageHeat: number;
```

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

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

##### damageHeatVariance

```ts
readonly damageHeatVariance: FleetFixedValue;
```

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

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

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

##### damageKinetic

```ts
readonly damageKinetic: number;
```

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

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

##### damageKineticVariance

```ts
readonly damageKineticVariance: FleetFixedValue;
```

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

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

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

##### damageShockwave

```ts
readonly damageShockwave: number;
```

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

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

##### damageShockwaveVariance

```ts
readonly damageShockwaveVariance: FleetFixedValue;
```

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

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

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

##### damageSuperchill

```ts
readonly damageSuperchill: number;
```

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

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

##### damageSuperchillVariance

```ts
readonly damageSuperchillVariance: FleetFixedValue;
```

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

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

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

##### fuelConsumptionRate

```ts
readonly fuelConsumptionRate: FleetFixedValue;
```

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

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

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

##### hitChance

```ts
readonly hitChance: FleetFixedValue;
```

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

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

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

##### hp

```ts
readonly hp: number;
```

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

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

##### lootRate

```ts
readonly lootRate: FleetFixedValue;
```

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

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

##### missileDamage

```ts
readonly missileDamage: FleetFixedValue;
```

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

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

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

##### missileFireRate

```ts
readonly missileFireRate: FleetFixedValue;
```

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

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

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

##### repairAbility

```ts
readonly repairAbility: FleetFixedValue;
```

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

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

##### repairCost

```ts
readonly repairCost: FleetFixedValue;
```

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

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

##### repairEfficiency

```ts
readonly repairEfficiency: FleetFixedValue;
```

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

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

##### repairRate

```ts
readonly repairRate: FleetFixedValue;
```

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

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

##### shieldBreakDelaySeconds

```ts
readonly shieldBreakDelaySeconds: number;
```

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

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

##### shieldRechargeRate

```ts
readonly shieldRechargeRate: FleetFixedValue;
```

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

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

##### sp

```ts
readonly sp: number;
```

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

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

##### stealthPower

```ts
readonly stealthPower: FleetFixedValue;
```

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

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

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

##### warpSpoolTimeSeconds

```ts
readonly warpSpoolTimeSeconds: number;
```

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

***

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

### FleetCombatStatusSnapshot

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

Immutable focused combat projection of one Fleet.

#### Example

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

#### Properties

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

##### current

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

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

###### abilityPowerPoints

```ts
readonly abilityPowerPoints: number;
```

###### hullPoints

```ts
readonly hullPoints: number;
```

###### pendingHullPoints

```ts
readonly pendingHullPoints: number;
```

###### shieldPoints

```ts
readonly shieldPoints: number;
```

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

##### faction

```ts
readonly faction: CombatFaction;
```

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

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

##### fleet

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

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

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

##### kind

```ts
readonly kind: "fleetCombatStatus";
```

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

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

##### ownerProfile

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

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

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

##### participant

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

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

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

##### stance

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

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

###### ammoUsage

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

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

##### stats

```ts
readonly stats: FleetCombatStatsData;
```

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

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

##### stimulants

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

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

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

##### timing

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

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

###### abilityPowerReloadAtUnixSeconds

```ts
readonly abilityPowerReloadAtUnixSeconds: bigint;
```

###### lastCombatUpdateAtUnixSeconds

```ts
readonly lastCombatUpdateAtUnixSeconds: bigint;
```

###### shieldBreakDelayEndsAtUnixSeconds

```ts
readonly shieldBreakDelayEndsAtUnixSeconds: bigint;
```

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### GameCombatConfigurationData

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

Translated Game combat configuration before cargo resolution.

#### Example

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

#### Properties

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

##### cargoRespawnTimeSeconds

```ts
readonly cargoRespawnTimeSeconds: bigint;
```

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

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

##### crewRespawnTimeSeconds

```ts
readonly crewRespawnTimeSeconds: bigint;
```

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

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

##### globalCeasefire

```ts
readonly globalCeasefire: boolean;
```

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

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

##### interactionRange

```ts
readonly interactionRange: GameCombatFixedValueData;
```

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

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

##### lootExclusivityTimeSeconds

```ts
readonly lootExclusivityTimeSeconds: bigint;
```

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

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

##### maxFleetSize

```ts
readonly maxFleetSize: number;
```

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

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

##### maxLootRate

```ts
readonly maxLootRate: GameCombatFixedValueData;
```

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

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

##### rawShipsRespawnTimeSeconds

```ts
readonly rawShipsRespawnTimeSeconds: bigint;
```

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

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

##### starbaseUpgradeProgressContinuation

```ts
readonly starbaseUpgradeProgressContinuation: GameCombatFixedValueData;
```

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

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

##### stimulantDefinitions

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

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

###### definitions

```ts
readonly definitions: readonly GameStimulantDefinitionData[];
```

###### sequenceId

```ts
readonly sequenceId: number;
```

***

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

### GameStimulantEffectData

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

One translated combat stimulant effect.

#### Example

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

#### Properties

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

##### charges

```ts
readonly charges: number;
```

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

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

##### deltaBps

```ts
readonly deltaBps: number;
```

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

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

##### stackRuleId

```ts
readonly stackRuleId: number;
```

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

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

##### statId

```ts
readonly statId: number;
```

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

***

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

### LootCargoItem

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

One resolved cargo quantity inside Loot.

#### Example

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

#### Properties

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

##### cargo

```ts
readonly cargo: CargoDefinitionSummary;
```

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

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

##### quantityRaw

```ts
readonly quantityRaw: bigint;
```

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

***

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

### LootInventory

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

Resolved inventory for one Loot leg.

#### Example

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

#### Properties

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

##### items

```ts
readonly items: readonly LootCargoItem[];
```

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

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

##### sequenceId

```ts
readonly sequenceId: number;
```

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

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

##### usedStorageUnitsRaw

```ts
readonly usedStorageUnitsRaw: bigint;
```

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

***

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

### LootItem

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

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

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

#### Properties

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

##### destroyer?

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

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

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

##### exclusivityUnlockAtUnixSeconds

```ts
readonly exclusivityUnlockAtUnixSeconds: bigint;
```

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

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

##### inventory

```ts
readonly inventory: LootInventory;
```

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

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

##### rewardReclaimAtUnixSeconds

```ts
readonly rewardReclaimAtUnixSeconds: bigint;
```

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

***

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

### LootRewardLeg

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

One reward leg as combat and rewards both expose it.

#### Properties

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

##### medallionsRaw

```ts
readonly medallionsRaw: bigint;
```

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

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

##### recipient

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

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

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

##### salvageTargetValueAtlasRaw

```ts
readonly salvageTargetValueAtlasRaw: bigint;
```

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

***

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

### LootSnapshot

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

Immutable Loot snapshot with resolved cargo inventory.

#### Example

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

#### Properties

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

##### address

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

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

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

##### coordinates

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

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

###### x

```ts
readonly x: number;
```

###### y

```ts
readonly y: number;
```

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

##### game

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

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

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

##### items

```ts
readonly items: readonly LootItem[];
```

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

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

##### kind

```ts
readonly kind: "loot";
```

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

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

##### profile

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

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

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

##### reward

```ts
readonly reward: LootRewardData;
```

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

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

##### version

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

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

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### OutlawFlagAccountData

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

Fully translated OutlawFlag account data.

#### Properties

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

##### bump

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

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

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

##### declaredAtUnixSeconds

```ts
readonly declaredAtUnixSeconds: bigint;
```

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

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

##### faction

```ts
readonly faction: CombatFaction;
```

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

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

##### isOutlaw

```ts
readonly isOutlaw: boolean;
```

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

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

##### profile

```ts
readonly profile: Address;
```

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

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

##### pvpUntilUnixSeconds

```ts
readonly pvpUntilUnixSeconds: bigint;
```

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

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

##### version

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

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

***

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

### OutlawFlagSnapshot

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

Immutable optional outlaw declaration derived from Profile and faction.

#### Example

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

#### Extends

- `Omit`\<[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata), `"profile"`\>

#### Properties

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

##### address

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

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

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

##### bump

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

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`bump`](/reference/combat/#outlawflagaccountdata)

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

##### declaredAtUnixSeconds

```ts
readonly declaredAtUnixSeconds: bigint;
```

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`declaredAtUnixSeconds`](/reference/combat/#outlawflagaccountdata)

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

##### faction

```ts
readonly faction: CombatFaction;
```

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`faction`](/reference/combat/#outlawflagaccountdata)

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

##### isOutlaw

```ts
readonly isOutlaw: boolean;
```

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`isOutlaw`](/reference/combat/#outlawflagaccountdata)

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

##### kind

```ts
readonly kind: "outlawFlag";
```

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

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

##### profile

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

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

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

##### pvpUntilUnixSeconds

```ts
readonly pvpUntilUnixSeconds: bigint;
```

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`pvpUntilUnixSeconds`](/reference/combat/#outlawflagaccountdata)

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

##### version

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

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

###### Inherited from

[`OutlawFlagAccountData`](/reference/combat/#outlawflagaccountdata).[`version`](/reference/combat/#outlawflagaccountdata)

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

## Type Aliases

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

### CombatFaction

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

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

Faction identifier accepted by combat reads.

#### Example

```ts
const faction: CombatFaction = 'mud';
```

***

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

### LootDiscoveryOptions

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

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

Options supported by targeted Loot discovery.

#### Example

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

***

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

### LootRewardData

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

Public reward state; leg recipients are Profile references.

## Functions

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

### getCombatConfiguration()

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

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

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`CombatConfigurationSnapshot`](/reference/combat/#combatconfigurationsnapshot)\>

#### Example

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

***

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

### getFleetCombatStatus()

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

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

Reads one Fleet and returns only its translated combat state.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`FleetCombatStatusSnapshot`](/reference/combat/#fleetcombatstatussnapshot)\>

#### Example

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

***

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

### getLoot()

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

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

Reads required Loot by its signer-created account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`LootSnapshot`](/reference/combat/#lootsnapshot)\>

#### Example

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

***

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

### getLootByProfile()

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

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

Discovers Loot created by one Profile using stable targeted filters.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `profile` | [`Address`](/reference/#address-20) |
| `options?` | [`LootDiscoveryOptions`](/reference/combat/#lootdiscoveryoptions) |

#### Returns

`Promise`\<readonly [`LootSnapshot`](/reference/combat/#lootsnapshot)[]\>

#### Example

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

***

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

### getOutlawFlag()

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

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

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `profile` | [`Address`](/reference/#address-20) |
| `againstFaction` | [`CombatFaction`](/reference/combat/#combatfaction) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`OutlawFlagSnapshot`](/reference/combat/#outlawflagsnapshot)
  \| `undefined`\>

#### Example

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

***

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

### maybeGetLoot()

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

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

Reads optional Loot by account address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`LootSnapshot`](/reference/combat/#lootsnapshot) \| `undefined`\>

#### Example

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