Recursive expansion of auto-opened exchangeables

[Will-Crain]

This came about because, as a new player, I couldn't find the sources for some items. I had to manually go through each drop table to find, for example, where a elixirs come from. Or, on the other end, wondering why a lostearring1 shows crossbow in it's drop table, but a Crossbow doesn't list lostearring1 as a source

This PR fixes some weird edge cases where, for example, a Crossbow doesn't have a lostearring1 as a source.
Also fixes issues where elixirvit0 and similar elixirs don't show the exchangeable shell as a source.

Notably, this does not interfere with the comment from 2022 around this function, which removed showing exchangeables like lostearring1 from showing as a source for weaponbox, since lostearring1 auto-opens a weaponbox.

The solution is a new recursive internal function recur_replace. This scans the drop table of all exchangeable items and looks for an entry whose [1] index is 'open'. 'open' in this context means the drop table in the [2] index is **automatically opened**. If it finds one of these items, recur_replace replaces that drop table entry with the contents of the automatically opened drop table.

Then, in the loop where we find which exchangeable items to show as a source, we simply look through these modified, recursively expanded drop tables.

For example: the Crossbow, weaponbox, and lostearring1
lostearring1s drop table is simply

[[
	1,
	'open',
	'weaponbox',
]]

So, our function will see this and replace lostearring1s drop table with the contents of weaponbox. Then, when we iterate through these modified drop tables, we can find that lostearring1 could indeed drop a crossbow

[Will-Crain]

I found an issue in 4f3e37c where I was mutating G.drops when calling recur_replace on it. d71ecf3 now feeds recur_replace with a shallow copy of a drop table from G.drops, so no mutations on the original data occur

This error was hinted to me in a discord discussion I had about this fix, but I didn't realize the issue at the time. My code had mutated G.drops so I did not see the basicelixir drop table tucked inside G.drops.seashell

Functionality in "Obtainable From" list, as described in the original comment remains unchanged, but G.drops no longer mutates when creating this list :)

[Telokis]

Hey, thank you very much for your contribution! I have a slight edge case that I'd like to see handled but apart from that, it's great, thanks!

Below is the whole code I used to test this out:

const G = {
    drops: {
        weaponbox: [
            [1.4, "t2bow"],
            [1, "mace"],
        ],
        tempbox: [
            [1, "open", "weaponbox"],
            [1, "firestars"],
            [1, "bow"],
        ],
        tempbox2: [
            [1, "open", "weaponbox"],
            [1, "lunarmace"],
            [1, "sertgsth"],
            [1, "open", "tempbox"],
            [1, "mything"],
        ],
    },
};

/**
 * Replace all "open" entries in a drop table with the contents of the table it references.
 * @param {Array} table - The drop table to expand.
 * @returns {Array} - The expanded drop table.
 */
function expand_drop_table(table) {
    let changed = true;
    let newTable = [...table];

    while (changed) {
        changed = false;

        const tmpTable = [];
        for (const drop_item of newTable) {
            if (drop_item[1] === "open") {
                tmpTable.push(...G.drops[drop_item[2]]);
                changed = true;
            } else {
                tmpTable.push(drop_item);
            }
        }
        newTable = tmpTable;
    }

    return newTable;
}

console.log(expand_drop_table(G.drops.tempbox));
console.log(expand_drop_table(G.drops.tempbox2));

[Telokis]

You are modifying an array while iterating over it. There are edge cases where this will break things. (If the first element needs to be expanded, for example)

Below is a rewrite with some docs and a more descriptive function name:

/**
 * Replace all "open" entries in a drop table with the contents of the table it references.
 * @param {Array} table - The drop table to expand.
 * @returns {Array} - The expanded drop table.
 */
function expand_drop_table(table) {
    let changed = true;
    let newTable = [...table];

    while (changed) {
        changed = false;

        const tmpTable = [];
        for (const drop_item of newTable) {
            if (drop_item[1] === "open") {
                tmpTable.push(...G.drops[drop_item[2]]);
                changed = true;
            } else {
                tmpTable.push(drop_item);
            }
        }
        newTable = tmpTable;
    }

    return newTable;
}

Thanks for your ground work, it helped me greatly.

[Telokis]

Let's remove the previous code instead of commenting it. But we can keep the comment explaining things.

[Telokis]

Please use a more descriptive name for the expanding function.

[Telokis]

Hey @EngineerYo! Thanks a lot for this PR!
Let me know if you don't have the time to implement my reviews, I'll do them myself, no worries!

[Will-Crain]

@Telokis -

Thanks for these comments! They're both very functional, and also educational for me 😄

I'm out of town with only a work laptop + my phone until April 22nd. If you'd like to implement these changes before then, by all means.

Otherwise, I'll revise the week I'm back home

[Telokis]

Thanks for these comments! They're both very functional, and also educational for me 😄

I'm out of town with only a work laptop + my phone until April 22nd. If you'd like to implement these changes before then, by all means.

Otherwise, I'll revise the week I'm back home

@EngineerYo Hey, thanks for answering! If you're motivated to fix the PR I'll let you do it, thanks!

[Telokis]

@Will-Crain Hey! How do you feel about this PR? Do you still wanna work on it or should I close it?