order_type.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_TYPE_H
#define ORDER_TYPE_H
 
#include "core/enum_type.hpp"
#include "depot_type.h"
#include "core/pool_type.hpp"
#include "station_type.h"
 
typedef uint8_t VehicleOrderID;  
using OrderListID = PoolID<uint16_t, struct OrderListIDTag, 64000, 0xFFFF>;
 
struct DestinationID {
  using BaseType = uint16_t;
  BaseType value = 0;
 
  explicit DestinationID() = default;
  constexpr DestinationID(size_t index) : value(static_cast<BaseType>(index)) {}
  constexpr DestinationID(DepotID depot) : value(depot.base()) {}
  constexpr DestinationID(StationID station) : value(station.base()) {}
 
  constexpr DepotID ToDepotID() const noexcept { return static_cast<DepotID>(this->value); }
  constexpr StationID ToStationID() const noexcept { return static_cast<StationID>(this->value); }
  constexpr BaseType base() const noexcept { return this->value; }
 
  constexpr bool operator ==(const DestinationID &destination) const { return this->value == destination.value; }
  constexpr bool operator ==(const StationID &station) const { return this->value == station; }
};
 
static const VehicleOrderID INVALID_VEH_ORDER_ID = 0xFF;
static const VehicleOrderID MAX_VEH_ORDER_ID     = INVALID_VEH_ORDER_ID - 1;
 
static const uint IMPLICIT_ORDER_ONLY_CAP = 32;
 
enum OrderType : uint8_t {
  OT_BEGIN         = 0,
  OT_NOTHING       = 0,
  OT_GOTO_STATION  = 1,
  OT_GOTO_DEPOT    = 2,
  OT_LOADING       = 3,
  OT_LEAVESTATION  = 4,
  OT_DUMMY         = 5,
  OT_GOTO_WAYPOINT = 6,
  OT_CONDITIONAL   = 7,
  OT_IMPLICIT      = 8,
  OT_END
};
 
enum class OrderUnloadType : uint8_t {
  UnloadIfPossible = 0, 
  Unload = 1, 
  Transfer = 2, 
  NoUnload = 4, 
};
 
enum class OrderLoadType : uint8_t {
  LoadIfPossible = 0, 
  FullLoad = 2, 
  FullLoadAny = 3, 
  NoLoad = 4, 
};
 
enum class OrderNonStopFlag : uint8_t {
  NoIntermediate = 0, 
  NoDestination = 1, 
};
 
using OrderNonStopFlags = EnumBitSet<OrderNonStopFlag, uint8_t>;
 
enum class OrderStopLocation : uint8_t {
  NearEnd = 0, 
  Middle = 1, 
  FarEnd = 2, 
  End,
};
 
enum class OrderDepotTypeFlag : uint8_t {
  Service = 0, 
  PartOfOrders = 1, 
};
 
using OrderDepotTypeFlags = EnumBitSet<OrderDepotTypeFlag, uint8_t>;
 
enum class OrderDepotActionFlag : uint8_t {
  Halt = 0, 
  NearestDepot = 1, 
  Unbunch = 2, 
};
 
using OrderDepotActionFlags = EnumBitSet<OrderDepotActionFlag, uint8_t>;
 
enum class OrderConditionVariable : uint8_t {
  LoadPercentage = 0, 
  Reliability = 1, 
  MaxSpeed = 2, 
  Age = 3, 
  RequiresService = 4, 
  Unconditionally = 5, 
  RemainingLifetime = 6, 
  MaxReliability = 7, 
  End,
};
 
enum class OrderConditionComparator : uint8_t {
  Equal = 0, 
  NotEqual = 1, 
  LessThan = 2, 
  LessThanOrEqual = 3, 
  MoreThan = 4, 
  MoreThanOrEqual = 5, 
  IsTrue = 6, 
  IsFalse = 7, 
  End,
};
 
 
enum ModifyOrderFlags : uint8_t {
  MOF_NON_STOP,        
  MOF_STOP_LOCATION,   
  MOF_UNLOAD,          
  MOF_LOAD,            
  MOF_DEPOT_ACTION,    
  MOF_COND_VARIABLE,   
  MOF_COND_COMPARATOR, 
  MOF_COND_VALUE,      
  MOF_COND_DESTINATION,
  MOF_END
};
 
enum class OrderDepotAction : uint8_t {
  AlwaysGo = 0, 
  Service = 1, 
  Stop = 2, 
  Unbunch = 3, 
  End
};
 
enum ModifyTimetableFlags : uint8_t {
  MTF_WAIT_TIME,    
  MTF_TRAVEL_TIME,  
  MTF_TRAVEL_SPEED, 
  MTF_END
};
 
enum CloneOptions : uint8_t {
  CO_SHARE   = 0,
  CO_COPY    = 1,
  CO_UNSHARE = 2
};
 
struct Order;
struct OrderList;
 
#endif /* ORDER_TYPE_H */