afnm-types 0.6.32 → 0.6.34

package/dist/breakthrough.d.ts

@@ -13,33 +13,22 @@ export interface Position {
 export interface PositionAndRotation extends Position {
     rotation: number;
 }
-/** Tracks which of the 6 core essences have been placed in the gate */
-export interface EssenceGate {
-    breath: boolean;
-    pulse: boolean;
-    echo: boolean;
-    growth: boolean;
-    marrow: boolean;
-    scar: boolean;
-}
-/** A lifeform stored in the player's soul realm */
-export interface StoredLifeform {
+/** A figment stored in the player's soul realm */
+export interface StoredFigment {
     id: string;
-    baseForm: string;
-    currentForm: string;
-    slottedEssences: string[];
+    primarySpecies?: string;
+    secondarySpecies?: string;
+    customName?: string;
+    autoName?: string;
     stances: StoredStance[];
     currentStyle?: StoredStyle;
     storedStyles?: StoredStyle[];
-    evolutionPath: string[];
 }
 /** State for the Life Flourishing breakthrough system */
 export interface LifeFlourishingState {
-    essenceGate: EssenceGate;
-    storedLifeforms: StoredLifeform[];
-    manifestedLifeformId?: string;
-    fightsInstead?: boolean;
-    creatingNewLifeform?: boolean;
+    unlockedSpecies: string[];
+    storedFigments: StoredFigment[];
+    manifestedFigmentId?: string;
 }
 export interface BreakthroughState {
     mundane?: {

package/dist/buff.d.ts

@@ -40,6 +40,7 @@ interface ConditionTechniqueCondition {
 }
 export interface Buff {
     name: string;
+    displayName?: Translatable;
     icon: string;
     colour?: string;
     canStack: boolean;

package/dist/craftingBuff.d.ts

@@ -1,5 +1,6 @@
 import { Realm } from './realm';
 import { CraftingStatistic, Scaling } from './stat';
+import { Translatable } from './translatable';
 export type CraftingTechniqueCondition = BuffTechniqueCondition | StateTechniqueCondition | ConditionTechniqueCondition | ChanceTechniqueCondition;
 interface BuffTechniqueCondition {
     kind: 'buff';
@@ -23,6 +24,7 @@ interface ChanceTechniqueCondition {
 export type CraftingBuffDisplayLocation = 'none' | 'avatar' | 'stabilityLeft' | 'stabilityRight' | 'perfectionLeft' | 'perfectionRight' | 'completionLeft' | 'completionRight';
 export interface CraftingBuff {
     name: string;
+    displayName?: Translatable;
     icon: string;
     canStack: boolean;
     effectHint?: string;

package/dist/craftingState.d.ts

@@ -2,6 +2,7 @@ import { CraftingTechniqueType, CraftingRecipeStats } from './craftingTechnique'
 import { CraftingCondition } from './crafting';
 import { CraftingEntity } from './entity';
 import { RecipeItem, ItemDesc } from './item';
+import type { GameEventState } from './reduxState';
 export interface ForgeWorksData {
     heat: number;
 }
@@ -84,4 +85,6 @@ export interface CraftingState {
     craftingLog: string[];
     craftResult?: CraftingResult;
     trainingMode?: CraftingTrainingMode;
+    /** Snapshot of entire event state when crafting started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }

package/dist/dualCultivation.d.ts

@@ -3,8 +3,10 @@ declare const intimateStats: readonly ["satisfaction", "energy", "painThreshold"
 export type IntimateStat = (typeof intimateStats)[number];
 declare const intimateResources: readonly ["pain", "harmony", "excitement", "rhythm"];
 export type IntimateResource = (typeof intimateResources)[number];
-declare const intimateTechniqueTypes: string[];
+declare const intimateTechniqueTypes: readonly ["rough", "tender", "passionate"];
 export type IntimateTechniqueType = (typeof intimateTechniqueTypes)[number];
+export declare const intimateTechniqueTypeToName: Record<IntimateTechniqueType, string>;
+export declare const intimateResourceToName: Record<IntimateResource, string>;
 export type IntimateTrait = {
     name: string;
     description: Translatable;

package/dist/dualCultivation.js

@@ -1,4 +1,14 @@
 const intimateStats = ['satisfaction', 'energy', 'painThreshold'];
 const intimateResources = ['pain', 'harmony', 'excitement', 'rhythm'];
 const intimateTechniqueTypes = ['rough', 'tender', 'passionate'];
-export {};
+export const intimateTechniqueTypeToName = {
+    rough: 'Rough',
+    tender: 'Tender',
+    passionate: 'Passionate',
+};
+export const intimateResourceToName = {
+    pain: 'Pain',
+    harmony: 'Harmony',
+    excitement: 'Excitement',
+    rhythm: 'Rhythm',
+};

package/dist/entity.d.ts

@@ -79,6 +79,7 @@ export type EnemyDifficulty = 'veryeasy' | 'easy' | 'mediumEasy' | 'medium' | 'm
 export type BattleLength = 'halfround' | '1round' | 'veryshort' | 'short' | 'medium' | 'long' | 'verylong' | 'verylong+' | 'verylong++' | 'verylong+++' | 'verylong++++';
 export interface EnemyEntity {
     name: string;
+    displayName?: Translatable;
     image: string;
     supportImage?: {
         image: string;
@@ -227,6 +228,7 @@ export interface CombatArtefact extends ArtefactItem {
 export interface CombatEntity {
     entityType: EntityType;
     name?: string;
+    displayName?: Translatable;
     image: string;
     supportImage?: {
         image: string;

package/dist/item.d.ts

@@ -14,6 +14,9 @@ import { CombatStatsMap, CraftingStatsMap, PhysicalStatistic, Scaling, SocialSta
 import { Technique, TechniqueEffect } from './technique';
 export declare const itemKinds: readonly ["clothing", "talisman", "artefact", "mount", "cauldron", "flame", "upgrade", "fruit", "elixir", "recipe", "technique", "action", "transport_seal", "enchantment", "pill", "reagent", "concoction", "consumable", "recuperation", "formation", "breakthrough", "pillar_shard", "material", "flare", "mystical_key", "condensation_art", "blueprint", "trophy", "treasure", "token", "life_essence", "device", "manual"];
 export type ItemKind = (typeof itemKinds)[number];
+export declare const itemKindToName: {
+    [key in ItemKind]: string;
+};
 export type ItemCostMap = {
     [key in ItemKind]: number;
 };
@@ -23,6 +26,7 @@ export type Item = TechniqueItem | TechniqueCrystalItem | TechniqueShardItem | T
 interface ItemBase {
     kind: ItemKind;
     name: string;
+    displayName?: Translatable;
     description: Translatable;
     icon: string;
     stacks: number;
@@ -158,6 +162,9 @@ export interface ArtefactTechnique {
     i?: number;
 }
 export type PillKind = 'combat' | 'crafting' | 'advancement' | 'consumable' | 'appearance_change';
+export declare const pillKindToName: {
+    [key in PillKind]: string;
+};
 interface BasePillItem extends ItemBase {
     kind: 'pill';
     pillKind: PillKind;

package/dist/item.js

@@ -33,6 +33,41 @@ export const itemKinds = [
     'device',
     'manual',
 ];
+export const itemKindToName = {
+    clothing: 'Clothing',
+    talisman: 'Talisman',
+    artefact: 'Artefact',
+    mount: 'Mount',
+    cauldron: 'Cauldron',
+    flame: 'Flame',
+    upgrade: 'Upgrade',
+    fruit: 'Fruit',
+    elixir: 'Elixir',
+    recipe: 'Recipe',
+    technique: 'Technique',
+    action: 'Action',
+    transport_seal: 'Transport Seal',
+    enchantment: 'Enchantment',
+    pill: 'Pill',
+    reagent: 'Reagent',
+    concoction: 'Concoction',
+    consumable: 'Consumable',
+    recuperation: 'Recuperation',
+    formation: 'Formation',
+    breakthrough: 'Breakthrough',
+    pillar_shard: 'Pillar Shard',
+    material: 'Material',
+    flare: 'Flare',
+    mystical_key: 'Mystical Key',
+    condensation_art: 'Condensation Art',
+    blueprint: 'Blueprint',
+    trophy: 'Trophy',
+    treasure: 'Treasure',
+    token: 'Token',
+    life_essence: 'Life Essence',
+    device: 'Device',
+    manual: 'Manual',
+};
 export const buyItemCostMap = {
     technique: 3000,
     artefact: 3500,
@@ -103,3 +138,10 @@ export const sellItemCostMap = {
     device: 600,
     manual: 0,
 };
+export const pillKindToName = {
+    combat: 'Combat Pill',
+    crafting: 'Crafting Pill',
+    advancement: 'Advancement Pill',
+    consumable: 'Consumable Pill',
+    appearance_change: 'Appearance Change Pill',
+};

package/dist/life.d.ts

@@ -2,9 +2,24 @@ import { Buff } from './buff';
 import { StoredStance, StoredStyle } from './entity';
 import { Realm } from './realm';
 import { Technique } from './technique';
+export interface LifeFormAnimationImage {
+    image: string;
+    scale?: number;
+    imageOffset?: {
+        x: number;
+        y: number;
+    };
+}
 export interface LifeForm {
-    name: string;
+    role: string;
+    species: string;
     image: string;
+    supportImage?: LifeFormAnimationImage;
+    defensiveImage?: LifeFormAnimationImage;
+    utilityImage?: LifeFormAnimationImage;
+    aggressiveImage?: LifeFormAnimationImage;
+    offensiveImage?: LifeFormAnimationImage;
+    hitImage?: LifeFormAnimationImage;
     realm: Realm;
     buffs: Buff[];
     techniques: Technique[];

package/dist/location.d.ts

@@ -237,6 +237,7 @@ export type CustomBuildingPosition = 'top' | 'topleft' | 'topright' | 'belowtop'
 export interface CustomBuilding extends BuildingBase {
     kind: 'custom';
     name: string;
+    displayName?: Translatable;
     icon: string;
     position: CustomBuildingPosition;
     condition: string;
@@ -277,6 +278,7 @@ export interface ModBuilding extends BuildingBase {
     kind: 'modBuilding';
     condition?: string;
     name: string;
+    displayName?: Translatable;
     icon: string;
     screen: string;
     position: CustomBuildingPosition;

package/dist/mine.d.ts

@@ -41,10 +41,13 @@ export type MineChamber = OreChamber | EventChamber | RandomDropChamber | Releas
 interface BaseChamber {
     icon: string;
     name: string;
+    displayName?: Translatable;
     description: Translatable;
     rarity: Rarity;
     condition: string;
     isUnique?: boolean;
+    /** If set, the chamber is only considered completed for pathing purposes when this game flag is truthy */
+    completeFlag?: string;
 }
 export interface OreChamber extends BaseChamber {
     kind: 'ore';

package/dist/mod.d.ts

@@ -729,6 +729,36 @@ export interface ModAPI {
          * });
          */
         addPlayerSprite: (sprite: PlayerSprite) => void;
+        /**
+         * Register translations for a language.
+         * If the language already exists (e.g., 'ru'), mod translations will be merged
+         * with the base game translations, with mod translations taking precedence.
+         * If the language is new, it will be added to the available languages list.
+         *
+         * @param language - Language code (e.g., 'ru', 'zh', 'es', 'de')
+         * @param translations - Translation data in the same format as template.json
+         * @example
+         * // Add translations for a new language
+         * addTranslation('es', {
+         *   "ui": {
+         *     "buttons": {
+         *       "[name] Continue": "Continuar",
+         *       "[name] Cancel": "Cancelar"
+         *     }
+         *   }
+         * });
+         *
+         * // Override/add translations for an existing language
+         * addTranslation('ru', {
+         *   "items": {
+         *     "myModItem": {
+         *       "[name] Magic Sword": "Волшебный меч",
+         *       "[description] A sword imbued with magic.": "Меч, наполненный магией."
+         *     }
+         *   }
+         * });
+         */
+        addTranslation: (language: string, translations: Record<string, unknown>) => void;
     };
     utils: {
         /**

package/dist/quest.d.ts

@@ -3,6 +3,7 @@ import { EventStep, GameEvent } from './event';
 import { ItemDesc } from './item';
 export interface Quest {
     name: string;
+    displayName?: Translatable;
     description: Translatable;
     category: 'main' | 'side' | 'missionHall' | 'craftingHall' | 'requestBoard' | 'guild';
     guild?: string;

package/dist/reduxState.d.ts

@@ -86,6 +86,8 @@ export interface CombatState {
         flag: string;
         value: number;
     };
+    /** Snapshot of entire event state when combat started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }
 export type CraftingSliceState = ExistingCraftingState;
 export interface ResetFlag {
@@ -168,6 +170,8 @@ export interface AuctionState {
     playerItemsSold: AuctionItem[];
     totalPlayerSales: number;
     needsPlayerSellSelection: boolean;
+    /** Snapshot of entire event state when auction started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }
 export interface BreakthroughSliceState extends BreakthroughState {
 }
@@ -245,6 +249,8 @@ export interface TournamentSliceState {
     participants?: EnemyEntity[];
     previousRounds?: TournamentRound[];
     currentRound?: TournamentRound;
+    /** Snapshot of entire event state when tournament started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }
 export interface HouseState {
     inHouse: boolean;
@@ -270,6 +276,8 @@ export interface DualCultivationState {
     };
     animations: string[];
     messages: DualCultivationMessage[];
+    /** Snapshot of entire event state when dual cultivation started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }
 export interface GuildState {
     selectedGuild?: string;
@@ -288,6 +296,8 @@ export interface StoneCuttingState {
     isCutting: boolean;
     realm: Realm;
     gainedItems: ItemDesc[];
+    /** Snapshot of entire event state when stone cutting started, restored on completion */
+    eventStateSnapshot?: GameEventState;
 }
 export interface FallenStarState {
     activeSites: Record<string, FallenStarData>;

package/dist/stat.js

@@ -214,11 +214,12 @@ export const uncommonStatTooltips = {
     healingBoost: '<n>Healing Boost</n> increases all healing received by a percentage.',
     barrierBoost: '<n>Barrier Boost</n> increases all barrier gained by a percentage.',
     overheal: '<n>Overheal</n> converts a percentage of healing beyond your maximum health into barrier.',
-    protection: '<n>Protection</n> reduces damage taken to your health. Does not affect damage taken to your barrier.',
+    protection: '<n>Protection</n> reduces damage taken to your health with diminishing returns. Does not affect damage taken to your barrier.',
     weakness: '<n>Weakness</n> reduces your power.',
     vulnerability: '<n>Vulnerability</n> increases damage taken to your <n>health</n>. Does not affect damage taken to your barrier.',
-    barrierBleed: '<n>Barrier Bleed</n> causes a percentage of your damage to bypass the enemy barrier and strike their health directly.',
+    barrierBleed: '<n>Barrier Bleed</n> causes a percentage of any damage to bypass your barrier and strike your health directly.',
     formationPartRecovery: 'Each point of <n>Formation Part Recovery</n> returns a <n>Formation Part</n> used in combat back to your Spatial Ring after battle.',
+    dr: '<n>Damage Resistance</n> reduces damage taken to your health after defense is applied. Each point equals <num>1%</num> reduction. Does not affect damage taken to your barrier.',
 };
 export const craftingStatToName = {
     maxpool: 'Max Qi Pool',

package/dist/translatable.d.ts

@@ -6,7 +6,7 @@
 export interface TranslatableString {
     readonly _translatable: true;
     readonly key: string;
-    readonly variables?: Record<string, string | number>;
+    readonly variables?: Record<string, Translatable | number>;
 }
 /**
  * A deferred plural translation object. Stores both singular and plural keys
@@ -18,7 +18,7 @@ export interface TranslatablePlural {
     readonly countVar: string;
     readonly one: string;
     readonly other: string;
-    readonly variables?: Record<string, string | number>;
+    readonly variables?: Record<string, Translatable | number>;
 }
 /**
  * A value that can be either a plain string or a deferred translation object.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "afnm-types",
-  "version": "0.6.32",
+  "version": "0.6.34",
   "description": "Type definitions for Ascend From Nine Mountains",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",