dockipelago/worlds/duke3d/levels/e1l4.py

from BaseClasses import Region

from ..base_classes import D3DLevel


class E1L4(D3DLevel):
    name = "Toxic Dump"
    levelnum = 3
    volumenum = 0
    keys = ["Blue", "Red"]
    location_defs = [
        {
            "name": "Gear Room Secret Scuba Gear",
            "id": 59,
            "type": "sprite",
            "density": 2,
        },
        {"name": "Gear Room Secret Armor", "id": 60, "type": "sprite", "density": 4},
        {"name": "Canyon Steroids", "id": 67, "type": "sprite", "density": 0},
        {
            "name": "Secret Alcove Holo Duke outside Submarine",
            "id": 86,
            "type": "sprite",
            "density": 2,
        },
        {"name": "Red Key Card", "id": 210, "type": "sprite", "density": 0},
        {"name": "Blue Key Card", "id": 247, "type": "sprite", "density": 0},
        {"name": "Guard Tower Chaingun", "id": 274, "type": "sprite", "density": 2},
        {"name": "MP Sewage Chaingun", "id": 293, "type": "sprite", "density": 5},
        {
            "name": "Toxic Waste Belt Scuba Gear",
            "id": 294,
            "type": "sprite",
            "density": 0,
        },
        {"name": "Sewage Atomic Health", "id": 301, "type": "sprite", "density": 0},
        {"name": "Gear Room Medkit", "id": 625, "type": "sprite", "density": 0},
        {
            "name": "Underwater Canyon Night Vision Goggles",
            "id": 626,
            "type": "sprite",
            "density": 3,
        },
        {
            "name": "Submarine Return Cave Atomic Health",
            "id": 741,
            "type": "sprite",
            "density": 2,
        },
        {"name": "Sewage Protective Boots", "id": 899, "type": "sprite", "density": 1},
        {"name": "MP Waterfall Shotgun", "id": 905, "type": "sprite", "density": 5},
        {
            "name": "Underwater Canyon Chaingun",
            "id": 913,
            "type": "sprite",
            "density": 1,
        },
        {"name": "Underwater Gate RPG", "id": 929, "type": "sprite", "density": 0},
        {"name": "Underwater Scuba Gear", "id": 957, "type": "sprite", "density": 1},
        {"name": "RPG near Blue Key Card", "id": 962, "type": "sprite", "density": 3},
        {
            "name": "Underwater Secret Pipebombs 1",
            "id": 969,
            "type": "sprite",
            "density": 4,
        },
        {
            "name": "Underwater Secret Pipebombs 2",
            "id": 970,
            "type": "sprite",
            "density": 4,
        },
        {
            "name": "Underwater Secret Atomic Health",
            "id": 971,
            "type": "sprite",
            "density": 2,
        },
        {
            "name": "Right Cylinder Atomic Health",
            "id": 987,
            "type": "sprite",
            "density": 3,
        },
        {"name": "Underwater Medkit", "id": 988, "type": "sprite", "density": 3},
        {"name": "Cylinders Armor", "id": 991, "type": "sprite", "density": 0},
        {
            "name": "Underwater Hallway Holo Duke",
            "id": 1013,
            "type": "sprite",
            "density": 1,
        },
        {
            "name": "Underwater Canyon Pipebombs",
            "id": 1014,
            "type": "sprite",
            "density": 3,
        },
        {
            "name": "Canyon Secret Scuba Gear",
            "id": 1050,
            "type": "sprite",
            "density": 2,
        },
        {"name": "Submarine Medkit", "id": 1060, "type": "sprite", "density": 4},
        {"name": "Submarine Atomic Health", "id": 1061, "type": "sprite", "density": 2},
        {"name": "Submarine Armor", "id": 1062, "type": "sprite", "density": 4},
        {
            "name": "Shotgun near Red Key Card",
            "id": 1069,
            "type": "sprite",
            "density": 3,
        },
        {
            "name": "Left Cylinder Atomic Health 2",
            "id": 1070,
            "type": "sprite",
            "density": 4,
        },
        {
            "name": "Left Cylinder Atomic Health 1",
            "id": 1071,
            "type": "sprite",
            "density": 2,
        },
        {
            "name": "Canyon Dark Cave Shotgun",
            "id": 1074,
            "type": "sprite",
            "density": 2,
        },
        {"name": "Canyon Dark Cave Medkit", "id": 1075, "type": "sprite", "density": 4},
        {
            "name": "Sewage Secret Alcove Atomic Health 1",
            "id": 1079,
            "type": "sprite",
            "density": 2,
        },
        {
            "name": "Sewage Secret Alcove Atomic Health 2",
            "id": 1080,
            "type": "sprite",
            "density": 4,
        },
        {"name": "Canyon RPG", "id": 1085, "type": "sprite", "density": 0},
        {"name": "Secret Submarine Return Cave 1", "id": 88, "type": "sector"},
        {"name": "Secret Submarine Return Cave 2", "id": 89, "type": "sector"},
        {"name": "Secret Submarine Return Cave 3", "id": 90, "type": "sector"},
        {"name": "Secret Waterfall Secret Teleporter", "id": 184, "type": "sector"},
        {"name": "Secret Underwater Secret Cave", "id": 267, "type": "sector"},
        {"name": "Secret Guard Tower", "id": 274, "type": "sector"},
        {"name": "Secret Alcove near Blue Key Card", "id": 330, "type": "sector"},
        {"name": "Secret Sewage Alcove", "id": 331, "type": "sector"},
        {"name": "Secret Toxic Waste Belt Hidden Alcove", "id": 418, "type": "sector"},
        {"name": "Secret Canyon Wall", "id": 421, "type": "sector"},
        {"name": "Secret Top of Submarine", "id": 430, "type": "sector"},
        {"name": "Secret Left Cylinder", "id": 435, "type": "sector"},
        {"name": "Secret Canyon Dark Cave", "id": 453, "type": "sector"},
        {"name": "Sewer Breakable Wall", "id": 465, "type": "sector"},
        {"name": "Exit", "id": 0, "type": "exit"},
        {"name": "Secret Exit", "id": 6, "type": "exit"},
    ]
    events = ["Underwater Gate"]
    must_dive = True

    def main_region(self) -> Region:
        r = self.rules
        ret = self.region(self.name)

        submarine = self.region(
            "Submarine",
            [
                "Underwater Scuba Gear",
                "Underwater Medkit",
                "RPG near Blue Key Card",
                "Blue Key Card",
            ],
        )
        # Can get out of the submarine in just 150 units. Relevant to note for later dive logic
        self.connect(ret, submarine, r.can_dive)

        blue_key_alcove = self.region(
            "Alcove near Blue Key Card",
            [
                "Secret Alcove Holo Duke outside Submarine",
                "Secret Alcove near Blue Key Card",
            ],
        )
        # jump requires SR50 without sprint speed
        self.connect(
            submarine,
            blue_key_alcove,
            r.can_open & (r.jetpack(50) | (r.can_jump & r.sr50)),
        )

        submarine_secret = self.region(
            "Submarine Secret",
            [
                "Secret Top of Submarine",
                "Submarine Medkit",
                "Submarine Atomic Health",
                "Submarine Armor",
            ],
        )
        # Can run off the Blue Key Card ledge, but requires sprint speed or SR50
        self.connect(submarine, submarine_secret, r.jump | r.sr50)

        underwater_cave = self.region(
            "Underwater Cave",
            [
                "Underwater Secret Atomic Health",
                "Underwater Secret Pipebombs 2",
                "Underwater Secret Pipebombs 1",
                "Secret Underwater Secret Cave",
            ],
        )
        self.connect(submarine, underwater_cave, r.explosives)

        facility = self.region(
            "Waste Facility",
            [
                "Secret Guard Tower",
                "Guard Tower Chaingun",
                "Toxic Waste Belt Scuba Gear",
                "Shotgun near Red Key Card",
                "Red Key Card",
                "Secret Toxic Waste Belt Hidden Alcove",
                "Cylinders Armor",
                "Right Cylinder Atomic Health",
            ],
        )
        # This is a hard Use and Open check currently with no known bypass, so we don't break down
        # the logic beyond this point in full detail for now
        self.connect(submarine, facility, self.blue_key & r.can_open)
        self.restrict("Red Key Card", r.can_open)
        self.restrict("Secret Toxic Waste Belt Hidden Alcove", r.can_open)

        cylinders = self.region(
            "Waste Storage Cylinders",
            [
                "Secret Left Cylinder",
                "Left Cylinder Atomic Health 2",
                "Left Cylinder Atomic Health 1",
            ],
        )
        self.connect(facility, cylinders, r.jump & r.can_use)
        # Can't touch the sector with just jetpack
        self.restrict("Secret Left Cylinder", r.can_jump)

        flooded_area = self.region(
            "Flooded Area",
            [
                "Underwater Canyon Night Vision Goggles",
                "Canyon Steroids",
                # Can shoot mine to unlock
                "Underwater Canyon Chaingun",
            ],
        )
        self.connect(
            facility,
            flooded_area,
            (
                (
                    (r.can_shrink & self.red_key)
                    | (r.glitched & r.can_crouch & r.can_jump)
                )
                & r.can_use
                # need sr40/sr50 to get through the maze
                & (r.difficulty("medium") | r.sprint)
                # dive capacity logic, need 150 to exit sub at start
                & (
                    r.dive(500)
                    | (r.difficulty("medium") & r.dive(250))
                    | (r.difficulty("hard") & r.dive(150))
                )
            ),
        )

        # Cost of rising the water level and getting to the top of the canyon with scuba gear remaining, from start
        second_dive = (
            r.dive(1000)
            | (r.difficulty("medium") & r.dive(750))
            | (r.difficulty("hard") & (r.dive(350) | (r.can_sprint & r.dive(300))))
        )

        canyon_far = self.region(
            "Canyon Far Side",
            ["Underwater Gate", "Canyon RPG"],
        )
        # need SR50 without sprint speed to cross
        self.connect(flooded_area, canyon_far, r.jump | r.sr50)

        canyon_alcove = self.region(
            "Canyon Alcove", ["Secret Canyon Wall", "Canyon Secret Scuba Gear"]
        )
        self.connect(canyon_far, canyon_alcove, r.can_open & r.can_crouch)

        canyon_return1 = self.region(
            "Canyon Return Path 1", ["Secret Submarine Return Cave 1"]
        )
        self.connect(canyon_far, canyon_return1, r.explosives)
        canyon_return2 = self.region(
            "Canyon Return Path 2",
            ["Secret Submarine Return Cave 2", "Submarine Return Cave Atomic Health"],
        )
        self.connect(canyon_return1, canyon_return2, r.explosives_count(2))
        canyon_return3 = self.region(
            "Canyon Return Path 1", ["Secret Submarine Return Cave 3"]
        )
        self.connect(canyon_return2, canyon_return3, r.explosives_count(3))

        canyon_dark_area = self.region(
            "Canyon Dark Area",
            [
                "Secret Canyon Dark Cave",
                "Canyon Dark Cave Medkit",
                "Canyon Dark Cave Shotgun",
            ],
        )
        self.connect(flooded_area, canyon_dark_area, r.jump)

        deep_water = self.region(
            "Deep Water Area",
            [
                "Underwater Hallway Holo Duke",
                "Gear Room Medkit",
                "Gear Room Secret Scuba Gear",
                "Gear Room Secret Armor",
                "MP Waterfall Shotgun",
                "Underwater Canyon Pipebombs",
            ],
        )
        self.restrict("Underwater Hallway Holo Duke", r.can_use)

        self.connect(
            flooded_area, deep_water, self.event("Underwater Gate") & second_dive
        )

        # Cost of rising the water level and getting through the moving gears
        third_dive = (
            r.dive(1900)
            | (r.difficulty("medium") & r.dive(1250))
            | (r.difficulty("hard") & (r.dive(950) | (r.can_sprint & r.dive(800))))
        )

        top_of_waterfall = self.region(
            "Top of Waterfall", ["Secret Waterfall Secret Teleporter"]
        )
        self.connect(deep_water, top_of_waterfall, third_dive)
        self.restrict(
            "Secret Waterfall Secret Teleporter",
            r.explosives | (r.jetpack(50) & (r.can_sprint | r.difficulty("hard"))),
        )

        moving_platforms = self.region("Moving Platforms", ["Underwater Gate RPG"])
        # Drops down a waterfall, one-way only this way around
        self.connect(top_of_waterfall, moving_platforms, r.true)
        # Need to open the shootable switch to access
        self.restrict("Underwater Gate RPG", r.can_use)

        top_of_sewer = self.region(
            "Sewers Top",
            [
                "MP Sewage Chaingun",
                "Sewage Atomic Health",
                "Sewage Protective Boots",
            ],
        )
        # There might be a way to get off the water fall without jump
        # Also need to use a button if we don't have jetpack to bypass stuff
        self.connect(
            moving_platforms, top_of_sewer, (r.can_jump & r.can_use) | r.jetpack(50)
        )

        sewage_alcove = self.region(
            "Sewage Alcove",
            [
                "Secret Sewage Alcove",
                "Sewage Secret Alcove Atomic Health 1",
                "Sewage Secret Alcove Atomic Health 2",
            ],
        )
        self.connect(top_of_sewer, sewage_alcove, r.jump)

        secret_exit = self.region(
            "Sewer Breakable Wall", ["Sewer Breakable Wall", "Secret Exit"]
        )
        self.connect(top_of_sewer, secret_exit, r.explosives)
        self.restrict("Secret Exit", r.can_use)

        exit_area = self.region("Exit Area", ["Exit"])
        # Secret teleporter in canyon wall
        self.connect(flooded_area, exit_area, r.jump & r.can_open)
        self.connect(
            secret_exit,
            exit_area,
            r.explosives & (r.can_sprint | r.can_jump | r.jetpack(250)),
        )
        # sprint might work with protective boots
        self.connect(
            exit_area, top_of_sewer, r.can_crouch & (r.can_jump | r.jetpack(500))
        )
        # respect scuba use up to here on this return path from teleporter
        self.connect(top_of_sewer, moving_platforms, second_dive)
        self.connect(moving_platforms, top_of_waterfall, r.jetpack(100))
        self.connect(top_of_waterfall, deep_water, second_dive)
        self.restrict("Exit", r.can_use)

        return ret