Archipelago/OWGSets.py

'''
Helper functions to deliver entrance/exit/region sets to OWG rules.
'''

def get_immediately_accessible_entrances(world, player):
    '''
    Entrances that are available with no items at all.

    At this point, these are fake flipper spots.
    '''
    entrances = [
        'Hobo Bridge',
        'Zoras River',
        'Capacity Upgrade',
        ]
    return entrances

def get_lw_boots_accessible_entrances(world, player):
    '''
    Light World entrances that can be accessed with boots clips.
    '''
    entrances = [
        'Bat Cave Drop Ledge',
        'Desert Ledge Return Rocks',
        'Desert Palace Entrance (West)',
        'Desert Palace Entrance (North)',
        'Broken Bridge (East)',
        'Death Mountain Drop',
        'Old Man Cave (East)',
        'Old Man House (Bottom)',
        'Old Man House (Top)',
        'Death Mountain Return Cave (East)',
        'Spectacle Rock Cave',
        'Spectacle Rock Cave Peak',
        'Spectacle Rock Cave (Bottom)',
        'Broken Bridge (West)',
        'Broken Bridge (East)',
        'East Death Mountain Drop',
        'Spiral Cave Ledge Drop',
        'Fairy Ascension Drop',
        'Fairy Ascension Cave (Bottom)',
        'East Death Mountain (Top)',
        'Death Mountain (Top)',
        'Death Mountain Return Cave (West)',
        'Paradox Cave (Bottom)',
        'Paradox Cave (Middle)',
        'Hookshot Fairy',
        'Spiral Cave (Bottom)',
        'Paradox Cave (Top)',
        'Spiral Cave Ledge Access',
        'Bumper Cave Ledge Mirror Spot',
        'Floating Island Mirror Spot',
        ]
    if world.mode[player] != 'inverted':
        entrances.append('Flute Spot 1')
        entrances.append('Spectacle Rock Drop')
        entrances.append('Fairy Ascension Ledge')
    return entrances


def get_lw_boots_accessible_locations():
    '''
    Light World locations that can be reached using boots clips.
    '''
    return [
        'Lake Hylia Island',
        'Desert Ledge',
        'Spectacle Rock',
        'Floating Island',
        ]


def get_dw_boots_accessible_entrances(world, player):
    '''
    Dark World entrances that can be accessed with boots clips.
    '''
    entrances = [
        'Northeast Dark World Broken Bridge Pass',
        'Peg Area Rocks',
        'Grassy Lawn Pegs',
        'West Dark World Gap',
        'Bumper Cave Ledge Drop',
        'Turtle Rock Drop',
        'Floating Island Drop',
        'Dark Death Mountain Drop (East)',
        'Village of Outcasts Drop',
        'Hype Cave',
        'Dark World Potion Shop',
        'Archery Game',
        'Brewery',
        'C-Shaped House',
        'Chest Game',
        'Thieves Town',
        'Bumper Cave Entrance Rock',
        'Red Shield Shop',
        'Fortune Teller (Dark)',
        'Dark World Lumberjack Shop',
        'Misery Mire',
        'Mire Shed',
        'Dark Desert Hint',
        'Dark Desert Fairy',
        ]
    if world.mode[player] != 'inverted':
        entrances.append('Dark Lake Hylia Ledge')
        entrances.append('Big Bomb Shop')
        entrances.append('Kings Grave Mirror Spot')
        entrances.append('Dark Sanctuary Hint')
    return entrances


def get_dw_boots_accessible_locations():
    '''
    Dark World locations accessible using boots clips.
    '''
    return [
        'Catfish',
        'Dark Blacksmith Ruins',
        'Bumper Cave Ledge',
        ]


def get_dw_bunny_inaccessible_locations():
    '''
    Locations that the bunny cannot access.
    '''
    return [
        'Thieves Town',
        'Graveyard Ledge Mirror Spot',
        'Kings Grave Mirror Spot',
        'Bumper Cave Entrance Rock',
        'Brewery',
        'Village of Outcasts Pegs',
        'Village of Outcasts Eastern Rocks',
        'Dark Lake Hylia Drop (South)',
        'Hype Cave',
        'Village of Outcasts Heavy Rock',
        'East Dark World Bridge',
        'Bonk Fairy (Dark)',
        ]


def get_dmd_and_bunny_regions():
    '''
    Dark World regions accessible using Link and Bunny DMD methods.
    '''
    return [
        'West Dark World',
        'South Dark World',
        'East Dark World',
        ]


def get_dmd_non_bunny_regions():
    '''
    Dark World regions accessible using only Link DMD methods.
    '''
    return [
        'Dark Desert',
        'Northeast Dark World',
        ]


def get_boots_accessible_regions_lw():
    '''
    Light World regions that can be accessed using boots clips.
    '''
    return [
        'Desert Ledge (Northeast)',
        'Desert Ledge',
        'Desert Palace Entrance (North) Spot',
        'Cave 45 Ledge',
        'Graveyard Ledge',
        'Lake Hylia Island',
        'Death Mountain',
        'Death Mountain Return Ledge',
        'Bombos Tablet Ledge',
        ]


def get_mirror_hookshot_accessible_dw_locations(world, player):
    '''
    Locations accessible potentially using weird mirror hookshot boots setups.
    '''
    locations = [
        'Pyramid Fairy',
        'Pyramid Entrance',
        'Pyramid Drop',
        ]
    locations.extend(world.get_region('Dark Death Mountain Ledge', player).locations)
    return locations


def get_sword_required_superbunny_mirror_regions():
    '''
    Cave regions that superbunny can get through - but only with a sword.
    '''
    return [
        'Mini Moldorm Cave',
        'Spiral Cave (Top)',
        ]


def get_invalid_mirror_bunny_entrances_dw():
    '''
    Dark World entrances that can't be superbunny-mirrored into.
    '''
    return [
        'Skull Woods Final Section (Entrance)',
        'Hype Cave',
        'Bonk Fairy (Dark)',
        'Thieves Town',
        'Dark World Hammer Peg Cave',
        'Brewery',
        'Hookshot Cave',
        'Hookshot Cave Exit (South)',
        'Dark Lake Hylia Ledge Fairy',
        'Dark Lake Hylia Ledge Spike Cave',
        ]


def get_invalid_mirror_bunny_entrances_lw():
    '''
    Light World entrances that can't be superbunny-mirrored into.

    A couple of these, like Blind's Hideout, are odd cases where the pixel
    leading into the entrance prevents mirror superbunnying - generally due to
    there being stairs there. 
    '''
    return [
        'Bonk Rock Cave',
        'Bonk Fairy (Light)',
        'Blinds Hideout',
        '50 Rupee Cave',
        '20 Rupee Cave',
        'Checkerboard Cave',
        'Light Hype Fairy',
        'Waterfall of Wishing',
        'Light World Bomb Hut',
        'Mini Moldorm Cave',
        'Ice Rod Cave',
        'Hyrule Castle Secret Entrance Stairs',
        'Sanctuary Grave',
        'Kings Grave',
        'Tower of Hera',
        ]


def get_superbunny_accessible_locations():
    '''
    Interior locations that can be accessed with superbunny state.
    '''
    return [
        'Waterfall of Wishing - Left',
        'Waterfall of Wishing - Right',
        'King\'s Tomb', 'Floodgate',
        'Floodgate Chest',
        'Cave 45',
        'Bonk Rock Cave',
        'Brewery',
        'C-Shaped House',
        'Chest Game',
        'Mire Shed - Left',
        'Mire Shed - Right',
        'Secret Passage',
        'Ice Rod Cave',
        'Pyramid Fairy - Left',
        'Pyramid Fairy - Right',
        'Superbunny Cave - Top',
        'Superbunny Cave - Bottom',
        ]