gameboy_worlds.emulation.harvest_moon.base_metrics

  1from typing import Optional
  2from abc import ABC
  3from gameboy_worlds.emulation.harvest_moon.parsers import (
  4    AgentState,
  5    HarvestMoon1Parser,
  6    HarvestMoon2Parser,
  7    HarvestMoon3Parser,
  8    HarvestMoonStateParser,
  9)
 10from gameboy_worlds.emulation.tracker import (
 11    MetricGroup,
 12    OCRegionMetric,
 13    TerminationTruncationMetric,
 14)
 15
 16import numpy as np
 17
 18
 19class CoreHarvestMoonMetrics(MetricGroup):
 20    """
 21    Harvest Moon-specific metrics.
 22
 23    Reports:
 24    - `agent_state`: The AgentState info. Is either FREE_ROAM or IN_DIALOGUE.
 25
 26    Final Reports:
 27    - None
 28    """
 29
 30    NAME = "harvest_moon_core"
 31    REQUIRED_PARSER = HarvestMoonStateParser
 32
 33    def reset(self, first=False):
 34        if not first:
 35            pass
 36        self.current_state: AgentState = (
 37            AgentState.IN_DIALOGUE
 38        )  # Start by default in dialogue because it has the least permissable actions.
 39        """ The current state of the agent in the game. """
 40        self._previous_state = self.current_state
 41
 42    def close(self):
 43        self.reset()
 44        return
 45
 46    def step(self, current_frame: np.ndarray, recent_frames: Optional[np.ndarray]):
 47        self._previous_state = self.current_state
 48        current_state = self.state_parser.get_agent_state(current_frame)
 49        self.current_state = current_state
 50
 51    def report(self) -> dict:
 52        return {
 53            "agent_state": self.current_state,
 54        }
 55
 56    def report_final(self) -> dict:
 57        return {}
 58
 59
 60class HarvestMoonOCRMetric(OCRegionMetric):
 61    REQUIRED_PARSER = HarvestMoonStateParser
 62
 63    def reset(self, first=False):
 64        super().reset(first)
 65        self.prev_was_in_menu = False
 66
 67    def start(self):
 68        self.kinds = {
 69            "dialogue": "dialogue_bottom_right",
 70            "menu": "menu_top_right",
 71        }
 72        super().start()
 73
 74    def can_read_kind(self, current_frame: np.ndarray, kind: str) -> bool:
 75        self.state_parser: PokemonStateParser
 76        if kind == "dialogue":
 77            in_dialogue = self.state_parser.dialogue_box_open(
 78                current_screen=current_frame
 79            )
 80            # dialogue_empty = self.state_parser.dialogue_box_empty(
 81            #     current_screen=current_frame
 82            # )
 83            return (
 84                in_dialogue
 85                # and not dialogue_empty
 86            )
 87        if kind == "menu":
 88            in_menu = self.state_parser.is_in_menu(current_screen=current_frame)
 89            return in_menu
 90        return False
 91
 92
 93class HarvestMoon1OCRMetric(HarvestMoonOCRMetric):
 94    REQUIRED_PARSER = HarvestMoon1Parser
 95
 96    def start(self):
 97        self.kinds = {
 98            "dialogue": "dialogue_bottom_right",
 99            "menu": "menu_top_right",
100        }
101        OCRegionMetric.start(self)
102
103
104class HarvestMoon2OCRMetric(HarvestMoonOCRMetric):
105    REQUIRED_PARSER = HarvestMoon2Parser
106
107    def start(self):
108        self.kinds = {
109            "dialogue": "dialogue_bottom_right",
110            "menu": "menu_top_right",
111        }
112        OCRegionMetric.start(self)
113
114
115class HarvestMoon3OCRMetric(HarvestMoonOCRMetric):
116    REQUIRED_PARSER = HarvestMoon3Parser
117
118    def start(self):
119        self.kinds = {
120            "dialogue": "dialogue_bottom_right",
121            "menu": "menu_top_right",
122        }
123        OCRegionMetric.start(self)
124
125
126class HarvestMoonTestMetric(MetricGroup):
127    """
128    Harvest Moon metrics for test environments.
129
130    Reports:
131    - `agent_state`: The current AgentState (FREE_ROAM or IN_DIALOGUE).
132    - `previous_agent_state`: The AgentState from the previous step.
133
134    Final Reports:
135    - None
136    """
137
138    NAME = "harvest_moon_test"
139    REQUIRED_PARSER = HarvestMoonStateParser
140
141    def start(self):
142        super().start()
143
144    def reset(self, first=False):
145        self.agent_state: AgentState = AgentState.IN_DIALOGUE
146        self.previous_agent_state: AgentState = self.agent_state
147
148    def close(self):
149        self.reset()
150        return
151
152    def step(self, current_frame: np.ndarray, recent_frames: Optional[np.ndarray]):
153        self.state_parser: HarvestMoonStateParser
154        self.previous_agent_state = self.agent_state
155        self.agent_state = self.state_parser.get_agent_state(current_frame)
156
157    def report(self) -> dict:
158        return {
159            "agent_state": self.agent_state,
160            "previous_agent_state": self.previous_agent_state,
161        }
162
163    def report_final(self) -> dict:
164        return {}