1

/* $Id$ */

     2

     3

/** @file ai_testmode.hpp class to switch the AI to Testing mode */

     4

     5

#ifndef AI_TESTMODE_HPP

     6

#define AI_TESTMODE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class to switch current mode to Testing mode.

    12

 * If you create an instance of this class, the mode will be switched to

    13

 *   Testing. The original mode is stored and recovered from when ever the

    14

 *   instance is destroyed.

    15

 * In Test mode all the commands you execute aren't really executed. The

    16

 *   system only checks if it would be able to execute your requests, and what

    17

 *   the cost would be.

    18

 */

    19

class AITestMode : public AIObject {

    20

private:

    21

	AIModeProc *last_mode;

    22

	AIObject *last_instance;

    23

    24

protected:

    25

	/**

    26

	 * The callback proc for Testing mode.

    27

	 */

    28

	static bool ModeProc(TileIndex tile, uint32 p1, uint32 p2, uint procc, CommandCost costs);

    29

    30

public:

    31

	/**

    32

	 * The name of the class, needed by several sub-processes.

    33

	 */

    34

	static const char *GetClassName() { return "AITestMode"; }

    35

    36

	/**

    37

	 * Creating instance of this class switches the build mode to Testing.

    38

	 * @note when the instance is destroyed, he restores the mode that was

    39

	 *   current when the instance was created!

    40

	 */

    41

	AITestMode();

    42

    43

	/**

    44

	 * Destroying this instance reset the building mode to the mode it was

    45

	 *   in when the instance was created.

    46

	 */

    47

	~AITestMode();

    48

};

    49

    50

#endif /* AI_TESTMODE_HPP */