from __future__ import annotations from typing import Dict, Set, Tuple, List, Optional from BaseClasses import MultiWorld, Item, CollectionState, Location class AutoWorldRegister(type): world_types: Dict[str, World] = {} def __new__(cls, name, bases, dct): # filter out any events dct["item_name_to_id"] = {name: id for name, id in dct["item_name_to_id"].items() if id} dct["location_name_to_id"] = {name: id for name, id in dct["location_name_to_id"].items() if id} # build reverse lookups dct["item_id_to_name"] = {code: name for name, code in dct["item_name_to_id"].items()} dct["location_id_to_name"] = {code: name for name, code in dct["location_name_to_id"].items()} # build rest dct["item_names"] = frozenset(dct["item_name_to_id"]) dct["location_names"] = frozenset(dct["location_name_to_id"]) dct["all_names"] = dct["item_names"] | dct["location_names"] | set(dct.get("item_name_groups", {})) # construct class new_class = super().__new__(cls, name, bases, dct) if "game" in dct: AutoWorldRegister.world_types[dct["game"]] = new_class return new_class class AutoLogicRegister(type): def __new__(cls, name, bases, dct): new_class = super().__new__(cls, name, bases, dct) for item_name, function in dct.items(): if not item_name.startswith("__"): if hasattr(CollectionState, item_name): raise Exception(f"Name conflict on Logic Mixin {name} trying to overwrite {item_name}") setattr(CollectionState, item_name, function) return new_class def call_single(world: MultiWorld, method_name: str, player: int, *args): method = getattr(world.worlds[player], method_name) return method(*args) def call_all(world: MultiWorld, method_name: str, *args): world_types = set() for player in world.player_ids: world_types.add(world.worlds[player].__class__) call_single(world, method_name, player, *args) for world_type in world_types: stage_callable = getattr(world_type, f"stage_{method_name}", None) if stage_callable: stage_callable(world, *args) def call_stage(world: MultiWorld, method_name: str, *args): world_types = {world.worlds[player].__class__ for player in world.player_ids} for world_type in world_types: stage_callable = getattr(world_type, f"stage_{method_name}", None) if stage_callable: stage_callable(world, *args) class World(metaclass=AutoWorldRegister): """A World object encompasses a game's Items, Locations, Rules and additional data or functionality required. A Game should have its own subclass of World in which it defines the required data structures.""" options: dict = {} # link your Options mapping game: str # name the game topology_present: bool = False # indicate if world type has any meaningful layout/pathing all_names: Set[str] = frozenset() # gets automatically populated with all item, item group and location names # map names to their IDs item_name_to_id: Dict[str, int] = {} location_name_to_id: Dict[str, int] = {} # maps item group names to sets of items. Example: "Weapons" -> {"Sword", "Bow"} item_name_groups: Dict[str, Set[str]] = {} # increment this every time something in your world's names/id mappings changes. # While this is set to 0 in *any* AutoWorld, the entire DataPackage is considered in testing mode and will be # retrieved by clients on every connection. data_version = 1 hint_blacklist: Set[str] = frozenset() # any names that should not be hintable # if a world is set to remote_items, then it just needs to send location checks to the server and the server # sends back the items # if a world is set to remote_items = False, then the server never sends an item where receiver == finder, # the client finds its own items in its own world. remote_items: bool = True # For games where after a victory it is impossible to go back in and get additional/remaining Locations checked. # this forces forfeit: auto for those games. forced_auto_forfeit: bool = False # Hide World Type from various views. Does not remove functionality. hidden = False # autoset on creation: world: MultiWorld player: int # automatically generated item_id_to_name: Dict[int, str] location_id_to_name: Dict[int, str] item_names: Set[str] # set of all potential item names location_names: Set[str] # set of all potential location names def __init__(self, world: MultiWorld, player: int): self.world = world self.player = player # overridable methods that get called by Main.py, sorted by execution order # can also be implemented as a classmethod and called "stage_ dict: """Fill in the slot_data field in the Connected network package.""" return {} def modify_multidata(self, multidata: dict): """For deeper modification of server multidata.""" pass def get_required_client_version(self) -> Tuple[int, int, int]: return 0, 0, 3 # end of Main.py calls def collect_item(self, state: CollectionState, item: Item, remove=False) -> Optional[str]: """Collect an item name into state. For speed reasons items that aren't logically useful get skipped. Collect None to skip item. :param remove: indicate if this is meant to remove from state instead of adding.""" if item.advancement: return item.name def create_item(self, name: str) -> Item: """Create an item for this world type and player. Warning: this may be called with self.world = None, for example by MultiServer""" raise NotImplementedError # following methods should not need to be overriden. def collect(self, state: CollectionState, item: Item) -> bool: name = self.collect_item(state, item) if name: state.prog_items[name, item.player] += 1 return True return False def remove(self, state: CollectionState, item: Item) -> bool: name = self.collect_item(state, item, True) if name: state.prog_items[name, item.player] -= 1 if state.prog_items[name, item.player] < 1: del (state.prog_items[name, item.player]) return True return False # any methods attached to this can be used as part of CollectionState, # please use a prefix as all of them get clobbered together class LogicMixin(metaclass=AutoLogicRegister): pass