Skip to content

sc2: Allowing unexcluded_items to affect items excluded by vanilla_items_only #5520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+58 −21
Open

sc2: Allowing unexcluded_items to affect items excluded by vanilla_items_only #5520

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed61215
sc2: Allowing unexcluded_items to affect items excluded by vanilla_it…
MatthewMarinets Oct 6, 2025
916657b
sc2: Adding testcase for vanilla items only + exclude OP items togeth…
MatthewMarinets Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 11 additions & 21 deletions worlds/sc2/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@ def create_items(self) -> None:
flag_start_inventory(self, item_list)
flag_unused_upgrade_types(self, item_list)
flag_unreleased_items(item_list)
flag_user_excluded_item_sets(self, item_list)
flag_war_council_items(self, item_list)
flag_and_add_resource_locations(self, item_list)
flag_mission_order_required_items(self, item_list)
Expand Down Expand Up @@ -392,6 +391,17 @@ def resolve_count(count: Optional[int], max_count: int) -> int:
if world.options.exclude_overpowered_items.value == ExcludeOverpoweredItems.option_true:
for item_name in item_groups.overpowered_items:
auto_excludes[item_name] = 1
if world.options.vanilla_items_only.value == VanillaItemsOnly.option_true:
for item_name, item_data in item_tables.item_table.items():
if item_name in item_groups.terran_original_progressive_upgrades:
auto_excludes[item_name] = max(item_data.quantity - 1, auto_excludes.get(item_name, 0))
elif item_name in item_groups.vanilla_items:
continue
elif item_name in item_groups.nova_equipment:
continue
else:
auto_excludes[item_name] = 0


result: List[FilterItem] = []
for item_name, item_data in item_tables.item_table.items():
Expand Down Expand Up @@ -834,26 +844,6 @@ def flag_unreleased_items(item_list: List[FilterItem]) -> None:
item.flags |= ItemFilterFlags.Removed


def flag_user_excluded_item_sets(world: SC2World, item_list: List[FilterItem]) -> None:
"""Excludes items based on item set options (`only_vanilla_items`)"""
vanilla_nonprogressive_count = {
item_name: 0 for item_name in item_groups.terran_original_progressive_upgrades
}
if world.options.vanilla_items_only.value == VanillaItemsOnly.option_true:
vanilla_items = item_groups.vanilla_items + item_groups.nova_equipment
for item in item_list:
if ItemFilterFlags.UserExcluded in item.flags:
continue
if item.name not in vanilla_items:
item.flags |= ItemFilterFlags.UserExcluded
if item.name in item_groups.terran_original_progressive_upgrades:
if vanilla_nonprogressive_count[item.name]:
item.flags |= ItemFilterFlags.UserExcluded
vanilla_nonprogressive_count[item.name] += 1

excluded_count: Dict[str, int] = dict()


def flag_war_council_items(world: SC2World, item_list: List[FilterItem]) -> None:
"""Excludes / start-inventories items based on `nerf_unit_baselines` option.
Will skip items that are excluded by other sources."""
Expand Down
31 changes: 31 additions & 0 deletions worlds/sc2/test/test_generation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,37 @@ def test_vanilla_items_only_includes_only_nova_equipment_and_vanilla_and_filler_
if item_data.quantity == 0:
continue
self.assertIn(item_name, item_groups.vanilla_items + item_groups.nova_equipment)

def test_vanilla_items_only_can_unexclude_items(self) -> None:
world_options = {
# Ensuring an excess of locations so expected items don't get culled
**self.ALL_CAMPAIGNS,
'mission_order': options.MissionOrder.option_grid,
'maximum_campaign_size': options.MaximumCampaignSize.range_end,
'enable_race_swap': options.EnableRaceSwapVariants.option_shuffle_all,
'selected_races': {SC2Race.TERRAN.get_title()},
# Options under test
'vanilla_items_only': True,
'unexcluded_items': {
item_names.PROGRESSIVE_FIRE_SUPPRESSION_SYSTEM: 0,
item_names.WARHOUND: 1,
item_groups.ItemGroupNames.TERRAN_STIMPACKS: 0,
},
# Avoid options that lock non-vanilla items for logic
'required_tactics': options.RequiredTactics.option_any_units,
'mastery_locations': options.MasteryLocations.option_disabled,
# Move the unit nerf items from the start inventory to the pool,
# else this option could push non-vanilla items past this test
'war_council_nerfs': True,
}
self.generate_world(world_options)
world_items = [item.name for item in self.multiworld.itempool]
self.assertTrue(world_items)
self.assertNotIn(item_names.MARAUDER_MAGRAIL_MUNITIONS, world_items)
self.assertEqual(world_items.count(item_names.PROGRESSIVE_FIRE_SUPPRESSION_SYSTEM), 2)
self.assertIn(item_names.WARHOUND, world_items)
self.assertIn(item_names.MARAUDER_PROGRESSIVE_STIMPACK, world_items)
self.assertIn(item_names.REAPER_PROGRESSIVE_STIMPACK, world_items)

def test_evil_awoken_with_vanilla_items_only_generates(self) -> None:
world_options = {
Expand Down
Loading