autoreplace_func.h

Go to the documentation of this file.
00001 /* $Id: autoreplace_func.h 17570 2009-09-19 09:51:14Z rubidium $ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
00008  */
00009 
00012 #ifndef AUTOREPLACE_FUNC_H
00013 #define AUTOREPLACE_FUNC_H
00014 
00015 #include "autoreplace_type.h"
00016 #include "company_base.h"
00017 
00023 void RemoveAllEngineReplacement(EngineRenewList *erl);
00024 
00033 EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group);
00034 
00044 CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, GroupID group, DoCommandFlag flags);
00045 
00054 CommandCost RemoveEngineReplacement(EngineRenewList *erl, EngineID engine, GroupID group, DoCommandFlag flags);
00055 
00060 static inline void RemoveAllEngineReplacementForCompany(Company *c)
00061 {
00062   RemoveAllEngineReplacement(&c->engine_renew_list);
00063 }
00064 
00073 static inline EngineID EngineReplacementForCompany(const Company *c, EngineID engine, GroupID group)
00074 {
00075   return EngineReplacement(c->engine_renew_list, engine, group);
00076 }
00077 
00085 static inline bool EngineHasReplacementForCompany(const Company *c, EngineID engine, GroupID group)
00086 {
00087   return EngineReplacementForCompany(c, engine, group) != INVALID_ENGINE;
00088 }
00089 
00099 static inline CommandCost AddEngineReplacementForCompany(Company *c, EngineID old_engine, EngineID new_engine, GroupID group, DoCommandFlag flags)
00100 {
00101   return AddEngineReplacement(&c->engine_renew_list, old_engine, new_engine, group, flags);
00102 }
00103 
00112 static inline CommandCost RemoveEngineReplacementForCompany(Company *c, EngineID engine, GroupID group, DoCommandFlag flags)
00113 {
00114   return RemoveEngineReplacement(&c->engine_renew_list, engine, group, flags);
00115 }
00116 
00117 bool CheckAutoreplaceValidity(EngineID from, EngineID to, CompanyID company);
00118 
00119 #endif /* AUTOREPLACE_FUNC_H */

Generated on Tue Jan 5 21:02:52 2010 for OpenTTD by  doxygen 1.5.6