autoreplace_func.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef AUTOREPLACE_FUNC_H
#define AUTOREPLACE_FUNC_H
 
#include "command_type.h"
#include "company_base.h"
 
void RemoveAllEngineReplacement(EngineRenewList *erl);
EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group, bool *replace_when_old = nullptr);
CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, GroupID group, bool replace_when_old, DoCommandFlags flags);
CommandCost RemoveEngineReplacement(EngineRenewList *erl, EngineID engine, GroupID group, DoCommandFlags flags);

inline void RemoveAllEngineReplacementForCompany(Company *c)
{
  RemoveAllEngineReplacement(&c->engine_renew_list);
}

inline EngineID EngineReplacementForCompany(const Company *c, EngineID engine, GroupID group, bool *replace_when_old = nullptr)
{
  return EngineReplacement(c->engine_renew_list, engine, group, replace_when_old);
}

inline bool EngineHasReplacementForCompany(const Company *c, EngineID engine, GroupID group)
{
  return EngineReplacementForCompany(c, engine, group) != EngineID::Invalid();
}

inline bool EngineHasReplacementWhenOldForCompany(const Company *c, EngineID engine, GroupID group)
{
  bool replace_when_old;
  EngineReplacement(c->engine_renew_list, engine, group, &replace_when_old);
  return replace_when_old;
}

inline CommandCost AddEngineReplacementForCompany(Company *c, EngineID old_engine, EngineID new_engine, GroupID group, bool replace_when_old, DoCommandFlags flags)
{
  return AddEngineReplacement(&c->engine_renew_list, old_engine, new_engine, group, replace_when_old, flags);
}

inline CommandCost RemoveEngineReplacementForCompany(Company *c, EngineID engine, GroupID group, DoCommandFlags flags)
{
  return RemoveEngineReplacement(&c->engine_renew_list, engine, group, flags);
}
 
bool CheckAutoreplaceValidity(EngineID from, EngineID to, CompanyID company);
 
#endif /* AUTOREPLACE_FUNC_H */