command_type.h

Go to the documentation of this file.

/* $Id: command_type.h 14466 2008-10-14 19:27:08Z rubidium $ */

#ifndef COMMAND_TYPE_H
#define COMMAND_TYPE_H

#include "economy_type.h"
#include "strings_type.h"
#include "tile_type.h"

class CommandCost {
  ExpensesType expense_type; 
  Money cost;       
  StringID message; 
  bool success;     

public:
  CommandCost() : expense_type(INVALID_EXPENSES), cost(0), message(INVALID_STRING_ID), success(true) {}

  CommandCost(StringID msg) : expense_type(INVALID_EXPENSES), cost(0), message(msg), success(false) {}

  CommandCost(ExpensesType ex_t) : expense_type(ex_t), cost(0), message(INVALID_STRING_ID), success(true) {}

  CommandCost(ExpensesType ex_t, Money cst) : expense_type(ex_t), cost(cst), message(INVALID_STRING_ID), success(true) {}

  CommandCost AddCost(CommandCost ret);

  CommandCost AddCost(Money cost)
  {
    this->cost += cost;
    return *this;
  }

  CommandCost MultiplyCost(int factor)
  {
    this->cost *= factor;
    return *this;
  }

  Money GetCost() const
  {
    return this->cost;
  }

  ExpensesType GetExpensesType() const
  {
    return this->expense_type;
  }

  void SetGlobalErrorMessage() const
  {
    extern StringID _error_message;
    if (this->message != INVALID_STRING_ID) _error_message = this->message;
  }

  StringID GetErrorMessage() const
  {
    extern StringID _error_message;

    if (this->success) return INVALID_STRING_ID;
    if (this->message != INVALID_STRING_ID) return this->message;
    return _error_message;
  }

  bool Succeeded() const
  {
    return this->success;
  }

  bool Failed() const
  {
    return !this->success;
  }
};

enum {
  CMD_BUILD_RAILROAD_TRACK,         
  CMD_REMOVE_RAILROAD_TRACK,        
  CMD_BUILD_SINGLE_RAIL,            
  CMD_REMOVE_SINGLE_RAIL,           
  CMD_LANDSCAPE_CLEAR,              
  CMD_BUILD_BRIDGE,                 
  CMD_BUILD_RAILROAD_STATION,       
  CMD_BUILD_TRAIN_DEPOT,            
  CMD_BUILD_SIGNALS,                
  CMD_REMOVE_SIGNALS,               
  CMD_TERRAFORM_LAND,               
  CMD_PURCHASE_LAND_AREA,           
  CMD_SELL_LAND_AREA,               
  CMD_BUILD_TUNNEL,                 

  CMD_REMOVE_FROM_RAILROAD_STATION, 
  CMD_CONVERT_RAIL,                 

  CMD_BUILD_TRAIN_WAYPOINT,         
  CMD_RENAME_WAYPOINT,              
  CMD_REMOVE_TRAIN_WAYPOINT,        

  CMD_BUILD_ROAD_STOP,              
  CMD_REMOVE_ROAD_STOP,             
  CMD_BUILD_LONG_ROAD,              
  CMD_REMOVE_LONG_ROAD,             
  CMD_BUILD_ROAD,                   
  CMD_REMOVE_ROAD,                  
  CMD_BUILD_ROAD_DEPOT,             

  CMD_BUILD_AIRPORT,                

  CMD_BUILD_DOCK,                   

  CMD_BUILD_SHIP_DEPOT,             
  CMD_BUILD_BUOY,                   

  CMD_PLANT_TREE,                   

  CMD_BUILD_RAIL_VEHICLE,           
  CMD_MOVE_RAIL_VEHICLE,            

  CMD_SELL_RAIL_WAGON,              

  CMD_SEND_TRAIN_TO_DEPOT,          
  CMD_FORCE_TRAIN_PROCEED,          
  CMD_REVERSE_TRAIN_DIRECTION,      

  CMD_MODIFY_ORDER,                 
  CMD_SKIP_TO_ORDER,                
  CMD_DELETE_ORDER,                 
  CMD_INSERT_ORDER,                 

  CMD_CHANGE_SERVICE_INT,           

  CMD_BUILD_INDUSTRY,               

  CMD_BUILD_COMPANY_HQ,             
  CMD_SET_COMPANY_MANAGER_FACE,     
  CMD_SET_COMPANY_COLOR,            

  CMD_INCREASE_LOAN,                
  CMD_DECREASE_LOAN,                

  CMD_WANT_ENGINE_PREVIEW,          

  CMD_RENAME_VEHICLE,               
  CMD_RENAME_ENGINE,                
  CMD_RENAME_COMPANY,               
  CMD_RENAME_PRESIDENT,             
  CMD_RENAME_STATION,               

  CMD_SELL_AIRCRAFT,                
  CMD_BUILD_AIRCRAFT,               
  CMD_SEND_AIRCRAFT_TO_HANGAR,      
  CMD_REFIT_AIRCRAFT,               

  CMD_PLACE_SIGN,                   
  CMD_RENAME_SIGN,                  

  CMD_BUILD_ROAD_VEH,               
  CMD_SELL_ROAD_VEH,                
  CMD_SEND_ROADVEH_TO_DEPOT,        
  CMD_TURN_ROADVEH,                 
  CMD_REFIT_ROAD_VEH,               

  CMD_PAUSE,                        

  CMD_BUY_SHARE_IN_COMPANY,         
  CMD_SELL_SHARE_IN_COMPANY,        
  CMD_BUY_COMPANY,                  

  CMD_BUILD_TOWN,                   

  CMD_RENAME_TOWN,                  
  CMD_DO_TOWN_ACTION,               

  CMD_SET_ROAD_DRIVE_SIDE,          

  CMD_SELL_SHIP,                    
  CMD_BUILD_SHIP,                   
  CMD_SEND_SHIP_TO_DEPOT,           
  CMD_REFIT_SHIP,                   

  CMD_ORDER_REFIT,                  
  CMD_CLONE_ORDER,                  
  CMD_CLEAR_AREA,                   

  CMD_MONEY_CHEAT,                  
  CMD_BUILD_CANAL,                  

  CMD_COMPANY_CTRL,                 
  CMD_LEVEL_LAND,                   

  CMD_REFIT_RAIL_VEHICLE,           
  CMD_RESTORE_ORDER_INDEX,          
  CMD_BUILD_LOCK,                   

  CMD_BUILD_SIGNAL_TRACK,           
  CMD_REMOVE_SIGNAL_TRACK,          

  CMD_GIVE_MONEY,                   
  CMD_CHANGE_PATCH_SETTING,         

  CMD_SET_AUTOREPLACE,              

  CMD_CLONE_VEHICLE,                
  CMD_START_STOP_VEHICLE,           
  CMD_MASS_START_STOP,              
  CMD_AUTOREPLACE_VEHICLE,          
  CMD_DEPOT_SELL_ALL_VEHICLES,      
  CMD_DEPOT_MASS_AUTOREPLACE,       

  CMD_CREATE_GROUP,                 
  CMD_DELETE_GROUP,                 
  CMD_RENAME_GROUP,                 
  CMD_ADD_VEHICLE_GROUP,            
  CMD_ADD_SHARED_VEHICLE_GROUP,     
  CMD_REMOVE_ALL_VEHICLES_GROUP,    
  CMD_SET_GROUP_REPLACE_PROTECTION, 

  CMD_MOVE_ORDER,                   
  CMD_CHANGE_TIMETABLE,             
  CMD_SET_VEHICLE_ON_TIME,          
  CMD_AUTOFILL_TIMETABLE,           
};

enum {
  DC_EXEC            = 0x001, 
  DC_AUTO            = 0x002, 
  DC_QUERY_COST      = 0x004, 
  DC_NO_WATER        = 0x008, 
  DC_NO_RAIL_OVERLAP = 0x010, 
  DC_AI_BUILDING     = 0x020, 
  DC_NO_TOWN_RATING  = 0x040, 
  DC_BANKRUPT        = 0x080, 
  DC_AUTOREPLACE     = 0x100, 
};

#define CMD_MSG(x) ((x) << 16)

enum {
  CMD_NO_WATER              = 0x0400, 
  CMD_NETWORK_COMMAND       = 0x0800, 
  CMD_NO_TEST_IF_IN_NETWORK = 0x1000, 
  CMD_SHOW_NO_ERROR         = 0x2000, 
};

enum {
  CMD_SERVER  = 0x1, 
  CMD_OFFLINE = 0x2, 
  CMD_AUTO    = 0x4, 
};

typedef CommandCost CommandProc(TileIndex tile, uint32 flags, uint32 p1, uint32 p2);

struct Command {
  CommandProc *proc;
  byte flags;
};

typedef void CommandCallback(bool success, TileIndex tile, uint32 p1, uint32 p2);

#endif /* COMMAND_TYPE_H */