264 lines
		
	
	
		
			8.9 KiB
		
	
	
	
		
			Python
		
	
	
	
			
		
		
	
	
			264 lines
		
	
	
		
			8.9 KiB
		
	
	
	
		
			Python
		
	
	
	
from functools import lru_cache
 | 
						|
from typing import Dict, List
 | 
						|
 | 
						|
from .item_definition_classes import (
 | 
						|
    CATEGORY_NAME_MAPPINGS,
 | 
						|
    DoorItemDefinition,
 | 
						|
    ItemCategory,
 | 
						|
    ItemDefinition,
 | 
						|
    ProgressiveItemDefinition,
 | 
						|
    WeightedItemDefinition,
 | 
						|
)
 | 
						|
from .utils import (
 | 
						|
    define_new_region,
 | 
						|
    get_items,
 | 
						|
    get_sigma_expert_logic,
 | 
						|
    get_sigma_normal_logic,
 | 
						|
    get_vanilla_logic,
 | 
						|
    parse_lambda,
 | 
						|
)
 | 
						|
 | 
						|
 | 
						|
class StaticWitnessLogicObj:
 | 
						|
    def read_logic_file(self, lines) -> None:
 | 
						|
        """
 | 
						|
        Reads the logic file and does the initial population of data structures
 | 
						|
        """
 | 
						|
 | 
						|
        current_region = dict()
 | 
						|
        current_area = {
 | 
						|
            "name": "Misc",
 | 
						|
            "regions": [],
 | 
						|
        }
 | 
						|
        self.ALL_AREAS_BY_NAME["Misc"] = current_area
 | 
						|
 | 
						|
        for line in lines:
 | 
						|
            if line == "" or line[0] == "#":
 | 
						|
                continue
 | 
						|
 | 
						|
            if line[-1] == ":":
 | 
						|
                new_region_and_connections = define_new_region(line)
 | 
						|
                current_region = new_region_and_connections[0]
 | 
						|
                region_name = current_region["name"]
 | 
						|
                self.ALL_REGIONS_BY_NAME[region_name] = current_region
 | 
						|
                self.STATIC_CONNECTIONS_BY_REGION_NAME[region_name] = new_region_and_connections[1]
 | 
						|
                current_area["regions"].append(region_name)
 | 
						|
                continue
 | 
						|
 | 
						|
            if line[0] == "=":
 | 
						|
                area_name = line[2:-2]
 | 
						|
                current_area = {
 | 
						|
                    "name": area_name,
 | 
						|
                    "regions": [],
 | 
						|
                }
 | 
						|
                self.ALL_AREAS_BY_NAME[area_name] = current_area
 | 
						|
                continue
 | 
						|
 | 
						|
            line_split = line.split(" - ")
 | 
						|
 | 
						|
            location_id = line_split.pop(0)
 | 
						|
 | 
						|
            entity_name_full = line_split.pop(0)
 | 
						|
 | 
						|
            entity_hex = entity_name_full[0:7]
 | 
						|
            entity_name = entity_name_full[9:-1]
 | 
						|
 | 
						|
            required_panel_lambda = line_split.pop(0)
 | 
						|
 | 
						|
            full_entity_name = current_region["shortName"] + " " + entity_name
 | 
						|
 | 
						|
            if location_id == "Door" or location_id == "Laser":
 | 
						|
                self.ENTITIES_BY_HEX[entity_hex] = {
 | 
						|
                    "checkName": full_entity_name,
 | 
						|
                    "entity_hex": entity_hex,
 | 
						|
                    "region": None,
 | 
						|
                    "id": None,
 | 
						|
                    "entityType": location_id,
 | 
						|
                    "area": current_area,
 | 
						|
                }
 | 
						|
 | 
						|
                self.ENTITIES_BY_NAME[self.ENTITIES_BY_HEX[entity_hex]["checkName"]] = self.ENTITIES_BY_HEX[entity_hex]
 | 
						|
 | 
						|
                self.STATIC_DEPENDENT_REQUIREMENTS_BY_HEX[entity_hex] = {
 | 
						|
                    "panels": parse_lambda(required_panel_lambda)
 | 
						|
                }
 | 
						|
 | 
						|
                # Lasers and Doors exist in a region, but don't have a regional *requirement*
 | 
						|
                # If a laser is activated, you don't need to physically walk up to it for it to count
 | 
						|
                # As such, logically, they behave more as if they were part of the "Entry" region
 | 
						|
                self.ALL_REGIONS_BY_NAME["Entry"]["panels"].append(entity_hex)
 | 
						|
                continue
 | 
						|
 | 
						|
            required_item_lambda = line_split.pop(0)
 | 
						|
 | 
						|
            laser_names = {
 | 
						|
                "Laser",
 | 
						|
                "Laser Hedges",
 | 
						|
                "Laser Pressure Plates",
 | 
						|
            }
 | 
						|
            is_vault_or_video = "Vault" in entity_name or "Video" in entity_name
 | 
						|
 | 
						|
            if "Discard" in entity_name:
 | 
						|
                location_type = "Discard"
 | 
						|
            elif is_vault_or_video or entity_name == "Tutorial Gate Close":
 | 
						|
                location_type = "Vault"
 | 
						|
            elif entity_name in laser_names:
 | 
						|
                location_type = "Laser"
 | 
						|
            elif "Obelisk Side" in entity_name:
 | 
						|
                location_type = "Obelisk Side"
 | 
						|
            elif "EP" in entity_name:
 | 
						|
                location_type = "EP"
 | 
						|
            else:
 | 
						|
                location_type = "General"
 | 
						|
 | 
						|
            required_items = parse_lambda(required_item_lambda)
 | 
						|
            required_panels = parse_lambda(required_panel_lambda)
 | 
						|
 | 
						|
            required_items = frozenset(required_items)
 | 
						|
 | 
						|
            requirement = {
 | 
						|
                "panels": required_panels,
 | 
						|
                "items": required_items
 | 
						|
            }
 | 
						|
 | 
						|
            if location_type == "Obelisk Side":
 | 
						|
                eps = set(next(iter(required_panels)))
 | 
						|
                eps -= {"Theater to Tunnels"}
 | 
						|
 | 
						|
                eps_ints = {int(h, 16) for h in eps}
 | 
						|
 | 
						|
                self.OBELISK_SIDE_ID_TO_EP_HEXES[int(entity_hex, 16)] = eps_ints
 | 
						|
                for ep_hex in eps:
 | 
						|
                    self.EP_TO_OBELISK_SIDE[ep_hex] = entity_hex
 | 
						|
 | 
						|
            self.ENTITIES_BY_HEX[entity_hex] = {
 | 
						|
                "checkName": full_entity_name,
 | 
						|
                "entity_hex": entity_hex,
 | 
						|
                "region": current_region,
 | 
						|
                "id": int(location_id),
 | 
						|
                "entityType": location_type,
 | 
						|
                "area": current_area,
 | 
						|
            }
 | 
						|
 | 
						|
            self.ENTITY_ID_TO_NAME[entity_hex] = full_entity_name
 | 
						|
 | 
						|
            self.ENTITIES_BY_NAME[self.ENTITIES_BY_HEX[entity_hex]["checkName"]] = self.ENTITIES_BY_HEX[entity_hex]
 | 
						|
            self.STATIC_DEPENDENT_REQUIREMENTS_BY_HEX[entity_hex] = requirement
 | 
						|
 | 
						|
            current_region["panels"].append(entity_hex)
 | 
						|
 | 
						|
    def __init__(self, lines=None) -> None:
 | 
						|
        if lines is None:
 | 
						|
            lines = get_sigma_normal_logic()
 | 
						|
 | 
						|
        # All regions with a list of panels in them and the connections to other regions, before logic adjustments
 | 
						|
        self.ALL_REGIONS_BY_NAME = dict()
 | 
						|
        self.ALL_AREAS_BY_NAME = dict()
 | 
						|
        self.STATIC_CONNECTIONS_BY_REGION_NAME = dict()
 | 
						|
 | 
						|
        self.ENTITIES_BY_HEX = dict()
 | 
						|
        self.ENTITIES_BY_NAME = dict()
 | 
						|
        self.STATIC_DEPENDENT_REQUIREMENTS_BY_HEX = dict()
 | 
						|
 | 
						|
        self.OBELISK_SIDE_ID_TO_EP_HEXES = dict()
 | 
						|
 | 
						|
        self.EP_TO_OBELISK_SIDE = dict()
 | 
						|
 | 
						|
        self.ENTITY_ID_TO_NAME = dict()
 | 
						|
 | 
						|
        self.read_logic_file(lines)
 | 
						|
 | 
						|
 | 
						|
# Item data parsed from WitnessItems.txt
 | 
						|
ALL_ITEMS: Dict[str, ItemDefinition] = {}
 | 
						|
_progressive_lookup: Dict[str, str] = {}
 | 
						|
 | 
						|
 | 
						|
def parse_items() -> None:
 | 
						|
    """
 | 
						|
    Parses currently defined items from WitnessItems.txt
 | 
						|
    """
 | 
						|
 | 
						|
    lines: List[str] = get_items()
 | 
						|
    current_category: ItemCategory = ItemCategory.SYMBOL
 | 
						|
 | 
						|
    for line in lines:
 | 
						|
        # Skip empty lines and comments.
 | 
						|
        if line == "" or line[0] == "#":
 | 
						|
            continue
 | 
						|
 | 
						|
        # If this line is a category header, update our cached category.
 | 
						|
        if line in CATEGORY_NAME_MAPPINGS.keys():
 | 
						|
            current_category = CATEGORY_NAME_MAPPINGS[line]
 | 
						|
            continue
 | 
						|
 | 
						|
        line_split = line.split(" - ")
 | 
						|
 | 
						|
        item_code = int(line_split[0])
 | 
						|
        item_name = line_split[1]
 | 
						|
        arguments: List[str] = line_split[2].split(",") if len(line_split) >= 3 else []
 | 
						|
 | 
						|
        if current_category in [ItemCategory.DOOR, ItemCategory.LASER]:
 | 
						|
            # Map doors to IDs.
 | 
						|
            ALL_ITEMS[item_name] = DoorItemDefinition(item_code, current_category, arguments)
 | 
						|
        elif current_category == ItemCategory.TRAP or current_category == ItemCategory.FILLER:
 | 
						|
            # Read filler weights.
 | 
						|
            weight = int(arguments[0]) if len(arguments) >= 1 else 1
 | 
						|
            ALL_ITEMS[item_name] = WeightedItemDefinition(item_code, current_category, weight)
 | 
						|
        elif arguments:
 | 
						|
            # Progressive items.
 | 
						|
            ALL_ITEMS[item_name] = ProgressiveItemDefinition(item_code, current_category, arguments)
 | 
						|
            for child_item in arguments:
 | 
						|
                _progressive_lookup[child_item] = item_name
 | 
						|
        else:
 | 
						|
            ALL_ITEMS[item_name] = ItemDefinition(item_code, current_category)
 | 
						|
 | 
						|
 | 
						|
def get_parent_progressive_item(item_name: str) -> str:
 | 
						|
    """
 | 
						|
    Returns the name of the item's progressive parent, if there is one, or the item's name if not.
 | 
						|
    """
 | 
						|
    return _progressive_lookup.get(item_name, item_name)
 | 
						|
 | 
						|
 | 
						|
@lru_cache
 | 
						|
def get_vanilla() -> StaticWitnessLogicObj:
 | 
						|
    return StaticWitnessLogicObj(get_vanilla_logic())
 | 
						|
 | 
						|
 | 
						|
@lru_cache
 | 
						|
def get_sigma_normal() -> StaticWitnessLogicObj:
 | 
						|
    return StaticWitnessLogicObj(get_sigma_normal_logic())
 | 
						|
 | 
						|
 | 
						|
@lru_cache
 | 
						|
def get_sigma_expert() -> StaticWitnessLogicObj:
 | 
						|
    return StaticWitnessLogicObj(get_sigma_expert_logic())
 | 
						|
 | 
						|
 | 
						|
def __getattr__(name):
 | 
						|
    if name == "vanilla":
 | 
						|
        return get_vanilla()
 | 
						|
    elif name == "sigma_normal":
 | 
						|
        return get_sigma_normal()
 | 
						|
    elif name == "sigma_expert":
 | 
						|
        return get_sigma_expert()
 | 
						|
    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")
 | 
						|
 | 
						|
 | 
						|
parse_items()
 | 
						|
 | 
						|
ALL_REGIONS_BY_NAME = get_sigma_normal().ALL_REGIONS_BY_NAME
 | 
						|
ALL_AREAS_BY_NAME = get_sigma_normal().ALL_AREAS_BY_NAME
 | 
						|
STATIC_CONNECTIONS_BY_REGION_NAME = get_sigma_normal().STATIC_CONNECTIONS_BY_REGION_NAME
 | 
						|
 | 
						|
ENTITIES_BY_HEX = get_sigma_normal().ENTITIES_BY_HEX
 | 
						|
ENTITIES_BY_NAME = get_sigma_normal().ENTITIES_BY_NAME
 | 
						|
STATIC_DEPENDENT_REQUIREMENTS_BY_HEX = get_sigma_normal().STATIC_DEPENDENT_REQUIREMENTS_BY_HEX
 | 
						|
 | 
						|
OBELISK_SIDE_ID_TO_EP_HEXES = get_sigma_normal().OBELISK_SIDE_ID_TO_EP_HEXES
 | 
						|
 | 
						|
EP_TO_OBELISK_SIDE = get_sigma_normal().EP_TO_OBELISK_SIDE
 | 
						|
 | 
						|
ENTITY_ID_TO_NAME = get_sigma_normal().ENTITY_ID_TO_NAME
 |