123 lines
3.9 KiB
Python
123 lines
3.9 KiB
Python
"""
|
|
Classes and functions related to AP locations for Pokemon Emerald
|
|
"""
|
|
from typing import TYPE_CHECKING, Dict, List, Optional, FrozenSet, Iterable
|
|
|
|
from BaseClasses import Location, Region
|
|
|
|
from .data import BASE_OFFSET, data
|
|
from .items import offset_item_value
|
|
|
|
if TYPE_CHECKING:
|
|
from . import PokemonEmeraldWorld
|
|
|
|
|
|
class PokemonEmeraldLocation(Location):
|
|
game: str = "Pokemon Emerald"
|
|
rom_address: Optional[int]
|
|
default_item_code: Optional[int]
|
|
tags: FrozenSet[str]
|
|
|
|
def __init__(
|
|
self,
|
|
player: int,
|
|
name: str,
|
|
flag: Optional[int],
|
|
parent: Optional[Region] = None,
|
|
rom_address: Optional[int] = None,
|
|
default_item_value: Optional[int] = None,
|
|
tags: FrozenSet[str] = frozenset()) -> None:
|
|
super().__init__(player, name, None if flag is None else offset_flag(flag), parent)
|
|
self.default_item_code = None if default_item_value is None else offset_item_value(default_item_value)
|
|
self.rom_address = rom_address
|
|
self.tags = tags
|
|
|
|
|
|
def offset_flag(flag: int) -> int:
|
|
"""
|
|
Returns the AP location id (address) for a given flag
|
|
"""
|
|
if flag is None:
|
|
return None
|
|
return flag + BASE_OFFSET
|
|
|
|
|
|
def reverse_offset_flag(location_id: int) -> int:
|
|
"""
|
|
Returns the flag id for a given AP location id (address)
|
|
"""
|
|
if location_id is None:
|
|
return None
|
|
return location_id - BASE_OFFSET
|
|
|
|
|
|
def create_locations_with_tags(world: "PokemonEmeraldWorld", regions: Dict[str, Region], tags: Iterable[str]) -> None:
|
|
"""
|
|
Iterates through region data and adds locations to the multiworld if
|
|
those locations include any of the provided tags.
|
|
"""
|
|
tags = set(tags)
|
|
|
|
for region_name, region_data in data.regions.items():
|
|
region = regions[region_name]
|
|
filtered_locations = [loc for loc in region_data.locations if len(tags & data.locations[loc].tags) > 0]
|
|
|
|
for location_name in filtered_locations:
|
|
location_data = data.locations[location_name]
|
|
location = PokemonEmeraldLocation(
|
|
world.player,
|
|
location_data.label,
|
|
location_data.flag,
|
|
region,
|
|
location_data.rom_address,
|
|
location_data.default_item,
|
|
location_data.tags
|
|
)
|
|
region.locations.append(location)
|
|
|
|
|
|
def create_location_label_to_id_map() -> Dict[str, int]:
|
|
"""
|
|
Creates a map from location labels to their AP location id (address)
|
|
"""
|
|
label_to_id_map: Dict[str, int] = {}
|
|
for region_data in data.regions.values():
|
|
for location_name in region_data.locations:
|
|
location_data = data.locations[location_name]
|
|
label_to_id_map[location_data.label] = offset_flag(location_data.flag)
|
|
|
|
return label_to_id_map
|
|
|
|
|
|
LOCATION_GROUPS = {
|
|
"Badges": {
|
|
"Rustboro Gym - Stone Badge",
|
|
"Dewford Gym - Knuckle Badge",
|
|
"Mauville Gym - Dynamo Badge",
|
|
"Lavaridge Gym - Heat Badge",
|
|
"Petalburg Gym - Balance Badge",
|
|
"Fortree Gym - Feather Badge",
|
|
"Mossdeep Gym - Mind Badge",
|
|
"Sootopolis Gym - Rain Badge",
|
|
},
|
|
"Gym TMs": {
|
|
"Rustboro Gym - TM39 from Roxanne",
|
|
"Dewford Gym - TM08 from Brawly",
|
|
"Mauville Gym - TM34 from Wattson",
|
|
"Lavaridge Gym - TM50 from Flannery",
|
|
"Petalburg Gym - TM42 from Norman",
|
|
"Fortree Gym - TM40 from Winona",
|
|
"Mossdeep Gym - TM04 from Tate and Liza",
|
|
"Sootopolis Gym - TM03 from Juan",
|
|
},
|
|
"Postgame Locations": {
|
|
"Littleroot Town - S.S. Ticket from Norman",
|
|
"SS Tidal - Hidden Item in Lower Deck Trash Can",
|
|
"SS Tidal - TM49 from Thief",
|
|
"Safari Zone NE - Hidden Item North",
|
|
"Safari Zone NE - Hidden Item East",
|
|
"Safari Zone SE - Hidden Item in South Grass 1",
|
|
"Safari Zone SE - Hidden Item in South Grass 2",
|
|
}
|
|
}
|