alex

/* *****************************************************************************
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * *****************************************************************************
 * A.L.E (Arcade Learning Environment)
 * Copyright (c) 2009-2013 by Yavar Naddaf, Joel Veness, Marc G. Bellemare and
 *   the Reinforcement Learning and Artificial Intelligence Laboratory
 * Released under the GNU General Public License; see License.txt for details.
 *
 * Based on: Stella  --  "An Atari 2600 VCS Emulator"
 * Copyright (c) 1995-2007 by Bradford W. Mott and the Stella team
 *
 * *****************************************************************************
 */

#include "Galaxian.hpp"

#include "../RomUtils.hpp"

namespace ale {

ActionVect GalaxianSettings::actions;

GalaxianSettings::GalaxianSettings() { reset(); }

/* create a new instance of the rom */
RomSettings* GalaxianSettings::clone() const {
  return new GalaxianSettings(*this);
}

/* process the latest information from ALE */
void GalaxianSettings::step(const System& system) {
  // update the reward
  int score = getDecimalScore(0xAE, 0xAD, 0xAC, &system);
  // reward cannot get negative in this game. When it does, it means that the score has looped
  // (overflow)
  m_reward = score - m_score;
  if (m_reward < 0) {
    // 1000000 is the highest possible score
    const int maximumScore = 1000000;
    m_reward = (maximumScore - m_score) + score;
  }
  m_score = score;

  // update terminal and lives
  // If bit 0x80 is on, then game is over
  int some_byte = readRam(&system, 0xBF);
  m_terminal = (some_byte & 0x80);
  if (m_terminal) {
    // Force lives to zero when the game is over since otherwise it would be left as 1
    m_lives = 0;
  } else {
    m_lives = readRam(&system, 0xB9) +
              1; // 0xB9 keeps the number of lives shown below the screen
  }
}

/* is end of game */
bool GalaxianSettings::isTerminal() const { return m_terminal; };

/* get the most recently observed reward */
reward_t GalaxianSettings::getReward() const { return m_reward; }

/* is an action part of the minimal set? */
bool GalaxianSettings::isMinimal(const Action& a) const {
  switch (a) {
    case PLAYER_A_NOOP:
    case PLAYER_A_LEFT:
    case PLAYER_A_RIGHT:
    case PLAYER_A_FIRE:
    case PLAYER_A_LEFTFIRE:
    case PLAYER_A_RIGHTFIRE:
      return true;
    default:
      return false;
  }
}

/* reset the state of the game */
void GalaxianSettings::reset() {
  m_reward = 0;
  m_score = 0;
  m_terminal = false;
  m_lives = 3;
}

/* saves the state of the rom settings */
void GalaxianSettings::saveState(Serializer& ser) {
  ser.putInt(m_reward);
  ser.putInt(m_score);
  ser.putBool(m_terminal);
  ser.putInt(m_lives);
}

// loads the state of the rom settings
void GalaxianSettings::loadState(Deserializer& ser) {
  m_reward = ser.getInt();
  m_score = ser.getInt();
  m_terminal = ser.getBool();
  m_lives = ser.getInt();
}

// returns a list of mode that the game can be played in
ModeVect GalaxianSettings::getAvailableModes() {
  return {1, 2, 3, 4, 5, 6, 7, 8, 9};
}

// set the mode of the game
// the given mode must be one returned by the previous function
void GalaxianSettings::setMode(
    game_mode_t mode, System& system,
    std::unique_ptr<StellaEnvironmentWrapper> environment) {
  if (mode == 0)
    mode = 1;

  if (mode >= 1 && mode <= 9) {
    // press select until the correct mode is reached
    while (mode != static_cast<unsigned>(readRam(&system, 0xB3))) {
      environment->pressSelect();
    }
    //reset the environment to apply changes.
    environment->softReset();
  } else {
    throw std::runtime_error("This mode doesn't currently exist for this game");
  }
}

}  // namespace ale