fleethub-core 1.11.17 → 1.11.18

package/node/fleethub_core.d.ts

@@ -23,6 +23,33 @@ export interface DamageReport {
   damage_state_density: Histogram<DamageState, number>;
 }
 
+export interface CompAnalyzerConfig {
+  engagement: Engagement;
+  formation: Formation;
+  anti_air_cutin: number | null;
+  ship_anti_air_resist: number;
+  fleet_anti_air_resist: number;
+  left_night_fleet_conditions: NightFleetConditions;
+  right_night_fleet_conditions: NightFleetConditions;
+}
+
+export interface CompNightAnalysis {
+  night_cutin: CompNightCutinAnalysis;
+  fleet_cutin: FleetCutinReport<NightAttackStyle>[];
+}
+
+export interface CompDayAnalysis {
+  day_cutin: CompDayCutinAnalysis;
+  fleet_cutin: FleetCutinReport<ShellingStyle>[];
+}
+
+export interface CompAnalysis {
+  day: CompDayAnalysis;
+  night: CompNightAnalysis;
+  contact: ContactAnalysis;
+  anti_air: CompAntiAirAnalysis;
+}
+
 export type AirSquadronMode = "Sortie" | "AirDefense";
 
 export interface AirSquadronState extends GearVecState, SlotSizeVecState {
@@ -39,10 +66,9 @@ export type AirState =
 
 export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
 
-export interface ShipConditions extends ShipPosition {
-  formation?: Formation;
-  amagiri_index?: number | null;
-}
+export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
+
+export type Role = "Main" | "Escort";
 
 export interface SupportShellingSimulatorParams {
   attacker_formation?: Formation;
@@ -51,8 +77,6 @@ export interface SupportShellingSimulatorParams {
   node_state: NodeState;
 }
 
-export type FhResult<T> = { Ok: T } | { Err: string };
-
 export interface MasterIBonuses {
   shelling_power: MasterIBonusRule[];
   shelling_accuracy: MasterIBonusRule[];
@@ -89,6 +113,7 @@ export interface AttackPower {
 }
 
 export interface AttackPowerParams {
+  is_cutin: boolean;
   basic: number;
   cap: number;
   precap_mod: AttackPowerModifier;
@@ -98,38 +123,12 @@ export interface AttackPowerParams {
   proficiency_critical_mod: number;
   armor_penetration: number;
   remaining_ammo_mod: number;
+  balloon_mod: number;
   special_enemy_mods: SpecialEnemyModifiers;
   historical_mod: AttackPowerModifier;
   custom_mods: CustomPowerModifiers;
 }
 
-export interface CompAnalyzerConfig {
-  engagement: Engagement;
-  formation: Formation;
-  anti_air_cutin: number | null;
-  ship_anti_air_resist: number;
-  fleet_anti_air_resist: number;
-  left_night_fleet_conditions: NightFleetConditions;
-  right_night_fleet_conditions: NightFleetConditions;
-}
-
-export interface CompNightAnalysis {
-  night_cutin: CompNightCutinAnalysis;
-  fleet_cutin: FleetCutinReport<NightAttackStyle>[];
-}
-
-export interface CompDayAnalysis {
-  day_cutin: CompDayCutinAnalysis;
-  fleet_cutin: FleetCutinReport<ShellingStyle>[];
-}
-
-export interface CompAnalysis {
-  day: CompDayAnalysis;
-  night: CompNightAnalysis;
-  contact: ContactAnalysis;
-  anti_air: CompAntiAirAnalysis;
-}
-
 export interface ActionReport<T> {
   data: Record<string, AttackReport<T>>;
   damage_state_density: Histogram<DamageState, number> | null;
@@ -185,10 +184,6 @@ export interface NightFleetConditions {
 
 export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
-export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
-
-export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
-
 export interface FleetState {
   id?: string;
   len?: number;
@@ -216,21 +211,14 @@ export interface CompMeta {
   fleets: Record<FleetType, FleetMeta>;
 }
 
-export type SpecialEnemyType =
-  | "None"
-  | "SoftSkinned"
-  | "Pillbox"
-  | "IsolatedIsland"
-  | "SupplyDepot"
-  | "NewSupplyDepot"
-  | "HarbourSummerPrincess"
-  | "PtImp"
-  | "BattleshipSummerPrincess"
-  | "HeavyCruiserSummerPrincess"
-  | "FrenchBattleshipPrincess"
-  | "AnchorageWaterDemonVacationMode"
-  | "DockPrincess"
-  | "SummerAircraftCarrierDemon";
+export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
+
+export interface ShipConditions extends ShipPosition {
+  formation?: Formation;
+  amagiri_index?: number | null;
+}
+
+export type FhResult<T> = { Ok: T } | { Err: string };
 
 export interface MasterData extends MasterBattleDefinitions {
   created_at: number;
@@ -253,37 +241,6 @@ export interface MasterAttrRule<T> {
   expr: CompiledEvaler;
 }
 
-export interface EquippabilityRule {
-  ship: CompiledEvaler;
-  keys?: string[];
-  include?: string;
-  exclude?: string;
-}
-
-export interface MasterEquippability {
-  equip_stype: EquipStype[];
-  equip_exslot: number[];
-  equip_ship: MstEquipShip[];
-  equip_exslot_ship: Record<number, MstEquipExslotShip>;
-  rules: EquippabilityRule[];
-}
-
-export interface MstEquipExslotShip {
-  api_ctypes: Record<number, number> | null;
-  api_ship_ids: Record<number, number> | null;
-  api_stypes: Record<number, number> | null;
-}
-
-export interface MstEquipShip {
-  api_ship_id: number;
-  api_equip_type: number[];
-}
-
-export interface EquipStype {
-  id: number;
-  equip_type: number[];
-}
-
 export interface MasterBattleDefinitions {
   formation: NestedFormationDef[];
   anti_air_cutin: AntiAirCutinDef[];
@@ -335,7 +292,12 @@ export interface DayCutinReport extends ActionReport<DayPhaseAttackStyle> {
   observation_term: number | null;
 }
 
-export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
+export interface AttackAnalyzerShipConfig
+  extends ShipConditions,
+    NightFleetConditions {
+  balloons?: number;
+  fleet_los_mod?: number | null;
+}
 
 export type SingleFormation =
   | "LineAhead"
@@ -384,8 +346,6 @@ export type GearAttr =
   | "SemiNightPlane"
   | "HighAltitudeInterceptor";
 
-export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
-
 export interface OrgState {
   id?: string;
   f1?: FleetState;
@@ -412,55 +372,55 @@ export type OrgType =
   | "EnemySingle"
   | "EnemyCombined";
 
-export type Role = "Main" | "Escort";
+export interface EquippabilityRule {
+  ship: CompiledEvaler;
+  keys?: string[];
+  include?: string;
+  exclude?: string;
+}
 
-export type Histogram<K extends keyof any, V> = Partial<Record<K, V>>;
+export interface MasterEquippability {
+  equip_stype: EquipStype[];
+  equip_exslot: number[];
+  equip_ship: MstEquipShip[];
+  equip_exslot_ship: Record<number, MstEquipExslotShip>;
+  rules: EquippabilityRule[];
+}
 
-export interface SimulatorResult {
-  items: SimulatorResultItem[];
-  sunk_vec: [number, number, number][];
+export interface MstEquipExslotShip {
+  api_ctypes: Record<number, number> | null;
+  api_ship_ids: Record<number, number> | null;
+  api_stypes: Record<number, number> | null;
 }
 
-export interface SimulatorResultItem {
-  id: string;
-  fleet_type: FleetType;
-  index: number;
-  damage_state_map: Record<DamageState, number>;
+export interface MstEquipShip {
+  api_ship_id: number;
+  api_equip_type: number[];
 }
 
-export interface AttackReport<T> {
-  style: T;
-  proc_rate: number | null;
-  attack_power: AttackPower | null;
-  attack_power_params: AttackPowerParams | null;
-  hits: number;
-  hit_rate: HitRate | null;
-  hit_rate_params: HitRateParams | null;
-  damage: DamageReport | null;
+export interface EquipStype {
+  id: number;
+  equip_type: number[];
 }
 
-export interface AttackAnalyzerShipConfig
-  extends ShipConditions,
-    NightFleetConditions {
-  fleet_los_mod?: number | null;
+export interface NodeAttackAnalyzerShipConfig extends NightFleetConditions {
+  formation?: Formation;
+  balloons?: number;
 }
 
-export interface CompAntiAirAnalysis {
-  fleet_adjusted_anti_air: number;
-  ships: AntiAirReport[];
-  anti_air_cutin_chance: [number, number][];
+export interface NodeAttackAnalyzerConfig {
+  air_state?: AirState;
+  engagement?: Engagement;
+  node_state?: NodeState;
+  left?: NodeAttackAnalyzerShipConfig;
+  right?: NodeAttackAnalyzerShipConfig;
 }
 
-export interface AntiAirReport {
-  ship_id: number;
-  role: Role;
-  index: number;
-  adjusted_anti_air: number | null;
-  proportional_shotdown_rate: number | null;
-  fixed_shotdown_number: number | null;
-  guaranteed: number | null;
-  anti_air_cutin_chance: [number, number][];
-  anti_air_propellant_barrage_chance: number | null;
+export interface NodeAttackAnalysis {
+  left: AttackAnalysis;
+  right: AttackAnalysis;
+  shelling_fleet_cutin: FleetCutinReport<ShellingStyle>[];
+  night_fleet_cutin: FleetCutinReport<NightAttackStyle>[];
 }
 
 export interface FormationCombatModifiersDef {
@@ -536,6 +496,8 @@ export interface BattleDefinitions {
   historical_bonuses: HistoricalBonusDef[];
 }
 
+export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
+
 export interface ShipPosition {
   org_type?: OrgType;
   fleet_type?: FleetType;
@@ -543,6 +505,49 @@ export interface ShipPosition {
   index?: number;
 }
 
+export interface SimulatorResult {
+  items: SimulatorResultItem[];
+  sunk_vec: [number, number, number][];
+}
+
+export interface SimulatorResultItem {
+  id: string;
+  fleet_type: FleetType;
+  index: number;
+  damage_state_map: Record<DamageState, number>;
+}
+
+export interface ContactAnalysis {
+  single: DayContactChance[] | null;
+  combined: DayContactChance[] | null;
+}
+
+export interface DayContactChance {
+  air_state: AirState;
+  trigger_rate: number;
+  rank3: number;
+  rank2: number;
+  rank1: number;
+  total: number;
+}
+
+export type NodeId = string;
+
+export interface NodeState {
+  map?: number;
+  node?: NodeId;
+  phase?: number;
+  debuff?: boolean;
+  disable_historical_mod?: boolean;
+  landing_battle?: boolean;
+}
+
+export type Side = "Player" | "Enemy";
+
+export type Align = "Left" | "Right";
+
+export type Histogram<K extends keyof any, V> = Partial<Record<K, V>>;
+
 export type CompiledEvaler = string;
 
 export interface HitRate {
@@ -567,37 +572,33 @@ export interface ShipAnalyzerConfig {
   right?: AttackAnalyzerShipConfig;
 }
 
-export interface NodeAttackAnalyzerShipConfig extends NightFleetConditions {
-  formation?: Formation;
-}
-
-export interface NodeAttackAnalyzerConfig {
-  air_state?: AirState;
-  engagement?: Engagement;
-  node_state?: NodeState;
-  left?: NodeAttackAnalyzerShipConfig;
-  right?: NodeAttackAnalyzerShipConfig;
-}
-
-export interface NodeAttackAnalysis {
-  left: AttackAnalysis;
-  right: AttackAnalysis;
-  shelling_fleet_cutin: FleetCutinReport<ShellingStyle>[];
-  night_fleet_cutin: FleetCutinReport<NightAttackStyle>[];
+export interface AttackReport<T> {
+  style: T;
+  proc_rate: number | null;
+  attack_power: AttackPower | null;
+  attack_power_params: AttackPowerParams | null;
+  hits: number;
+  hit_rate: HitRate | null;
+  hit_rate_params: HitRateParams | null;
+  damage: DamageReport | null;
 }
 
-export interface ContactAnalysis {
-  single: DayContactChance[] | null;
-  combined: DayContactChance[] | null;
+export interface CompAntiAirAnalysis {
+  fleet_adjusted_anti_air: number;
+  ships: AntiAirReport[];
+  anti_air_cutin_chance: [number, number][];
 }
 
-export interface DayContactChance {
-  air_state: AirState;
-  trigger_rate: number;
-  rank3: number;
-  rank2: number;
-  rank1: number;
-  total: number;
+export interface AntiAirReport {
+  ship_id: number;
+  role: Role;
+  index: number;
+  adjusted_anti_air: number | null;
+  proportional_shotdown_rate: number | null;
+  fixed_shotdown_number: number | null;
+  guaranteed: number | null;
+  anti_air_cutin_chance: [number, number][];
+  anti_air_propellant_barrage_chance: number | null;
 }
 
 export type AirWaveType = "Jet" | "LandBase" | "Carrier";
@@ -627,20 +628,6 @@ export type NightPhaseAttackType =
 
 export type TorpedoAttackType = null;
 
-export type NodeId = string;
-
-export interface NodeState {
-  map?: number;
-  node?: NodeId;
-  phase?: number;
-  debuff?: boolean;
-  disable_historical_mod?: boolean;
-}
-
-export type Side = "Player" | "Enemy";
-
-export type Align = "Left" | "Right";
-
 export interface MoveShipPayload {
   current: [string, string, ShipKey];
   target: [string | null, string, ShipKey];
@@ -745,6 +732,46 @@ export type SlotSizeVec = (number | null)[];
 
 export type SpeedGroup = "A" | "B1" | "B2" | "C";
 
+export type GearVecInput = GearInput[];
+
+export interface GearInput {
+  gear_id: number;
+  types: GearTypeIdArray;
+  firepower: number;
+  torpedo: number;
+  anti_air: number;
+  armor: number;
+  evasion: number;
+  asw: number;
+  los: number;
+  bombing: number;
+  accuracy: number;
+  range: number;
+  radius: number;
+  stars: number;
+  ace: number;
+}
+
+export interface ShipInput {
+  ship_id: number;
+  ctype: number;
+  stype: number;
+  yomi: string;
+}
+
+export interface EBonuses {
+  firepower: number;
+  torpedo: number;
+  anti_air: number;
+  armor: number;
+  evasion: number;
+  asw: number;
+  los: number;
+  bombing: number;
+  accuracy: number;
+  range: number;
+}
+
 export interface MasterShip {
   ship_id: number;
   name: string;
@@ -779,16 +806,17 @@ export interface MasterShip {
 
 export type StatInterval = [number | null, number | null];
 
-export interface AttackAnalysis {
-  attacker_is_player: boolean;
-  attacker_ship_id: number;
-  target_ship_id: number;
-  historical_params: HistoricalParams;
-  day: ActionReport<DayPhaseAttackStyle>;
-  night: ActionReport<NightPhaseAttackStyle>;
-  closing_torpedo: ActionReport<TorpedoAttackStyle>;
-  opening_asw: ActionReport<AswAttackStyle>;
-  support_shelling: ActionReport<SupportShellingStyle>;
+export interface FleetCutinReport<T> {
+  cutin: FleetCutin;
+  rate: number | null;
+  formation: Formation;
+  attacks: FleetCutinAttackReport<T>[];
+}
+
+export interface FleetCutinAttackReport<T> extends AttackReport<T> {
+  index: number;
+  ship_id: number;
+  power_mod: number;
 }
 
 export type DayCutin =
@@ -930,27 +958,6 @@ export type GearCategory =
   | "LandBased"
   | "Misc";
 
-export type ShipAttr =
-  | "Unknown"
-  | "NightCarrier"
-  | "Installation"
-  | "RoyalNavy"
-  | "Kai2"
-  | "TurbineSpeedBonus"
-  | "NewModelBoilerSpeedBonus"
-  | "Pillbox"
-  | "IsolatedIsland"
-  | "HarbourSummerPrincess"
-  | "SupplyDepot"
-  | "NewSupplyDepot"
-  | "PtImp"
-  | "BattleshipSummerPrincess"
-  | "HeavyCruiserSummerPrincess"
-  | "AnchorageWaterDemonVacationMode"
-  | "FrenchBattleshipPrincess"
-  | "DockPrincess"
-  | "SummerAircraftCarrierDemon";
-
 export type ShipCategory =
   | "Battleship"
   | "AircraftCarrier"
@@ -986,58 +993,56 @@ export type ShipType =
   | "CT"
   | "AO";
 
-export type GearVecInput = GearInput[];
-
-export interface GearInput {
-  gear_id: number;
-  types: GearTypeIdArray;
-  firepower: number;
-  torpedo: number;
-  anti_air: number;
-  armor: number;
-  evasion: number;
-  asw: number;
-  los: number;
-  bombing: number;
-  accuracy: number;
-  range: number;
-  radius: number;
-  stars: number;
-  ace: number;
-}
-
-export interface ShipInput {
-  ship_id: number;
-  ctype: number;
-  stype: number;
-  yomi: string;
+export interface AttackAnalysis {
+  attacker_is_player: boolean;
+  attacker_ship_id: number;
+  target_ship_id: number;
+  historical_params: HistoricalParams;
+  day: ActionReport<DayPhaseAttackStyle>;
+  night: ActionReport<NightPhaseAttackStyle>;
+  closing_torpedo: ActionReport<TorpedoAttackStyle>;
+  opening_asw: ActionReport<AswAttackStyle>;
+  support_shelling: ActionReport<SupportShellingStyle>;
 }
 
-export interface EBonuses {
-  firepower: number;
-  torpedo: number;
-  anti_air: number;
-  armor: number;
-  evasion: number;
-  asw: number;
-  los: number;
-  bombing: number;
-  accuracy: number;
-  range: number;
-}
+export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
 
-export interface FleetCutinReport<T> {
-  cutin: FleetCutin;
-  rate: number | null;
-  formation: Formation;
-  attacks: FleetCutinAttackReport<T>[];
-}
+export type ShipAttr =
+  | "Unknown"
+  | "NightCarrier"
+  | "Installation"
+  | "RoyalNavy"
+  | "Kai2"
+  | "TurbineSpeedBonus"
+  | "NewModelBoilerSpeedBonus"
+  | "Pillbox"
+  | "IsolatedIsland"
+  | "HarbourSummerPrincess"
+  | "SupplyDepot"
+  | "NewSupplyDepot"
+  | "PtImp"
+  | "BattleshipSummerPrincess"
+  | "HeavyCruiserSummerPrincess"
+  | "AnchorageWaterDemonVacationMode"
+  | "FrenchBattleshipPrincess"
+  | "DockPrincess"
+  | "SummerAircraftCarrierDemon";
 
-export interface FleetCutinAttackReport<T> extends AttackReport<T> {
-  index: number;
-  ship_id: number;
-  power_mod: number;
-}
+export type SpecialEnemyType =
+  | "None"
+  | "SoftSkinned"
+  | "Pillbox"
+  | "IsolatedIsland"
+  | "SupplyDepot"
+  | "NewSupplyDepot"
+  | "HarbourSummerPrincess"
+  | "PtImp"
+  | "BattleshipSummerPrincess"
+  | "HeavyCruiserSummerPrincess"
+  | "FrenchBattleshipPrincess"
+  | "AnchorageWaterDemonVacationMode"
+  | "DockPrincess"
+  | "SummerAircraftCarrierDemon";
 
 /**
  */
@@ -1234,6 +1239,10 @@ export class Comp {
    * @returns {number | undefined}
    */
   fleet_los_mod(fleet_type: FleetType): number | undefined;
+  /**
+   * @returns {number}
+   */
+  balloons(): number;
   /**
    */
   boss_sup?: Fleet;
@@ -1526,6 +1535,10 @@ export class Gear {
    * @returns {boolean}
    */
   can_be_deployed_to_land_base(): boolean;
+  /**
+   * @returns {boolean}
+   */
+  is_balloon(): boolean;
   /**
    */
   readonly accuracy: number;