Archipelago/worlds/sc2wol/MissionTables.py

from typing import NamedTuple, Dict, List, Set

from BaseClasses import MultiWorld
from .Options import get_option_value

no_build_regions_list = ["Liberation Day", "Breakout", "Ghost of a Chance", "Piercing the Shroud", "Whispers of Doom",
                         "Belly of the Beast"]
easy_regions_list = ["The Outlaws", "Zero Hour", "Evacuation", "Outbreak", "Smash and Grab", "Devil's Playground"]
medium_regions_list = ["Safe Haven", "Haven's Fall", "The Dig", "The Moebius Factor", "Supernova",
                       "Welcome to the Jungle", "The Great Train Robbery", "Cutthroat", "Media Blitz",
                       "A Sinister Turn", "Echoes of the Future"]
hard_regions_list = ["Maw of the Void", "Engine of Destruction", "In Utter Darkness", "Gates of Hell",
                     "Shatter the Sky"]


class MissionInfo(NamedTuple):
    id: int
    required_world: List[int]
    category: str
    number: int = 0  # number of worlds need beaten
    completion_critical: bool = False  # missions needed to beat game
    or_requirements: bool = False  # true if the requirements should be or-ed instead of and-ed


class FillMission(NamedTuple):
    type: str
    connect_to: List[int]  # -1 connects to Menu
    category: str
    number: int = 0  # number of worlds need beaten
    completion_critical: bool = False  # missions needed to beat game
    or_requirements: bool = False  # true if the requirements should be or-ed instead of and-ed
    relegate: bool = False  # true if this is a slot no build missions should be relegated to.


vanilla_shuffle_order = [
    FillMission("no_build", [-1], "Mar Sara", completion_critical=True),
    FillMission("easy", [0], "Mar Sara", completion_critical=True),
    FillMission("easy", [1], "Mar Sara", completion_critical=True),
    FillMission("easy", [2], "Colonist"),
    FillMission("medium", [3], "Colonist"),
    FillMission("hard", [4], "Colonist", number=7),
    FillMission("hard", [4], "Colonist", number=7, relegate=True),
    FillMission("easy", [2], "Artifact", completion_critical=True),
    FillMission("medium", [7], "Artifact", number=8, completion_critical=True),
    FillMission("hard", [8], "Artifact", number=11, completion_critical=True),
    FillMission("hard", [9], "Artifact", number=14, completion_critical=True),
    FillMission("hard", [10], "Artifact", completion_critical=True),
    FillMission("medium", [2], "Covert", number=4),
    FillMission("medium", [12], "Covert"),
    FillMission("hard", [13], "Covert", number=8, relegate=True),
    FillMission("hard", [13], "Covert", number=8, relegate=True),
    FillMission("medium", [2], "Rebellion", number=6),
    FillMission("hard", [16], "Rebellion"),
    FillMission("hard", [17], "Rebellion"),
    FillMission("hard", [18], "Rebellion"),
    FillMission("hard", [19], "Rebellion", relegate=True),
    FillMission("medium", [8], "Prophecy"),
    FillMission("hard", [21], "Prophecy"),
    FillMission("hard", [22], "Prophecy"),
    FillMission("hard", [23], "Prophecy", relegate=True),
    FillMission("hard", [11], "Char", completion_critical=True),
    FillMission("hard", [25], "Char", completion_critical=True),
    FillMission("hard", [25], "Char", completion_critical=True),
    FillMission("all_in", [26, 27], "Char", completion_critical=True, or_requirements=True)
]

mini_campaign_order = [
    FillMission("no_build", [-1], "Mar Sara", completion_critical=True),
    FillMission("easy", [0], "Colonist"),
    FillMission("medium", [1], "Colonist"),
    FillMission("medium", [0], "Artifact", completion_critical=True),
    FillMission("medium", [3], "Artifact", number=4, completion_critical=True),
    FillMission("hard", [4], "Artifact", number=8, completion_critical=True),
    FillMission("medium", [0], "Covert", number=2),
    FillMission("hard", [6], "Covert"),
    FillMission("medium", [0], "Rebellion", number=3),
    FillMission("hard", [8], "Rebellion"),
    FillMission("medium", [4], "Prophecy"),
    FillMission("hard", [10], "Prophecy"),
    FillMission("hard", [5], "Char", completion_critical=True),
    FillMission("hard", [5], "Char", completion_critical=True),
    FillMission("all_in", [12, 13], "Char", completion_critical=True, or_requirements=True)
]

gauntlet_order = [
    FillMission("no_build", [-1], "I", completion_critical=True),
    FillMission("easy", [0], "II", completion_critical=True),
    FillMission("medium", [1], "III", completion_critical=True),
    FillMission("medium", [2], "IV", completion_critical=True),
    FillMission("hard", [3], "V", completion_critical=True),
    FillMission("hard", [4], "VI", completion_critical=True),
    FillMission("all_in", [5], "Final", completion_critical=True)
]

grid_order = [
    FillMission("no_build", [-1], "_1"),
    FillMission("medium", [0], "_1"),
    FillMission("medium", [1, 6, 3], "_1", or_requirements=True),
    FillMission("hard", [2, 7], "_1", or_requirements=True),
    FillMission("easy", [0], "_2"),
    FillMission("medium", [1, 4], "_2", or_requirements=True),
    FillMission("hard", [2, 5, 10, 7], "_2", or_requirements=True),
    FillMission("hard", [3, 6, 11], "_2", or_requirements=True),
    FillMission("medium", [4, 9, 12], "_3", or_requirements=True),
    FillMission("hard", [5, 8, 10, 13], "_3", or_requirements=True),
    FillMission("hard", [6, 9, 11, 14], "_3", or_requirements=True),
    FillMission("hard", [7, 10], "_3", or_requirements=True),
    FillMission("hard", [8, 13], "_4", or_requirements=True),
    FillMission("hard", [9, 12, 14], "_4", or_requirements=True),
    FillMission("hard", [10, 13], "_4", or_requirements=True),
    FillMission("all_in", [11, 14], "_4", or_requirements=True)
]

mini_grid_order = [
    FillMission("no_build", [-1], "_1"),
    FillMission("medium", [0], "_1"),
    FillMission("medium", [1, 5], "_1", or_requirements=True),
    FillMission("easy", [0], "_2"),
    FillMission("medium", [1, 3], "_2", or_requirements=True),
    FillMission("hard", [2, 4], "_2", or_requirements=True),
    FillMission("medium", [3, 7], "_3", or_requirements=True),
    FillMission("hard", [4, 6], "_3", or_requirements=True),
    FillMission("all_in", [5, 7], "_3", or_requirements=True)
]

blitz_order = [
    FillMission("no_build", [-1], "I"),
    FillMission("easy", [-1], "I"),
    FillMission("medium", [0, 1], "II", number=1, or_requirements=True),
    FillMission("medium", [0, 1], "II", number=1, or_requirements=True),
    FillMission("medium", [0, 1], "III", number=2, or_requirements=True),
    FillMission("medium", [0, 1], "III", number=2, or_requirements=True),
    FillMission("hard", [0, 1], "IV", number=3, or_requirements=True),
    FillMission("hard", [0, 1], "IV", number=3, or_requirements=True),
    FillMission("hard", [0, 1], "V", number=4, or_requirements=True),
    FillMission("hard", [0, 1], "V", number=4, or_requirements=True),
    FillMission("hard", [0, 1], "Final", number=5, or_requirements=True),
    FillMission("all_in", [0, 1], "Final", number=5, or_requirements=True)
]

mission_orders = [vanilla_shuffle_order, vanilla_shuffle_order, mini_campaign_order, grid_order, mini_grid_order, blitz_order, gauntlet_order]


vanilla_mission_req_table = {
    "Liberation Day": MissionInfo(1, [], "Mar Sara", completion_critical=True),
    "The Outlaws": MissionInfo(2, [1], "Mar Sara", completion_critical=True),
    "Zero Hour": MissionInfo(3, [2], "Mar Sara", completion_critical=True),
    "Evacuation": MissionInfo(4, [3], "Colonist"),
    "Outbreak": MissionInfo(5, [4], "Colonist"),
    "Safe Haven": MissionInfo(6, [5], "Colonist", number=7),
    "Haven's Fall": MissionInfo(7, [5], "Colonist", number=7),
    "Smash and Grab": MissionInfo(8, [3], "Artifact", completion_critical=True),
    "The Dig": MissionInfo(9, [8], "Artifact", number=8, completion_critical=True),
    "The Moebius Factor": MissionInfo(10, [9], "Artifact", number=11, completion_critical=True),
    "Supernova": MissionInfo(11, [10], "Artifact", number=14, completion_critical=True),
    "Maw of the Void": MissionInfo(12, [11], "Artifact", completion_critical=True),
    "Devil's Playground": MissionInfo(13, [3], "Covert", number=4),
    "Welcome to the Jungle": MissionInfo(14, [13], "Covert"),
    "Breakout": MissionInfo(15, [14], "Covert", number=8),
    "Ghost of a Chance": MissionInfo(16, [14], "Covert", number=8),
    "The Great Train Robbery": MissionInfo(17, [3], "Rebellion", number=6),
    "Cutthroat": MissionInfo(18, [17], "Rebellion"),
    "Engine of Destruction": MissionInfo(19, [18], "Rebellion"),
    "Media Blitz": MissionInfo(20, [19], "Rebellion"),
    "Piercing the Shroud": MissionInfo(21, [20], "Rebellion"),
    "Whispers of Doom": MissionInfo(22, [9], "Prophecy"),
    "A Sinister Turn": MissionInfo(23, [22], "Prophecy"),
    "Echoes of the Future": MissionInfo(24, [23], "Prophecy"),
    "In Utter Darkness": MissionInfo(25, [24], "Prophecy"),
    "Gates of Hell": MissionInfo(26, [12], "Char", completion_critical=True),
    "Belly of the Beast": MissionInfo(27, [26], "Char", completion_critical=True),
    "Shatter the Sky": MissionInfo(28, [26], "Char", completion_critical=True),
    "All-In": MissionInfo(29, [27, 28], "Char", completion_critical=True, or_requirements=True)
}

lookup_id_to_mission: Dict[int, str] = {
    data.id: mission_name for mission_name, data in vanilla_mission_req_table.items() if data.id}

no_build_starting_mission_locations = {
    "Liberation Day": "Liberation Day: Victory",
    "Breakout": "Breakout: Victory",
    "Ghost of a Chance": "Ghost of a Chance: Victory",
    "Piercing the Shroud": "Piercing the Shroud: Victory",
    "Whispers of Doom": "Whispers of Doom: Victory",
    "Belly of the Beast": "Belly of the Beast: Victory",
}

build_starting_mission_locations = {
    "Zero Hour": "Zero Hour: First Group Rescued",
    "Evacuation": "Evacuation: First Chysalis",
    "Devil's Playground": "Devil's Playground: Tosh's Miners"
}

advanced_starting_mission_locations = {
    "Smash and Grab": "Smash and Grab: First Relic",
    "The Great Train Robbery": "The Great Train Robbery: North Defiler"
}


def get_starting_mission_locations(world: MultiWorld, player: int) -> Set[str]:
    if get_option_value(world, player, 'shuffle_no_build') or get_option_value(world, player, 'mission_order') < 2:
        # Always start with a no-build mission unless explicitly relegating them
        # Vanilla and Vanilla Shuffled always start with a no-build even when relegated
        return no_build_starting_mission_locations
    elif get_option_value(world, player, 'required_tactics') > 0:
        # Advanced Tactics/No Logic add more starting missions to the pool
        return {**build_starting_mission_locations, **advanced_starting_mission_locations}
    else:
        # Standard starting missions when relegate is on
        return build_starting_mission_locations


alt_final_mission_locations = {
    "Maw of the Void": "Maw of the Void: Victory",
    "Engine of Destruction": "Engine of Destruction: Victory",
    "Supernova": "Supernova: Victory",
    "Gates of Hell": "Gates of Hell: Victory",
    "Shatter the Sky": "Shatter the Sky: Victory"
}