cargo_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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef CARGO_TYPE_H
#define CARGO_TYPE_H
 
#include "core/enum_type.hpp"
 
typedef byte CargoID;
 
enum CargoType {
  /* Temperate */
  CT_PASSENGERS   =  0,
  CT_COAL         =  1,
  CT_MAIL         =  2,
  CT_OIL          =  3,
  CT_LIVESTOCK    =  4,
  CT_GOODS        =  5,
  CT_GRAIN        =  6,
  CT_WOOD         =  7,
  CT_IRON_ORE     =  8,
  CT_STEEL        =  9,
  CT_VALUABLES    = 10,
 
  /* Arctic */
  CT_WHEAT        =  6,
  CT_HILLY_UNUSED =  8,
  CT_PAPER        =  9,
  CT_GOLD         = 10,
  CT_FOOD         = 11,
 
  /* Tropic */
  CT_RUBBER       =  1,
  CT_FRUIT        =  4,
  CT_MAIZE        =  6,
  CT_COPPER_ORE   =  8,
  CT_WATER        =  9,
  CT_DIAMONDS     = 10,
 
  /* Toyland */
  CT_SUGAR        =  1,
  CT_TOYS         =  3,
  CT_BATTERIES    =  4,
  CT_CANDY        =  5,
  CT_TOFFEE       =  6,
  CT_COLA         =  7,
  CT_COTTON_CANDY =  8,
  CT_BUBBLES      =  9,
  CT_PLASTIC      = 10,
  CT_FIZZY_DRINKS = 11,
 
  CT_INVALID      = 0xFF, 
};
 
static const CargoID NUM_ORIGINAL_CARGO = 12; 
static const CargoID NUM_CARGO = 64; 
 
/* CARGO_AUTO_REFIT and CARGO_NO_REFIT are stored in save-games for refit-orders, so should not be changed. */
static const CargoID CARGO_AUTO_REFIT = 0xFD; 
static const CargoID CARGO_NO_REFIT = 0xFE; 
 
static const CargoID INVALID_CARGO = UINT8_MAX;
 
namespace CargoFilterCriteria {
  static constexpr CargoID CF_ANY     = NUM_CARGO;     
  static constexpr CargoID CF_NONE    = NUM_CARGO + 1; 
  static constexpr CargoID CF_ENGINES = NUM_CARGO + 2; 
  static constexpr CargoID CF_FREIGHT = NUM_CARGO + 3; 
};
 
inline bool IsValidCargoType(CargoType t) { return t != CT_INVALID; }
inline bool IsValidCargoID(CargoID t) { return t != INVALID_CARGO; }
 
typedef uint64_t CargoTypes;
 
static const CargoTypes ALL_CARGOTYPES = (CargoTypes)UINT64_MAX;
 
struct CargoArray : std::array<uint, NUM_CARGO> {
  template <typename T>
  inline const T GetSum() const
  {
    return std::reduce(this->begin(), this->end(), T{});
  }
 
  inline uint GetCount() const
  {
    return std::count_if(this->begin(), this->end(), [](uint amount) { return amount != 0; });
  }
};
 
 
enum class SourceType : byte {
  Industry,     
  Town,         
  Headquarters, 
};
 
typedef uint16_t SourceID; 
static const SourceID INVALID_SOURCE = 0xFFFF; 
 
#endif /* CARGO_TYPE_H */