phantasmal-world/src/stores/HuntOptimizerStore.ts

import solver from 'javascript-lp-solver';
import { autorun, IObservableArray, observable, computed } from "mobx";
import { Difficulties, Difficulty, HuntMethod, ItemType, KONDRIEU_PROB, NpcType, RARE_ENEMY_PROB, SectionId, SectionIds, Server, Episode } from "../domain";
import { applicationStore } from './ApplicationStore';
import { huntMethodStore } from "./HuntMethodStore";
import { itemDropStores } from './ItemDropStore';
import { itemTypeStores } from './ItemTypeStore';
import Logger from 'js-logger';

const logger = Logger.get('stores/HuntOptimizerStore');

export class WantedItem {
    @observable readonly itemType: ItemType;
    @observable amount: number;

    constructor(itemType: ItemType, amount: number) {
        this.itemType = itemType;
        this.amount = amount;
    }
}

export class OptimalResult {
    constructor(
        readonly wantedItems: Array<ItemType>,
        readonly optimalMethods: Array<OptimalMethod>
    ) { }
}

export class OptimalMethod {
    readonly totalTime: number;

    constructor(
        readonly difficulty: Difficulty,
        readonly sectionIds: Array<SectionId>,
        readonly methodName: string,
        readonly methodEpisode: Episode,
        readonly methodTime: number,
        readonly runs: number,
        readonly itemCounts: Map<ItemType, number>
    ) {
        this.totalTime = runs * methodTime;
    }
}

// TODO: take into account mothmants spawned from mothverts.
// TODO: take into account split slimes.
// TODO: Prefer methods that don't split pan arms over methods that do.
//       For some reason this doesn't actually seem to be a problem, should probably investigate.
// TODO: Show expected value or probability per item per method.
//       Can be useful when deciding which item to hunt first.
// TODO: boxes.
class HuntOptimizerStore {
    @computed get huntableItemTypes(): Array<ItemType> {
        const itemDropStore = itemDropStores.current.value;
        return itemTypeStores.current.value.itemTypes.filter(i =>
            itemDropStore.enemyDrops.getDropsForItemType(i.id).length
        );
    }

    // TODO: wanted items per server.
    @observable readonly wantedItems: IObservableArray<WantedItem> = observable.array();
    @observable result?: OptimalResult;

    constructor() {
        this.initialize();
    }

    optimize = async () => {
        if (!this.wantedItems.length) {
            this.result = undefined;
            return;
        }

        // Initialize this set before awaiting data, so user changes don't affect this optimization
        // run from this point on.
        const wantedItems = new Set(this.wantedItems.filter(w => w.amount > 0).map(w => w.itemType));

        const methods = await huntMethodStore.methods.current.promise;
        const dropTable = (await itemDropStores.current.promise).enemyDrops;

        // Add a constraint per wanted item.
        const constraints: { [itemName: string]: { min: number } } = {};

        for (const wanted of this.wantedItems) {
            constraints[wanted.itemType.name] = { min: wanted.amount };
        }

        // Add a variable to the LP model per method per difficulty per section ID.
        // When a method with pan arms is encountered, two variables are added. One for the method
        // with migiums and hidooms and one with pan arms.
        // Each variable has a time property to minimize and a property per item with the number
        // of enemies that drop the item multiplied by the corresponding drop rate as its value.
        type Variable = {
            time: number,
            [itemName: string]: number,
        }
        const variables: { [methodName: string]: Variable } = {};

        type VariableDetails = {
            method: HuntMethod,
            difficulty: Difficulty,
            sectionId: SectionId,
            splitPanArms: boolean,
        }
        const variableDetails: Map<string, VariableDetails> = new Map();

        for (const method of methods) {
            // Counts include rare enemies, so they are fractional.
            const counts = new Map<NpcType, number>();

            for (const [enemy, count] of method.enemy_counts.entries()) {
                const oldCount = counts.get(enemy) || 0;

                if (enemy.rareType == null) {
                    counts.set(enemy, oldCount + count);
                } else {
                    let rate, rareRate;

                    if (enemy.rareType === NpcType.Kondrieu) {
                        rate = 1 - KONDRIEU_PROB;
                        rareRate = KONDRIEU_PROB;
                    } else {
                        rate = 1 - RARE_ENEMY_PROB;
                        rareRate = RARE_ENEMY_PROB;
                    }

                    counts.set(enemy, oldCount + count * rate);
                    counts.set(
                        enemy.rareType,
                        (counts.get(enemy.rareType) || 0) + count * rareRate
                    );
                }
            }

            // Create a secondary counts map if there are any pan arms that can be split into
            // migiums and hidooms.
            const countsList: Array<Map<NpcType, number>> = [counts];
            const panArmsCount = counts.get(NpcType.PanArms);

            if (panArmsCount) {
                const splitCounts = new Map(counts);

                splitCounts.delete(NpcType.PanArms);
                splitCounts.set(NpcType.Migium, panArmsCount);
                splitCounts.set(NpcType.Hidoom, panArmsCount);

                countsList.push(splitCounts);
            }

            const panArms2Count = counts.get(NpcType.PanArms2);

            if (panArms2Count) {
                const splitCounts = new Map(counts);

                splitCounts.delete(NpcType.PanArms2);
                splitCounts.set(NpcType.Migium2, panArms2Count);
                splitCounts.set(NpcType.Hidoom2, panArms2Count);

                countsList.push(splitCounts);
            }

            for (let i = 0; i < countsList.length; i++) {
                const counts = countsList[i];
                const splitPanArms = i === 1;

                for (const diff of Difficulties) {
                    for (const sectionId of SectionIds) {
                        // Will contain an entry per wanted item dropped by enemies in this method/
                        // difficulty/section ID combo.
                        const variable: Variable = {
                            time: method.time
                        };
                        // Only add the variable if the method provides at least 1 item we want.
                        let addVariable = false;

                        for (const [npcType, count] of counts.entries()) {
                            const drop = dropTable.getDrop(diff, sectionId, npcType);

                            if (drop && wantedItems.has(drop.item_type)) {
                                const value = variable[drop.item_type.name] || 0;
                                variable[drop.item_type.name] = value + count * drop.rate;
                                addVariable = true;
                            }
                        }

                        if (addVariable) {
                            const name = this.fullMethodName(
                                diff, sectionId, method, splitPanArms
                            );
                            variables[name] = variable;
                            variableDetails.set(name, {
                                method,
                                difficulty: diff,
                                sectionId,
                                splitPanArms
                            });
                        }
                    }
                }
            }
        }

        const result: {
            feasible: boolean,
            bounded: boolean,
            result: number,
            /**
             * Value will always be a number if result is indexed with an actual method name.
             */
            [method: string]: number | boolean
        } = solver.Solve({
            optimize: 'time',
            opType: 'min',
            constraints,
            variables
        });

        if (!result.feasible) {
            this.result = undefined;
            return;
        }

        const optimalMethods: Array<OptimalMethod> = [];

        // Loop over the entries in result, ignore standard properties that aren't variables.
        for (const [variableName, runsOrOther] of Object.entries(result)) {
            const details = variableDetails.get(variableName);

            if (details) {
                const { method, difficulty, sectionId, splitPanArms } = details;
                const runs = runsOrOther as number;
                const variable = variables[variableName];

                const items = new Map<ItemType, number>();

                for (const [itemName, expectedAmount] of Object.entries(variable)) {
                    for (const item of wantedItems) {
                        if (itemName === item.name) {
                            items.set(item, runs * expectedAmount);
                            break;
                        }
                    }
                }

                // Find all section IDs that provide the same items with the same expected amount.
                // E.g. if you need a spread needle and a bringer's right arm, using either
                // purplenum or yellowboze will give you the exact same probabilities.
                const sectionIds: Array<SectionId> = [];

                for (const sid of SectionIds) {
                    let matchFound = true;

                    if (sid !== sectionId) {
                        const v = variables[
                            this.fullMethodName(difficulty, sid, method, splitPanArms)
                        ];

                        if (!v) {
                            matchFound = false;
                        } else {
                            for (const itemName of Object.keys(variable)) {
                                if (variable[itemName] !== v[itemName]) {
                                    matchFound = false;
                                    break;
                                }
                            }
                        }
                    }

                    if (matchFound) {
                        sectionIds.push(sid);
                    }
                }

                optimalMethods.push(new OptimalMethod(
                    difficulty,
                    sectionIds,
                    method.name + (splitPanArms ? ' (Split Pan Arms)' : ''),
                    method.episode,
                    method.time,
                    runs,
                    items
                ));
            }
        }

        this.result = new OptimalResult(
            [...wantedItems],
            optimalMethods
        );
    }

    private fullMethodName(
        difficulty: Difficulty,
        sectionId: SectionId,
        method: HuntMethod,
        splitPanArms: boolean
    ): string {
        let name = `${difficulty}\t${sectionId}\t${method.id}`;
        if (splitPanArms) name += '\tspa';
        return name;
    }

    private initialize = async () => {
        try {
            await this.loadFromLocalStorage();
            autorun(this.storeInLocalStorage);
        } catch (e) {
            logger.error(e);
        }
    }

    private loadFromLocalStorage = async () => {
        const wantedItemsJson = localStorage.getItem(
            `HuntOptimizerStore.wantedItems.${Server[applicationStore.currentServer]}`
        );

        if (wantedItemsJson) {
            const itemStore = await itemTypeStores.current.promise;
            const wi = JSON.parse(wantedItemsJson);

            const wantedItems: WantedItem[] = [];

            for (const { itemTypeId, itemKindId, amount } of wi) {
                const item = itemTypeId != null
                    ? itemStore.getById(itemTypeId)
                    : itemStore.getById(itemKindId); // Legacy name.

                if (item) {
                    wantedItems.push(new WantedItem(item, amount));
                }
            }

            this.wantedItems.replace(wantedItems);
        }
    }

    private storeInLocalStorage = () => {
        try {
            localStorage.setItem(
                `HuntOptimizerStore.wantedItems.${Server[applicationStore.currentServer]}`,
                JSON.stringify(
                    this.wantedItems.map(({ itemType, amount }) => ({
                        itemTypeId: itemType.id,
                        amount
                    }))
                )
            );
        } catch (e) {
            logger.error(e);
        }
    }
}

export const huntOptimizerStore = new HuntOptimizerStore();