feat(core): Backport improved typedefs from KE branch

Author: oliversalzburg

packages/kitten-scientists/source/ReligionManager.ts

@@ -295,7 +295,7 @@ export class ReligionManager implements Automation {
     let bestAmortization = Infinity;
     let bestBuilding: ZiggurathUpgrade | "unicornPasture" | null = null;
     const unicornsPerTickBase = mustExist(
-      this._host.game.bld.getBuildingExt("unicornPasture").meta.effects["unicornsPerTickBase"],
+      this._host.game.bld.getBuildingExt("unicornPasture").meta.effects?.["unicornsPerTickBase"],
     );
     const pastureProduction =
       unicornsPerTickBase *

packages/kitten-scientists/source/types/buildings.ts

@@ -51,11 +51,206 @@ export const StagedBuildings = [
 ] as const;
 export type StagedBuilding = (typeof StagedBuildings)[number];
 
-// Returned from game.bld.getBuildingExt()
+export type BuildingEffects = {
+  // from game.bld
+  academyMeteorBonus: number;
+  aiLevel: number;
+  alicornPerTickCon: number;
+  bloodstoneRatio: number;
+  cathPollutionPerTickCon: number;
+  cathPollutionPerTickProd: number;
+  catnipDemandRatio: number;
+  catnipMax: number;
+  catnipPerTickBase: number;
+  catnipPerTickCon: number;
+  catnipRatio: number;
+  coalMax: number;
+  coalPerTickAutoprod: number;
+  coalPerTickBase: number;
+  coalPerTickCon: number;
+  coalRatioGlobal: number;
+  craftRatio: number;
+  cultureMax: number;
+  cultureMaxRatio: number;
+  culturePerTickBase: number;
+  energyConsumption: number;
+  energyProduction: number;
+  faithMax: number;
+  faithPerTickBase: number;
+  festivalArrivalRatio: number;
+  festivalRatio: number;
+  fursDemandRatio: number;
+  fursPerTickProd: number;
+  gflopsPerTickBase: number;
+  goldMax: number;
+  goldPerTickAutoprod: number;
+  goldPerTickCon: number;
+  happiness: number;
+  hunterRatio: number;
+  ironMax: number;
+  ironPerTickAutoprod: number;
+  ironPerTickCon: number;
+  ivoryDemandRatio: number;
+  ivoryPerTickCon: number;
+  ivoryPerTickProd: number;
+  magnetoBoostRatio: number;
+  magnetoRatio: number;
+  manpowerMax: number;
+  manpowerPerTickCon: number;
+  manuscriptPerTickProd: number;
+  maxKittens: number;
+  mineralsMax: number;
+  mineralsPerTickCon: number;
+  mineralsPerTickProd: number;
+  mineralsRatio: number;
+  oilMax: number;
+  oilPerTick: number;
+  oilPerTickBase: number;
+  oilPerTickCon: number;
+  oilPerTickProd: number;
+  productionRatio: number;
+  refineRatio: number;
+  resStasisRatio: number;
+  scienceMax: number;
+  scienceRatio: number;
+  skillXP: number;
+  spiceDemandRatio: number;
+  spicePerTickCon: number;
+  standingRatio: number;
+  starAutoSuccessChance: number;
+  starEventChance: number;
+  steelPerTickProd: number;
+  tMythrilCraftRatio: number;
+  tMythrilPerTick: number;
+  temporalFluxProduction: number;
+  thoriumPerTick: number;
+  titaniumMax: number;
+  titaniumPerTickAutoprod: number;
+  titaniumPerTickCon: number;
+  tradeRatio: number;
+  unhappinessRatio: number;
+  unicornsPerTickBase: number;
+  uraniumMax: number;
+  uraniumPerTick: number;
+  uraniumPerTickAutoprod: number;
+  uraniumPerTickBase: number;
+  woodMax: number;
+  woodPerTickCon: number;
+  woodRatio: number;
+  zebraPreparations: number;
+
+  // from game.religion
+  activeHG: number;
+  alicornChance: number;
+  alicornPerTick: number;
+  blackLibraryBonus: number;
+  blsCorruptionRatio: number;
+  blsLimit: number;
+  compendiaTTBoostRatio: number;
+  corruptionBoostRatio: number;
+  corruptionRatio: number;
+  cultureMaxRatioBonus: number;
+  deficitRecoveryRatio: number;
+  energyProductionRatio: number;
+  faithRatioReligion: number;
+  globalResourceRatio: number;
+  goldMaxRatio: number;
+  ivoryMeteorChance: number;
+  ivoryMeteorRatio: number;
+  maxKittensRatio: number;
+  necrocornPerDay: number;
+  pactBlackLibraryBoost: number;
+  pactDeficitRecoveryRatio: number;
+  pactFaithRatio: number;
+  pactGlobalProductionRatio: number;
+  pactGlobalResourceRatio: number;
+  pactSpaceCompendiumRatio: number;
+  pactsAvailable: number;
+  pyramidFaithRatio: number;
+  pyramidGlobalProductionRatio: number;
+  pyramidGlobalResourceRatio: number;
+  pyramidRecoveryRatio: number;
+  pyramidSpaceCompendiumRatio: number;
+  relicRefineRatio: number;
+  riftChance: number;
+  rrRatio: number;
+  simScalingRatio: number;
+  solarRevolutionLimit: number;
+  solarRevolutionRatio: number;
+  tcRefineRatio: number;
+  timeRatio: number;
+  unicornsRatioReligion: number;
+
+  // from game.workshop.upgrades
+  acceleratorRatio: number;
+  barnRatio: number;
+  beaconRelicsPerDay: number;
+  biofuelRatio: number;
+  broadcastTowerRatio: number;
+  cadBlueprintCraftRatio: number;
+  calcinerRatio: number;
+  calcinerSteelCraftRatio: number;
+  calcinerSteelRatio: number;
+  calcinerSteelReactorBonus: number;
+  catnipDemandWorkerRatioGlobal: number;
+  catnipJobRatio: number;
+  catnipMaxRatio: number;
+  coalRatioGlobalReduction: number;
+  coalSuperRatio: number;
+  crackerRatio: number;
+  dataCenterAIRatio: number;
+  eludiumAutomationBonus: number;
+  factoryRefineRatio: number;
+  harborCoalRatio: number;
+  harborRatio: number;
+  hutPriceRatio: number;
+  hydroPlantRatio: number;
+  libraryRatio: number;
+  lumberMillRatio: number;
+  lunarOutpostRatio: number;
+  manpowerJobRatio: number;
+  oilWellRatio: number;
+  queueCap: number;
+  reactorEnergyRatio: number;
+  reactorThoriumPerTick: number;
+  routeSpeed: number;
+  satnavRatio: number;
+  shipLimit: number;
+  skillMultiplier: number;
+  smelterRatio: number;
+  solarFarmRatio: number;
+  solarFarmSeasonRatio: number;
+  spaceScienceRatio: number;
+  starchartGlobalRatio: number;
+  t1CraftRatio: number;
+  t2CraftRatio: number;
+  t3CraftRatio: number;
+  t4CraftRatio: number;
+  t5CraftRatio: number;
+  temporalFluxProductionChronosphere: number;
+  temporalParadoxDayBonus: number;
+  unicornsGlobalRatio: number;
+  uplinkDCRatio: number;
+  uplinkLabRatio: number;
+  uraniumRatio: number;
+  warehouseRatio: number;
+  woodJobRatio: number;
+
+  // other tabs
+  goldPriceRatio: number;
+  happinessKittenProductionRatio: number;
+  heatMax: number;
+  heatPerTick: number;
+  observatoryRatio: number;
+  starchartPerTickBaseSpace: number;
+  temporalFluxMax: number;
+  unobtainiumPerTickSpace: number;
+  uraniumPerTickCon: number;
+};
 export type BuildingMeta = {
   calculateEffects?: (model: unknown, game: Game) => void;
   description?: string;
-  effects: { unicornsPerTickBase?: number };
+  effects?: Partial<BuildingEffects>;
   flavor?: string;
   label?: string;
   name: Building;
@@ -68,7 +263,7 @@ export type BuildingMeta = {
     calculateEffects?: (model: unknown, game: Game) => void;
     calculateEnergyProduction?: (game: Game, season: unknown) => void;
     description: string;
-    effects?: { catnipDemandRatio?: number };
+    effects?: Partial<BuildingEffects>;
     flavor?: string;
     label: string;
     priceRatio: number;

packages/kitten-scientists/source/types/craft.ts

@@ -1,4 +1,4 @@
-import { Resource, ResourceCraftable } from "./index.js";
+import { Price, Resource, ResourceCraftable } from "./index.js";
 
 export type ResourceInfo = {
   calculatePerDay?: boolean;
@@ -18,6 +18,10 @@ export type ResourceInfo = {
 export type CraftableInfo = {
   name: ResourceCraftable;
   label: string;
+  description: string;
+  prices: Array<Price>;
+  ignoreBonuses?: boolean;
+  progressHandicap: number;
   tier: number;
-  unlocked: boolean;
+  unlocked?: boolean;
 };

packages/kitten-scientists/source/types/game.ts

@@ -5,6 +5,7 @@ import {
   AllBuildings,
   BuildButton,
   Building,
+  BuildingEffects,
   BuildingExt,
   BuildingMeta,
   Challenge,
@@ -360,12 +361,7 @@ export type Game = {
        */
       description: string;
 
-      effects: {
-        energyConsumption?: number;
-        energyProduction?: number;
-        observatoryRatio?: number;
-        starchartPerTickBaseSpace?: number;
-      };
+      effects: Partial<BuildingEffects>;
 
       /**
        * An internationalized label for this space building.
@@ -387,7 +383,15 @@ export type Game = {
       val: number;
     };
     meta: Array<{
-      meta: Array<{ label: string; name: string; unlocked: boolean; val: number; on: number }>;
+      meta: Array<{
+        effects?: Partial<BuildingEffects>;
+        label: string;
+        name: string;
+        on: number;
+        prices: Array<Price>;
+        unlocked: boolean;
+        val: number;
+      }>;
     }>;
     planets: Array<{ label: string; buildings: Array<{ name: SpaceBuilding; label: string }> }>;
     programs: Array<{ name: Mission; label: string }>;

packages/kitten-scientists/source/types/religion.ts

@@ -1,11 +1,13 @@
 import {
   BuildButton,
+  BuildingEffects,
   ButtonModernModel,
   Game,
   GameTab,
   Price,
   RefineTearsBtnController,
   TransformBtnController,
+  Unlocks,
 } from "./index.js";
 
 export type ReligionTab = GameTab & {
@@ -116,6 +118,8 @@ export type AbstractReligionUpgradeInfo = {
    * be refactored later.
    */
   rHidden?: boolean;
+
+  unlocks?: Partial<Unlocks>;
 };
 
 export type ReligionUpgradeInfo = AbstractReligionUpgradeInfo & {
@@ -125,9 +129,7 @@ export type ReligionUpgradeInfo = AbstractReligionUpgradeInfo & {
    */
   description: string;
 
-  effects: {
-    faithRatioReligion?: number;
-  };
+  effects: Partial<BuildingEffects>;
 
   faith: number;
 
@@ -146,17 +148,10 @@ export type ZiggurathUpgradeInfo = AbstractReligionUpgradeInfo & {
    */
   description: string;
 
-  effects: {
-    riftChance?: number;
-    unicornsRatioReligion?: number;
-  };
+  effects: Partial<BuildingEffects>;
 
   name: ZiggurathUpgrade;
   priceRatio: number;
-
-  unlocks: {
-    zigguratUpgrades: Array<"ivoryTower">;
-  };
 };
 
 export type TranscendenceUpgradeInfo = AbstractReligionUpgradeInfo & {
@@ -167,16 +162,11 @@ export type TranscendenceUpgradeInfo = AbstractReligionUpgradeInfo & {
    */
   description: string;
 
-  effects: {
-    solarRevolutionLimit?: number;
-  };
+  effects: Partial<BuildingEffects>;
 
   flavor: string;
 
   name: TranscendenceUpgrade;
   priceRatio?: number;
   tier: number;
-  unlocks: {
-    zigguratUpgrades: Array<"ivoryTower">;
-  };
 };