fleethub-core 1.6.2 → 1.7.0

package/node/fleethub_core.d.ts

@@ -3,46 +3,6 @@
 /**
  */
 export function set_panic_hook(): void;
-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 ShipInput {
-  ship_id: number;
-  ctype: number;
-  stype: number;
-  yomi: string;
-}
-
-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 type GearVecInput = GearInput[];
-
 export type ShipType =
   | "Unknown"
   | "DE"
@@ -78,46 +38,40 @@ export type ShipCategory =
   | "Submarine"
   | "AuxiliaryShip";
 
-export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+export type ShellingSpecialAttack =
+  | { DayCutin: DayCutin }
+  | { FleetCutin: FleetCutin };
 
-export type AirState =
-  | "AirSupremacy"
-  | "AirSuperiority"
-  | "AirParity"
-  | "AirDenial"
-  | "AirIncapability";
+export type DayCutin =
+  | "MainMain"
+  | "MainAp"
+  | "MainRadar"
+  | "MainSec"
+  | "DoubleAttack"
+  | "FBA"
+  | "BBA"
+  | "BA"
+  | "Zuiun"
+  | "AirSea";
 
-export interface FleetCutinAnalysis {
-  shelling: FleetCutinInfo[];
-  night: FleetCutinInfo[];
+export interface ShellingSupportSimulatorParams {
+  attacker_formation: Formation;
+  target_formation: Formation;
+  engagement: Engagement;
+  custom_mods: CustomModifiers;
 }
 
-export interface FleetCutinInfo {
-  cutin: FleetCutin;
-  rate: number | null;
-  formation: Formation;
-  items: FleetCutinInfoItem[];
-}
+export type ShellingAttackType = "Normal" | "Carrier";
 
-export interface FleetCutinInfoItem {
-  ship_id: number;
-  cutin: FleetCutin;
-  fleet_cutin_mod: number;
-  stats: AttackStats;
-}
+export type AirWaveType = "Jet" | "LandBase" | "Carrier";
 
-export interface DamageInfo {
-  miss_damage_min: number;
-  miss_damage_max: number;
-  normal_damage_min: number;
-  normal_damage_max: number;
-  critical_damage_min: number;
-  critical_damage_max: number;
-  normal_scratch_rate: number;
-  critical_scratch_rate: number;
-  damage_map: NumMap<number, number>;
-  damage_state_map: NumMap<DamageState, number>;
-}
+export type OrgType =
+  | "Single"
+  | "CarrierTaskForce"
+  | "SurfaceTaskForce"
+  | "TransportEscort"
+  | "EnemySingle"
+  | "EnemyCombined";
 
 export interface WarfareContext {
   attacker_env: WarfareShipEnvironment;
@@ -136,6 +90,21 @@ export interface WarfareShipEnvironment {
   fleet_los_mod: number | null;
 }
 
+export interface CompMeta {
+  fleets: Record<FleetType, FleetMeta>;
+}
+
+export interface FleetMeta {
+  id: string;
+  len: number;
+  ships: [string, ShipMeta | null][];
+}
+
+export interface ShipMeta {
+  id: string;
+  ship_id: number;
+}
+
 export interface AttackPower {
   precap: number;
   is_capped: boolean;
@@ -182,28 +151,9 @@ export interface AttackPowerModifier {
   b: number;
 }
 
-export type OrgType =
-  | "Single"
-  | "CarrierTaskForce"
-  | "SurfaceTaskForce"
-  | "TransportEscort"
-  | "EnemySingle"
-  | "EnemyCombined";
-
-export interface CompMeta {
-  fleets: Record<FleetType, FleetMeta>;
-}
-
-export interface FleetMeta {
-  id: string;
-  len: number;
-  ships: [string, ShipMeta | null][];
-}
+export type NumMap<K, V> = Partial<Record<K, V>>;
 
-export interface ShipMeta {
-  id: string;
-  ship_id: number;
-}
+export type Role = "Main" | "Escort";
 
 export interface MasterData {
   gears: MasterGear[];
@@ -231,26 +181,6 @@ export interface MasterAttrRule<T> {
   expr: string;
 }
 
-export type NumMap<K, V> = Partial<Record<K, V>>;
-
-export type ShellingSpecialAttack =
-  | { DayCutin: DayCutin }
-  | { FleetCutin: FleetCutin };
-
-export type DayCutin =
-  | "MainMain"
-  | "MainAp"
-  | "MainRadar"
-  | "MainSec"
-  | "DoubleAttack"
-  | "FBA"
-  | "BBA"
-  | "BA"
-  | "Zuiun"
-  | "AirSea";
-
-export type Role = "Main" | "Escort";
-
 export type GearCategory =
   | "Fighter"
   | "Bomber"
@@ -328,15 +258,6 @@ export type GearType =
 
 export type Engagement = "GreenT" | "Parallel" | "HeadOn" | "RedT";
 
-export interface ShellingSupportSimulatorParams {
-  attacker_formation: Formation;
-  target_formation: Formation;
-  engagement: Engagement;
-  custom_mods: CustomModifiers;
-}
-
-export type ShellingAttackType = "Normal" | "Carrier";
-
 export interface CompDayCutinRateInfo {
   main: FleetDayCutinRateInfo;
   escort: FleetDayCutinRateInfo | null;
@@ -359,6 +280,46 @@ export interface DayCutinRateInfo {
   total_cutin_rate: number | null;
 }
 
+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 ShipInput {
+  ship_id: number;
+  ctype: number;
+  stype: number;
+  yomi: string;
+}
+
+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 type GearVecInput = GearInput[];
+
 export type ShipAttr =
   | "Unknown"
   | "Abyssal"
@@ -375,6 +336,15 @@ export type ShipAttr =
   | "BattleshipSummerPrincess"
   | "HeavyCruiserSummerPrincess";
 
+export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+
+export type AirState =
+  | "AirSupremacy"
+  | "AirSuperiority"
+  | "AirParity"
+  | "AirDenial"
+  | "AirIncapability";
+
 export interface MasterIBonuses {
   shelling_power: MasterIBonusRule[];
   carrier_shelling_power: MasterIBonusRule[];
@@ -405,6 +375,38 @@ export interface NightSituation {
   searchlight: boolean;
 }
 
+export interface FleetCutinAnalysis {
+  shelling: FleetCutinInfo[];
+  night: FleetCutinInfo[];
+}
+
+export interface FleetCutinInfo {
+  cutin: FleetCutin;
+  rate: number | null;
+  formation: Formation;
+  items: FleetCutinInfoItem[];
+}
+
+export interface FleetCutinInfoItem {
+  ship_id: number;
+  cutin: FleetCutin;
+  fleet_cutin_mod: number;
+  stats: AttackStats;
+}
+
+export interface DamageInfo {
+  miss_damage_min: number;
+  miss_damage_max: number;
+  normal_damage_min: number;
+  normal_damage_max: number;
+  critical_damage_min: number;
+  critical_damage_max: number;
+  normal_scratch_rate: number;
+  critical_scratch_rate: number;
+  damage_map: NumMap<number, number>;
+  damage_state_map: NumMap<DamageState, number>;
+}
+
 export type GearAttr =
   | "Unknown"
   | "Abyssal"
@@ -454,27 +456,6 @@ export type SingleFormation =
 
 export type FleetType = "Main" | "Escort" | "RouteSup" | "BossSup";
 
-export interface AttackInfo<AttackType, Cutin> {
-  attack_type: AttackType;
-  items: AttackInfoItem<Cutin>[];
-  damage_state_map: NumMap<DamageState, number> | null;
-}
-
-export interface AttackInfoItem<Cutin> {
-  cutin: Cutin;
-  rate: number | null;
-  stats: AttackStats;
-}
-
-export interface AttackStats {
-  attack_power: AttackPower | null;
-  attack_power_params: AttackPowerParams | null;
-  hits: number;
-  hit_rate: HitRate | null;
-  hit_rate_params: HitRateParams | null;
-  damage: DamageInfo | null;
-}
-
 export interface CompAntiAirInfo {
   fleet_adjusted_anti_air: number;
   ships: ShipAntiAirInfo[];
@@ -505,6 +486,122 @@ export interface AirstrikeContactChance {
   total: number;
 }
 
+export type SlotSizeVec = (number | null)[];
+
+export type NightAttackType = "Normal" | "ArkRoyal" | "Carrier";
+
+export type NightSpecialAttack =
+  | { NightCutin: NightCutin }
+  | { FleetCutin: FleetCutin };
+
+export type NightCutin =
+  | "MainTorpRadar"
+  | "TorpLookoutRadar"
+  | "TorpTsloTorp"
+  | "TorpTsloDrum"
+  | "DoubleAttack"
+  | "TorpTorpMain"
+  | "TorpTorpTorp"
+  | "MainMainSec"
+  | "MainMainMain"
+  | "SubTorpTorp"
+  | "SubRadarTorp"
+  | "Cvci1_25"
+  | "Cvci1_20"
+  | "Cvci1_18"
+  | "Photobomber";
+
+export interface MasterGear {
+  gear_id: number;
+  name: string;
+  types: GearTypeIdArray;
+  special_type?: number;
+  max_hp?: number;
+  firepower?: number;
+  armor?: number;
+  torpedo?: number;
+  anti_air?: number;
+  speed?: number;
+  bombing?: number;
+  asw?: number;
+  los?: number;
+  luck?: number;
+  accuracy?: number;
+  evasion?: number;
+  range?: number;
+  radius?: number;
+  cost?: number;
+  improvable?: boolean;
+  ship_anti_air_resistance?: number;
+  fleet_anti_air_resistance?: number;
+}
+
+export interface MasterEquippable {
+  equip_stype: EquipStype[];
+  equip_exslot: number[];
+  equip_ship: MstEquipShip[];
+  equip_exslot_ship: MstEquipExslotShip[];
+}
+
+export interface MstEquipExslotShip {
+  api_slotitem_id: number;
+  api_ship_ids: number[];
+}
+
+export interface MstEquipShip {
+  api_ship_id: number;
+  api_equip_type: number[];
+}
+
+export interface EquipStype {
+  id: number;
+  equip_type: number[];
+}
+
+export interface HitRate {
+  total: number;
+  normal: number;
+  critical: number;
+}
+
+export interface HitRateParams {
+  accuracy_term: number;
+  evasion_term: number;
+  target_morale_mod: number;
+  critical_rate_constant: number;
+  critical_percentage_bonus: number;
+  hit_percentage_bonus: number;
+}
+
+export type NightBattleAttackType =
+  | { t: "NightAttack"; c: NightAttackType }
+  | { t: "Asw"; c: AswAttackType };
+
+export type DayBattleAttackType =
+  | { t: "Shelling"; c: ShellingAttackType }
+  | { t: "Asw"; c: AswAttackType };
+
+export interface AttackInfo<AttackType, Cutin> {
+  attack_type: AttackType;
+  items: AttackInfoItem<Cutin>[];
+  damage_state_map: NumMap<DamageState, number> | null;
+}
+
+export interface AttackInfoItem<Cutin> {
+  cutin: Cutin;
+  rate: number | null;
+  stats: AttackStats;
+}
+
+export interface AttackStats {
+  attack_power: AttackPower | null;
+  attack_power_params: AttackPowerParams | null;
+  hits: number;
+  hit_rate: HitRate | null;
+  hit_rate_params: HitRateParams | null;
+  damage: DamageInfo | null;
+}
+
 export type ShipStateMap = Record<ShipKey, ShipState>;
 
 export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
@@ -555,7 +652,7 @@ export interface FleetState {
   s7?: ShipState;
 }
 
-export interface ShipState {
+export interface ShipState extends GearVecState, SlotSizeVecState {
   id?: string;
   ship_id: number;
   level?: number;
@@ -572,26 +669,23 @@ export interface ShipState {
   asw_mod?: number;
   los_mod?: number;
   luck_mod?: number;
-  g1?: GearState;
-  g2?: GearState;
-  g3?: GearState;
-  g4?: GearState;
-  g5?: GearState;
-  gx?: GearState;
+}
+
+export interface SlotSizeVecState {
   ss1?: number;
   ss2?: number;
   ss3?: number;
   ss4?: number;
   ss5?: number;
-  overrides?: ShipOverrides;
 }
 
-export interface ShipOverrides {
-  naked_max_hp?: number;
-  naked_luck?: number;
-  naked_evasion?: number;
-  naked_asw?: number;
-  naked_los?: number;
+export interface GearVecState {
+  g1?: GearState;
+  g2?: GearState;
+  g3?: GearState;
+  g4?: GearState;
+  g5?: GearState;
+  gx?: GearState;
 }
 
 export interface GearState {
@@ -601,55 +695,69 @@ export interface GearState {
   stars?: number;
 }
 
-export interface MasterEquippable {
-  equip_stype: EquipStype[];
-  equip_exslot: number[];
-  equip_ship: MstEquipShip[];
-  equip_exslot_ship: MstEquipExslotShip[];
+export interface MasterShip {
+  ship_id: number;
+  name: string;
+  yomi: string;
+  stype: number;
+  ctype: number;
+  sort_id?: number;
+  max_hp: StatInterval;
+  firepower: StatInterval;
+  armor: StatInterval;
+  torpedo: StatInterval;
+  evasion: StatInterval;
+  anti_air: StatInterval;
+  asw: StatInterval;
+  los: StatInterval;
+  luck: StatInterval;
+  torpedo_accuracy?: number;
+  basic_evasion_term?: number;
+  speed: number;
+  range?: number;
+  fuel?: number;
+  ammo?: number;
+  next_id?: number;
+  next_level?: number;
+  slotnum: number;
+  slots: SlotSizeVec;
+  stock: GearState[];
+  speed_group?: SpeedGroup;
+  useful?: boolean;
 }
 
-export interface MstEquipExslotShip {
-  api_slotitem_id: number;
-  api_ship_ids: number[];
+export type StatInterval = [number | null, number | null];
+
+export interface WarfareInfo {
+  day: AttackInfo<DayBattleAttackType, DayCutin | null> | null;
+  closing_torpedo: AttackInfo<null, null> | null;
+  night: AttackInfo<NightBattleAttackType, NightCutin | null> | null;
+  shelling_support: AttackInfo<null, null> | null;
+  opening_asw: AttackInfo<null, null> | null;
 }
 
-export interface MstEquipShip {
-  api_ship_id: number;
-  api_equip_type: number[];
+export interface WarfareAnalyzerContext {
+  attacker_env: WarfareAnalyzerShipEnvironment;
+  target_env: WarfareAnalyzerShipEnvironment;
+  engagement: Engagement;
+  air_state: AirState;
 }
 
-export interface EquipStype {
-  id: number;
-  equip_type: number[];
+export interface WarfareAnalyzerShipEnvironment {
+  org_type: OrgType;
+  role: Role;
+  ship_index: number;
+  fleet_len: number;
+  formation: Formation;
+  fleet_los_mod: number | null;
+  night_situation: NightSituation;
+  custom_mods: CustomModifiers;
 }
 
-export type SlotSizeVec = (number | null)[];
+export type GearTypeIdArray = [number, number, number, number, number];
 
 export type Side = "Player" | "Enemy";
 
-export type NightAttackType = "Normal" | "ArkRoyal" | "Carrier";
-
-export type NightSpecialAttack =
-  | { NightCutin: NightCutin }
-  | { FleetCutin: FleetCutin };
-
-export type NightCutin =
-  | "MainTorpRadar"
-  | "TorpLookoutRadar"
-  | "TorpTsloTorp"
-  | "TorpTsloDrum"
-  | "DoubleAttack"
-  | "TorpTorpMain"
-  | "TorpTorpTorp"
-  | "MainMainSec"
-  | "MainMainMain"
-  | "SubTorpTorp"
-  | "SubRadarTorp"
-  | "Cvci1_25"
-  | "Cvci1_20"
-  | "Cvci1_18"
-  | "Photobomber";
-
 export interface BattleConfig {
   formation: Record<Formation, NestedFormationDef>;
   anti_air_cutin: Record<number, AntiAirCutinDef>;
@@ -702,114 +810,6 @@ export interface FormationWarfareDef {
   evasion_mod: number | null;
 }
 
-export interface MasterGear {
-  gear_id: number;
-  name: string;
-  types: GearTypeIdArray;
-  special_type?: number;
-  max_hp?: number;
-  firepower?: number;
-  armor?: number;
-  torpedo?: number;
-  anti_air?: number;
-  speed?: number;
-  bombing?: number;
-  asw?: number;
-  los?: number;
-  luck?: number;
-  accuracy?: number;
-  evasion?: number;
-  range?: number;
-  radius?: number;
-  cost?: number;
-  improvable?: boolean;
-  ship_anti_air_resistance?: number;
-  fleet_anti_air_resistance?: number;
-}
-
-export interface HitRate {
-  total: number;
-  normal: number;
-  critical: number;
-}
-
-export interface HitRateParams {
-  accuracy_term: number;
-  evasion_term: number;
-  target_morale_mod: number;
-  critical_rate_constant: number;
-  critical_percentage_bonus: number;
-  hit_percentage_bonus: number;
-}
-
-export type NightBattleAttackType =
-  | { t: "NightAttack"; c: NightAttackType }
-  | { t: "Asw"; c: AswAttackType };
-
-export type DayBattleAttackType =
-  | { t: "Shelling"; c: ShellingAttackType }
-  | { t: "Asw"; c: AswAttackType };
-
-export type GearTypeIdArray = [number, number, number, number, number];
-
-export interface MasterShip {
-  ship_id: number;
-  name: string;
-  yomi: string;
-  stype: number;
-  ctype: number;
-  sort_id?: number;
-  max_hp: StatInterval;
-  firepower: StatInterval;
-  armor: StatInterval;
-  torpedo: StatInterval;
-  evasion: StatInterval;
-  anti_air: StatInterval;
-  asw: StatInterval;
-  los: StatInterval;
-  luck: StatInterval;
-  torpedo_accuracy?: number;
-  speed: number;
-  range?: number;
-  fuel?: number;
-  ammo?: number;
-  next_id?: number;
-  next_level?: number;
-  slotnum: number;
-  slots: SlotSizeVec;
-  stock: GearState[];
-  speed_group?: SpeedGroup;
-  useful?: boolean;
-}
-
-export type StatInterval = [number | null, number | null];
-
-export interface WarfareInfo {
-  day: AttackInfo<DayBattleAttackType, DayCutin | null> | null;
-  closing_torpedo: AttackInfo<null, null> | null;
-  night: AttackInfo<NightBattleAttackType, NightCutin | null> | null;
-  shelling_support: AttackInfo<null, null> | null;
-  opening_asw: AttackInfo<null, null> | null;
-}
-
-export interface WarfareAnalyzerContext {
-  attacker_env: WarfareAnalyzerShipEnvironment;
-  target_env: WarfareAnalyzerShipEnvironment;
-  engagement: Engagement;
-  air_state: AirState;
-}
-
-export interface WarfareAnalyzerShipEnvironment {
-  org_type: OrgType;
-  role: Role;
-  ship_index: number;
-  fleet_len: number;
-  formation: Formation;
-  fleet_los_mod: number | null;
-  night_situation: NightSituation;
-  custom_mods: CustomModifiers;
-}
-
 export type SpecialEnemyType =
   | "None"
   | "SoftSkinned"
@@ -835,8 +835,6 @@ export type FleetCutin =
 
 export type ContactRank = "Rank1" | "Rank2" | "Rank3";
 
-export type AirWaveType = "Jet" | "LandBase" | "Carrier";
-
 export interface SimulatorResult {
   items: SimulatorResultItem[];
   sunk_vec: [number, number, number][];