# Module `pyboy.plugins.game_wrapper_pokemon_pinball`

Expand source code

    #
    # License: See LICENSE.md file
    # GitHub: https://github.com/Baekalfen/PyBoy
    #
    __pdoc__ = {
        "GameWrapperPokemonPinball.cartridge_title": False,
        "GameWrapperPokemonPinball.post_tick": False,
        "GameWrapperPokemonPinball._set_stage": False,
        "GameWrapperPokemonPinball.ball_size": False,
    }

    import logging
    from enum import Enum

    from pyboy.utils import PyBoyException, WindowEvent, bcd_to_dec

    from .base_plugin import PyBoyGameWrapper

    logger = logging.getLogger(__name__)

    class Stage(Enum):
        """
        The stage values in the game.
        """

        RED_TOP = 0
        RED_BOTTOM = 1
        BLUE_TOP = 4
        BLUE_BOTTOM = 5
        GENGAR = 7
        MEWTWO = 9
        MEOWTH = 11
        DIGLETT = 13
        SEEL = 15

    class Pokemon(Enum):
        """
        The Pokemon values in the game.
        """

        BULBASAUR = 0
        IVYSAUR = 1
        VENUSAUR = 2
        CHARMANDER = 3
        CHARMELEON = 4
        CHARIZARD = 5
        SQUIRTLE = 6
        WARTORTLE = 7
        BLASTOISE = 8
        CATERPIE = 9
        METAPOD = 10
        BUTTERFREE = 11
        WEEDLE = 12
        KAKUNA = 13
        BEEDRILL = 14
        PIDGEY = 15
        PIDGEOTTO = 16
        PIDGEOT = 17
        RATTATA = 18
        RATICATE = 19
        SPEAROW = 20
        FEAROW = 21
        EKANS = 22
        ARBOK = 23
        PIKACHU = 24
        RAICHU = 25
        SANDSHREW = 26
        SANDSLASH = 27
        NIDORAN_F = 28
        NIDORINA = 29
        NIDOQUEEN = 30
        NIDORAN_M = 31
        NIDORINO = 32
        NIDOKING = 33
        CLEFAIRY = 34
        CLEFABLE = 35
        VULPIX = 36
        NINETALES = 37
        JIGGLYPUFF = 38
        WIGGLYTUFF = 39
        ZUBAT = 40
        GOLBAT = 41
        ODDISH = 42
        GLOOM = 43
        VILEPLUME = 44
        PARAS = 45
        PARASECT = 46
        VENONAT = 47
        VENOMOTH = 48
        DIGLETT = 49
        DUGTRIO = 50
        MEOWTH = 51
        PERSIAN = 52
        PSYDUCK = 53
        GOLDUCK = 54
        MANKEY = 55
        PRIMEAPE = 56
        GROWLITHE = 57
        ARCANINE = 58
        POLIWAG = 59
        POLIWHIRL = 60
        POLIWRATH = 61
        ABRA = 62
        KADABRA = 63
        ALAKAZAM = 64
        MACHOP = 65
        MACHOKE = 66
        MACHAMP = 67
        BELLSPROUT = 68
        WEEPINBELL = 69
        VICTREEBEL = 70
        TENTACOOL = 71
        TENTACRUEL = 72
        GEODUDE = 73
        GRAVELER = 74
        GOLEM = 75
        PONYTA = 76
        RAPIDASH = 77
        SLOWPOKE = 78
        SLOWBRO = 79
        MAGNEMITE = 80
        MAGNETON = 81
        FARFETCH_D = 82
        DODUO = 83
        DODRIO = 84
        SEEL = 85
        DEWGONG = 86
        GRIMER = 87
        MUK = 88
        SHELLDER = 89
        CLOYSTER = 90
        GASTLY = 91
        HAUNTER = 92
        GENGAR = 93
        ONIX = 94
        DROWZEE = 95
        HYPNO = 96
        KRABBY = 97
        KINGLER = 98
        VOLTORB = 99
        ELECTRODE = 100
        EXEGGCUTE = 101
        EXEGGUTOR = 102
        CUBONE = 103
        MAROWAK = 104
        HITMONLEE = 105
        HITMONCHAN = 106
        LICKITUNG = 107
        KOFFING = 108
        WEEZING = 109
        RHYHORN = 110
        RHYDON = 111
        CHANSEY = 112
        TANGELA = 113
        KANGASKHAN = 114
        HORSEA = 115
        SEADRA = 116
        GOLDEEN = 117
        SEAKING = 118
        STARYU = 119
        STARMIE = 120
        MR_MIME = 121
        SCYTHER = 122
        JYNX = 123
        ELECTABUZZ = 124
        MAGMAR = 125
        PINSIR = 126
        TAUROS = 127
        MAGIKARP = 128
        GYARADOS = 129
        LAPRAS = 130
        DITTO = 131
        EEVEE = 132
        VAPOREON = 133
        JOLTEON = 134
        FLAREON = 135
        PORYGON = 136
        OMANYTE = 137
        OMASTAR = 138
        KABUTO = 139
        KABUTOPS = 140
        AERODACTYL = 141
        SNORLAX = 142
        ARTICUNO = 143
        ZAPDOS = 144
        MOLTRES = 145
        DRATINI = 146
        DRAGONAIR = 147
        DRAGONITE = 148
        MEWTWO = 149
        MEW = 150

    class Maps(Enum):
        """
        The map values in the game.
        """

        PALLET_TOWN = 0
        VIRIDIAN_CITY = 1
        VIRIDIAN_FOREST = 2
        PEWTER_CITY = 3
        MT_MOON = 4
        CERULEAN_CITY = 5
        VERMILION_SEASIDE = 6
        VERMILION_STREETS = 7
        ROCK_MOUNTAIN = 8
        LAVENDER_TOWN = 9
        CELADON_CITY = 10
        CYCLING_ROAD = 11
        FUCHSIA_CITY = 12
        SAFARI_ZONE = 13
        SAFFRON_CITY = 14
        SEAFOAM_ISLANDS = 15
        CINNABAR_ISLAND = 16
        INDIGO_PLATEAU = 17

    class SpecialMode(Enum):
        CATCH = 0
        EVOLVE = 1
        STAGE_CHANGE = 2

    class BallType(Enum):
        POKEBALL = 0
        GREATBALL = 2
        ULTRABALL = 3
        MASTERBALL = 4

    class BallSize(Enum):
        DEFAULT = 0
        MINI = 1
        SUPERMINI = 2

    RedStages = [Stage.RED_TOP, Stage.RED_BOTTOM]
    BlueStages = [Stage.BLUE_TOP, Stage.BLUE_BOTTOM]

    RedBonusStages = [Stage.DIGLETT, Stage.GENGAR, Stage.MEWTWO]

    BlueBonusStages = [Stage.MEOWTH, Stage.SEEL, Stage.MEWTWO]

    AllBonusStageValues = RedBonusStages + BlueBonusStages

    class GameWrapperPokemonPinball(PyBoyGameWrapper):
        """
        This class wraps Pokemon Pinball, and provides access to game info for AIs.
        """

        cartridge_title = "POKEPINBALLVPH"

        def __init__(self, *args, **kwargs):
            self.shape = (20, 16)
            """The shape of the game area"""
            self.score = 0
            """The score provided by the game"""
            self.balls_left = 0
            """The lives remaining provided by the game"""
            self.game_over = False
            """The game over state"""
            self.ball_type = BallType.POKEBALL.value
            """The current ball type"""
            self.multiplier = 1
            """The current multiplier"""
            self.current_stage = 0
            """The current stage"""
            self.ball_size = 0
            self.ball_saver_seconds_left = 0
            """The current ball saver seconds left"""
            self.pokedex = [False] * 151
            self._unlimited_saver = False
            self.ball_x = 0
            """The x position of the ball"""
            self.ball_y = 0
            """The y position of the ball"""
            self.ball_x_velocity = 0
            """The x velocity of the ball"""
            self.ball_y_velocity = 0
            """The y velocity of the ball"""
            self.special_mode = 0
            """
            The special mode state value

            Example:
            ```python
            >>> from pyboy.plugins.game_wrapper_pokemon_pinball import SpecialMode
            >>> pyboy = PyBoy(pokemon_pinball_rom)
            >>> pyboy.game_wrapper.special_mode == SpecialMode.CATCH.value
            True
            ```
            """

            self.special_mode_active = False
            """The special mode active state"""

            ##########################
            # Fitness Related Values #
            ##########################

            ######################
            # Evolution tracking #
            ######################
            self.evolution_failure_count = 0
            """The number of times an evolution has failed"""
            self.evolution_success_count = 0
            """The number of times an evolution has succeeded"""

            ########################
            # Bonus stage tracking #
            ########################
            self.diglett_stages_completed = 0
            """The number of Diglett stages completed"""
            self.diglett_stages_visited = 0
            """The number of Diglett stages visited"""
            self.gengar_stages_completed = 0
            """The number of Gengar stages completed"""
            self.gengar_stages_visited = 0
            """The number of Gengar stages visited"""
            self.meowth_stages_completed = 0
            """The number of Meowth stages completed"""
            self.meowth_stages_visited = 0
            """The number of Meowth stages visited"""
            self.mewtwo_stages_completed = 0
            """The number of Mewtwo stages completed"""
            self.mewtwo_stages_visited = 0
            """The number of Mewtwo stages visited"""
            self.seel_stages_completed = 0
            """The number of Seel stages completed"""
            self.seel_stages_visited = 0
            """The number of Seel stages visited"""

            ##########################
            # Pikachu Saver tracking #
            ##########################
            self.pikachu_saver_charge = 0  # range of 0-15
            """The charge of the Pikachu saver, ranges from 0 to 15"""
            self.pikachu_saver_increments = 0
            """The number of times the Pikachu saver charge has incremented"""
            self.pikachu_saver_used = 0
            """The number of times the Pikachu saver has been used"""

            ################
            # Map tracking #
            ################
            self.current_map = 0
            """The current map

            Example:
            ```python
            >>> from pyboy.plugins.game_wrapper_pokemon_pinball import Maps
            >>> pyboy = PyBoy(pokemon_pinball_rom)
            >>> pyboy.game_wrapper.current_map == Maps.PALLET_TOWN.value
            True
            ```
            """
            self.map_change_attempts = 0
            """The number of times a map change has been attempted"""
            self.map_change_successes = 0
            """The number of times a map change has been successful"""

            ###########################
            # Pokemon Caught Tracking #
            ###########################
            self.pokemon_caught_in_session = 0
            """The number of pokemon caught in the current session"""
            self.pokemon_seen_in_session = 0
            """The number of pokemon seen in the current session"""

            #########################
            # Ball upgrade Tracking #
            #########################
            self.great_ball_upgrades = 0
            """The number of Great Ball upgrades obtained"""
            self.ultra_ball_upgrades = 0
            """The number of Ultra Ball upgrades obtained"""
            self.master_ball_upgrades = 0
            """The number of Master Ball upgrades obtained"""

            #######################
            # Extra Ball Tracking #
            #######################
            self.extra_balls_added = 0  # Does not include extra balls rewarded via roulette
            """The number of extra balls added, not including those rewarded via roulette"""

            ##########################
            # Lost Ball During Saver #
            ##########################
            self.lost_ball_during_saver = 0
            """The number of balls lost during a saver mode"""

            #################
            # Slot Tracking #
            #################
            self.roulette_slots_opened = 0
            """The number of roulette slots opened"""
            self.roulette_slots_entered = 0
            """The number of roulette slots entered"""

            super().__init__(*args, game_area_section=(0, 0) + self.shape, game_area_follow_scxy=True, **kwargs)

            if not self.enabled():
                return

            self._add_hooks()

        def _update_pokedex(self):
            for pokemon in Pokemon:
                self.pokedex[pokemon.value] = self.pyboy.memory[ADDR_POKEDEX + pokemon.value]

        def has_pokemon(self, pokemon):
            """
            Check if the player has caught the given pokemon

            Args:
                pokemon (Pokemon): The pokemon to check for
            """
            return self.pokedex[pokemon.value] == 2

        def set_unlimited_saver(self, unlimited_saver=True):
            """
            Sets the unlimited saver mode in the game.

            This function allows for an unlimited saver option in the game.

            Parameters:
            unlimited_saver (bool, optional): If True, the saver mode in the game is unlimited. Defaults to True.

            Returns:
            None
            """
            self._unlimited_saver = unlimited_saver

        def _set_stage(self, stage):
            """
            Override rom memory to set the default stage to the desired stage
            Bonus stages require further initialization
            This method should be called before the game starts

            No ops out these asm lines:
                jr z, .pressedB
                ld a, [wSelectedFieldIndex]
                ld c, a
                ld b, $0
                ld hl, StartingStages
                add hl, bc
                ld a, [hl]

            Inserts the following asm:
                ld a, stage.value

            Kwargs:
                stage (Stage): The stage to set the game to.
            """

            if stage is None:
                return
            for i in range(NO_OP_BYTE_WIDTH_STAGE_OVERRIDE):
                # equivalent to no op
                self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE + i] = 0x00
            # equivalent to ld a, stage.value
            self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE] = 0b00111110
            self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE + 1] = stage.value

        def _init_bonus_stage(self, stage):
            # set backup stage if it is a bonus stage
            if stage in RedBonusStages:
                self.pyboy.memory[ADDR_CURRENT_STAGE_BACKUP] = Stage.RED_BOTTOM.value
            elif stage in BlueBonusStages:
                self.pyboy.memory[ADDR_CURRENT_STAGE_BACKUP] = Stage.BLUE_BOTTOM.value

            # do initializations skipped by loading bonus stage instead of main stage
            if stage in RedBonusStages or stage in BlueBonusStages:
                self.pyboy.memory[ADDR_CURRENT_SLOT_FRAME] = CURRENT_SLOT_FRAME_VALUE
                self.pyboy.memory[ADDR_BALLS_LEFT] = 1
                self.pyboy.memory[ADDR_NUM_BALL_LIVES] = 3
                self.pyboy.memory[ADDR_STAGE_COLLISION_STATE] = 0b100
                self.pyboy.memory[ADDR_STAGE_COLLISION_STATE_HELPER] = 0b100

        def start_catch_mode(self, pokemon=Pokemon.BULBASAUR, unlimited_time=False):
            """
            Starts the catch mode in the game. NOTE: This method does not change stage specific values and may need a top/bottom stage change to work properly.

            This function sets up the game state for catch mode, including the Pokemon to catch and the game timer.

            Parameters:
            pokemon (Pokemon, optional): The Pokemon to catch in this mode. Defaults to Pokemon.BULBASAUR.
            unlimited_time (bool, optional): If True, the game timer is not activated, giving unlimited time in catch mode. Defaults to False.

            Returns:
            None
            """
            # All values are based on PRET disassembly
            self.pyboy.memory[ADDR_SPECIAL_MODE] = SpecialMode.CATCH.value
            self.pyboy.memory[ADDR_POKEMON_TO_CATCH] = pokemon.value
            self.pyboy.memory[ADDR_SPECIAL_MODE_ACTIVE] = 1
            self.pyboy.memory[ADDR_SPECIAL_MODE_STATE] = 0
            self.pyboy.memory[ADDR_D5C6] = 0
            self.pyboy.memory[ADDR_NUM_MON_HITS] = 0
            self.pyboy.memory[ADDR_NUM_CATCH_TILES_FLIPPED] = 0
            self.pyboy.memory[ADDR_TILE_ILLUMINATION : ADDR_TILE_ILLUMINATION + TILE_ILLUMINATION_BYTE_WIDTH] = 0
            if not unlimited_time:
                self.pyboy.memory[ADDR_TIMER_SECONDS] = 0
                self.pyboy.memory[ADDR_TIMER_MINUTES] = 2
                self.pyboy.memory[ADDR_TIMER_FRAMES] = 0
                self.pyboy.memory[ADDR_TIMER_RAN_OUT] = 0
                self.pyboy.memory[ADDR_TIMER_PAUSED] = 0
                self.pyboy.memory[ADDR_TIMER_ACTIVE] = 1
                self.pyboy.memory[ADDR_D580] = 1

        # replaces pause button with evolution start
        def enable_evolve_hack(self, unlimited_time=False):
            """
            Enables the evolution hack in the game.

            This function replaces the pause button with the evolution start method. It also allows for an unlimited time option.

            Parameters:
            unlimited_time (bool, optional): If True, the game timer is disabled, giving unlimited time in the game. Defaults to False.

            Returns:
            None
            """
            bank_addr_evo = BANK_OFFSET_START_EVOLUTION

            lower_8bits = bank_addr_evo[1] & 0xFF
            upper_8bits = (bank_addr_evo[1] >> 8) & 0xFF

            bank_addr_pause = BANK_OFFSET_PAUSE_METHOD_CALL

            self.pyboy.memory[BANK_OFFSET_PAUSE_METHOD_BANK] = bank_addr_evo[0]
            self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1]] = lower_8bits
            self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1] + 1] = upper_8bits
            if unlimited_time:

                def disable_timer(context):
                    context.memory[ADDR_TIMER_ACTIVE] = 0

                bank = BANK_OFFSET_DISABLE_TIMER[0]
                offset = BANK_OFFSET_DISABLE_TIMER[1]
                try:
                    self.pyboy.hook_register(bank, offset, disable_timer, self.pyboy)
                except ValueError:
                    pass  # hook already exists

        def current_map_completed(self):
            """
            Determines if all Pokemon in the current map have been caught.

            This function checks whether all Pokemon, both common and rare, in the current stage's map have been caught.
            It supports both Red and Blue stages. If any Pokemon in the map has not been caught, the function returns False.
            If all Pokemon have been caught, it returns True.

            Returns:
            bool: True if all Pokemon in the current map have been caught, False otherwise.
            """
            if self.current_stage in RedStages:
                for pokemon in RedStageMapWildMons[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
                for pokemon in RedStageMapWildMonsRare[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
            elif self.current_stage in BlueStages:
                for pokemon in BlueStageMapWildMons[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
                for pokemon in BlueStageMapWildMonsRare[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
            return True

        def start_game(self, timer_div=None, stage=None):
            """
            Starts the game with optional timer division and stage parameters.

            This function sets up the game state, sends the necessary inputs to start the game, and saves the initial game state.

            Parameters:
            timer_div (int, optional): The division value for the game timer. Defaults to None.
            stage (int, optional): The stage to start the game at. Defaults to None.

            Returns:
            None
            """
            if self.game_has_started:
                raise PyBoyException("Gamewrapper already started! Use 'reset' instead.")

            self._set_stage(stage)

            # Random tilemap I observed doesn't change until shortly before input is read
            while self.tilemap_background[10, 10] != 269:
                self.pyboy.tick(1, False)

            # tick needed count to get to the point where input is read
            self.pyboy.tick(18, False)

            # start game
            self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
            self.pyboy.tick(1, False)
            self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
            # tick count needed to get to the next point where input is read
            self.pyboy.tick(95, False)

            self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
            self.pyboy.tick(1, False)
            self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
            self.pyboy.tick(1, False)

            ticks_until_visible = 74
            self.pyboy.tick(ticks_until_visible, False)

            ticks_until_input_ready = 4
            self.pyboy.tick(ticks_until_input_ready, False)

            # needs to be called after normal initializations, otherwise it will be overwritten
            self._init_bonus_stage(stage)

            PyBoyGameWrapper.start_game(self, timer_div=timer_div)

        def reset_game(self, timer_div=None):
            """
            After calling `start_game`, use this method to reset the beginning of the game.

            Kwargs:
                timer_div (int): Replace timer's DIV register with this value. Use `None` to randomize.
            """
            PyBoyGameWrapper.reset_game(self, timer_div=timer_div)

        def get_unique_pokemon_caught(self):
            """
            Get the number of unique pokemon caught in the current session based off the in game pokedex
            """
            return self.pokedex.count(2)

        def post_tick(self):
            self._tile_cache_invalid = True
            self._sprite_cache_invalid = True

            self.ball_type = self.pyboy.memory[ADDR_BALL_TYPE]
            self.balls_left = 3 - self.pyboy.memory[ADDR_BALLS_LEFT] + self.pyboy.memory[ADDR_EXTRA_BALLS]
            self.game_over = self.pyboy.memory[ADDR_GAME_OVER] == 1

            self.current_map = self.pyboy.memory[ADDR_CURRENT_MAP]
            self.current_stage = self.pyboy.memory[ADDR_CURRENT_STAGE]

            self.special_mode = self.pyboy.memory[ADDR_SPECIAL_MODE]
            self.special_mode_active = self.pyboy.memory[ADDR_SPECIAL_MODE_ACTIVE] == 1

            self.score = (
                bcd_to_dec(
                    int.from_bytes(self.pyboy.memory[ADDR_SCORE : ADDR_SCORE + SCORE_BYTE_WIDTH], "little"),
                    byte_width=SCORE_BYTE_WIDTH,
                )
                * 10
            )

            self.multiplier = self.pyboy.memory[ADDR_MULTIPLIER]

            self.ball_size = self.pyboy.memory[ADDR_BALL_SIZE]

            self.ball_x = self.pyboy.memory[ADDR_BALL_X]
            self.ball_y = self.pyboy.memory[ADDR_BALL_Y]
            self.ball_x_velocity = self.pyboy.memory[ADDR_BALL_X_VELOCITY]
            self.ball_y_velocity = self.pyboy.memory[ADDR_BALL_Y_VELOCITY]

            self.pikachu_saver_charge = self.pyboy.memory[ADDR_PIKACHU_SAVER_CHARGE]

            if self._unlimited_saver:
                self.pyboy.memory[ADDR_BALL_SAVER_SECONDS_LEFT] = 30

            self.ball_saver_seconds_left = self.pyboy.memory[ADDR_BALL_SAVER_SECONDS_LEFT]

            self._update_pokedex()

        def __repr__(self):
            # fmt: off
            return (
                "PokemonPinball:\n" +
                "Score: " + str(self.score) + "\n" +
                "Multiplier: " + str(self.multiplier) + "\n" +
                "Balls left: " + str(self.balls_left) + "\n" +
                "Ball type: " + str(BallType(self.ball_type).name) + "\n" +
                "Ball X: " + str(self.ball_x) + "\n" +
                "Ball Y: " + str(self.ball_y) + "\n" +
                "Ball X Velocity: " + str(self.ball_x_velocity) + "\n" +
                "Ball Y Velocity: " + str(self.ball_y_velocity) + "\n" +
                "Current stage: " + str(Stage(self.current_stage).name) + "\n" +
                "Game over: " + str(self.game_over) + "\n" +
                "Ball saver seconds left: " + str(self.ball_saver_seconds_left) + "\n" +
                "Pokemon caught in session: " + str(self.pokemon_caught_in_session) + "\n" +
                "Pokemon seen in session: " + str(self.pokemon_seen_in_session) + "\n" +
                "Ball lost during saver: " + str(self.lost_ball_during_saver) + "\n" +
                "Special mode active: " + str(self.special_mode_active) + "\n" +
                "Evolution failure count: " + str(self.evolution_failure_count) + "\n" +
                "Evolution success count: " + str(self.evolution_success_count) + "\n" +
                "Pikachu saver charge: " + str(self.pikachu_saver_charge) + "\n" +
                "Pikachu saver used: " + str(self.pikachu_saver_used) + "\n" +
                "Great Ball upgrades: " + str(self.great_ball_upgrades) + "\n" +
                "Ultra Ball upgrades: " + str(self.ultra_ball_upgrades) + "\n" +
                "Master Ball upgrades: " + str(self.master_ball_upgrades) + "\n" +
                "Extra balls added: " + str(self.extra_balls_added) + "\n" +
                "Roulette slots opened: " + str(self.roulette_slots_opened) + "\n" +
                "Roulette slots entered: " + str(self.roulette_slots_entered) + "\n" +
                "Current map: " + str(self.current_map) + "\n" +
                "Diglett stages completed: " + str(self.diglett_stages_completed) + " / Visited: " + str(self.diglett_stages_visited) + "\n" +
                "Gengar stages completed: " + str(self.gengar_stages_completed) + " / Visited: " + str(self.gengar_stages_visited) + "\n" +
                "Meowth stages completed: " + str(self.meowth_stages_completed) + " / Visited: " + str(self.meowth_stages_visited) + "\n" +
                "Mewtwo stages completed: " + str(self.mewtwo_stages_completed) + " / Visited: " + str(self.mewtwo_stages_visited) + "\n" +
                "Seel stages completed: " + str(self.seel_stages_completed) + " / Visited: " + str(self.seel_stages_visited) + "\n"
            )
            # fmt: on

        def _add_hooks(self):
            def completed_evolution(context):
                context.evolution_success_count += 1

            self.pyboy.hook_register(
                BANK_OFFSET_COMPLETE_EVOLUTION_MODE_RED_FIELD[0],
                BANK_OFFSET_COMPLETE_EVOLUTION_MODE_RED_FIELD[1],
                completed_evolution,
                self,
            )
            self.pyboy.hook_register(
                BANK_OFFSET_COMPLETE_EVOLUTION_MODE_BLUE_FIELD[0],
                BANK_OFFSET_COMPLETE_EVOLUTION_MODE_BLUE_FIELD[1],
                completed_evolution,
                self,
            )

            def failed_evolution(context):
                context.evolution_failure_count += 1

            self.pyboy.hook_register(
                BANK_OFFSET_FAIL_EVOLUTION_MODE_RED_FIELD[0],
                BANK_OFFSET_FAIL_EVOLUTION_MODE_RED_FIELD[1],
                failed_evolution,
                self,
            )
            self.pyboy.hook_register(
                BANK_OFFSET_FAIL_EVOLUTION_MODE_BLUE_FIELD[0],
                BANK_OFFSET_FAIL_EVOLUTION_MODE_BLUE_FIELD[1],
                failed_evolution,
                self,
            )

            def pokemon_caught(context):
                context.pokemon_caught_in_session += 1

            self.pyboy.hook_register(
                BANK_OFFSET_ADD_CAUGHT_POKEMON_TO_PARTY[0], BANK_OFFSET_ADD_CAUGHT_POKEMON_TO_PARTY[1], pokemon_caught, self
            )

            def pokemon_seen(context):
                context.pokemon_seen_in_session += 1

            self.pyboy.hook_register(
                BANK_OFFSET_SET_POKEMON_SEEN_FLAG[0], BANK_OFFSET_SET_POKEMON_SEEN_FLAG[1], pokemon_seen, self
            )

            def meowth_visited(context):
                context.meowth_stages_visited += 1

            self.pyboy.hook_register(
                BANK_OFFSET_INIT_MEOWTH_BONUS_STAGE[0], BANK_OFFSET_INIT_MEOWTH_BONUS_STAGE[1], meowth_visited, self
            )

            def diglett_visited(context):
                context.diglett_stages_visited += 1

            self.pyboy.hook_register(
                BANK_OFFSET_INIT_DIGLETT_BONUS_STAGE[0], BANK_OFFSET_INIT_DIGLETT_BONUS_STAGE[1], diglett_visited, self
            )

            def gengar_visited(context):
                context.gengar_stages_visited += 1

            self.pyboy.hook_register(
                BANK_OFFSET_INIT_GENGAR_BONUS_STAGE[0], BANK_OFFSET_INIT_GENGAR_BONUS_STAGE[1], gengar_visited, self
            )

            def seel_visited(context):
                context.seel_stages_visited += 1

            self.pyboy.hook_register(
                BANK_OFFSET_INIT_SEEL_BONUS_STAGE[0], BANK_OFFSET_INIT_SEEL_BONUS_STAGE[1], seel_visited, self
            )

            def mewtwo_visited(context):
                context.mewtwo_stages_visited += 1

            self.pyboy.hook_register(
                BANK_OFFSET_INIT_MEWTWO_BONUS_STAGE[0], BANK_OFFSET_INIT_MEWTWO_BONUS_STAGE[1], mewtwo_visited, self
            )

            def meowth_completed(context):
                context.meowth_stages_completed += 1

            self.pyboy.hook_register(
                BANK_OFFSET_MEOWTH_STAGE_COMPLETE[0], BANK_OFFSET_MEOWTH_STAGE_COMPLETE[1], meowth_completed, self
            )

            def diglett_completed(context):
                context.diglett_stages_completed += 1

            self.pyboy.hook_register(
                BANK_OFFSET_DIGLETT_STAGE_COMPLETE[0], BANK_OFFSET_DIGLETT_STAGE_COMPLETE[1], diglett_completed, self
            )

            def gengar_completed(context):
                context.gengar_stages_completed += 1

            self.pyboy.hook_register(
                BANK_OFFSET_GENGAR_STAGE_COMPLETE[0], BANK_OFFSET_GENGAR_STAGE_COMPLETE[1], gengar_completed, self
            )

            def seel_completed(context):
                context.seel_stages_completed += 1

            self.pyboy.hook_register(
                BANK_OFFSET_SEEL_STAGE_COMPLETE[0], BANK_OFFSET_SEEL_STAGE_COMPLETE[1], seel_completed, self
            )

            def mewtwo_completed(context):
                context.mewtwo_stages_completed += 1

            self.pyboy.hook_register(
                BANK_OFFSET_MEWTWO_STAGE_COMPLETE[0], BANK_OFFSET_MEWTWO_STAGE_COMPLETE[1], mewtwo_completed, self
            )

            def map_change_attempt(context):
                context.map_change_attempts += 1

            self.pyboy.hook_register(
                BANK_OFFSET_MAP_CHANGE_ATTEMPT[0], BANK_OFFSET_MAP_CHANGE_ATTEMPT[1], map_change_attempt, self
            )

            def map_change_success(context):
                context.map_change_successes += 1

            self.pyboy.hook_register(
                BANK_OFFSET_MAP_CHANGE_SUCCESS[0], BANK_OFFSET_MAP_CHANGE_SUCCESS[1], map_change_success, self
            )

            def pika_saver_increment(context):
                context.pikachu_saver_increments += 1

            self.pyboy.hook_register(
                BANK_OFFSET_PIKA_SAVER_INCREMENT_BLUE_FIELD[0],
                BANK_OFFSET_PIKA_SAVER_INCREMENT_BLUE_FIELD[1],
                pika_saver_increment,
                self,
            )
            self.pyboy.hook_register(
                BANK_OFFSET_PIKA_SAVER_INCREMENT_RED_FIELD[0],
                BANK_OFFSET_PIKA_SAVER_INCREMENT_RED_FIELD[1],
                pika_saver_increment,
                self,
            )

            def pika_saver_used(context):
                context.pikachu_saver_used += 1

            self.pyboy.hook_register(
                BANK_OFFSET_PIKA_SAVER_USED_BLUE_FIELD[0], BANK_OFFSET_PIKA_SAVER_USED_BLUE_FIELD[1], pika_saver_used, self
            )
            self.pyboy.hook_register(
                BANK_OFFSET_PIKA_SAVER_USED_RED_FIELD[0], BANK_OFFSET_PIKA_SAVER_USED_RED_FIELD[1], pika_saver_used, self
            )

            def ball_upgrade_trigger(context):
                if context.ball_type == BallType.POKEBALL.value:
                    context.great_ball_upgrades += 1
                elif context.ball_type == BallType.GREATBALL.value:
                    context.ultra_ball_upgrades += 1
                elif context.ball_type == BallType.ULTRABALL.value:
                    context.master_ball_upgrades += 1

            self.pyboy.hook_register(
                BANK_OFFSET_BALL_UPGRADE_TRIGGER_BLUE_FIELD[0],
                BANK_OFFSET_BALL_UPGRADE_TRIGGER_BLUE_FIELD[1],
                ball_upgrade_trigger,
                self,
            )
            self.pyboy.hook_register(
                BANK_OFFSET_BALL_UPGRADE_TRIGGER_RED_FIELD[0],
                BANK_OFFSET_BALL_UPGRADE_TRIGGER_RED_FIELD[1],
                ball_upgrade_trigger,
                self,
            )

            def extra_ball_added(context):
                context.extra_balls_added += 1

            self.pyboy.hook_register(BANK_OFFSET_ADD_EXTRA_BALL[0], BANK_OFFSET_ADD_EXTRA_BALL[1], extra_ball_added, self)

            # This prevents slot reward extra ball from being counted as it is mostly RNG based and not a good fitness metric
            def slot_reward_extra_ball(context):
                context.extra_balls_added -= 1

            self.pyboy.hook_register(
                BANK_OFFSET_SLOT_REWARD_EXTRA_BALL[0], BANK_OFFSET_SLOT_REWARD_EXTRA_BALL[1], slot_reward_extra_ball, self
            )

            def opened_slot_by_getting_4_cave_lights(context):
                context.roulette_slots_opened += 1

            self.pyboy.hook_register(
                BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_BLUE[0],
                BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_BLUE[1],
                opened_slot_by_getting_4_cave_lights,
                self,
            )
            self.pyboy.hook_register(
                BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_RED[0],
                BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_RED[1],
                opened_slot_by_getting_4_cave_lights,
                self,
            )

            def slot_reward_roulette(context):
                context.roulette_slots_entered += 1

            self.pyboy.hook_register(
                BANK_OFFSET_SLOT_REWARD_ROULETTE[0], BANK_OFFSET_SLOT_REWARD_ROULETTE[1], slot_reward_roulette, self
            )

            def lost_ball_during_saver(context):
                context.lost_ball_during_saver += 1

            self.pyboy.hook_register(
                BANK_OFFSET_BALL_SAVED_RED[0], BANK_OFFSET_BALL_SAVED_RED[1], lost_ball_during_saver, self
            )
            self.pyboy.hook_register(
                BANK_OFFSET_BALL_SAVED_BLUE[0], BANK_OFFSET_BALL_SAVED_BLUE[1], lost_ball_during_saver, self
            )

    #################
    # RAM Addresses #
    #################

    # value starts at 1, increments by 1 for each new ball launch and compares to ADDR_NUM_BALL_LIVES
    ADDR_BALLS_LEFT = 0xD49D

    # value gets initialized to 3 by red and blue stage initialization code
    ADDR_NUM_BALL_LIVES = 0xD49E

    ADDR_BALL_TYPE = 0xD47E
    ADDR_BALL_SIZE = 0xD4C8
    ADDR_EXTRA_BALLS = 0xD49B

    ADDR_BALL_X = 0xD4B3
    ADDR_BALL_Y = 0xD4B5
    ADDR_BALL_X_VELOCITY = 0xD4BB
    ADDR_BALL_Y_VELOCITY = 0xD4BD

    ADDR_BALL_SAVER_SECONDS_LEFT = 0xD4A4

    ADDR_NUM_MON_HITS = 0xD5C0
    ADDR_NUM_CATCH_TILES_FLIPPED = 0xD5B6
    ADDR_TILE_ILLUMINATION = 0xD586
    TILE_ILLUMINATION_BYTE_WIDTH = 48

    ADDR_MESSAGE_BUFFER = 0xC600
    MESSAGE_BUFFER_BYTE_WIDTH = 100

    ADDR_WHICH_DIGLETT = 0xD4ED
    ADDR_RIGHT_MAP_MOVE_COUNTER = 0xD4F2
    ADDR_LEFT_MAP_MOVE_COUNTER = 0xD4F0

    ADDR_TIMER_SECONDS = 0xD57A
    ADDR_TIMER_MINUTES = 0xD57B
    ADDR_TIMER_FRAMES = 0xD57C
    ADDR_TIMER_RAN_OUT = 0xD57E  # 1 = ran out
    ADDR_TIMER_PAUSED = 0xD57F  # nz = paused
    ADDR_TIMER_ACTIVE = 0xD57D  # 1 = active
    ADDR_D580 = 0xD580  # Something to do with the timer, needs to be initialized.

    ADDR_CURRENT_MAP = 0xD54A

    ADDR_D5C6 = 0xD5C6  # Something to do with the catch mode, needs to be initialized.

    ADDR_POKEDEX = 0xD962

    ADDR_STAGE_COLLISION_STATE = 0xD4AF
    ADDR_STAGE_COLLISION_STATE_HELPER = 0xD7AD

    ADDR_CURRENT_STAGE = 0xD4AC
    ADDR_CURRENT_STAGE_BACKUP = 0xD4AD

    ADDR_BONUS_STAGE_WON = 0xD49A

    ADDR_PIKACHU_SAVER_CHARGE = 0xD517
    PIKACHU_SAVER_CHARGE_MAX = 15

    ADDR_CURRENT_SLOT_FRAME = 0xD603
    # this is the value needed to properly return to main stage after bonus stage
    # it sets the current slot frame to 7, which is the frame before getting spit out after bonus stage
    CURRENT_SLOT_FRAME_VALUE = 0x7

    ADDR_SCORE = 0xD46A
    SCORE_BYTE_WIDTH = 6
    MAX_SCORE = 999999999999 * 10
    """The maximum score possible, multiplied by ten to add the implied extra 0 the game uses"""

    ADDR_GAME_OVER = 0xD616
    ADDR_MULTIPLIER = 0xD482

    ADDR_POKEMON_TO_CATCH = 0xD579
    ADDR_RARE_POKEMON_FLAG = 0xD55B

    ADDR_SPECIAL_MODE = 0xD550
    ADDR_SPECIAL_MODE_ACTIVE = 0xD54B
    ADDR_SPECIAL_MODE_STATE = 0xD54D  # 0 = handleEvolutionMode, 1 = CompleteEvolutionMode, 2 = FailEvolutionMode
    # see here: https://github.com/pret/pokepinball/blob/dcfffa520017ba89108f8be97f51d76c68ea44c9/engine/pinball_game/evolution_mode/evolution_mode_blue_field.asm#L34

    #######################
    # ROM Bank and Offset #
    #######################

    ADDR_TO_NO_OP_STAGE_OVERRIDE = 0x1774 + 37
    ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE = 3
    NO_OP_BYTE_WIDTH_STAGE_OVERRIDE = 11

    # Evolution hack related addresses
    BANK_OFFSET_START_EVOLUTION = (4, 0x4AB3)
    BANK_OFFSET_PAUSE_METHOD_BANK = (3, 0x5954)
    BANK_OFFSET_PAUSE_METHOD_CALL = (3, 0x5956)

    BANK_OFFSET_COMPLETE_EVOLUTION_MODE_BLUE_FIELD = (8, 0x4D30)
    BANK_OFFSET_COMPLETE_EVOLUTION_MODE_RED_FIELD = (8, 0x470B)
    BANK_OFFSET_FAIL_EVOLUTION_MODE_BLUE_FIELD = (8, 0x4D7C)
    BANK_OFFSET_FAIL_EVOLUTION_MODE_RED_FIELD = (8, 0x4757)
    BANK_OFFSET_ADD_CAUGHT_POKEMON_TO_PARTY = (4, 0x473D)
    BANK_OFFSET_SET_POKEMON_SEEN_FLAG = (4, 0x4753)
    BANK_OFFSET_INIT_DIGLETT_BONUS_STAGE = (6, 0x59F2)
    BANK_OFFSET_INIT_MEOWTH_BONUS_STAGE = (9, 0x4000)
    BANK_OFFSET_INIT_GENGAR_BONUS_STAGE = (6, 0x4099)
    BANK_OFFSET_INIT_SEEL_BONUS_STAGE = (9, 0x5A7C)
    BANK_OFFSET_INIT_MEWTWO_BONUS_STAGE = (6, 0x524F)
    BANK_OFFSET_DIGLETT_STAGE_COMPLETE = (6, 0x6BF2)
    BANK_OFFSET_GENGAR_STAGE_COMPLETE = (6, 0x4A14)
    BANK_OFFSET_MEOWTH_STAGE_COMPLETE = (9, 0x444B)
    BANK_OFFSET_SEEL_STAGE_COMPLETE = (9, 0x5C5A)
    BANK_OFFSET_MEWTWO_STAGE_COMPLETE = (6, 0x565E)
    BANK_OFFSET_MAP_CHANGE_ATTEMPT = (0xC, 0x41EC)
    BANK_OFFSET_MAP_CHANGE_SUCCESS = (0xC, 0x55D5)
    BANK_OFFSET_PIKA_SAVER_INCREMENT_BLUE_FIELD = (0x7, 0x4AFF)
    BANK_OFFSET_PIKA_SAVER_INCREMENT_RED_FIELD = (0x5, 0x4E8A)
    BANK_OFFSET_PIKA_SAVER_USED_BLUE_FIELD = (0x7, 0x50C9)
    BANK_OFFSET_PIKA_SAVER_USED_RED_FIELD = (0x5, 0x6634)
    BANK_OFFSET_BALL_UPGRADE_TRIGGER_BLUE_FIELD = (0x7, 0x63DE)
    BANK_OFFSET_BALL_UPGRADE_TRIGGER_RED_FIELD = (0x5, 0x53C0)
    BANK_OFFSET_ADD_EXTRA_BALL = (0xC, 0x4164)
    BANK_OFFSET_SLOT_REWARD_EXTRA_BALL = (0x3, 0x6FA7)
    BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_BLUE = (0x7, 0x667E)
    BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_RED = (0x5, 0x5284)
    BANK_OFFSET_SLOT_REWARD_ROULETTE = (0x3, 0x6D8E)
    BANK_OFFSET_DISABLE_TIMER = (4, 0x4D64)
    BANK_OFFSET_BALL_SAVED_RED = (3, 0x5D7F)
    BANK_OFFSET_BALL_SAVED_BLUE = (3, 0x5E58)

    RedStageMapWildMons = {
        Maps.PALLET_TOWN: {
            Pokemon.BULBASAUR: 0.0625,
            Pokemon.CHARMANDER: 0.375,
            Pokemon.PIDGEY: 0.1875,
            Pokemon.RATTATA: 0.1875,
            Pokemon.NIDORAN_M: 0.0625,
            Pokemon.POLIWAG: 0.0625,
            Pokemon.TENTACOOL: 0.0625,
        },
        Maps.VIRIDIAN_FOREST: {
            Pokemon.WEEDLE: 0.3125,
            Pokemon.PIDGEY: 0.3125,
            Pokemon.RATTATA: 0.3125,
            Pokemon.PIKACHU: 0.0625,
        },
        Maps.PEWTER_CITY: {
            Pokemon.PIDGEY: 0.125,
            Pokemon.SPEAROW: 0.375,
            Pokemon.EKANS: 0.0625,
            Pokemon.JIGGLYPUFF: 0.3125,
            Pokemon.MAGIKARP: 0.125,
        },
        Maps.CERULEAN_CITY: {
            Pokemon.WEEDLE: 0.125,
            Pokemon.PIDGEY: 0.0625,
            Pokemon.ODDISH: 0.3125,
            Pokemon.PSYDUCK: 0.0625,
            Pokemon.MANKEY: 0.1875,
            Pokemon.ABRA: 0.125,
            Pokemon.KRABBY: 0.0625,
            Pokemon.GOLDEEN: 0.0625,
        },
        Maps.VERMILION_SEASIDE: {
            Pokemon.PIDGEY: 0.0625,
            Pokemon.SPEAROW: 0.0625,
            Pokemon.EKANS: 0.125,
            Pokemon.ODDISH: 0.125,
            Pokemon.MANKEY: 0.125,
            Pokemon.SHELLDER: 0.1875,
            Pokemon.DROWZEE: 0.125,
            Pokemon.KRABBY: 0.1875,
        },
        Maps.ROCK_MOUNTAIN: {
            Pokemon.RATTATA: 0.0625,
            Pokemon.SPEAROW: 0.0625,
            Pokemon.EKANS: 0.1875,
            Pokemon.ZUBAT: 0.0625,
            Pokemon.DIGLETT: 0.1875,
            Pokemon.MACHOP: 0.0625,
            Pokemon.GEODUDE: 0.0625,
            Pokemon.SLOWPOKE: 0.0625,
            Pokemon.ONIX: 0.0625,
            Pokemon.VOLTORB: 0.1875,
        },
        Maps.LAVENDER_TOWN: {
            Pokemon.PIDGEY: 0.125,
            Pokemon.EKANS: 0.125,
            Pokemon.MANKEY: 0.125,
            Pokemon.GROWLITHE: 0.125,
            Pokemon.MAGNEMITE: 0.125,
            Pokemon.GASTLY: 0.3125,
            Pokemon.CUBONE: 0.0625,
        },
        Maps.CYCLING_ROAD: {
            Pokemon.RATTATA: 0.125,
            Pokemon.SPEAROW: 0.125,
            Pokemon.TENTACOOL: 0.125,
            Pokemon.DODUO: 0.1875,
            Pokemon.KRABBY: 0.125,
            Pokemon.LICKITUNG: 0.0625,
            Pokemon.GOLDEEN: 0.125,
            Pokemon.MAGIKARP: 0.125,
        },
        Maps.SAFARI_ZONE: {Pokemon.NIDORAN_M: 0.25, Pokemon.PARAS: 0.25, Pokemon.DODUO: 0.25, Pokemon.RHYHORN: 0.25},
        Maps.SEAFOAM_ISLANDS: {
            Pokemon.ZUBAT: 0.0625,
            Pokemon.PSYDUCK: 0.0625,
            Pokemon.TENTACOOL: 0.0625,
            Pokemon.SLOWPOKE: 0.0625,
            Pokemon.SEEL: 0.0625,
            Pokemon.SHELLDER: 0.0625,
            Pokemon.KRABBY: 0.0625,
            Pokemon.HORSEA: 0.25,
            Pokemon.GOLDEEN: 0.0625,
            Pokemon.STARYU: 0.25,
        },
        Maps.CINNABAR_ISLAND: {
            Pokemon.GROWLITHE: 0.25,
            Pokemon.PONYTA: 0.25,
            Pokemon.GRIMER: 0.125,
            Pokemon.KOFFING: 0.25,
            Pokemon.TANGELA: 0.125,
        },
        Maps.INDIGO_PLATEAU: {
            Pokemon.SPEAROW: 0.0625,
            Pokemon.EKANS: 0.0625,
            Pokemon.ZUBAT: 0.125,
            Pokemon.MACHOP: 0.1875,
            Pokemon.GEODUDE: 0.1875,
            Pokemon.ONIX: 0.1875,
            Pokemon.DITTO: 0.1875,
        },
    }
    """The wild Pokemon that can be found in each map in the Red stage, along with their encounter rates"""

    RedStageMapWildMonsRare = {
        Maps.PALLET_TOWN: {
            Pokemon.BULBASAUR: 0.1875,
            Pokemon.CHARMANDER: 0.0625,
            Pokemon.PIDGEY: 0.0625,
            Pokemon.RATTATA: 0.0625,
            Pokemon.NIDORAN_M: 0.1875,
            Pokemon.POLIWAG: 0.25,
            Pokemon.TENTACOOL: 0.1875,
        },
        Maps.VIRIDIAN_FOREST: {
            Pokemon.CATERPIE: 0.125,
            Pokemon.WEEDLE: 0.1875,
            Pokemon.PIDGEY: 0.125,
            Pokemon.RATTATA: 0.125,
            Pokemon.PIKACHU: 0.4375,
        },
        Maps.PEWTER_CITY: {
            Pokemon.PIDGEY: 0.125,
            Pokemon.SPEAROW: 0.1875,
            Pokemon.EKANS: 0.25,
            Pokemon.JIGGLYPUFF: 0.1875,
            Pokemon.MAGIKARP: 0.25,
        },
        Maps.CERULEAN_CITY: {
            Pokemon.CATERPIE: 0.0625,
            Pokemon.NIDORAN_M: 0.0625,
            Pokemon.ODDISH: 0.0625,
            Pokemon.PSYDUCK: 0.125,
            Pokemon.MANKEY: 0.125,
            Pokemon.ABRA: 0.1875,
            Pokemon.KRABBY: 0.0625,
            Pokemon.GOLDEEN: 0.125,
            Pokemon.JYNX: 0.1875,
        },
        Maps.VERMILION_SEASIDE: {
            Pokemon.EKANS: 0.25,
            Pokemon.ODDISH: 0.0625,
            Pokemon.MANKEY: 0.0625,
            Pokemon.FARFETCH_D: 0.25,
            Pokemon.SHELLDER: 0.125,
            Pokemon.DROWZEE: 0.125,
            Pokemon.KRABBY: 0.125,
        },
        Maps.ROCK_MOUNTAIN: {
            Pokemon.ZUBAT: 0.125,
            Pokemon.DIGLETT: 0.0625,
            Pokemon.MACHOP: 0.125,
            Pokemon.GEODUDE: 0.125,
            Pokemon.SLOWPOKE: 0.125,
            Pokemon.ONIX: 0.125,
            Pokemon.VOLTORB: 0.125,
            Pokemon.MR_MIME: 0.1875,
        },
        Maps.LAVENDER_TOWN: {
            Pokemon.EKANS: 0.0625,
            Pokemon.MANKEY: 0.0625,
            Pokemon.GROWLITHE: 0.0625,
            Pokemon.MAGNEMITE: 0.125,
            Pokemon.GASTLY: 0.125,
            Pokemon.CUBONE: 0.1875,
            Pokemon.ELECTABUZZ: 0.1875,
            Pokemon.ZAPDOS: 0.1875,
        },
        Maps.CYCLING_ROAD: {
            Pokemon.TENTACOOL: 0.0625,
            Pokemon.DODUO: 0.3125,
            Pokemon.KRABBY: 0.0625,
            Pokemon.LICKITUNG: 0.25,
            Pokemon.GOLDEEN: 0.0625,
            Pokemon.MAGIKARP: 0.0625,
            Pokemon.SNORLAX: 0.1875,
        },
        Maps.SAFARI_ZONE: {
            Pokemon.NIDORAN_M: 0.125,
            Pokemon.PARAS: 0.125,
            Pokemon.RHYHORN: 0.125,
            Pokemon.CHANSEY: 0.25,
            Pokemon.SCYTHER: 0.125,
            Pokemon.TAUROS: 0.125,
            Pokemon.DRATINI: 0.125,
        },
        Maps.SEAFOAM_ISLANDS: {Pokemon.SEEL: 0.3125, Pokemon.GOLDEEN: 0.25, Pokemon.STARYU: 0.25, Pokemon.ARTICUNO: 0.1875},
        Maps.CINNABAR_ISLAND: {
            Pokemon.GROWLITHE: 0.125,
            Pokemon.PONYTA: 0.125,
            Pokemon.GRIMER: 0.0625,
            Pokemon.KOFFING: 0.125,
            Pokemon.TANGELA: 0.1875,
            Pokemon.OMANYTE: 0.1875,
            Pokemon.KABUTO: 0.1875,
        },
        Maps.INDIGO_PLATEAU: {
            Pokemon.SPEAROW: 0.0625,
            Pokemon.EKANS: 0.0625,
            Pokemon.ZUBAT: 0.0625,
            Pokemon.MACHOP: 0.0625,
            Pokemon.GEODUDE: 0.0625,
            Pokemon.ONIX: 0.0625,
            Pokemon.DITTO: 0.25,
            Pokemon.MOLTRES: 0.1875,
            Pokemon.MEWTWO: 0.1875,
            Pokemon.MEW: 0.0625,
        },
    }
    """The rare wild Pokemon that can be found in each map in the Red stage, along with their encounter rates"""

    BlueStageMapWildMons = {
        Maps.VIRIDIAN_CITY: {
            Pokemon.BULBASAUR: 0.0625,
            Pokemon.SQUIRTLE: 0.3125,
            Pokemon.SPEAROW: 0.0625,
            Pokemon.NIDORAN_F: 0.1875,
            Pokemon.NIDORAN_M: 0.1875,
            Pokemon.POLIWAG: 0.0625,
            Pokemon.TENTACOOL: 0.0625,
            Pokemon.GOLDEEN: 0.0625,
        },
        Maps.VIRIDIAN_FOREST: {
            Pokemon.CATERPIE: 0.3125,
            Pokemon.PIDGEY: 0.3125,
            Pokemon.RATTATA: 0.3125,
            Pokemon.PIKACHU: 0.0625,
        },
        Maps.MT_MOON: {
            Pokemon.RATTATA: 0.0625,
            Pokemon.SPEAROW: 0.125,
            Pokemon.EKANS: 0.125,
            Pokemon.SANDSHREW: 0.125,
            Pokemon.ZUBAT: 0.125,
            Pokemon.PARAS: 0.125,
            Pokemon.PSYDUCK: 0.0625,
            Pokemon.GEODUDE: 0.125,
            Pokemon.KRABBY: 0.0625,
            Pokemon.GOLDEEN: 0.0625,
        },
        Maps.CERULEAN_CITY: {
            Pokemon.CATERPIE: 0.125,
            Pokemon.PIDGEY: 0.0625,
            Pokemon.MEOWTH: 0.1875,
            Pokemon.PSYDUCK: 0.0625,
            Pokemon.ABRA: 0.125,
            Pokemon.BELLSPROUT: 0.3125,
            Pokemon.KRABBY: 0.0625,
            Pokemon.GOLDEEN: 0.0625,
        },
        Maps.VERMILION_STREETS: {
            Pokemon.PIDGEY: 0.0625,
            Pokemon.SPEAROW: 0.0625,
            Pokemon.SANDSHREW: 0.125,
            Pokemon.MEOWTH: 0.125,
            Pokemon.BELLSPROUT: 0.125,
            Pokemon.SHELLDER: 0.1875,
            Pokemon.DROWZEE: 0.125,
            Pokemon.KRABBY: 0.1875,
        },
        Maps.ROCK_MOUNTAIN: {
            Pokemon.RATTATA: 0.0625,
            Pokemon.SPEAROW: 0.0625,
            Pokemon.SANDSHREW: 0.125,
            Pokemon.ZUBAT: 0.0625,
            Pokemon.DIGLETT: 0.25,
            Pokemon.MACHOP: 0.0625,
            Pokemon.GEODUDE: 0.0625,
            Pokemon.SLOWPOKE: 0.0625,
            Pokemon.ONIX: 0.0625,
            Pokemon.VOLTORB: 0.1875,
        },
        Maps.CELADON_CITY: {
            Pokemon.PIDGEY: 0.125,
            Pokemon.VULPIX: 0.125,
            Pokemon.ODDISH: 0.125,
            Pokemon.MEOWTH: 0.1875,
            Pokemon.MANKEY: 0.1875,
            Pokemon.GROWLITHE: 0.125,
            Pokemon.BELLSPROUT: 0.125,
        },
        Maps.FUCHSIA_CITY: {
            Pokemon.VENONAT: 0.125,
            Pokemon.KRABBY: 0.1875,
            Pokemon.EXEGGCUTE: 0.125,
            Pokemon.KANGASKHAN: 0.125,
            Pokemon.GOLDEEN: 0.1875,
            Pokemon.MAGIKARP: 0.25,
        },
        Maps.SAFARI_ZONE: {Pokemon.NIDORAN_F: 0.25, Pokemon.PARAS: 0.25, Pokemon.DODUO: 0.25, Pokemon.RHYHORN: 0.25},
        Maps.SAFFRON_CITY: {
            Pokemon.PIDGEY: 0.125,
            Pokemon.EKANS: 0.1875,
            Pokemon.SANDSHREW: 0.1875,
            Pokemon.VULPIX: 0.0625,
            Pokemon.ODDISH: 0.125,
            Pokemon.MEOWTH: 0.0625,
            Pokemon.MANKEY: 0.0625,
            Pokemon.GROWLITHE: 0.0625,
            Pokemon.BELLSPROUT: 0.125,
        },
        Maps.CINNABAR_ISLAND: {
            Pokemon.VULPIX: 0.1875,
            Pokemon.PONYTA: 0.3125,
            Pokemon.GRIMER: 0.125,
            Pokemon.KOFFING: 0.25,
            Pokemon.TANGELA: 0.125,
        },
        Maps.INDIGO_PLATEAU: {
            Pokemon.SPEAROW: 0.0625,
            Pokemon.SANDSHREW: 0.0625,
            Pokemon.ZUBAT: 0.125,
            Pokemon.MACHOP: 0.1875,
            Pokemon.GEODUDE: 0.1875,
            Pokemon.ONIX: 0.1875,
            Pokemon.DITTO: 0.1875,
        },
    }
    """The wild Pokemon that can be found in each map in the Blue stage, along with their encounter rates"""

    BlueStageMapWildMonsRare = {
        Maps.VIRIDIAN_CITY: {
            Pokemon.BULBASAUR: 0.1875,
            Pokemon.SQUIRTLE: 0.0625,
            Pokemon.SPEAROW: 0.125,
            Pokemon.NIDORAN_F: 0.125,
            Pokemon.NIDORAN_M: 0.125,
            Pokemon.POLIWAG: 0.125,
            Pokemon.TENTACOOL: 0.125,
            Pokemon.GOLDEEN: 0.125,
        },
        Maps.VIRIDIAN_FOREST: {
            Pokemon.CATERPIE: 0.1875,
            Pokemon.WEEDLE: 0.125,
            Pokemon.PIDGEY: 0.125,
            Pokemon.RATTATA: 0.125,
            Pokemon.PIKACHU: 0.4375,
        },
        Maps.MT_MOON: {
            Pokemon.EKANS: 0.125,
            Pokemon.SANDSHREW: 0.125,
            Pokemon.CLEFAIRY: 0.375,
            Pokemon.ZUBAT: 0.125,
            Pokemon.PARAS: 0.125,
            Pokemon.GEODUDE: 0.125,
        },
        Maps.CERULEAN_CITY: {
            Pokemon.WEEDLE: 0.0625,
            Pokemon.NIDORAN_M: 0.0625,
            Pokemon.MEOWTH: 0.125,
            Pokemon.PSYDUCK: 0.125,
            Pokemon.ABRA: 0.1875,
            Pokemon.BELLSPROUT: 0.0625,
            Pokemon.KRABBY: 0.0625,
            Pokemon.GOLDEEN: 0.125,
            Pokemon.JYNX: 0.1875,
        },
        Maps.VERMILION_STREETS: {
            Pokemon.SANDSHREW: 0.25,
            Pokemon.MEOWTH: 0.0625,
            Pokemon.BELLSPROUT: 0.0625,
            Pokemon.FARFETCH_D: 0.25,
            Pokemon.SHELLDER: 0.125,
            Pokemon.DROWZEE: 0.125,
            Pokemon.KRABBY: 0.125,
        },
        Maps.ROCK_MOUNTAIN: {
            Pokemon.ZUBAT: 0.125,
            Pokemon.DIGLETT: 0.0625,
            Pokemon.MACHOP: 0.125,
            Pokemon.GEODUDE: 0.125,
            Pokemon.SLOWPOKE: 0.125,
            Pokemon.ONIX: 0.125,
            Pokemon.VOLTORB: 0.125,
            Pokemon.MR_MIME: 0.1875,
        },
        Maps.CELADON_CITY: {
            Pokemon.CLEFAIRY: 0.125,
            Pokemon.ABRA: 0.125,
            Pokemon.SCYTHER: 0.0625,
            Pokemon.PINSIR: 0.0625,
            Pokemon.EEVEE: 0.1875,
            Pokemon.PORYGON: 0.25,
            Pokemon.DRATINI: 0.1875,
        },
        Maps.FUCHSIA_CITY: {
            Pokemon.VENONAT: 0.25,
            Pokemon.KRABBY: 0.0625,
            Pokemon.EXEGGCUTE: 0.25,
            Pokemon.KANGASKHAN: 0.25,
            Pokemon.GOLDEEN: 0.0625,
            Pokemon.MAGIKARP: 0.125,
        },
        Maps.SAFARI_ZONE: {
            Pokemon.NIDORAN_F: 0.125,
            Pokemon.PARAS: 0.125,
            Pokemon.RHYHORN: 0.125,
            Pokemon.CHANSEY: 0.25,
            Pokemon.PINSIR: 0.125,
            Pokemon.TAUROS: 0.125,
            Pokemon.DRATINI: 0.125,
        },
        Maps.SAFFRON_CITY: {
            Pokemon.PIDGEY: 0.0625,
            Pokemon.EKANS: 0.0625,
            Pokemon.SANDSHREW: 0.0625,
            Pokemon.VULPIX: 0.0625,
            Pokemon.MEOWTH: 0.0625,
            Pokemon.MANKEY: 0.0625,
            Pokemon.GROWLITHE: 0.0625,
            Pokemon.HITMONLEE: 0.1875,
            Pokemon.HITMONCHAN: 0.1875,
            Pokemon.LAPRAS: 0.1875,
        },
        Maps.CINNABAR_ISLAND: {
            Pokemon.VULPIX: 0.0625,
            Pokemon.PONYTA: 0.125,
            Pokemon.GRIMER: 0.125,
            Pokemon.KOFFING: 0.125,
            Pokemon.TANGELA: 0.1875,
            Pokemon.MAGMAR: 0.1875,
            Pokemon.AERODACTYL: 0.1875,
        },
        Maps.INDIGO_PLATEAU: {
            Pokemon.SPEAROW: 0.0625,
            Pokemon.SANDSHREW: 0.0625,
            Pokemon.ZUBAT: 0.0625,
            Pokemon.MACHOP: 0.0625,
            Pokemon.GEODUDE: 0.0625,
            Pokemon.ONIX: 0.0625,
            Pokemon.DITTO: 0.25,
            Pokemon.MOLTRES: 0.1875,
            Pokemon.MEWTWO: 0.1875,
            Pokemon.MEW: 0.0625,
        },
    }
    """The rare wild Pokemon that can be found in each map in the Blue stage, along with their encounter rates"""

## Global variables

`var MAX_SCORE`

  The maximum score possible, multiplied by ten to add the implied extra 0 the game uses

`var RedStageMapWildMons`

  The wild Pokemon that can be found in each map in the Red stage, along with their encounter rates

`var RedStageMapWildMonsRare`

  The rare wild Pokemon that can be found in each map in the Red stage, along with their encounter rates

`var BlueStageMapWildMons`

  The wild Pokemon that can be found in each map in the Blue stage, along with their encounter rates

`var BlueStageMapWildMonsRare`

  The rare wild Pokemon that can be found in each map in the Blue stage, along with their encounter rates

## Classes

`class Stage (*args, **kwds)`

  The stage values in the game.

  Expand source code

      class Stage(Enum):
          """
          The stage values in the game.
          """

          RED_TOP = 0
          RED_BOTTOM = 1
          BLUE_TOP = 4
          BLUE_BOTTOM = 5
          GENGAR = 7
          MEWTWO = 9
          MEOWTH = 11
          DIGLETT = 13
          SEEL = 15

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var RED_TOP`
  `var RED_BOTTOM`
  `var BLUE_TOP`
  `var BLUE_BOTTOM`
  `var GENGAR`
  `var MEWTWO`
  `var MEOWTH`
  `var DIGLETT`
  `var SEEL`
`class Pokemon (*args, **kwds)`

  The Pokemon values in the game.

  Expand source code

      class Pokemon(Enum):
          """
          The Pokemon values in the game.
          """

          BULBASAUR = 0
          IVYSAUR = 1
          VENUSAUR = 2
          CHARMANDER = 3
          CHARMELEON = 4
          CHARIZARD = 5
          SQUIRTLE = 6
          WARTORTLE = 7
          BLASTOISE = 8
          CATERPIE = 9
          METAPOD = 10
          BUTTERFREE = 11
          WEEDLE = 12
          KAKUNA = 13
          BEEDRILL = 14
          PIDGEY = 15
          PIDGEOTTO = 16
          PIDGEOT = 17
          RATTATA = 18
          RATICATE = 19
          SPEAROW = 20
          FEAROW = 21
          EKANS = 22
          ARBOK = 23
          PIKACHU = 24
          RAICHU = 25
          SANDSHREW = 26
          SANDSLASH = 27
          NIDORAN_F = 28
          NIDORINA = 29
          NIDOQUEEN = 30
          NIDORAN_M = 31
          NIDORINO = 32
          NIDOKING = 33
          CLEFAIRY = 34
          CLEFABLE = 35
          VULPIX = 36
          NINETALES = 37
          JIGGLYPUFF = 38
          WIGGLYTUFF = 39
          ZUBAT = 40
          GOLBAT = 41
          ODDISH = 42
          GLOOM = 43
          VILEPLUME = 44
          PARAS = 45
          PARASECT = 46
          VENONAT = 47
          VENOMOTH = 48
          DIGLETT = 49
          DUGTRIO = 50
          MEOWTH = 51
          PERSIAN = 52
          PSYDUCK = 53
          GOLDUCK = 54
          MANKEY = 55
          PRIMEAPE = 56
          GROWLITHE = 57
          ARCANINE = 58
          POLIWAG = 59
          POLIWHIRL = 60
          POLIWRATH = 61
          ABRA = 62
          KADABRA = 63
          ALAKAZAM = 64
          MACHOP = 65
          MACHOKE = 66
          MACHAMP = 67
          BELLSPROUT = 68
          WEEPINBELL = 69
          VICTREEBEL = 70
          TENTACOOL = 71
          TENTACRUEL = 72
          GEODUDE = 73
          GRAVELER = 74
          GOLEM = 75
          PONYTA = 76
          RAPIDASH = 77
          SLOWPOKE = 78
          SLOWBRO = 79
          MAGNEMITE = 80
          MAGNETON = 81
          FARFETCH_D = 82
          DODUO = 83
          DODRIO = 84
          SEEL = 85
          DEWGONG = 86
          GRIMER = 87
          MUK = 88
          SHELLDER = 89
          CLOYSTER = 90
          GASTLY = 91
          HAUNTER = 92
          GENGAR = 93
          ONIX = 94
          DROWZEE = 95
          HYPNO = 96
          KRABBY = 97
          KINGLER = 98
          VOLTORB = 99
          ELECTRODE = 100
          EXEGGCUTE = 101
          EXEGGUTOR = 102
          CUBONE = 103
          MAROWAK = 104
          HITMONLEE = 105
          HITMONCHAN = 106
          LICKITUNG = 107
          KOFFING = 108
          WEEZING = 109
          RHYHORN = 110
          RHYDON = 111
          CHANSEY = 112
          TANGELA = 113
          KANGASKHAN = 114
          HORSEA = 115
          SEADRA = 116
          GOLDEEN = 117
          SEAKING = 118
          STARYU = 119
          STARMIE = 120
          MR_MIME = 121
          SCYTHER = 122
          JYNX = 123
          ELECTABUZZ = 124
          MAGMAR = 125
          PINSIR = 126
          TAUROS = 127
          MAGIKARP = 128
          GYARADOS = 129
          LAPRAS = 130
          DITTO = 131
          EEVEE = 132
          VAPOREON = 133
          JOLTEON = 134
          FLAREON = 135
          PORYGON = 136
          OMANYTE = 137
          OMASTAR = 138
          KABUTO = 139
          KABUTOPS = 140
          AERODACTYL = 141
          SNORLAX = 142
          ARTICUNO = 143
          ZAPDOS = 144
          MOLTRES = 145
          DRATINI = 146
          DRAGONAIR = 147
          DRAGONITE = 148
          MEWTWO = 149
          MEW = 150

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var BULBASAUR`
  `var IVYSAUR`
  `var VENUSAUR`
  `var CHARMANDER`
  `var CHARMELEON`
  `var CHARIZARD`
  `var SQUIRTLE`
  `var WARTORTLE`
  `var BLASTOISE`
  `var CATERPIE`
  `var METAPOD`
  `var BUTTERFREE`
  `var WEEDLE`
  `var KAKUNA`
  `var BEEDRILL`
  `var PIDGEY`
  `var PIDGEOTTO`
  `var PIDGEOT`
  `var RATTATA`
  `var RATICATE`
  `var SPEAROW`
  `var FEAROW`
  `var EKANS`
  `var ARBOK`
  `var PIKACHU`
  `var RAICHU`
  `var SANDSHREW`
  `var SANDSLASH`
  `var NIDORAN_F`
  `var NIDORINA`
  `var NIDOQUEEN`
  `var NIDORAN_M`
  `var NIDORINO`
  `var NIDOKING`
  `var CLEFAIRY`
  `var CLEFABLE`
  `var VULPIX`
  `var NINETALES`
  `var JIGGLYPUFF`
  `var WIGGLYTUFF`
  `var ZUBAT`
  `var GOLBAT`
  `var ODDISH`
  `var GLOOM`
  `var VILEPLUME`
  `var PARAS`
  `var PARASECT`
  `var VENONAT`
  `var VENOMOTH`
  `var DIGLETT`
  `var DUGTRIO`
  `var MEOWTH`
  `var PERSIAN`
  `var PSYDUCK`
  `var GOLDUCK`
  `var MANKEY`
  `var PRIMEAPE`
  `var GROWLITHE`
  `var ARCANINE`
  `var POLIWAG`
  `var POLIWHIRL`
  `var POLIWRATH`
  `var ABRA`
  `var KADABRA`
  `var ALAKAZAM`
  `var MACHOP`
  `var MACHOKE`
  `var MACHAMP`
  `var BELLSPROUT`
  `var WEEPINBELL`
  `var VICTREEBEL`
  `var TENTACOOL`
  `var TENTACRUEL`
  `var GEODUDE`
  `var GRAVELER`
  `var GOLEM`
  `var PONYTA`
  `var RAPIDASH`
  `var SLOWPOKE`
  `var SLOWBRO`
  `var MAGNEMITE`
  `var MAGNETON`
  `var FARFETCH_D`
  `var DODUO`
  `var DODRIO`
  `var SEEL`
  `var DEWGONG`
  `var GRIMER`
  `var MUK`
  `var SHELLDER`
  `var CLOYSTER`
  `var GASTLY`
  `var HAUNTER`
  `var GENGAR`
  `var ONIX`
  `var DROWZEE`
  `var HYPNO`
  `var KRABBY`
  `var KINGLER`
  `var VOLTORB`
  `var ELECTRODE`
  `var EXEGGCUTE`
  `var EXEGGUTOR`
  `var CUBONE`
  `var MAROWAK`
  `var HITMONLEE`
  `var HITMONCHAN`
  `var LICKITUNG`
  `var KOFFING`
  `var WEEZING`
  `var RHYHORN`
  `var RHYDON`
  `var CHANSEY`
  `var TANGELA`
  `var KANGASKHAN`
  `var HORSEA`
  `var SEADRA`
  `var GOLDEEN`
  `var SEAKING`
  `var STARYU`
  `var STARMIE`
  `var MR_MIME`
  `var SCYTHER`
  `var JYNX`
  `var ELECTABUZZ`
  `var MAGMAR`
  `var PINSIR`
  `var TAUROS`
  `var MAGIKARP`
  `var GYARADOS`
  `var LAPRAS`
  `var DITTO`
  `var EEVEE`
  `var VAPOREON`
  `var JOLTEON`
  `var FLAREON`
  `var PORYGON`
  `var OMANYTE`
  `var OMASTAR`
  `var KABUTO`
  `var KABUTOPS`
  `var AERODACTYL`
  `var SNORLAX`
  `var ARTICUNO`
  `var ZAPDOS`
  `var MOLTRES`
  `var DRATINI`
  `var DRAGONAIR`
  `var DRAGONITE`
  `var MEWTWO`
  `var MEW`
`class Maps (*args, **kwds)`

  The map values in the game.

  Expand source code

      class Maps(Enum):
          """
          The map values in the game.
          """

          PALLET_TOWN = 0
          VIRIDIAN_CITY = 1
          VIRIDIAN_FOREST = 2
          PEWTER_CITY = 3
          MT_MOON = 4
          CERULEAN_CITY = 5
          VERMILION_SEASIDE = 6
          VERMILION_STREETS = 7
          ROCK_MOUNTAIN = 8
          LAVENDER_TOWN = 9
          CELADON_CITY = 10
          CYCLING_ROAD = 11
          FUCHSIA_CITY = 12
          SAFARI_ZONE = 13
          SAFFRON_CITY = 14
          SEAFOAM_ISLANDS = 15
          CINNABAR_ISLAND = 16
          INDIGO_PLATEAU = 17

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var PALLET_TOWN`
  `var VIRIDIAN_CITY`
  `var VIRIDIAN_FOREST`
  `var PEWTER_CITY`
  `var MT_MOON`
  `var CERULEAN_CITY`
  `var VERMILION_SEASIDE`
  `var VERMILION_STREETS`
  `var ROCK_MOUNTAIN`
  `var LAVENDER_TOWN`
  `var CELADON_CITY`
  `var CYCLING_ROAD`
  `var FUCHSIA_CITY`
  `var SAFARI_ZONE`
  `var SAFFRON_CITY`
  `var SEAFOAM_ISLANDS`
  `var CINNABAR_ISLAND`
  `var INDIGO_PLATEAU`
`class SpecialMode (*args, **kwds)`

  Create a collection of name/value pairs.

  Example enumeration:

      >>> class Color(Enum):
      ...     RED = 1
      ...     BLUE = 2
      ...     GREEN = 3

  Access them by:

  - attribute access::

      >>> Color.RED
      <Color.RED: 1>

  - value lookup:

      >>> Color(1)
      <Color.RED: 1>

  - name lookup:

      >>> Color['RED']
      <Color.RED: 1>

  Enumerations can be iterated over, and know how many members they have:

      >>> len(Color)
      3

      >>> list(Color)
      [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

  Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

  Expand source code

      class SpecialMode(Enum):
          CATCH = 0
          EVOLVE = 1
          STAGE_CHANGE = 2

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var CATCH`
  `var EVOLVE`
  `var STAGE_CHANGE`
`class BallType (*args, **kwds)`

  Create a collection of name/value pairs.

  Example enumeration:

      >>> class Color(Enum):
      ...     RED = 1
      ...     BLUE = 2
      ...     GREEN = 3

  Access them by:

  - attribute access::

      >>> Color.RED
      <Color.RED: 1>

  - value lookup:

      >>> Color(1)
      <Color.RED: 1>

  - name lookup:

      >>> Color['RED']
      <Color.RED: 1>

  Enumerations can be iterated over, and know how many members they have:

      >>> len(Color)
      3

      >>> list(Color)
      [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

  Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

  Expand source code

      class BallType(Enum):
          POKEBALL = 0
          GREATBALL = 2
          ULTRABALL = 3
          MASTERBALL = 4

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var POKEBALL`
  `var GREATBALL`
  `var ULTRABALL`
  `var MASTERBALL`
`class BallSize (*args, **kwds)`

  Create a collection of name/value pairs.

  Example enumeration:

      >>> class Color(Enum):
      ...     RED = 1
      ...     BLUE = 2
      ...     GREEN = 3

  Access them by:

  - attribute access::

      >>> Color.RED
      <Color.RED: 1>

  - value lookup:

      >>> Color(1)
      <Color.RED: 1>

  - name lookup:

      >>> Color['RED']
      <Color.RED: 1>

  Enumerations can be iterated over, and know how many members they have:

      >>> len(Color)
      3

      >>> list(Color)
      [<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

  Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

  Expand source code

      class BallSize(Enum):
          DEFAULT = 0
          MINI = 1
          SUPERMINI = 2

  ### Ancestors

  - enum.Enum

  ### Class variables

  `var DEFAULT`
  `var MINI`
  `var SUPERMINI`
`class GameWrapperPokemonPinball (*args, **kwargs)`

  This class wraps Pokemon Pinball, and provides access to game info for AIs.

  Expand source code

      class GameWrapperPokemonPinball(PyBoyGameWrapper):
          """
          This class wraps Pokemon Pinball, and provides access to game info for AIs.
          """

          cartridge_title = "POKEPINBALLVPH"

          def __init__(self, *args, **kwargs):
              self.shape = (20, 16)
              """The shape of the game area"""
              self.score = 0
              """The score provided by the game"""
              self.balls_left = 0
              """The lives remaining provided by the game"""
              self.game_over = False
              """The game over state"""
              self.ball_type = BallType.POKEBALL.value
              """The current ball type"""
              self.multiplier = 1
              """The current multiplier"""
              self.current_stage = 0
              """The current stage"""
              self.ball_size = 0
              self.ball_saver_seconds_left = 0
              """The current ball saver seconds left"""
              self.pokedex = [False] * 151
              self._unlimited_saver = False
              self.ball_x = 0
              """The x position of the ball"""
              self.ball_y = 0
              """The y position of the ball"""
              self.ball_x_velocity = 0
              """The x velocity of the ball"""
              self.ball_y_velocity = 0
              """The y velocity of the ball"""
              self.special_mode = 0
              """
              The special mode state value

              Example:
              ```python
              >>> from pyboy.plugins.game_wrapper_pokemon_pinball import SpecialMode
              >>> pyboy = PyBoy(pokemon_pinball_rom)
              >>> pyboy.game_wrapper.special_mode == SpecialMode.CATCH.value
              True
              ```
              """

              self.special_mode_active = False
              """The special mode active state"""

              ##########################
              # Fitness Related Values #
              ##########################

              ######################
              # Evolution tracking #
              ######################
              self.evolution_failure_count = 0
              """The number of times an evolution has failed"""
              self.evolution_success_count = 0
              """The number of times an evolution has succeeded"""

              ########################
              # Bonus stage tracking #
              ########################
              self.diglett_stages_completed = 0
              """The number of Diglett stages completed"""
              self.diglett_stages_visited = 0
              """The number of Diglett stages visited"""
              self.gengar_stages_completed = 0
              """The number of Gengar stages completed"""
              self.gengar_stages_visited = 0
              """The number of Gengar stages visited"""
              self.meowth_stages_completed = 0
              """The number of Meowth stages completed"""
              self.meowth_stages_visited = 0
              """The number of Meowth stages visited"""
              self.mewtwo_stages_completed = 0
              """The number of Mewtwo stages completed"""
              self.mewtwo_stages_visited = 0
              """The number of Mewtwo stages visited"""
              self.seel_stages_completed = 0
              """The number of Seel stages completed"""
              self.seel_stages_visited = 0
              """The number of Seel stages visited"""

              ##########################
              # Pikachu Saver tracking #
              ##########################
              self.pikachu_saver_charge = 0  # range of 0-15
              """The charge of the Pikachu saver, ranges from 0 to 15"""
              self.pikachu_saver_increments = 0
              """The number of times the Pikachu saver charge has incremented"""
              self.pikachu_saver_used = 0
              """The number of times the Pikachu saver has been used"""

              ################
              # Map tracking #
              ################
              self.current_map = 0
              """The current map

              Example:
              ```python
              >>> from pyboy.plugins.game_wrapper_pokemon_pinball import Maps
              >>> pyboy = PyBoy(pokemon_pinball_rom)
              >>> pyboy.game_wrapper.current_map == Maps.PALLET_TOWN.value
              True
              ```
              """
              self.map_change_attempts = 0
              """The number of times a map change has been attempted"""
              self.map_change_successes = 0
              """The number of times a map change has been successful"""

              ###########################
              # Pokemon Caught Tracking #
              ###########################
              self.pokemon_caught_in_session = 0
              """The number of pokemon caught in the current session"""
              self.pokemon_seen_in_session = 0
              """The number of pokemon seen in the current session"""

              #########################
              # Ball upgrade Tracking #
              #########################
              self.great_ball_upgrades = 0
              """The number of Great Ball upgrades obtained"""
              self.ultra_ball_upgrades = 0
              """The number of Ultra Ball upgrades obtained"""
              self.master_ball_upgrades = 0
              """The number of Master Ball upgrades obtained"""

              #######################
              # Extra Ball Tracking #
              #######################
              self.extra_balls_added = 0  # Does not include extra balls rewarded via roulette
              """The number of extra balls added, not including those rewarded via roulette"""

              ##########################
              # Lost Ball During Saver #
              ##########################
              self.lost_ball_during_saver = 0
              """The number of balls lost during a saver mode"""

              #################
              # Slot Tracking #
              #################
              self.roulette_slots_opened = 0
              """The number of roulette slots opened"""
              self.roulette_slots_entered = 0
              """The number of roulette slots entered"""

              super().__init__(*args, game_area_section=(0, 0) + self.shape, game_area_follow_scxy=True, **kwargs)

              if not self.enabled():
                  return

              self._add_hooks()

          def _update_pokedex(self):
              for pokemon in Pokemon:
                  self.pokedex[pokemon.value] = self.pyboy.memory[ADDR_POKEDEX + pokemon.value]

          def has_pokemon(self, pokemon):
              """
              Check if the player has caught the given pokemon

              Args:
                  pokemon (Pokemon): The pokemon to check for
              """
              return self.pokedex[pokemon.value] == 2

          def set_unlimited_saver(self, unlimited_saver=True):
              """
              Sets the unlimited saver mode in the game.

              This function allows for an unlimited saver option in the game.

              Parameters:
              unlimited_saver (bool, optional): If True, the saver mode in the game is unlimited. Defaults to True.

              Returns:
              None
              """
              self._unlimited_saver = unlimited_saver

          def _set_stage(self, stage):
              """
              Override rom memory to set the default stage to the desired stage
              Bonus stages require further initialization
              This method should be called before the game starts

              No ops out these asm lines:
                  jr z, .pressedB
                  ld a, [wSelectedFieldIndex]
                  ld c, a
                  ld b, $0
                  ld hl, StartingStages
                  add hl, bc
                  ld a, [hl]

              Inserts the following asm:
                  ld a, stage.value

              Kwargs:
                  stage (Stage): The stage to set the game to.
              """

              if stage is None:
                  return
              for i in range(NO_OP_BYTE_WIDTH_STAGE_OVERRIDE):
                  # equivalent to no op
                  self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE + i] = 0x00
              # equivalent to ld a, stage.value
              self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE] = 0b00111110
              self.pyboy.memory[ADDR_TO_NO_OP_BANK_STAGE_OVERRIDE, ADDR_TO_NO_OP_STAGE_OVERRIDE + 1] = stage.value

          def _init_bonus_stage(self, stage):
              # set backup stage if it is a bonus stage
              if stage in RedBonusStages:
                  self.pyboy.memory[ADDR_CURRENT_STAGE_BACKUP] = Stage.RED_BOTTOM.value
              elif stage in BlueBonusStages:
                  self.pyboy.memory[ADDR_CURRENT_STAGE_BACKUP] = Stage.BLUE_BOTTOM.value

              # do initializations skipped by loading bonus stage instead of main stage
              if stage in RedBonusStages or stage in BlueBonusStages:
                  self.pyboy.memory[ADDR_CURRENT_SLOT_FRAME] = CURRENT_SLOT_FRAME_VALUE
                  self.pyboy.memory[ADDR_BALLS_LEFT] = 1
                  self.pyboy.memory[ADDR_NUM_BALL_LIVES] = 3
                  self.pyboy.memory[ADDR_STAGE_COLLISION_STATE] = 0b100
                  self.pyboy.memory[ADDR_STAGE_COLLISION_STATE_HELPER] = 0b100

          def start_catch_mode(self, pokemon=Pokemon.BULBASAUR, unlimited_time=False):
              """
              Starts the catch mode in the game. NOTE: This method does not change stage specific values and may need a top/bottom stage change to work properly.

              This function sets up the game state for catch mode, including the Pokemon to catch and the game timer.

              Parameters:
              pokemon (Pokemon, optional): The Pokemon to catch in this mode. Defaults to Pokemon.BULBASAUR.
              unlimited_time (bool, optional): If True, the game timer is not activated, giving unlimited time in catch mode. Defaults to False.

              Returns:
              None
              """
              # All values are based on PRET disassembly
              self.pyboy.memory[ADDR_SPECIAL_MODE] = SpecialMode.CATCH.value
              self.pyboy.memory[ADDR_POKEMON_TO_CATCH] = pokemon.value
              self.pyboy.memory[ADDR_SPECIAL_MODE_ACTIVE] = 1
              self.pyboy.memory[ADDR_SPECIAL_MODE_STATE] = 0
              self.pyboy.memory[ADDR_D5C6] = 0
              self.pyboy.memory[ADDR_NUM_MON_HITS] = 0
              self.pyboy.memory[ADDR_NUM_CATCH_TILES_FLIPPED] = 0
              self.pyboy.memory[ADDR_TILE_ILLUMINATION : ADDR_TILE_ILLUMINATION + TILE_ILLUMINATION_BYTE_WIDTH] = 0
              if not unlimited_time:
                  self.pyboy.memory[ADDR_TIMER_SECONDS] = 0
                  self.pyboy.memory[ADDR_TIMER_MINUTES] = 2
                  self.pyboy.memory[ADDR_TIMER_FRAMES] = 0
                  self.pyboy.memory[ADDR_TIMER_RAN_OUT] = 0
                  self.pyboy.memory[ADDR_TIMER_PAUSED] = 0
                  self.pyboy.memory[ADDR_TIMER_ACTIVE] = 1
                  self.pyboy.memory[ADDR_D580] = 1

          # replaces pause button with evolution start
          def enable_evolve_hack(self, unlimited_time=False):
              """
              Enables the evolution hack in the game.

              This function replaces the pause button with the evolution start method. It also allows for an unlimited time option.

              Parameters:
              unlimited_time (bool, optional): If True, the game timer is disabled, giving unlimited time in the game. Defaults to False.

              Returns:
              None
              """
              bank_addr_evo = BANK_OFFSET_START_EVOLUTION

              lower_8bits = bank_addr_evo[1] & 0xFF
              upper_8bits = (bank_addr_evo[1] >> 8) & 0xFF

              bank_addr_pause = BANK_OFFSET_PAUSE_METHOD_CALL

              self.pyboy.memory[BANK_OFFSET_PAUSE_METHOD_BANK] = bank_addr_evo[0]
              self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1]] = lower_8bits
              self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1] + 1] = upper_8bits
              if unlimited_time:

                  def disable_timer(context):
                      context.memory[ADDR_TIMER_ACTIVE] = 0

                  bank = BANK_OFFSET_DISABLE_TIMER[0]
                  offset = BANK_OFFSET_DISABLE_TIMER[1]
                  try:
                      self.pyboy.hook_register(bank, offset, disable_timer, self.pyboy)
                  except ValueError:
                      pass  # hook already exists

          def current_map_completed(self):
              """
              Determines if all Pokemon in the current map have been caught.

              This function checks whether all Pokemon, both common and rare, in the current stage's map have been caught.
              It supports both Red and Blue stages. If any Pokemon in the map has not been caught, the function returns False.
              If all Pokemon have been caught, it returns True.

              Returns:
              bool: True if all Pokemon in the current map have been caught, False otherwise.
              """
              if self.current_stage in RedStages:
                  for pokemon in RedStageMapWildMons[self.current_map]:
                      if not self.has_pokemon(pokemon):
                          return False
                  for pokemon in RedStageMapWildMonsRare[self.current_map]:
                      if not self.has_pokemon(pokemon):
                          return False
              elif self.current_stage in BlueStages:
                  for pokemon in BlueStageMapWildMons[self.current_map]:
                      if not self.has_pokemon(pokemon):
                          return False
                  for pokemon in BlueStageMapWildMonsRare[self.current_map]:
                      if not self.has_pokemon(pokemon):
                          return False
              return True

          def start_game(self, timer_div=None, stage=None):
              """
              Starts the game with optional timer division and stage parameters.

              This function sets up the game state, sends the necessary inputs to start the game, and saves the initial game state.

              Parameters:
              timer_div (int, optional): The division value for the game timer. Defaults to None.
              stage (int, optional): The stage to start the game at. Defaults to None.

              Returns:
              None
              """
              if self.game_has_started:
                  raise PyBoyException("Gamewrapper already started! Use 'reset' instead.")

              self._set_stage(stage)

              # Random tilemap I observed doesn't change until shortly before input is read
              while self.tilemap_background[10, 10] != 269:
                  self.pyboy.tick(1, False)

              # tick needed count to get to the point where input is read
              self.pyboy.tick(18, False)

              # start game
              self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
              self.pyboy.tick(1, False)
              self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
              # tick count needed to get to the next point where input is read
              self.pyboy.tick(95, False)

              self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
              self.pyboy.tick(1, False)
              self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
              self.pyboy.tick(1, False)

              ticks_until_visible = 74
              self.pyboy.tick(ticks_until_visible, False)

              ticks_until_input_ready = 4
              self.pyboy.tick(ticks_until_input_ready, False)

              # needs to be called after normal initializations, otherwise it will be overwritten
              self._init_bonus_stage(stage)

              PyBoyGameWrapper.start_game(self, timer_div=timer_div)

          def reset_game(self, timer_div=None):
              """
              After calling `start_game`, use this method to reset the beginning of the game.

              Kwargs:
                  timer_div (int): Replace timer's DIV register with this value. Use `None` to randomize.
              """
              PyBoyGameWrapper.reset_game(self, timer_div=timer_div)

          def get_unique_pokemon_caught(self):
              """
              Get the number of unique pokemon caught in the current session based off the in game pokedex
              """
              return self.pokedex.count(2)

          def post_tick(self):
              self._tile_cache_invalid = True
              self._sprite_cache_invalid = True

              self.ball_type = self.pyboy.memory[ADDR_BALL_TYPE]
              self.balls_left = 3 - self.pyboy.memory[ADDR_BALLS_LEFT] + self.pyboy.memory[ADDR_EXTRA_BALLS]
              self.game_over = self.pyboy.memory[ADDR_GAME_OVER] == 1

              self.current_map = self.pyboy.memory[ADDR_CURRENT_MAP]
              self.current_stage = self.pyboy.memory[ADDR_CURRENT_STAGE]

              self.special_mode = self.pyboy.memory[ADDR_SPECIAL_MODE]
              self.special_mode_active = self.pyboy.memory[ADDR_SPECIAL_MODE_ACTIVE] == 1

              self.score = (
                  bcd_to_dec(
                      int.from_bytes(self.pyboy.memory[ADDR_SCORE : ADDR_SCORE + SCORE_BYTE_WIDTH], "little"),
                      byte_width=SCORE_BYTE_WIDTH,
                  )
                  * 10
              )

              self.multiplier = self.pyboy.memory[ADDR_MULTIPLIER]

              self.ball_size = self.pyboy.memory[ADDR_BALL_SIZE]

              self.ball_x = self.pyboy.memory[ADDR_BALL_X]
              self.ball_y = self.pyboy.memory[ADDR_BALL_Y]
              self.ball_x_velocity = self.pyboy.memory[ADDR_BALL_X_VELOCITY]
              self.ball_y_velocity = self.pyboy.memory[ADDR_BALL_Y_VELOCITY]

              self.pikachu_saver_charge = self.pyboy.memory[ADDR_PIKACHU_SAVER_CHARGE]

              if self._unlimited_saver:
                  self.pyboy.memory[ADDR_BALL_SAVER_SECONDS_LEFT] = 30

              self.ball_saver_seconds_left = self.pyboy.memory[ADDR_BALL_SAVER_SECONDS_LEFT]

              self._update_pokedex()

          def __repr__(self):
              # fmt: off
              return (
                  "PokemonPinball:\n" +
                  "Score: " + str(self.score) + "\n" +
                  "Multiplier: " + str(self.multiplier) + "\n" +
                  "Balls left: " + str(self.balls_left) + "\n" +
                  "Ball type: " + str(BallType(self.ball_type).name) + "\n" +
                  "Ball X: " + str(self.ball_x) + "\n" +
                  "Ball Y: " + str(self.ball_y) + "\n" +
                  "Ball X Velocity: " + str(self.ball_x_velocity) + "\n" +
                  "Ball Y Velocity: " + str(self.ball_y_velocity) + "\n" +
                  "Current stage: " + str(Stage(self.current_stage).name) + "\n" +
                  "Game over: " + str(self.game_over) + "\n" +
                  "Ball saver seconds left: " + str(self.ball_saver_seconds_left) + "\n" +
                  "Pokemon caught in session: " + str(self.pokemon_caught_in_session) + "\n" +
                  "Pokemon seen in session: " + str(self.pokemon_seen_in_session) + "\n" +
                  "Ball lost during saver: " + str(self.lost_ball_during_saver) + "\n" +
                  "Special mode active: " + str(self.special_mode_active) + "\n" +
                  "Evolution failure count: " + str(self.evolution_failure_count) + "\n" +
                  "Evolution success count: " + str(self.evolution_success_count) + "\n" +
                  "Pikachu saver charge: " + str(self.pikachu_saver_charge) + "\n" +
                  "Pikachu saver used: " + str(self.pikachu_saver_used) + "\n" +
                  "Great Ball upgrades: " + str(self.great_ball_upgrades) + "\n" +
                  "Ultra Ball upgrades: " + str(self.ultra_ball_upgrades) + "\n" +
                  "Master Ball upgrades: " + str(self.master_ball_upgrades) + "\n" +
                  "Extra balls added: " + str(self.extra_balls_added) + "\n" +
                  "Roulette slots opened: " + str(self.roulette_slots_opened) + "\n" +
                  "Roulette slots entered: " + str(self.roulette_slots_entered) + "\n" +
                  "Current map: " + str(self.current_map) + "\n" +
                  "Diglett stages completed: " + str(self.diglett_stages_completed) + " / Visited: " + str(self.diglett_stages_visited) + "\n" +
                  "Gengar stages completed: " + str(self.gengar_stages_completed) + " / Visited: " + str(self.gengar_stages_visited) + "\n" +
                  "Meowth stages completed: " + str(self.meowth_stages_completed) + " / Visited: " + str(self.meowth_stages_visited) + "\n" +
                  "Mewtwo stages completed: " + str(self.mewtwo_stages_completed) + " / Visited: " + str(self.mewtwo_stages_visited) + "\n" +
                  "Seel stages completed: " + str(self.seel_stages_completed) + " / Visited: " + str(self.seel_stages_visited) + "\n"
              )
              # fmt: on

          def _add_hooks(self):
              def completed_evolution(context):
                  context.evolution_success_count += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_COMPLETE_EVOLUTION_MODE_RED_FIELD[0],
                  BANK_OFFSET_COMPLETE_EVOLUTION_MODE_RED_FIELD[1],
                  completed_evolution,
                  self,
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_COMPLETE_EVOLUTION_MODE_BLUE_FIELD[0],
                  BANK_OFFSET_COMPLETE_EVOLUTION_MODE_BLUE_FIELD[1],
                  completed_evolution,
                  self,
              )

              def failed_evolution(context):
                  context.evolution_failure_count += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_FAIL_EVOLUTION_MODE_RED_FIELD[0],
                  BANK_OFFSET_FAIL_EVOLUTION_MODE_RED_FIELD[1],
                  failed_evolution,
                  self,
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_FAIL_EVOLUTION_MODE_BLUE_FIELD[0],
                  BANK_OFFSET_FAIL_EVOLUTION_MODE_BLUE_FIELD[1],
                  failed_evolution,
                  self,
              )

              def pokemon_caught(context):
                  context.pokemon_caught_in_session += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_ADD_CAUGHT_POKEMON_TO_PARTY[0], BANK_OFFSET_ADD_CAUGHT_POKEMON_TO_PARTY[1], pokemon_caught, self
              )

              def pokemon_seen(context):
                  context.pokemon_seen_in_session += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_SET_POKEMON_SEEN_FLAG[0], BANK_OFFSET_SET_POKEMON_SEEN_FLAG[1], pokemon_seen, self
              )

              def meowth_visited(context):
                  context.meowth_stages_visited += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_INIT_MEOWTH_BONUS_STAGE[0], BANK_OFFSET_INIT_MEOWTH_BONUS_STAGE[1], meowth_visited, self
              )

              def diglett_visited(context):
                  context.diglett_stages_visited += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_INIT_DIGLETT_BONUS_STAGE[0], BANK_OFFSET_INIT_DIGLETT_BONUS_STAGE[1], diglett_visited, self
              )

              def gengar_visited(context):
                  context.gengar_stages_visited += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_INIT_GENGAR_BONUS_STAGE[0], BANK_OFFSET_INIT_GENGAR_BONUS_STAGE[1], gengar_visited, self
              )

              def seel_visited(context):
                  context.seel_stages_visited += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_INIT_SEEL_BONUS_STAGE[0], BANK_OFFSET_INIT_SEEL_BONUS_STAGE[1], seel_visited, self
              )

              def mewtwo_visited(context):
                  context.mewtwo_stages_visited += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_INIT_MEWTWO_BONUS_STAGE[0], BANK_OFFSET_INIT_MEWTWO_BONUS_STAGE[1], mewtwo_visited, self
              )

              def meowth_completed(context):
                  context.meowth_stages_completed += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_MEOWTH_STAGE_COMPLETE[0], BANK_OFFSET_MEOWTH_STAGE_COMPLETE[1], meowth_completed, self
              )

              def diglett_completed(context):
                  context.diglett_stages_completed += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_DIGLETT_STAGE_COMPLETE[0], BANK_OFFSET_DIGLETT_STAGE_COMPLETE[1], diglett_completed, self
              )

              def gengar_completed(context):
                  context.gengar_stages_completed += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_GENGAR_STAGE_COMPLETE[0], BANK_OFFSET_GENGAR_STAGE_COMPLETE[1], gengar_completed, self
              )

              def seel_completed(context):
                  context.seel_stages_completed += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_SEEL_STAGE_COMPLETE[0], BANK_OFFSET_SEEL_STAGE_COMPLETE[1], seel_completed, self
              )

              def mewtwo_completed(context):
                  context.mewtwo_stages_completed += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_MEWTWO_STAGE_COMPLETE[0], BANK_OFFSET_MEWTWO_STAGE_COMPLETE[1], mewtwo_completed, self
              )

              def map_change_attempt(context):
                  context.map_change_attempts += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_MAP_CHANGE_ATTEMPT[0], BANK_OFFSET_MAP_CHANGE_ATTEMPT[1], map_change_attempt, self
              )

              def map_change_success(context):
                  context.map_change_successes += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_MAP_CHANGE_SUCCESS[0], BANK_OFFSET_MAP_CHANGE_SUCCESS[1], map_change_success, self
              )

              def pika_saver_increment(context):
                  context.pikachu_saver_increments += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_PIKA_SAVER_INCREMENT_BLUE_FIELD[0],
                  BANK_OFFSET_PIKA_SAVER_INCREMENT_BLUE_FIELD[1],
                  pika_saver_increment,
                  self,
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_PIKA_SAVER_INCREMENT_RED_FIELD[0],
                  BANK_OFFSET_PIKA_SAVER_INCREMENT_RED_FIELD[1],
                  pika_saver_increment,
                  self,
              )

              def pika_saver_used(context):
                  context.pikachu_saver_used += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_PIKA_SAVER_USED_BLUE_FIELD[0], BANK_OFFSET_PIKA_SAVER_USED_BLUE_FIELD[1], pika_saver_used, self
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_PIKA_SAVER_USED_RED_FIELD[0], BANK_OFFSET_PIKA_SAVER_USED_RED_FIELD[1], pika_saver_used, self
              )

              def ball_upgrade_trigger(context):
                  if context.ball_type == BallType.POKEBALL.value:
                      context.great_ball_upgrades += 1
                  elif context.ball_type == BallType.GREATBALL.value:
                      context.ultra_ball_upgrades += 1
                  elif context.ball_type == BallType.ULTRABALL.value:
                      context.master_ball_upgrades += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_BALL_UPGRADE_TRIGGER_BLUE_FIELD[0],
                  BANK_OFFSET_BALL_UPGRADE_TRIGGER_BLUE_FIELD[1],
                  ball_upgrade_trigger,
                  self,
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_BALL_UPGRADE_TRIGGER_RED_FIELD[0],
                  BANK_OFFSET_BALL_UPGRADE_TRIGGER_RED_FIELD[1],
                  ball_upgrade_trigger,
                  self,
              )

              def extra_ball_added(context):
                  context.extra_balls_added += 1

              self.pyboy.hook_register(BANK_OFFSET_ADD_EXTRA_BALL[0], BANK_OFFSET_ADD_EXTRA_BALL[1], extra_ball_added, self)

              # This prevents slot reward extra ball from being counted as it is mostly RNG based and not a good fitness metric
              def slot_reward_extra_ball(context):
                  context.extra_balls_added -= 1

              self.pyboy.hook_register(
                  BANK_OFFSET_SLOT_REWARD_EXTRA_BALL[0], BANK_OFFSET_SLOT_REWARD_EXTRA_BALL[1], slot_reward_extra_ball, self
              )

              def opened_slot_by_getting_4_cave_lights(context):
                  context.roulette_slots_opened += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_BLUE[0],
                  BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_BLUE[1],
                  opened_slot_by_getting_4_cave_lights,
                  self,
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_RED[0],
                  BANK_OFFSET_OPENED_SLOT_BY_GETTING_4_CAVE_LIGHTS_RED[1],
                  opened_slot_by_getting_4_cave_lights,
                  self,
              )

              def slot_reward_roulette(context):
                  context.roulette_slots_entered += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_SLOT_REWARD_ROULETTE[0], BANK_OFFSET_SLOT_REWARD_ROULETTE[1], slot_reward_roulette, self
              )

              def lost_ball_during_saver(context):
                  context.lost_ball_during_saver += 1

              self.pyboy.hook_register(
                  BANK_OFFSET_BALL_SAVED_RED[0], BANK_OFFSET_BALL_SAVED_RED[1], lost_ball_during_saver, self
              )
              self.pyboy.hook_register(
                  BANK_OFFSET_BALL_SAVED_BLUE[0], BANK_OFFSET_BALL_SAVED_BLUE[1], lost_ball_during_saver, self
              )

  ### Ancestors

  - PyBoyGameWrapper
  - pyboy.plugins.base_plugin.PyBoyPlugin

  ### Instance variables

  `var score`

    The score provided by the game

  `var balls_left`

    The lives remaining provided by the game

  `var ball_type`

    The current ball type

  `var multiplier`

    The current multiplier

  `var current_stage`

    The current stage

  `var ball_saver_seconds_left`

    The current ball saver seconds left

  `var ball_x`

    The x position of the ball

  `var ball_y`

    The y position of the ball

  `var ball_x_velocity`

    The x velocity of the ball

  `var ball_y_velocity`

    The y velocity of the ball

  `var special_mode`

    The special mode state value

    Example:

        >>> from pyboy.plugins.game_wrapper_pokemon_pinball import SpecialMode
        >>> pyboy = PyBoy(pokemon_pinball_rom)
        >>> pyboy.game_wrapper.special_mode == SpecialMode.CATCH.value
        True

  `var special_mode_active`

    The special mode active state

  `var evolution_failure_count`

    The number of times an evolution has failed

  `var evolution_success_count`

    The number of times an evolution has succeeded

  `var diglett_stages_completed`

    The number of Diglett stages completed

  `var diglett_stages_visited`

    The number of Diglett stages visited

  `var gengar_stages_completed`

    The number of Gengar stages completed

  `var gengar_stages_visited`

    The number of Gengar stages visited

  `var meowth_stages_completed`

    The number of Meowth stages completed

  `var meowth_stages_visited`

    The number of Meowth stages visited

  `var mewtwo_stages_completed`

    The number of Mewtwo stages completed

  `var mewtwo_stages_visited`

    The number of Mewtwo stages visited

  `var seel_stages_completed`

    The number of Seel stages completed

  `var seel_stages_visited`

    The number of Seel stages visited

  `var pikachu_saver_charge`

    The charge of the Pikachu saver, ranges from 0 to 15

  `var pikachu_saver_increments`

    The number of times the Pikachu saver charge has incremented

  `var pikachu_saver_used`

    The number of times the Pikachu saver has been used

  `var current_map`

    The current map

    Example:

        >>> from pyboy.plugins.game_wrapper_pokemon_pinball import Maps
        >>> pyboy = PyBoy(pokemon_pinball_rom)
        >>> pyboy.game_wrapper.current_map == Maps.PALLET_TOWN.value
        True

  `var map_change_attempts`

    The number of times a map change has been attempted

  `var map_change_successes`

    The number of times a map change has been successful

  `var pokemon_caught_in_session`

    The number of pokemon caught in the current session

  `var pokemon_seen_in_session`

    The number of pokemon seen in the current session

  `var great_ball_upgrades`

    The number of Great Ball upgrades obtained

  `var ultra_ball_upgrades`

    The number of Ultra Ball upgrades obtained

  `var master_ball_upgrades`

    The number of Master Ball upgrades obtained

  `var extra_balls_added`

    The number of extra balls added, not including those rewarded via roulette

  `var lost_ball_during_saver`

    The number of balls lost during a saver mode

  `var roulette_slots_opened`

    The number of roulette slots opened

  `var roulette_slots_entered`

    The number of roulette slots entered

  ### Methods

  `def has_pokemon(self, pokemon)`

    Check if the player has caught the given pokemon

    ## Args

    `pokemon` :`Pokemon`
      The pokemon to check for
    Expand source code

        def has_pokemon(self, pokemon):
            """
            Check if the player has caught the given pokemon

            Args:
                pokemon (Pokemon): The pokemon to check for
            """
            return self.pokedex[pokemon.value] == 2

  `def set_unlimited_saver(self, unlimited_saver=True)`

    Sets the unlimited saver mode in the game.

    This function allows for an unlimited saver option in the game.

    Parameters: unlimited_saver (bool, optional): If True, the saver mode in the game is unlimited. Defaults to True.

    Returns: None

    Expand source code

        def set_unlimited_saver(self, unlimited_saver=True):
            """
            Sets the unlimited saver mode in the game.

            This function allows for an unlimited saver option in the game.

            Parameters:
            unlimited_saver (bool, optional): If True, the saver mode in the game is unlimited. Defaults to True.

            Returns:
            None
            """
            self._unlimited_saver = unlimited_saver

  `def start_catch_mode(self, pokemon=Pokemon.BULBASAUR, unlimited_time=False)`

    Starts the catch mode in the game. NOTE: This method does not change stage specific values and may need a top/bottom stage change to work properly.

    This function sets up the game state for catch mode, including the Pokemon to catch and the game timer.

    Parameters: pokemon (Pokemon, optional): The Pokemon to catch in this mode. Defaults to Pokemon.BULBASAUR. unlimited_time (bool, optional): If True, the game timer is not activated, giving unlimited time in catch mode. Defaults to False.

    Returns: None

    Expand source code

        def start_catch_mode(self, pokemon=Pokemon.BULBASAUR, unlimited_time=False):
            """
            Starts the catch mode in the game. NOTE: This method does not change stage specific values and may need a top/bottom stage change to work properly.

            This function sets up the game state for catch mode, including the Pokemon to catch and the game timer.

            Parameters:
            pokemon (Pokemon, optional): The Pokemon to catch in this mode. Defaults to Pokemon.BULBASAUR.
            unlimited_time (bool, optional): If True, the game timer is not activated, giving unlimited time in catch mode. Defaults to False.

            Returns:
            None
            """
            # All values are based on PRET disassembly
            self.pyboy.memory[ADDR_SPECIAL_MODE] = SpecialMode.CATCH.value
            self.pyboy.memory[ADDR_POKEMON_TO_CATCH] = pokemon.value
            self.pyboy.memory[ADDR_SPECIAL_MODE_ACTIVE] = 1
            self.pyboy.memory[ADDR_SPECIAL_MODE_STATE] = 0
            self.pyboy.memory[ADDR_D5C6] = 0
            self.pyboy.memory[ADDR_NUM_MON_HITS] = 0
            self.pyboy.memory[ADDR_NUM_CATCH_TILES_FLIPPED] = 0
            self.pyboy.memory[ADDR_TILE_ILLUMINATION : ADDR_TILE_ILLUMINATION + TILE_ILLUMINATION_BYTE_WIDTH] = 0
            if not unlimited_time:
                self.pyboy.memory[ADDR_TIMER_SECONDS] = 0
                self.pyboy.memory[ADDR_TIMER_MINUTES] = 2
                self.pyboy.memory[ADDR_TIMER_FRAMES] = 0
                self.pyboy.memory[ADDR_TIMER_RAN_OUT] = 0
                self.pyboy.memory[ADDR_TIMER_PAUSED] = 0
                self.pyboy.memory[ADDR_TIMER_ACTIVE] = 1
                self.pyboy.memory[ADDR_D580] = 1

  `def enable_evolve_hack(self, unlimited_time=False)`

    Enables the evolution hack in the game.

    This function replaces the pause button with the evolution start method. It also allows for an unlimited time option.

    Parameters: unlimited_time (bool, optional): If True, the game timer is disabled, giving unlimited time in the game. Defaults to False.

    Returns: None

    Expand source code

        def enable_evolve_hack(self, unlimited_time=False):
            """
            Enables the evolution hack in the game.

            This function replaces the pause button with the evolution start method. It also allows for an unlimited time option.

            Parameters:
            unlimited_time (bool, optional): If True, the game timer is disabled, giving unlimited time in the game. Defaults to False.

            Returns:
            None
            """
            bank_addr_evo = BANK_OFFSET_START_EVOLUTION

            lower_8bits = bank_addr_evo[1] & 0xFF
            upper_8bits = (bank_addr_evo[1] >> 8) & 0xFF

            bank_addr_pause = BANK_OFFSET_PAUSE_METHOD_CALL

            self.pyboy.memory[BANK_OFFSET_PAUSE_METHOD_BANK] = bank_addr_evo[0]
            self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1]] = lower_8bits
            self.pyboy.memory[bank_addr_pause[0], bank_addr_pause[1] + 1] = upper_8bits
            if unlimited_time:

                def disable_timer(context):
                    context.memory[ADDR_TIMER_ACTIVE] = 0

                bank = BANK_OFFSET_DISABLE_TIMER[0]
                offset = BANK_OFFSET_DISABLE_TIMER[1]
                try:
                    self.pyboy.hook_register(bank, offset, disable_timer, self.pyboy)
                except ValueError:
                    pass  # hook already exists

  `def current_map_completed(self)`

    Determines if all Pokemon in the current map have been caught.

    This function checks whether all Pokemon, both common and rare, in the current stage's map have been caught. It supports both Red and Blue stages. If any Pokemon in the map has not been caught, the function returns False. If all Pokemon have been caught, it returns True.

    Returns: bool: True if all Pokemon in the current map have been caught, False otherwise.

    Expand source code

        def current_map_completed(self):
            """
            Determines if all Pokemon in the current map have been caught.

            This function checks whether all Pokemon, both common and rare, in the current stage's map have been caught.
            It supports both Red and Blue stages. If any Pokemon in the map has not been caught, the function returns False.
            If all Pokemon have been caught, it returns True.

            Returns:
            bool: True if all Pokemon in the current map have been caught, False otherwise.
            """
            if self.current_stage in RedStages:
                for pokemon in RedStageMapWildMons[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
                for pokemon in RedStageMapWildMonsRare[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
            elif self.current_stage in BlueStages:
                for pokemon in BlueStageMapWildMons[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
                for pokemon in BlueStageMapWildMonsRare[self.current_map]:
                    if not self.has_pokemon(pokemon):
                        return False
            return True

  `def start_game(self, timer_div=None, stage=None)`

    Starts the game with optional timer division and stage parameters.

    This function sets up the game state, sends the necessary inputs to start the game, and saves the initial game state.

    Parameters: timer_div (int, optional): The division value for the game timer. Defaults to None. stage (int, optional): The stage to start the game at. Defaults to None.

    Returns: None

    Expand source code

        def start_game(self, timer_div=None, stage=None):
            """
            Starts the game with optional timer division and stage parameters.

            This function sets up the game state, sends the necessary inputs to start the game, and saves the initial game state.

            Parameters:
            timer_div (int, optional): The division value for the game timer. Defaults to None.
            stage (int, optional): The stage to start the game at. Defaults to None.

            Returns:
            None
            """
            if self.game_has_started:
                raise PyBoyException("Gamewrapper already started! Use 'reset' instead.")

            self._set_stage(stage)

            # Random tilemap I observed doesn't change until shortly before input is read
            while self.tilemap_background[10, 10] != 269:
                self.pyboy.tick(1, False)

            # tick needed count to get to the point where input is read
            self.pyboy.tick(18, False)

            # start game
            self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
            self.pyboy.tick(1, False)
            self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
            # tick count needed to get to the next point where input is read
            self.pyboy.tick(95, False)

            self.pyboy.send_input(WindowEvent.PRESS_BUTTON_A)
            self.pyboy.tick(1, False)
            self.pyboy.send_input(WindowEvent.RELEASE_BUTTON_A)
            self.pyboy.tick(1, False)

            ticks_until_visible = 74
            self.pyboy.tick(ticks_until_visible, False)

            ticks_until_input_ready = 4
            self.pyboy.tick(ticks_until_input_ready, False)

            # needs to be called after normal initializations, otherwise it will be overwritten
            self._init_bonus_stage(stage)

            PyBoyGameWrapper.start_game(self, timer_div=timer_div)

  `def reset_game(self, timer_div=None)`

    After calling `start_game`, use this method to reset the beginning of the game.

    ## Kwargs

    timer_div (int): Replace timer's DIV register with this value. Use `None` to randomize.

    Expand source code

        def reset_game(self, timer_div=None):
            """
            After calling `start_game`, use this method to reset the beginning of the game.

            Kwargs:
                timer_div (int): Replace timer's DIV register with this value. Use `None` to randomize.
            """
            PyBoyGameWrapper.reset_game(self, timer_div=timer_div)

  `def get_unique_pokemon_caught(self)`

    Get the number of unique pokemon caught in the current session based off the in game pokedex

    Expand source code

        def get_unique_pokemon_caught(self):
            """
            Get the number of unique pokemon caught in the current session based off the in game pokedex
            """
            return self.pokedex.count(2)

  ### Inherited members

  - `PyBoyGameWrapper`:
    - `game_area`
    - `game_over`
    - `mapping_one_to_one`
    - `shape`