gameboy_worlds.emulation.pokemon.test_metrics

  1from typing import Optional
  2
  3from gameboy_worlds.emulation.pokemon.parsers import PokemonRedStateParser, PokemonPrismStateParser
  4from gameboy_worlds.emulation.tracker import (
  5    RegionMatchTerminationOnlyMetric,
  6    TerminationMetric,
  7    RegionMatchTerminationMetric,
  8    RegionMatchSubGoal,
  9    AnyRegionMatchSubGoal,
 10)
 11from gameboy_worlds.emulation.pokemon.base_metrics import (
 12    PokemonExitBattleTruncationMetric,
 13)
 14import numpy as np
 15
 16
 17class PokemonCenterTerminateMetric(RegionMatchTerminationOnlyMetric):
 18    REQUIRED_PARSER = PokemonRedStateParser
 19
 20    _TERMINATION_NAMED_REGION = "screen_bottom_half"
 21    _TERMINATION_TARGET_NAME = "viridian_pokemon_center_entrance"
 22
 23
 24class OutsideViridianCenterSubgoal(AnyRegionMatchSubGoal):
 25    NAME = "outside_viridian_center"
 26    _NAMED_REGIONS = [
 27        "screen_middle",
 28        "screen_middle",
 29    ]
 30    _TARGET_NAMES = [
 31        "outside_viridian_center_from_left",
 32        "outside_viridian_center_from_right",
 33    ]
 34
 35
 36class MtMoonTerminateMetric(RegionMatchTerminationOnlyMetric):
 37    REQUIRED_PARSER = PokemonRedStateParser
 38
 39    _TERMINATION_NAMED_REGION = "screen_bottom_half"
 40    _TERMINATION_TARGET_NAME = "mt_moon_entrance"
 41
 42
 43class SpeakToBillCompleteTerminateMetric(RegionMatchTerminationOnlyMetric):
 44    REQUIRED_PARSER = PokemonRedStateParser
 45
 46    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 47    _TERMINATION_TARGET_NAME = "talk_bill_complete"
 48
 49
 50class PickupPokeballTerminateMetric(RegionMatchTerminationOnlyMetric):
 51    REQUIRED_PARSER = PokemonRedStateParser
 52
 53    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 54    _TERMINATION_TARGET_NAME = "pick_up_pokeball_starting"
 55
 56
 57class ReadTrainersTipsSignTerminateMetric(RegionMatchTerminationOnlyMetric):
 58    REQUIRED_PARSER = PokemonRedStateParser
 59
 60    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 61    _TERMINATION_TARGET_NAME = "trainers_tips_sign"
 62
 63
 64class SpeakToCinnabarGymAideCompleteTerminateMetric(RegionMatchTerminationOnlyMetric):
 65    REQUIRED_PARSER = PokemonRedStateParser
 66
 67    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 68    _TERMINATION_TARGET_NAME = "cinnabar_gym_aid_complete"
 69
 70
 71class SpeakToCinnabarMonkTerminateMetric(RegionMatchTerminationOnlyMetric):
 72    REQUIRED_PARSER = PokemonRedStateParser
 73
 74    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 75    _TERMINATION_TARGET_NAME = "talk_cinnabar_monk"
 76
 77
 78class DefeatedBrockTerminateMetric(
 79    RegionMatchTerminationMetric, PokemonExitBattleTruncationMetric
 80):
 81    REQUIRED_PARSER = PokemonRedStateParser
 82
 83    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 84    _TERMINATION_TARGET_NAME = "defeated_brock"
 85
 86
 87class DefeatedLassTerminateMetric(
 88    RegionMatchTerminationMetric, PokemonExitBattleTruncationMetric
 89):
 90    REQUIRED_PARSER = PokemonRedStateParser
 91
 92    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
 93    _TERMINATION_TARGET_NAME = "defeated_lass"
 94
 95
 96class CaughtPidgeyTerminateMetric(
 97    RegionMatchTerminationMetric, PokemonExitBattleTruncationMetric
 98):
 99    REQUIRED_PARSER = PokemonRedStateParser
100
101    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
102    _TERMINATION_TARGET_NAME = "caught_pidgey"
103
104
105class CaughtPikachuTerminateMetric(
106    RegionMatchTerminationMetric, PokemonExitBattleTruncationMetric
107):
108    REQUIRED_PARSER = PokemonRedStateParser
109
110    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
111    _TERMINATION_TARGET_NAME = "caught_pikachu"
112
113
114class BoughtPotionAtPewterPokemartTerminateMetric(RegionMatchTerminationOnlyMetric):
115    REQUIRED_PARSER = PokemonRedStateParser
116
117    _TERMINATION_NAMED_REGION = "screen_bottom_half"
118    _TERMINATION_TARGET_NAME = "bought_potion_at_pewter_pokemart"
119
120
121class UsedPotionOnCharmanderTerminateMetric(RegionMatchTerminationOnlyMetric):
122    REQUIRED_PARSER = PokemonRedStateParser
123
124    _TERMINATION_NAMED_REGION = "dialogue_box_middle"
125    _TERMINATION_TARGET_NAME = "used_potion_on_charmander"
126
127
128class OpenMapTerminateMetric(TerminationMetric):
129    REQUIRED_PARSER = PokemonRedStateParser
130
131    def determine_terminated(
132        self, current_frame: np.ndarray, recent_frames: Optional[np.ndarray]
133    ) -> bool:
134        all_frames = [current_frame]
135        if recent_frames is not None:
136            all_frames = recent_frames
137        for frame in all_frames:
138            self.state_parser: PokemonRedStateParser
139            in_map = self.state_parser.named_region_matches_target(
140                frame, "map_bottom_right"
141            )
142            if in_map:
143                return True
144        return False
145
146
147# ---------------------------------------------------------------------------
148# Pokemon Prism metrics
149# ---------------------------------------------------------------------------
150
151# Pokemon Prism is Crystal-engine based. Naljo badges share the same memory
152# layout as Johto badges in Crystal: byte at 0xD57C, one bit per badge.
153# Bit 0 = Magma Badge (Gym 1 – Brimstone City, Leader Tansy, Fire type).
154_PRISM_BADGE_ADDR = 0xD57C
155
156
157class PokemonPrismFirstBadgeTerminateMetric(
158    TerminationMetric, PokemonExitBattleTruncationMetric
159):
160    """Terminates when the player has obtained the first Naljo badge (Magma Badge)."""
161
162    REQUIRED_PARSER = PokemonPrismStateParser
163
164    def determine_terminated(
165        self, current_frame: np.ndarray, recent_frames: Optional[np.ndarray]
166    ) -> bool:
167        badge_byte = self.state_parser.read_m(_PRISM_BADGE_ADDR)
168        # Bit 0 set means the first badge has been awarded
169        return bool(badge_byte & 0x01)