AIAccounting Class Reference

Class that keeps track of the costs, so you can request how much a block of commands did cost in total. More...


Public Member Functions

 AIAccounting ()
 Creating instance of this class starts counting the costs of commands from zero.
Money GetCosts ()
 Get the current value of the costs.
void ResetCosts ()
 Reset the costs to zero.


Detailed Description

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());
   }
 

Constructor & Destructor Documentation

AIAccounting::AIAccounting (  ) 

Creating instance of this class starts counting the costs of commands from zero.

Saves the current value of GetCosts so we can return to the old value when the instance gets deleted.


Member Function Documentation

Money AIAccounting::GetCosts (  ) 

Get the current value of the costs.

Returns:
The current costs.
Note:
when nesting AIAccounting instances all instances' GetCosts will always return the value of the 'top' instance.

void AIAccounting::ResetCosts (  ) 

Reset the costs to zero.

Note:
when nesting AIAccounting instances all instances' ResetCosts will always effect on the 'top' instance.


Generated on Thu May 31 21:43:01 2012 for OpenTTD NoAI API by  doxygen 1.5.6