Mm/item option refactor

[MatthewMarinets]

What is this fixing or adding?

Updating locked_items and excluded_items to take an amount parameter. Reworked most of the item filtering logic in __init__.py, as I had to change that code anyways to work with the new data structure.

Most code changes roughly follows a chain-of-responsibility model, so different effects can easily be added / removed / shifted in order by just adding to or removing from the chain. Things are essentially just kept in a list, with each item getting its own flags marking locks / start inventory / exclusion / plando. Plando flags are underused because I don't know how plando works.

Excluding / locking / unexcluding an amount of 0 just sets the amount to the maximum quantity. For filler items (quantity 0), the amount is unchanged. For a group, the specified amount is distributed to all elements in the group, and 0 is resolved per-item (so Terran Items: 0 will have 1 marine, 2 Progressive Orbital commands, and 3 Progressive Regenerative Biosteels).

This targets #185

How was this tested?

Added a bunch of unit tests, and ran a generation and played a mission through with some start inventory items. On Harvest of Screams, zerg units, morphs, and unit upgrades seemed to work fine.

Other changes

• Remove Kerrigan presence option "Not present and no passives"
  • Should just exclude "Evolution Pit" item group to get rid of Kerrigan passives
• Psi Disrupter and HME are now auto-excluded if there are no TvZ build missions
• flag_start_inventory() (former assign_starter_items()) now checks start no-logic locations based on a dummy CollectionState rather than checking equality with the default logic function
• Nova gets a weapon in start inventory if she appears in the first mission, even if it's not Sudden Strike
• Sudden Strike can no longer pick a start unit that has its support item excluded or plando'd
• Fixed a broken anti-air logic requirement on Cutthroat
• Logic requirement changed on Evil Awoken to no longer require Stalker upgrades. Those upgrades don't exist in vanilla, meaning a vanilla comp wouldn't be within logic (and the discord agreed)
• Added many item groups to allow users to fine-tune their item pools into what was preset by options, and many new combinations
  • Replaced separate bw_items, nco_items, and ext_items options with a unified vanilla_items_only option, which limits the pool to only those items that exist in the 3 main vanilla campaigns (WoL, HotS, and LotV)
  • Other compositions, such as NCO units+upgrades only, or NCO+WoL, or NCO units with all upgrades, etc, can be created with the new item groups
• Added an un-exclude option, to allow fine-tuning exclusions without locking items
  • Excluding group + unit is done with two entries in excluded_items, group and unit
  • Excluding group - unit is done with group excluded and unit unexcluded
  • Whitelisting behaviour is done by excluding a large group, and unexcluding items from that group. Example:

    excluded_items:
    Terran Items: 0
    unexcluded_items:
    NCO +Items: 0,
    NCO -Items: 1,

TODO

• [x] Remove Kerrigan Presence option "Not present and no passives"
• [x] Remove ItemOrigin or use it
• [x] Remove bw_items, nco_items, ext_items; replace with item groups and a single vanilla_only switch
• [x] Add an "un-exclude" option that allows for a whitelisting effect / adding items back to a pool, without necessarily locking them
• [x] Apparently older Python doesn't have StrEnum, will have to either update all usages of ItemType and make it a regular enum, or make it a plain string.

[Ziktofel]

What about using this: https://pypi.org/project/StrEnum/

[Ziktofel]

Or you can use plain enum like in SC2Mission:

class SC2Mission(Enum):

[MatthewMarinets]

I'm going to go the basic Enum route; using StrEnum was just a temporary measure while I tried to get something that works, as it's backwards compatible with the existing string == checks we do everywhere. It shouldn't be too difficult to track down, and mypy should catch anything I miss.

[MatthewMarinets]

This is still barely tested, but I need to sleep. Will do some local generation tomorrow, add some unit test, and maybe add the unexclude option if people have had time to weigh in.

[MatthewMarinets]

There's definitely more that I can play around with, but I think this is a good place to stop for a PR. The review will likely already take a while with how big this change is :/

There's enough tests that I'm fairly confident things are stable and the new options do what they say they do. There's also now a framework we can use to make new tests as issues get reported.

This PR removes all dependencies in ItemData.origin, instead looking at item groups added in ItemGroups.py. ItemData.origin can probably be removed now, idk if that should be in this PR. There's also further cleanup that can be done -- many item groups defined in Items.py can be moved to ItemGroups.py and given a user-facing name (and many are probably unused). I've also tried to avoid having item generation look at enabled campaigns as much as possible, instead preferring to look at the mission table. This means that excluding all the missions in a campaign should behave the same as disabling the campaign, and also promotes more fine-tuned item exclusion around matchups / no-builds / mission flags.

[Ziktofel]

I think the item filtering needs touching in order to get everything working

[MatthewMarinets]

What happens if you have vanilla only items, standard tactics and Evil Awoken?

Looks like the dynamic item filtering needs still adjusting

Good catch, that breaks generation. I'm inclined to say that the logic should change with vanilla items only, rather than the item filtering. In my mind, vanilla items only means vanilla items only. Will ask in the discord before proceeding, though.

[Ziktofel]

What happens if you have vanilla only items, standard tactics and Evil Awoken? Looks like the dynamic item filtering needs still adjusting

Good catch, that breaks generation. I'm inclined to say that the logic should change with vanilla items only, rather than the item filtering. In my mind, vanilla items only means vanilla items only. Will ask in the discord before proceeding, though.

The thing is this exact case is very rough for less skilled players, therefore this logic rule exists. I think the case with warning should do the case (if your exclusions break logic, the offending item gets back into pool). That would also increase generation stability (also for async that like to put settings to random).

Surely, logic rules isn't the place that will do "if X is excluded, do something else"

[MatthewMarinets]

What happens if you have vanilla only items, standard tactics and Evil Awoken? Looks like the dynamic item filtering needs still adjusting

Good catch, that breaks generation. I'm inclined to say that the logic should change with vanilla items only, rather than the item filtering. In my mind, vanilla items only means vanilla items only. Will ask in the discord before proceeding, though.

The thing is this exact case is very rough for less skilled players, therefore this logic rule exists. I think the case with warning should do the case (if your exclusions break logic, the offending item gets back into pool). That would also increase generation stability (also for async that like to put settings to random).

Surely, logic rules isn't the place that will do "if X is excluded, do something else"

The people have spoken: https://discord.com/channels/731205301247803413/980554570075873300/1235470259620675645

I will remove the Stalker upgrade dependency entirely. I'm in agreement with the general sentiment that there should be a vanilla composition that is in-logic.

I also notice this logic requirement is only on the victory check, and stalkers are not at all necessary for the fainl escape sequence between Temple Investigated and Victory.

[Ziktofel]

BTW the ppl who voted aren't the target audience for who this one rule exists (it exists mainly for casual/normal players playing on standard tactics)

So either bring the rule back or do a cleanup -> remove the Stalker upgrade function and mark those items as useful (they aren't used in any other rule and this rule is just for Evil Awoken)

[MatthewMarinets]

Noting that this also resolves most of #160 .