1

/* $Id$ */

     2

     3

/** @file ai_execmode.hpp class to switch the AI to Execute mode */

     4

     5

#ifndef AI_EXECMODE_HPP

     6

#define AI_EXECMODE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class to switch current mode to Execute mode.

    12

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

    13

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

    14

 *   instance is destroyed.

    15

 * In Execute mode all commands you do are executed for real.

    16

 */

    17

class AIExecMode : public AIObject {

    18

private:

    19

	AIModeProc *last_mode;

    20

	AIObject *last_instance;

    21

    22

protected:

    23

	/**

    24

	 * The callback proc for Execute mode.

    25

	 */

    26

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

    27

    28

public:

    29

	/**

    30

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

    31

	 */

    32

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

    33

    34

	/**

    35

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

    36

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

    37

	 *   current when the instance was created!

    38

	 */

    39

	AIExecMode();

    40

    41

	/**

    42

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

    43

	 *   in when the instance was created.

    44

	 */

    45

	~AIExecMode();

    46

};

    47

    48

#endif /* AI_EXECMODE_HPP */