diff -r 8b688e6517d0 -r d675836e865c src/ai/api/ai_testmode.hpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/ai/api/ai_testmode.hpp Sun Mar 18 16:02:23 2007 +0000 @@ -0,0 +1,50 @@ +/* $Id$ */ + +/** @file ai_testmode.hpp class to switch the AI to Testing mode */ + +#ifndef AI_TESTMODE_HPP +#define AI_TESTMODE_HPP + +#include "ai_object.hpp" + +/** + * Class to switch current mode to Testing 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. + */ +class AITestMode : public AIObject { +private: + AIModeProc *last_mode; + +protected: + static bool ModeProc(TileIndex tile, uint32 p1, uint32 p2, uint32 flags, uint procc); + +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! + */ + AITestMode(); + + /** + * Destroying this instance reset the building mode to the mode it was + * in when the instance was created. + */ + ~AITestMode(); +}; + +#ifdef DEFINE_SQUIRREL_CLASS +void SQAITestModeRegister(Squirrel *engine) { + DefSQClass SQAITestMode("AITestMode"); + SQAITestMode.PreRegister(engine); + SQAITestMode.AddConstructor(engine); + SQAITestMode.PostRegister(engine); +} +#endif /* SQUIRREL_CLASS */ + +#endif /* AI_TESTMODE_HPP */