Merge pull request ArchipelagoMW#9 from silasary/requests

A few small enhancements

Author: FuzzyGamesOn

ManualClient.py

@@ -90,7 +90,11 @@ def get_location_by_name(self, name):
         if location:
             return location
         return AutoWorldRegister.world_types[self.game].location_name_to_location[name]
-    
+
+    def get_location_by_id(self, id):
+        name = self.location_names[id]
+        return self.get_location_by_name(name)
+
     def get_item_by_name(self, name):
         item = self.item_table.get(name)
         if item:
@@ -159,10 +163,10 @@ class ManualManager(GameManager):
                 ("Manual", "Manual"),
             ]
             base_title = "Archipelago Manual Client"
-            listed_items = {"(no category)": []}
-            item_categories = ["(no category)"]
-            listed_locations = {"(no category)": []}
-            location_categories = ["(no category)"]
+            listed_items = {"(No Category)": []}
+            item_categories = ["(No Category)"]
+            listed_locations = {"(No Category)": []}
+            location_categories = ["(No Category)"]
 
             active_item_accordion = 0
             active_location_accordion = 0
@@ -197,13 +201,13 @@ def build(self) -> Layout:
                     self.ctx.build_gui(self)
 
                 return self.container
-            
+
             def clear_lists(self):
-                self.listed_items = {"(no category)": []}
-                self.item_categories = ["(no category)"]
-                self.listed_locations = {"(no category)": []}
-                self.location_categories = ["(no category)"]
-                
+                self.listed_items = {"(No Category)": []}
+                self.item_categories = ["(No Category)"]
+                self.listed_locations = {"(No Category)": [], "(Hinted)": []}
+                self.location_categories = ["(No Category)", "(Hinted)"]
+
             def set_active_item_accordion(self, instance):
                 index = 0
 
@@ -224,6 +228,21 @@ def set_active_location_accordion(self, instance):
 
                     index += 1
 
+            def update_hints(self):
+                super().update_hints()
+                rebuild = False
+                for hint in self.ctx.stored_data.get(f"_read_hints_{self.ctx.team}_{self.ctx.slot}", []):
+                    if hint["finding_player"] == self.ctx.slot:
+                        if hint["location"] in self.ctx.missing_locations:
+                            location = self.ctx.get_location_by_id(hint["location"])
+                            if "(Hinted)" not in location["category"]:
+                                location["category"].append("(Hinted)")
+                                rebuild = True
+
+                if rebuild:
+                    self.build_tracker_and_locations_table()
+                self.update_tracker_and_locations_table()
+
             def build_tracker_and_locations_table(self):
                 self.tracker_and_locations_panel.clear_widgets()
 
@@ -268,7 +287,7 @@ def build_tracker_and_locations_table(self):
 
                             self.listed_locations[category].append(location_id)
                     else: # leave it in the generic category
-                        self.listed_locations["(no category)"].append(location_id)
+                        self.listed_locations["(No Category)"].append(location_id)
 
                 victory_location =  self.ctx.get_location_by_name("__Manual Game Complete__")
 
@@ -310,7 +329,7 @@ def build_tracker_and_locations_table(self):
                     locations_in_category = len(self.listed_locations[location_category])
 
                     if ("category" in victory_location_data and location_category in victory_location_data["category"]) or \
-                        ("category" not in victory_location_data and location_category == "(no category)"):
+                        ("category" not in victory_location_data and location_category == "(No Category)"):
                         locations_in_category += 1
 
                     category_tree = locations_panel.add_node(
@@ -329,8 +348,8 @@ def build_tracker_and_locations_table(self):
 
                     # if this is the category that Victory is in, display the Victory button
                     # if ("category" in victory_location_data and location_category in victory_location_data["category"]) or \
-                    #     ("category" not in victory_location_data and location_category == "(no category)"):
-                    if (location_category == "(no category)"):
+                    #     ("category" not in victory_location_data and location_category == "(No Category)"):
+                    if (location_category == "(No Category)"):
 
                         # Add the Victory location to be marked at any point, which is why locations length has 1 added to it above
                         location_button = TreeViewButton(text="VICTORY! (seed finished)", size_hint=(None, None), height=30, width=400)
@@ -398,12 +417,12 @@ def update_tracker_and_locations_table(self, update_highlights=False):
                                     item_data = self.ctx.get_item_by_name(item_name)
 
                                     if "category" not in item_data or not item_data["category"]:
-                                        item_data["category"] = ["(no category)"]
+                                        item_data["category"] = ["(No Category)"]
 
                                     if category_name in item_data["category"] and network_item.item not in self.listed_items[category_name]:
                                         item_name_parts = self.ctx.item_names[network_item.item].split(":")
                                         item_count = len(list(i for i in self.ctx.items_received if i.item == network_item.item))
-                                        item_text = Label(text="%s (%s)" % (item_name_parts[0], item_count), 
+                                        item_text = Label(text="%s (%s)" % (item_name_parts[0], item_count),
                                                     size_hint=(None, None), height=30, width=400, bold=True)
 
                                         category_grid.add_widget(item_text)

worlds/_manual/Items.py

@@ -12,6 +12,7 @@
 
 item_id_to_name = {}
 item_name_to_item = {}
+item_name_groups = {}
 advancement_item_names = set()
 lastItemId = -1
 
@@ -35,10 +36,15 @@
     item_name_to_item[item_name] = item
     if item["progression"]:
         advancement_item_names.add(item_name)
-    
-    if item["id"] != None:
+
+    if item["id"] is not None:
         lastItemId = max(lastItemId, item["id"])
 
+    for c in item.get("category", []):
+        if c not in item_name_groups:
+            item_name_groups[c] = []
+        item_name_groups[c].append(item_name)
+
 progressive_item_list = {}
 
 for item in progressive_item_table:
@@ -59,6 +65,7 @@
 item_id_to_name[None] = "__Victory__"
 item_name_to_id = {name: id for id, name in item_id_to_name.items()}
 
+
 ######################
 # Item classes
 ######################

worlds/_manual/Locations.py

@@ -18,7 +18,7 @@
     if "victory" in location_table[key] and location_table[key]["victory"]:
         custom_victory_location = location_table[key]
         victory_key = key # store the victory location to be removed later
-        
+
         continue
 
     location_table[key]["id"] = count
@@ -42,11 +42,18 @@
 
 location_id_to_name = {}
 location_name_to_location = {}
+location_name_groups = {}
 
 for item in location_table:
     location_id_to_name[item["id"]] = item["name"]
     location_name_to_location[item["name"]] = item
 
+    for c in item.get("category", []):
+        if c not in location_name_groups:
+            location_name_groups[c] = []
+        location_name_groups[c].append(item["name"])
+
+
 # location_id_to_name[None] = "__Manual Game Complete__"
 location_name_to_id = {name: id for id, name in location_id_to_name.items()}
 

worlds/_manual/Rules.py

@@ -28,7 +28,7 @@ def infix_to_postfix(expr, location):
         while stack:
             postfix += stack.pop()
     except Exception:
-        raise KeyError("Invalid logic format for location/region {}.".format(location)) 
+        raise KeyError("Invalid logic format for location/region {}.".format(location))
     return postfix
 
 
@@ -52,8 +52,8 @@ def evaluate_postfix(expr, location):
                 op = stack.pop()
                 stack.append(not op)
     except Exception:
-        raise KeyError("Invalid logic format for location/region {}.".format(location)) 
-    
+        raise KeyError("Invalid logic format for location/region {}.".format(location))
+
     if len(stack) != 1:
         raise KeyError("Invalid logic format for location/region {}.".format(location))
     return stack.pop()
@@ -80,19 +80,32 @@ def checkRequireStringForArea(state, area):
 
             if len(item_parts) > 1:
                 item_name = item_parts[0]
-                item_count = int(item_parts[1])
+                item_count = item_parts[1]
 
             total = 0
 
             if require_type == 'category':
-                category_items = [item["name"] for item in base.item_name_to_item.values() if "category" in item and item_name in item["category"]]
+                category_items = [item for item in base.item_name_to_item.values() if "category" in item and item_name in item["category"]]
+                if item_count.lower() == 'all':
+                    item_count = sum([base.item_name_to_item[category_item["name"]]['count'] for category_item in category_items])
+                elif item_count.lower() == 'half':
+                    item_count = sum([base.item_name_to_item[category_item["name"]]['count'] for category_item in category_items]) / 2
+                else:
+                    item_count = int(item_count)
 
                 for category_item in category_items:
-                    total += state.count(category_item, player)
+                    total += state.count(category_item["name"], player)
 
                     if total >= item_count:
                         requires_list = requires_list.replace(item_base, "1")
             elif require_type == 'item':
+                if item_count.lower() == 'all':
+                    item_count = base.item_name_to_item[item_name]['count']
+                elif item_count.lower() == 'half':
+                    item_count = base.item_name_to_item[item_name]['count'] / 2
+                else:
+                    item_count = int(item_count)
+
                 total = state.count(item_name, player)
 
                 if total >= item_count:
@@ -116,7 +129,7 @@ def checkRequireDictForArea(state, area):
             if (isinstance(item, dict) and "or" in item and isinstance(item["or"], list)) or (isinstance(item, list)):
                 canAccessOr = True
                 or_items = item
-                
+
                 if isinstance(item, dict):
                     or_items = item["or"]
 

worlds/_manual/__init__.py

@@ -5,8 +5,8 @@
 
 from .Data import item_table, progressive_item_table, location_table, region_table
 from .Game import game_name, filler_item_name, starting_items
-from .Locations import location_id_to_name, location_name_to_id, location_name_to_location
-from .Items import item_id_to_name, item_name_to_id, item_name_to_item, advancement_item_names
+from .Locations import location_id_to_name, location_name_to_id, location_name_to_location, location_name_groups
+from .Items import item_id_to_name, item_name_to_id, item_name_to_item, advancement_item_names, item_name_groups
 
 from .Regions import create_regions
 from .Items import ManualItem
@@ -57,11 +57,13 @@ class ManualWorld(World):
     item_id_to_name = item_id_to_name
     item_name_to_id = item_name_to_id
     item_name_to_item = item_name_to_item
+    item_name_groups = item_name_groups
     advancement_item_names = advancement_item_names
     location_table = location_table # this is likely imported from Data instead of Locations because the Game Complete location should not be in here, but is used for lookups
     location_id_to_name = location_id_to_name
     location_name_to_id = location_name_to_id
     location_name_to_location = location_name_to_location
+    location_name_groups = location_name_groups
 
     def pre_fill(self):
         before_pre_fill(self, self.multiworld, self.player)