diff options
Diffstat (limited to 'src/ai/api/ai_accounting.hpp')
-rw-r--r-- | src/ai/api/ai_accounting.hpp | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/src/ai/api/ai_accounting.hpp b/src/ai/api/ai_accounting.hpp new file mode 100644 index 000000000..bffa051f1 --- /dev/null +++ b/src/ai/api/ai_accounting.hpp @@ -0,0 +1,54 @@ +/* $Id$ */ + +/** @file ai_accounting.hpp Everything to handle AI accounting things. */ + +#ifndef AI_ACCOUNTING_HPP +#define AI_ACCOUNTING_HPP + +#include "ai_object.hpp" + +/** + * Class that keeps track of the costs, so you can request how much a block of + * commands did cost in total. Works in both Execute as in Test mode. + * Example: + * { + * local costs = AIAccounting(); + * BuildRoad(from_here, to_here); + * BuildRoad(from_there, to_there); + * print("Costs for route is: " + costs.GetCosts()); + * } + */ +class AIAccounting : public AIObject { +public: + static const char *GetClassName() { return "AIAccounting"; } + + /** + * Creating instance of this class starts counting the costs of commands + * from zero. + * @note when the instance is destroyed, he restores the costs that was + * current when the instance was created! + */ + AIAccounting(); + + /** + * Destroying this instance reset the costs to the value it was + * in when the instance was created. + */ + ~AIAccounting(); + + /** + * Get the current value of the costs. + * @return The current costs. + */ + Money GetCosts(); + + /** + * Reset the costs to zero. + */ + void ResetCosts(); + +private: + Money last_costs; +}; + +#endif /* AI_ACCOUNTING_HPP */ |