blob: 4ca29d5dc9bb86198d2e341e682820147c928fdf (
plain)
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
|
/* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file script_testmode.hpp Switch the script instance to Test Mode. */
#ifndef SCRIPT_TESTMODE_HPP
#define SCRIPT_TESTMODE_HPP
#include "script_object.hpp"
/**
* Class to switch current mode to Test Mode.
* If you create an instance of this class, the mode will be switched to
* Testing. The original mode is stored and recovered from when ever the
* instance is destroyed.
* In Test mode all the commands you execute aren't really executed. The
* system only checks if it would be able to execute your requests, and what
* the cost would be.
* @api ai game
*/
class ScriptTestMode : public ScriptObject {
private:
ScriptModeProc *last_mode; ///< The previous mode we were in.
ScriptObject *last_instance; ///< The previous instance of the mode.
protected:
/**
* The callback proc for Testing mode.
*/
static bool ModeProc();
public:
/**
* Creating instance of this class switches the build mode to Testing.
* @note When the instance is destroyed, he restores the mode that was
* current when the instance was created!
*/
ScriptTestMode();
/**
* Destroying this instance reset the building mode to the mode it was
* in when the instance was created.
*/
~ScriptTestMode();
};
#endif /* SCRIPT_TESTMODE_HPP */
|
