Core: Rework accessibility

BaseClasses.py

@@ -556,7 +556,7 @@ def fulfills_accessibility(self, state: Optional[CollectionState] = None):
         players: Dict[str, Set[int]] = {
             "minimal": set(),
             "items": set(),
-            "locations": set()
+            "full": set()
         }
         for player, access in self.accessibility.items():
             players[access.current_key].add(player)
@@ -571,9 +571,10 @@ def location_condition(location: Location):
 
         def location_relevant(location: Location):
             """Determine if this location is relevant to sweep."""
-            if location.progress_type != LocationProgressType.EXCLUDED \
-                and (location.player in players["locations"] or location.event
-                     or (location.item and location.item.advancement)):
+            if __debug__ \
+                    and location.progress_type != LocationProgressType.EXCLUDED \
+                    and (location.player in players["full"] or location.event
+                         or (location.item and location.item.advancement)):
                 return True
             return False
 

Options.py

@@ -880,14 +880,23 @@ class ItemSet(OptionSet):
 
 class Accessibility(Choice):
     """Set rules for reachability of your items/locations.
-    Locations: ensure everything can be reached and acquired.
-    Items: ensure all logically relevant items can be acquired.
+
+    Full: ensure everything can be reached and acquired.
     Minimal: ensure what is needed to reach your goal can be acquired."""
     display_name = "Accessibility"
-    option_locations = 0
-    option_items = 1
+    option_full = 0
     option_minimal = 2
     alias_none = 2
+    default = 0
+
+
+class ItemsAccessibility(Accessibility):
+    """Set rules for reachability of your items/locations.
+
+    Full: ensure everything can be reached and acquired.
+    Items: ensure all logically relevant items can be acquired. Some items, such as keys, may be self-locking.
+    Minimal: ensure what is needed to reach your goal can be acquired."""
+    option_items = 1
     default = 1
 
 

playerSettings.yaml

@@ -44,10 +44,10 @@ A Link to the Past:
 
   accessibility:
     # Set rules for reachability of your items/locations.
-    # Locations: ensure everything can be reached and acquired.
-    # Items: ensure all logically relevant items can be acquired.
+    # Full: ensure everything can be reached and acquired.
+    # Items: ensure all logically relevant items can be acquired. Some items, such as keys, may be self-locking.
     # Minimal: ensure what is needed to reach your goal can be acquired.
-    locations: 0
+    full: 0
     items: 50
     minimal: 0
 

test/general/TestFill.py

@@ -221,7 +221,7 @@ def test_minimal_mixed_fill(self):
         player2 = generate_player_data(multi_world, 2, 3, 3)
 
         multi_world.accessibility[player1.id].value = multi_world.accessibility[player1.id].option_minimal
-        multi_world.accessibility[player2.id].value = multi_world.accessibility[player2.id].option_locations
+        multi_world.accessibility[player2.id].value = multi_world.accessibility[player2.id].option_full
 
         multi_world.completion_condition[player1.id] = lambda state: True
         multi_world.completion_condition[player2.id] = lambda state: state.has(player2.prog_items[2].name, player2.id)

worlds/alttp/Options.py

@@ -1,7 +1,8 @@
 import typing
 
 from BaseClasses import MultiWorld
-from Options import Choice, Range, Option, Toggle, DefaultOnToggle, DeathLink, StartInventoryPool, PlandoBosses
+from Options import Choice, DeathLink, DefaultOnToggle, ItemsAccessibility, Option, PlandoBosses, Range, \
+    StartInventoryPool, Toggle
 
 
 class Logic(Choice):
@@ -432,6 +433,7 @@ class AllowCollect(Toggle):
 
 
 alttp_options: typing.Dict[str, type(Option)] = {
+    "accessibility": ItemsAccessibility,
     "crystals_needed_for_gt": CrystalsTower,
     "crystals_needed_for_ganon": CrystalsGanon,
     "open_pyramid": OpenPyramid,

worlds/alttp/Rules.py

@@ -2,6 +2,7 @@
 import logging
 from typing import Iterator, Set
 
+from Options import ItemsAccessibility
 from BaseClasses import Entrance, MultiWorld
 from worlds.generic.Rules import (add_item_rule, add_rule, forbid_item,
                                   item_name_in_location_names, location_item_name, set_rule, allow_self_locking_items)
@@ -39,7 +40,7 @@ def set_rules(world):
         else:
             # Set access rules according to max glitches for multiworld progression.
             # Set accessibility to none, and shuffle assuming the no logic players can always win
-            world.accessibility[player] = world.accessibility[player].from_text("minimal")
+            world.accessibility[player].value = ItemsAccessibility.option_minimal
             world.progression_balancing[player].value = 0
 
     else:
@@ -289,7 +290,7 @@ def global_rules(world, player):
     set_rule(world.get_entrance('Tower of Hera Big Key Door', player), lambda state: state.has('Big Key (Tower of Hera)', player))
     set_rule(world.get_location('Tower of Hera - Big Chest', player), lambda state: state.has('Big Key (Tower of Hera)', player))
     set_rule(world.get_location('Tower of Hera - Big Key Chest', player), lambda state: has_fire_source(state, player))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         set_always_allow(world.get_location('Tower of Hera - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Tower of Hera)' and item.player == player)
 
     set_rule(world.get_entrance('Swamp Palace Moat', player), lambda state: state.has('Flippers', player) and state.has('Open Floodgate', player))
@@ -301,7 +302,7 @@ def global_rules(world, player):
         if state.has('Hookshot', player)
         else state._lttp_has_key('Small Key (Swamp Palace)', player, 4))
     set_rule(world.get_location('Swamp Palace - Big Chest', player), lambda state: state.has('Big Key (Swamp Palace)', player))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         allow_self_locking_items(world.get_location('Swamp Palace - Big Chest', player), 'Big Key (Swamp Palace)')
     set_rule(world.get_entrance('Swamp Palace (North)', player), lambda state: state.has('Hookshot', player) and state._lttp_has_key('Small Key (Swamp Palace)', player, 5))
     if not world.smallkey_shuffle[player] and world.logic[player] not in ['hybridglitches', 'nologic']:
@@ -316,7 +317,7 @@ def global_rules(world, player):
 
     set_rule(world.get_location('Thieves\' Town - Big Chest', player),
              lambda state: (state._lttp_has_key('Small Key (Thieves Town)', player, 3)) and state.has('Hammer', player))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         allow_self_locking_items(world.get_location('Thieves\' Town - Big Chest', player), 'Small Key (Thieves Town)')
 
     set_rule(world.get_location('Thieves\' Town - Attic', player), lambda state: state._lttp_has_key('Small Key (Thieves Town)', player, 3))
@@ -329,7 +330,7 @@ def global_rules(world, player):
     set_rule(world.get_entrance('Skull Woods First Section West Door', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
     set_rule(world.get_entrance('Skull Woods First Section (Left) Door to Exit', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
     set_rule(world.get_location('Skull Woods - Big Chest', player), lambda state: state.has('Big Key (Skull Woods)', player))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         allow_self_locking_items(world.get_location('Skull Woods - Big Chest', player), 'Big Key (Skull Woods)')
     set_rule(world.get_entrance('Skull Woods Torch Room', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 4) and state.has('Fire Rod', player) and has_sword(state, player))  # sword required for curtain
     add_rule(world.get_location('Skull Woods - Prize', player), lambda state: state._lttp_has_key('Small Key (Skull Woods)', player, 5))
@@ -409,12 +410,12 @@ def global_rules(world, player):
 
     set_rule(world.get_entrance('Palace of Darkness Big Key Chest Staircase', player), lambda state: state._lttp_has_key('Small Key (Palace of Darkness)', player, 6) or (
             location_item_name(state, 'Palace of Darkness - Big Key Chest', player) in [('Small Key (Palace of Darkness)', player)] and state._lttp_has_key('Small Key (Palace of Darkness)', player, 3)))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         set_always_allow(world.get_location('Palace of Darkness - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Palace of Darkness)' and item.player == player and state._lttp_has_key('Small Key (Palace of Darkness)', player, 5))
 
     set_rule(world.get_entrance('Palace of Darkness Spike Statue Room Door', player), lambda state: state._lttp_has_key('Small Key (Palace of Darkness)', player, 6) or (
             location_item_name(state, 'Palace of Darkness - Harmless Hellway', player) in [('Small Key (Palace of Darkness)', player)] and state._lttp_has_key('Small Key (Palace of Darkness)', player, 4)))
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         set_always_allow(world.get_location('Palace of Darkness - Harmless Hellway', player), lambda state, item: item.name == 'Small Key (Palace of Darkness)' and item.player == player and state._lttp_has_key('Small Key (Palace of Darkness)', player, 5))
 
     set_rule(world.get_entrance('Palace of Darkness Maze Door', player), lambda state: state._lttp_has_key('Small Key (Palace of Darkness)', player, 6))
@@ -1060,7 +1061,7 @@ def tr_big_key_chest_keys_needed(state):
                 # Must not go in the Chain Chomps chest - only 2 other chests available and 3+ keys required for all other chests
                 forbid_item(world.get_location('Turtle Rock - Chain Chomps', player), 'Big Key (Turtle Rock)', player)
                 forbid_item(world.get_location('Turtle Rock - Pokey 2 Key Drop', player), 'Big Key (Turtle Rock)', player)
-            if world.accessibility[player] == 'locations' and world.goal[player] != 'icerodhunt':
+            if world.accessibility[player] == 'full' and world.goal[player] != 'icerodhunt':
                 if world.bigkey_shuffle[player] and can_reach_big_chest:
                     # Must not go in the dungeon - all 3 available chests (Chomps, Big Chest, Crystaroller) must be keys to access laser bridge, and the big key is required first
                     for location in ['Turtle Rock - Chain Chomps', 'Turtle Rock - Compass Chest',
@@ -1075,7 +1076,7 @@ def tr_big_key_chest_keys_needed(state):
                     location.event = True
                     toss_junk_item(world, player)
 
-    if world.accessibility[player] != 'locations':
+    if world.accessibility[player] != 'full':
         set_always_allow(world.get_location('Turtle Rock - Big Key Chest', player), lambda state, item: item.name == 'Small Key (Turtle Rock)' and item.player == player
                 and state.can_reach(state.multiworld.get_region('Turtle Rock (Second Section)', player)))
 

worlds/alttp/test/dungeons/TestDungeon.py

@@ -1,6 +1,6 @@
 from BaseClasses import CollectionState, ItemClassification
-from worlds.alttp.Dungeons import create_dungeons, get_dungeon_item_pool
-from worlds.alttp.EntranceShuffle import mandatory_connections, connect_simple
+from worlds.alttp.Dungeons import get_dungeon_item_pool
+from worlds.alttp.EntranceShuffle import connect_simple, mandatory_connections
 from worlds.alttp.ItemPool import difficulties
 from worlds.alttp.Items import ItemFactory
 from worlds.alttp.Regions import create_regions

worlds/alttp/test/inverted/TestInverted.py

@@ -1,12 +1,11 @@
-from worlds.alttp.Dungeons import create_dungeons, get_dungeon_item_pool
+from test.TestBase import TestBase
+from worlds.alttp.Dungeons import get_dungeon_item_pool
 from worlds.alttp.EntranceShuffle import link_inverted_entrances
 from worlds.alttp.InvertedRegions import create_inverted_regions
 from worlds.alttp.ItemPool import difficulties
 from worlds.alttp.Items import ItemFactory
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.TestBase import TestBase
-
 from worlds.alttp.test import LTTPTestBase
 
 

worlds/alttp/test/inverted_minor_glitches/TestInvertedMinor.py

@@ -1,12 +1,11 @@
-from worlds.alttp.Dungeons import create_dungeons, get_dungeon_item_pool
+from test.TestBase import TestBase
+from worlds.alttp.Dungeons import get_dungeon_item_pool
 from worlds.alttp.EntranceShuffle import link_inverted_entrances
 from worlds.alttp.InvertedRegions import create_inverted_regions
 from worlds.alttp.ItemPool import difficulties
 from worlds.alttp.Items import ItemFactory
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.TestBase import TestBase
-
 from worlds.alttp.test import LTTPTestBase
 
 

worlds/alttp/test/inverted_owg/TestInvertedOWG.py

@@ -1,12 +1,11 @@
-from worlds.alttp.Dungeons import create_dungeons, get_dungeon_item_pool
+from test.TestBase import TestBase
+from worlds.alttp.Dungeons import get_dungeon_item_pool
 from worlds.alttp.EntranceShuffle import link_inverted_entrances
 from worlds.alttp.InvertedRegions import create_inverted_regions
 from worlds.alttp.ItemPool import difficulties
 from worlds.alttp.Items import ItemFactory
 from worlds.alttp.Regions import mark_light_world_regions
 from worlds.alttp.Shops import create_shops
-from test.TestBase import TestBase
-
 from worlds.alttp.test import LTTPTestBase
 
 

worlds/messenger/options.py

@@ -3,14 +3,14 @@
 
 from schema import And, Optional, Or, Schema
 
-from Options import Accessibility, Choice, DeathLink, DefaultOnToggle, OptionDict, PerGameCommonOptions, Range, \
+from Options import Choice, DeathLink, DefaultOnToggle, ItemsAccessibility, OptionDict, PerGameCommonOptions, Range, \
     StartInventoryPool, Toggle
 
 
-class MessengerAccessibility(Accessibility):
-    default = Accessibility.option_locations
+class MessengerAccessibility(ItemsAccessibility):
     # defaulting to locations accessibility since items makes certain items self-locking
-    __doc__ = Accessibility.__doc__.replace(f"default {Accessibility.default}", f"default {default}")
+    default = ItemsAccessibility.option_full
+    __doc__ = ItemsAccessibility.__doc__
 
 
 class Logic(Choice):

worlds/messenger/rules.py

@@ -150,7 +150,7 @@ def set_messenger_rules(self) -> None:
                      lambda state: state.has("Shop Chest", self.player))
 
         multiworld.completion_condition[self.player] = lambda state: state.has("Rescue Phantom", self.player)
-        if multiworld.accessibility[self.player] > MessengerAccessibility.option_locations:
+        if multiworld.accessibility[self.player] > MessengerAccessibility.option_full:
             set_self_locking_items(self.world, self.player)
 
 

worlds/minecraft/docs/minecraft_es.md

@@ -29,7 +29,7 @@ name: TuNombre
 game: Minecraft
 
 # Opciones compartidas por todos los juegos:
-accessibility: locations
+accessibility: full
 progression_balancing: 50
 # Opciones Especficicas para Minecraft
 

worlds/minecraft/docs/minecraft_sv.md

@@ -79,7 +79,7 @@ description: Template Name
 # Ditt spelnamn. Mellanslag kommer bli omplacerad med understräck och det är en 16-karaktärsgräns.
 name: YourName
 game: Minecraft
-accessibility: locations
+accessibility: full
 progression_balancing: 0
 advancement_goal:
   few: 0

worlds/oot/Rules.py

@@ -223,7 +223,7 @@ def set_shop_rules(ootworld):
 # The goal is to automatically set item rules based on age requirements in case entrances were shuffled
 def set_entrances_based_rules(ootworld):
 
-    if ootworld.multiworld.accessibility == 'beatable': 
+    if ootworld.multiworld.accessibility[ootworld.player] == 'minimal':
         return
 
     all_state = ootworld.multiworld.get_all_state(False)

worlds/pokemon_rb/__init__.py

@@ -522,7 +522,7 @@ def number_of_zones(mon):
         self.multiworld.elite_four_pokedex_condition[self.player].total = \
             int((len(reachable_mons) / 100) * self.multiworld.elite_four_pokedex_condition[self.player].value)
 
-        if self.multiworld.accessibility[self.player] == "locations":
+        if self.multiworld.accessibility[self.player] == "full":
             balls = [self.create_item(ball) for ball in ["Poke Ball", "Great Ball", "Ultra Ball"]]
             traps = [self.create_item(trap) for trap in item_groups["Traps"]]
             locations = [location for location in self.multiworld.get_locations(self.player) if "Pokedex - " in

worlds/pokemon_rb/options.py

@@ -1,4 +1,4 @@
-from Options import Toggle, Choice, Range, SpecialRange, TextChoice, DeathLink
+from Options import Choice, DeathLink, ItemsAccessibility, Range, SpecialRange, TextChoice, Toggle
 
 
 class GameVersion(Choice):
@@ -859,6 +859,7 @@ class RandomizePokemonPalettes(Choice):
 
 
 pokemon_rb_options = {
+    "accessibility": ItemsAccessibility,
     "game_version": GameVersion,
     "trainer_name": TrainerName,
     "rival_name": RivalName,

worlds/pokemon_rb/pokemon.py

@@ -323,12 +323,12 @@ def roll_tm_compat(roll_move):
                 mon_data["tms"][int(flag / 8)] &= ~(1 << (flag % 8))
 
     hm_verify = ["Surf", "Strength"]
-    if self.multiworld.accessibility[self.player] == "locations" or ((not
+    if self.multiworld.accessibility[self.player] == "full" or ((not
             self.multiworld.badgesanity[self.player]) and max(self.multiworld.elite_four_badges_condition[self.player],
             self.multiworld.route_22_gate_condition[self.player], self.multiworld.victory_road_condition[self.player])
             > 7) or (self.multiworld.door_shuffle[self.player] not in ("off", "simple")):
         hm_verify += ["Cut"]
-    if self.multiworld.accessibility[self.player] == "locations" or (not
+    if self.multiworld.accessibility[self.player] == "full" or (not
             self.multiworld.dark_rock_tunnel_logic[self.player]) and ((self.multiworld.trainersanity[self.player] or
                                                                        self.multiworld.extra_key_items[self.player])
                                                                       or self.multiworld.door_shuffle[self.player]):

worlds/pokemon_rb/rules.py

@@ -22,7 +22,7 @@ def prize_rule(i):
         item_rules["Celadon Prize Corner - Item Prize 2"] = prize_rule
         item_rules["Celadon Prize Corner - Item Prize 3"] = prize_rule
 
-    if multiworld.accessibility[player] != "locations":
+    if multiworld.accessibility[player] != "full":
         multiworld.get_location("Cerulean Bicycle Shop", player).always_allow = (lambda state, item:
                                                                                    item.name == "Bike Voucher"
                                                                                    and item.player == player)

worlds/smz3/Options.py

@@ -1,5 +1,5 @@
 import typing
-from Options import Choice, Option, Toggle, DefaultOnToggle, Range
+from Options import Choice, Option, Toggle, DefaultOnToggle, Range, ItemsAccessibility
 
 class SMLogic(Choice):
     """This option selects what kind of logic to use for item placement inside
@@ -128,6 +128,7 @@ class EnergyBeep(DefaultOnToggle):
 
 
 smz3_options: typing.Dict[str, type(Option)] = {
+    "accessibility": ItemsAccessibility,
     "sm_logic": SMLogic,
     "sword_location": SwordLocation,
     "morph_location": MorphLocation,

worlds/smz3/__init__.py

@@ -244,7 +244,7 @@ def set_rules(self):
             set_rule(entrance, lambda state, region=region: region.CanEnter(state.smz3state[self.player]))
             for loc in region.Locations:
                 l = self.locations[loc.Name]
-                if self.multiworld.accessibility[self.player] != 'locations':
+                if self.multiworld.accessibility[self.player] != 'full':
                     l.always_allow = lambda state, item, loc=loc: \
                         item.game == "SMZ3" and \
                         loc.alwaysAllow(item.item, state.smz3state[self.player])