order_backup.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 ORDER_BACKUP_H
#define ORDER_BACKUP_H
 
#include "core/pool_type.hpp"
#include "group_type.h"
#include "tile_type.h"
#include "vehicle_type.h"
#include "base_consist.h"
#include "saveload/saveload.h"

using OrderBackupID = PoolID<uint8_t, struct OrderBackupIDTag, 255, 0xFF>;
struct OrderBackup;
enum class ClientID : uint32_t;

using OrderBackupPool = Pool<OrderBackup, OrderBackupID, 1>;
extern OrderBackupPool _order_backup_pool;
using OrderBackupPoolItem = OrderBackupPool::PoolItem<&_order_backup_pool>;

struct OrderBackup : OrderBackupPoolItem, BaseConsist {
private:
  friend SaveLoadTable GetOrderBackupDescription(); 
  friend struct BKORChunkHandler; 
  template <typename T>
  friend class SlOrders;
 
  ClientID user{}; 
  TileIndex tile = INVALID_TILE; 
  GroupID group = GroupID::Invalid(); 
 
  const Vehicle *clone = nullptr; 
  std::vector<Order> orders; 
  uint32_t old_order_index = 0;
 
  void DoRestore(Vehicle *v);
 
  friend OrderBackupPoolItem; 
  OrderBackup(OrderBackupID index);
  OrderBackup(OrderBackupID index, const Vehicle *v, ClientID user);
 
public:
  ~OrderBackup();
 
  static void Backup(const Vehicle *v, ClientID user);
  static void Restore(Vehicle *v, ClientID user);
 
  static void ResetOfUser(TileIndex tile, ClientID user);
  static void ResetUser(ClientID user);
  static void Reset(TileIndex tile = INVALID_TILE, bool from_gui = true);
 
  static void ClearGroup(GroupID group);
  static void ClearVehicle(const Vehicle *v);
  static void RemoveOrder(OrderType type, DestinationID destination, bool hangar);
};
 
#endif /* ORDER_BACKUP_H */