(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / cheat_type.h
bloba75acf35e39d91e15af2c5ad6c72b2a6258172b8
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file cheat_type.h Types related to cheating. */
12 #ifndef CHEAT_TYPE_H
13 #define CHEAT_TYPE_H
15 /**
16 * Info about each of the cheats.
18 struct Cheat {
19 bool been_used; ///< has this cheat been used before?
20 bool value; ///< tells if the bool cheat is active or not
23 /**
24 * WARNING! Do _not_ remove entries in Cheats struct or change the order
25 * of the existing ones! Would break downward compatibility.
26 * Only add new entries at the end of the struct!
28 struct Cheats {
29 Cheat magic_bulldozer; ///< dynamite industries, objects
30 Cheat switch_company; ///< change to another company
31 Cheat money; ///< get rich or poor
32 Cheat crossing_tunnels; ///< allow tunnels that cross each other
33 Cheat dummy1; ///< empty cheat (build while in pause mode)
34 Cheat no_jetcrash; ///< no jet will crash on small airports anymore
35 Cheat dummy2; ///< empty cheat (change the climate of the map)
36 Cheat change_date; ///< changes date ingame
37 Cheat setup_prod; ///< setup raw-material production in game
38 Cheat dummy3; ///< empty cheat (enable running el-engines on normal rail)
39 Cheat edit_max_hl; ///< edit the maximum heightlevel; this is a cheat because of the fact that it needs to reset NewGRF game state and doing so as a simple configuration breaks the expectation of many
42 extern Cheats _cheats;
44 #endif /* CHEAT_TYPE_H */