document Regions.location_table

EntranceShuffle.py

@@ -139,7 +139,7 @@ def link_entrances(world, player):
         dw_must_exits = list(DW_Entrances_Must_Exit)
         old_man_entrances = list(Old_Man_Entrances)
         caves = list(Cave_Exits + Cave_Three_Exits)
-        single_doors = list(Single_Cave_Doors)
+
         bomb_shop_doors = list(Bomb_Shop_Single_Cave_Doors + Bomb_Shop_Multi_Cave_Doors)
         blacksmith_doors = list(Blacksmith_Single_Cave_Doors + Blacksmith_Multi_Cave_Doors)
         door_targets = list(Single_Cave_Targets)

Regions.py

@@ -1,4 +1,5 @@
 import collections
+import typing
 
 from BaseClasses import Region, Location, Entrance, RegionType, Shop, TakeAny, UpgradeShop, ShopType
 
@@ -450,7 +451,17 @@ key_drop_data = {
     'Ganons Tower - Mini Helmasaur Key Drop': [0x14001e, 0x14001f]
 }
 
-location_table = {'Mushroom': (0x180013, 0x186338, False, 'in the woods'),
+# tuple contents:
+# address to write to for item
+# address to write to for player getting the item
+# can this location drop a crystal
+# hint tile/npc text for this location
+location_table: typing.Dict[str,
+                            typing.Tuple[typing.Optional[typing.Union[int, typing.Tuple[int, ...]]],
+                                         typing.Optional[int],
+                                         bool,
+                                         typing.Optional[str]]] = \
+    {'Mushroom': (0x180013, 0x186338, False, 'in the woods'),
      'Bottle Merchant': (0x2eb18, 0x186339, False, 'with a merchant'),
      'Flute Spot': (0x18014a, 0x18633d, False, 'underground'),
      'Sunken Treasure': (0x180145, 0x186354, False, 'underwater'),