fleethub-core 1.8.9 → 1.8.10

package/node/fleethub_core.d.ts

@@ -8,7 +8,7 @@ export function set_panic_hook(): void;
  * @returns {ShipConditions}
  */
 export function parse_ship_conditions(value: ShipConditions): ShipConditions;
-export type Role = "Main" | "Escort";
+export type Side = "Player" | "Enemy";
 
 export interface ShipPosition {
   org_type?: OrgType;
@@ -86,43 +86,94 @@ export interface FormationCombatModifiersDef {
   evasion_mod?: number;
 }
 
-export type TorpedoAttackType = null;
+export type CompiledEvaler = string;
 
-export type NightPhaseAttackType =
-  | { t: "Night"; c: NightAttackType }
-  | { t: "Asw"; c: AswAttackType };
+export interface OrgState {
+  id?: string;
+  f1?: FleetState;
+  f2?: FleetState;
+  f3?: FleetState;
+  f4?: FleetState;
+  a1?: AirSquadronState;
+  a2?: AirSquadronState;
+  a3?: AirSquadronState;
+  hq_level?: number;
+  org_type?: OrgType;
+  sortie?: FleetKey;
+  route_sup?: FleetKey;
+  boss_sup?: FleetKey;
+}
 
-export type DayPhaseAttackType =
-  | { t: "Shelling"; c: ShellingType }
-  | { t: "Asw"; c: AswAttackType };
+export interface AirSquadronState extends GearVecState, SlotSizeVecState {
+  id?: string;
+  mode?: AirSquadronMode;
+}
 
-export type AttackType =
-  | { t: "Asw"; c: AswAttackType }
-  | { t: "Shelling"; c: ShellingType }
-  | { t: "Night"; c: NightAttackType }
-  | { t: "Torpedo" }
-  | { t: "SupportShelling"; c: SupportShellingType };
+export type AirSquadronMode = "Sortie" | "AirDefense";
 
-export type SupportShellingType = ShellingType;
+export interface FleetState {
+  id?: string;
+  len?: number;
+  s1?: ShipState;
+  s2?: ShipState;
+  s3?: ShipState;
+  s4?: ShipState;
+  s5?: ShipState;
+  s6?: ShipState;
+  s7?: ShipState;
+}
 
-export type NightAttackType = "Normal" | "Swordfish" | "Carrier";
+export interface ShipState extends GearVecState, SlotSizeVecState {
+  id?: string;
+  ship_id: number;
+  level?: number;
+  current_hp?: number;
+  morale?: number;
+  ammo?: number;
+  fuel?: number;
+  max_hp_mod?: number;
+  firepower_mod?: number;
+  torpedo_mod?: number;
+  armor_mod?: number;
+  anti_air_mod?: number;
+  evasion_mod?: number;
+  asw_mod?: number;
+  los_mod?: number;
+  luck_mod?: number;
+  day_gunfit_accuracy?: number;
+  night_gunfit_accuracy?: number;
+  custom_power_mods?: CustomPowerModifiers;
+}
 
-export type ShellingType = "Normal" | "Carrier";
+export interface SlotSizeVecState {
+  ss1?: number;
+  ss2?: number;
+  ss3?: number;
+  ss4?: number;
+  ss5?: number;
+}
 
-export type AswAttackType = "DepthCharge" | "Aircraft";
+export interface GearVecState {
+  g1?: GearState;
+  g2?: GearState;
+  g3?: GearState;
+  g4?: GearState;
+  g5?: GearState;
+  gx?: GearState;
+}
 
-export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+export interface GearState {
+  id?: string;
+  gear_id: number;
+  exp?: number;
+  stars?: number;
+}
 
-export type AirState =
-  | "AirSupremacy"
-  | "AirSuperiority"
-  | "AirParity"
-  | "AirDenial"
-  | "AirIncapability";
+export type SpeedGroup = "A" | "B1" | "B2" | "C";
 
-export type CompiledEvaler = string;
+export type SlotSizeVec = (number | null)[];
 
-export type SpeedGroup = "A" | "B1" | "B2" | "C";
+export type Role = "Main" | "Escort";
 
 export interface ActionReport<T> {
   data: Record<string, AttackReport<T>>;
@@ -130,8 +181,6 @@ export interface ActionReport<T> {
   is_active: boolean;
 }
 
-export type GearTypeIdArray = [number, number, number, number, number];
-
 export type ShipType =
   | "Unknown"
   | "DE"
@@ -167,8 +216,6 @@ export type ShipCategory =
   | "Submarine"
   | "AuxiliaryShip";
 
-export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
-
 export type NightCutinLike = NightCutin | FleetCutin;
 
 export type DayCutinLike = DayCutin | FleetCutin;
@@ -253,18 +300,14 @@ export interface FleetCutinAttackReport<T> extends AttackReport<T> {
   power_mod: number;
 }
 
-export type SpecialEnemyType =
-  | "None"
-  | "SoftSkinned"
-  | "Pillbox"
-  | "IsolatedIsland"
-  | "SupplyDepot"
-  | "HarbourSummerPrincess"
-  | "PtImp"
-  | "BattleshipSummerPrincess"
-  | "HeavyCruiserSummerPrincess";
+export interface MoveShipPayload {
+  current: [string, string, ShipKey];
+  target: [string | null, string, ShipKey];
+}
 
-export type ContactRank = "Rank1" | "Rank2" | "Rank3";
+export type GearTypeIdArray = [number, number, number, number, number];
+
+export type MoraleState = "Sparkle" | "Normal" | "Orange" | "Red";
 
 export type AirWaveType = "Jet" | "LandBase" | "Carrier";
 
@@ -280,6 +323,21 @@ export interface SimulatorResultItem {
   damage_state_map: Record<DamageState, number>;
 }
 
+export type SpecialEnemyType =
+  | "None"
+  | "SoftSkinned"
+  | "Pillbox"
+  | "IsolatedIsland"
+  | "SupplyDepot"
+  | "HarbourSummerPrincess"
+  | "PtImp"
+  | "BattleshipSummerPrincess"
+  | "HeavyCruiserSummerPrincess";
+
+export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
+
+export type ContactRank = "Rank1" | "Rank2" | "Rank3";
+
 export type GearCategory =
   | "Fighter"
   | "Bomber"
@@ -358,6 +416,40 @@ export type GearType =
 
 export type DamageState = "Normal" | "Shouha" | "Chuuha" | "Taiha" | "Sunk";
 
+export type TorpedoAttackType = null;
+
+export type NightPhaseAttackType =
+  | { t: "Night"; c: NightAttackType }
+  | { t: "Asw"; c: AswAttackType };
+
+export type DayPhaseAttackType =
+  | { t: "Shelling"; c: ShellingType }
+  | { t: "Asw"; c: AswAttackType };
+
+export type AttackType =
+  | { t: "Asw"; c: AswAttackType }
+  | { t: "Shelling"; c: ShellingType }
+  | { t: "Night"; c: NightAttackType }
+  | { t: "Torpedo" }
+  | { t: "SupportShelling"; c: SupportShellingType };
+
+export type SupportShellingType = ShellingType;
+
+export type NightAttackType = "Normal" | "Swordfish" | "Carrier";
+
+export type ShellingType = "Normal" | "Carrier";
+
+export type AswAttackType = "DepthCharge" | "Aircraft";
+
+export type AirStateRank = "Rank0" | "Rank1" | "Rank2" | "Rank3";
+
+export type AirState =
+  | "AirSupremacy"
+  | "AirSuperiority"
+  | "AirParity"
+  | "AirDenial"
+  | "AirIncapability";
+
 export type FhResult<T> = { Ok: T } | { Err: string };
 
 export interface MasterData extends MasterBattleDefinitions {
@@ -437,33 +529,10 @@ export interface GearInput {
 
 export type GearVecInput = GearInput[];
 
-export type Side = "Player" | "Enemy";
-
 export interface ShipConditions extends ShipPosition {
   formation?: Formation;
 }
 
-export type OrgType =
-  | "Single"
-  | "CarrierTaskForce"
-  | "SurfaceTaskForce"
-  | "TransportEscort"
-  | "EnemySingle"
-  | "EnemyCombined";
-
-export interface SupportShellingSimulatorParams {
-  attacker_formation?: Formation;
-  target_formation?: Formation;
-  engagement: Engagement;
-}
-
-export interface ShipAnalyzerConfig {
-  air_state?: AirState;
-  engagement?: Engagement;
-  left?: AttackAnalyzerShipConfig;
-  right?: AttackAnalyzerShipConfig;
-}
-
 export type ShipAttr =
   | "Unknown"
   | "Abyssal"
@@ -480,6 +549,14 @@ export type ShipAttr =
   | "BattleshipSummerPrincess"
   | "HeavyCruiserSummerPrincess";
 
+export type OrgType =
+  | "Single"
+  | "CarrierTaskForce"
+  | "SurfaceTaskForce"
+  | "TransportEscort"
+  | "EnemySingle"
+  | "EnemyCombined";
+
 export type GearAttr =
   | "Unknown"
   | "Abyssal"
@@ -512,6 +589,21 @@ export type GearAttr =
   | "SemiNightPlane"
   | "HighAltitudeInterceptor";
 
+export type FleetKey = "f1" | "f2" | "f3" | "f4";
+
+export interface SupportShellingSimulatorParams {
+  attacker_formation?: Formation;
+  target_formation?: Formation;
+  engagement: Engagement;
+}
+
+export interface ShipAnalyzerConfig {
+  air_state?: AirState;
+  engagement?: Engagement;
+  left?: AttackAnalyzerShipConfig;
+  right?: AttackAnalyzerShipConfig;
+}
+
 export interface CompAntiAirAnalysis {
   fleet_adjusted_anti_air: number;
   ships: AntiAirReport[];
@@ -569,28 +661,6 @@ export interface ShellingStyle {
   hits: number;
 }
 
-export interface CustomPowerModifiers {
-  precap_mod?: AttackPowerModifier;
-  postcap_mod?: AttackPowerModifier;
-  basic_power_mod?: AttackPowerModifier;
-}
-
-export interface SpecialEnemyModifiers {
-  precap_general_mod: AttackPowerModifier;
-  stype_mod: AttackPowerModifier;
-  landing_craft_synergy_mod: AttackPowerModifier;
-  toku_daihatsu_tank_mod: AttackPowerModifier;
-  m4a1dd_mod: AttackPowerModifier;
-  honi_mod: AttackPowerModifier;
-  postcap_general_mod: AttackPowerModifier;
-  pt_mod: AttackPowerModifier;
-}
-
-export interface AttackPowerModifier {
-  a?: number;
-  b?: number;
-}
-
 export interface AttackPower {
   precap: number;
   is_capped: boolean;
@@ -686,6 +756,28 @@ export type SingleFormation =
   | "LineAbreast"
   | "Vanguard";
 
+export interface CustomPowerModifiers {
+  precap_mod?: AttackPowerModifier;
+  postcap_mod?: AttackPowerModifier;
+  basic_power_mod?: AttackPowerModifier;
+}
+
+export interface SpecialEnemyModifiers {
+  precap_general_mod: AttackPowerModifier;
+  stype_mod: AttackPowerModifier;
+  landing_craft_synergy_mod: AttackPowerModifier;
+  toku_daihatsu_tank_mod: AttackPowerModifier;
+  m4a1dd_mod: AttackPowerModifier;
+  honi_mod: AttackPowerModifier;
+  postcap_general_mod: AttackPowerModifier;
+  pt_mod: AttackPowerModifier;
+}
+
+export interface AttackPowerModifier {
+  a?: number;
+  b?: number;
+}
+
 export interface MasterBattleDefinitions {
   formation: NestedFormationDef[];
   anti_air_cutin: AntiAirCutinDef[];
@@ -844,104 +936,6 @@ export interface CompAnalysis {
   anti_air: CompAntiAirAnalysis;
 }
 
-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 type ShipStateMap = Record<ShipKey, ShipState>;
-
-export type ShipKey = "s1" | "s2" | "s3" | "s4" | "s5" | "s6" | "s7";
-
-export interface OrgState {
-  id?: string;
-  f1?: FleetState;
-  f2?: FleetState;
-  f3?: FleetState;
-  f4?: FleetState;
-  a1?: AirSquadronState;
-  a2?: AirSquadronState;
-  a3?: AirSquadronState;
-  hq_level?: number;
-  org_type?: OrgType;
-  sortie?: string;
-  route_sup?: string;
-  boss_sup?: string;
-}
-
-export interface AirSquadronState extends GearVecState, SlotSizeVecState {
-  id?: string;
-  mode?: AirSquadronMode;
-}
-
-export type AirSquadronMode = "Sortie" | "AirDefense";
-
-export interface FleetState {
-  id?: string;
-  len?: number;
-  s1?: ShipState;
-  s2?: ShipState;
-  s3?: ShipState;
-  s4?: ShipState;
-  s5?: ShipState;
-  s6?: ShipState;
-  s7?: ShipState;
-}
-
-export interface ShipState extends GearVecState, SlotSizeVecState {
-  id?: string;
-  ship_id: number;
-  level?: number;
-  current_hp?: number;
-  morale?: number;
-  ammo?: number;
-  fuel?: number;
-  max_hp_mod?: number;
-  firepower_mod?: number;
-  torpedo_mod?: number;
-  armor_mod?: number;
-  anti_air_mod?: number;
-  evasion_mod?: number;
-  asw_mod?: number;
-  los_mod?: number;
-  luck_mod?: number;
-  day_gunfit_accuracy?: number;
-  night_gunfit_accuracy?: number;
-  custom_power_mods?: CustomPowerModifiers;
-}
-
-export interface SlotSizeVecState {
-  ss1?: number;
-  ss2?: number;
-  ss3?: number;
-  ss4?: number;
-  ss5?: number;
-}
-
-export interface GearVecState {
-  g1?: GearState;
-  g2?: GearState;
-  g3?: GearState;
-  g4?: GearState;
-  g5?: GearState;
-  gx?: GearState;
-}
-
-export interface GearState {
-  id?: string;
-  gear_id: number;
-  exp?: number;
-  stars?: number;
-}
-
-export type SlotSizeVec = (number | null)[];
-
 export interface NightFleetConditions {
   night_contact_rank?: ContactRank | null;
   starshell_index?: number | null;
@@ -989,6 +983,17 @@ export interface MasterGear {
   fleet_anti_air_resist?: 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 class AirSquadron {
@@ -1118,16 +1123,16 @@ export class Comp {
   get_fleet_id(ft: FleetType): string | undefined;
   /**
    * @param {FleetType} ft
-   * @param {string} key
+   * @param {ShipKey} key
    * @returns {Ship | undefined}
    */
-  get_ship_with_clone(ft: FleetType, key: string): Ship | undefined;
+  get_ship_with_clone(ft: FleetType, key: ShipKey): Ship | undefined;
   /**
    * @param {FleetType} ft
-   * @param {string} key
+   * @param {ShipKey} key
    * @returns {string | undefined}
    */
-  get_ship_entity_id(ft: FleetType, key: string): string | undefined;
+  get_ship_entity_id(ft: FleetType, key: ShipKey): string | undefined;
   /**
    * @param {string} id
    * @returns {Ship | undefined}
@@ -1170,6 +1175,11 @@ export class Comp {
    * @returns {ShipConditions}
    */
   get_ship_conditions(ship: Ship, formation?: Formation): ShipConditions;
+  /**
+   * @param {FleetType} fleet_type
+   * @returns {number | undefined}
+   */
+  fleet_los_mod(fleet_type: FleetType): number | undefined;
   /**
    */
   boss_sup?: Fleet;
@@ -1303,10 +1313,10 @@ export class Fleet {
    */
   count_ships(): number;
   /**
-   * @param {string} key
+   * @param {ShipKey} key
    * @returns {Ship | undefined}
    */
-  get_ship(key: string): Ship | undefined;
+  get_ship(key: ShipKey): Ship | undefined;
   /**
    * @param {AirWaveType} air_type
    * @returns {number | undefined}
@@ -1563,11 +1573,26 @@ export class Gear {
 export class Org {
   free(): void;
   /**
-   * @param {Role} role
-   * @param {string} key
    * @returns {string | undefined}
    */
-  get_ship_entity_id(role: Role, key: string): string | undefined;
+  first_ship_id(): string | undefined;
+  /**
+   * @param {FleetKey} fleet_key
+   * @param {ShipKey} ship_key
+   * @returns {number | undefined}
+   */
+  get_ship_mid(fleet_key: FleetKey, ship_key: ShipKey): number | undefined;
+  /**
+   * @param {FleetKey} fleet_key
+   * @param {ShipKey} ship_key
+   * @returns {string | undefined}
+   */
+  get_ship_eid(fleet_key: FleetKey, ship_key: ShipKey): string | undefined;
+  /**
+   * @param {FleetKey} key
+   * @returns {string}
+   */
+  get_fleet_id(key: FleetKey): string;
   /**
    * @returns {(string)[]}
    */
@@ -1581,24 +1606,35 @@ export class Org {
    */
   escort_ship_ids(): Uint16Array;
   /**
-   * @param {string} key
+   * @param {FleetKey} key
    * @returns {Fleet}
    */
-  clone_fleet(key: string): Fleet;
+  clone_fleet(key: FleetKey): Fleet;
+  /**
+   * @param {FleetKey} fleet_key
+   * @param {ShipKey} ship_key
+   * @returns {Ship | undefined}
+   */
+  clone_ship(fleet_key: FleetKey, ship_key: ShipKey): Ship | undefined;
   /**
    * @param {string} id
    * @returns {Ship | undefined}
    */
   get_ship_by_id(id: string): Ship | undefined;
+  /**
+   * @param {FleetKey} key
+   * @returns {(string)[]}
+   */
+  ship_keys(key: FleetKey): string[];
   /**
    * @returns {Comp}
    */
   create_comp(): Comp;
   /**
-   * @param {string} key
+   * @param {FleetKey} key
    * @returns {Comp}
    */
-  create_comp_by_key(key: string): Comp;
+  create_comp_by_key(key: FleetKey): Comp;
   /**
    * @param {string} key
    * @returns {AirSquadron}
@@ -1642,9 +1678,25 @@ export class Org {
    * @returns {number}
    */
   high_altitude_interception_power(): number;
+  /**
+   * @param {string} id
+   * @param {number} x
+   * @param {number} y
+   * @returns {MoveShipPayload | undefined}
+   */
+  create_move_ship_payload(
+    id: string,
+    x: number,
+    y: number
+  ): MoveShipPayload | undefined;
+  /**
+   * @param {FleetKey} key
+   * @returns {FleetType | undefined}
+   */
+  get_fleet_type(key: FleetKey): FleetType | undefined;
   /**
    */
-  boss_sup?: string;
+  readonly boss_sup: FleetKey | undefined;
   /**
    */
   readonly hash: bigint;
@@ -1659,10 +1711,10 @@ export class Org {
   readonly org_type: OrgType;
   /**
    */
-  route_sup?: string;
+  readonly route_sup: FleetKey | undefined;
   /**
    */
-  sortie: string;
+  readonly sortie: FleetKey;
 }
 /**
  */