1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* *****************************************************************************
* The method lives() is based on Xitari's code, from Google Inc.
*
* 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 "Tutankham.hpp"
#include "../RomUtils.hpp"
namespace ale {
TutankhamSettings::TutankhamSettings() { reset(); }
/* create a new instance of the rom */
RomSettings* TutankhamSettings::clone() const {
RomSettings* rval = new TutankhamSettings();
*rval = *this;
return rval;
}
/* process the latest information from ALE */
void TutankhamSettings::step(const System& system) {
// update the reward
int score = getDecimalScore(0x9C, 0x9A, &system);
int reward = score - m_score;
m_reward = reward;
m_score = score;
// update terminal status
int lives_byte = readRam(&system, 0x9E);
// byte 0x81 is set to 0x84 when the game is loaded, but not reset
int some_byte = readRam(&system, 0x81);
m_terminal = lives_byte == 0 && some_byte != 0x84;
m_lives = (lives_byte & 0x3);
}
/* is end of game */
bool TutankhamSettings::isTerminal() const { return m_terminal; };
/* get the most recently observed reward */
reward_t TutankhamSettings::getReward() const { return m_reward; }
/* is an action part of the minimal set? */
bool TutankhamSettings::isMinimal(const Action& a) const {
switch (a) {
case PLAYER_A_NOOP:
case PLAYER_A_UP:
case PLAYER_A_RIGHT:
case PLAYER_A_LEFT:
case PLAYER_A_DOWN:
case PLAYER_A_UPFIRE:
case PLAYER_A_RIGHTFIRE:
case PLAYER_A_LEFTFIRE:
return true;
default:
return false;
}
}
/* reset the state of the game */
void TutankhamSettings::reset() {
m_reward = 0;
m_score = 0;
m_terminal = false;
m_lives = 3;
}
/* saves the state of the rom settings */
void TutankhamSettings::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 TutankhamSettings::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 TutankhamSettings::getAvailableModes() {
ModeVect modes = {0, 4, 8, 12};
return modes;
}
// set the mode of the game
// the given mode must be one returned by the previous function
void TutankhamSettings::setMode(
game_mode_t m, System& system,
std::unique_ptr<StellaEnvironmentWrapper> environment) {
if (m == 0 || m == 4 || m == 8 || m == 12) {
// read the mode we are currently in
unsigned char mode = readRam(&system, 0xAB);
// press select until the correct mode is reached
while (mode != m) {
environment->pressSelect(2);
mode = readRam(&system, 0xAB);
}
//reset the environment to apply changes.
environment->softReset();
} else {
throw std::runtime_error("This mode doesn't currently exist for this game");
}
}
} // namespace ale