engine_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 ENGINE_TYPE_H
#define ENGINE_TYPE_H
 
#include "economy_type.h"
#include "rail_type.h"
#include "road_type.h"
#include "cargo_type.h"
#include "timer/timer_game_calendar.h"
#include "sound_type.h"
#include "strings_type.h"
 
typedef uint16_t EngineID; 
 
struct Engine;
 
enum RailVehicleTypes {
  RAILVEH_SINGLEHEAD,  
  RAILVEH_MULTIHEAD,   
  RAILVEH_WAGON,       
};
 
enum EngineClass {
  EC_STEAM,    
  EC_DIESEL,   
  EC_ELECTRIC, 
  EC_MONORAIL, 
  EC_MAGLEV,   
};
 
struct RailVehicleInfo {
  byte image_index;
  RailVehicleTypes railveh_type;
  byte cost_factor;               
  RailType railtype;              
  RailType intended_railtype;     
  uint16_t max_speed;               
  uint16_t power;                   
  uint16_t weight;                  
  byte running_cost;              
  Price running_cost_class;
  EngineClass engclass;           
  byte capacity;                  
  byte ai_passenger_only;         
  uint16_t pow_wag_power;           
  byte pow_wag_weight;            
  byte visual_effect;             
  byte shorten_factor;            
  byte tractive_effort;           
  byte air_drag;                  
  byte user_def_data;             
  int16_t curve_speed_mod;          
};
 
struct ShipVehicleInfo {
  byte image_index;
  byte cost_factor;
  uint8_t acceleration;    
  uint16_t max_speed;      
  uint16_t capacity;
  byte running_cost;
  SoundID sfx;
  bool old_refittable;   
  byte visual_effect;    
  byte ocean_speed_frac; 
  byte canal_speed_frac; 
 
  uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
  {
    /* speed_frac == 0 means no reduction while 0xFF means reduction to 1/256. */
    return raw_speed * (256 - (is_ocean ? this->ocean_speed_frac : this->canal_speed_frac)) / 256;
  }
};
 
enum AircraftSubTypeBits {
  AIR_HELI = 0,
  AIR_CTOL = 1, 
  AIR_FAST = 2
};
 
struct AircraftVehicleInfo {
  byte image_index;
  byte cost_factor;
  byte running_cost;
  byte subtype;               
  SoundID sfx;
  byte acceleration;
  uint16_t max_speed;           
  byte mail_capacity;         
  uint16_t passenger_capacity;  
  uint16_t max_range;           
};
 
struct RoadVehicleInfo {
  byte image_index;
  byte cost_factor;
  byte running_cost;
  Price running_cost_class;
  SoundID sfx;
  uint16_t max_speed;        
  byte capacity;
  uint8_t weight;            
  uint8_t power;             
  uint8_t tractive_effort;   
  uint8_t air_drag;          
  byte visual_effect;      
  byte shorten_factor;     
  RoadType roadtype;       
};
 
enum class ExtraEngineFlags : uint32_t {
  None = 0,
  NoNews          = (1U << 0), 
  NoPreview       = (1U << 1), 
  JoinPreview     = (1U << 2), 
  SyncReliability = (1U << 3), 
};
DECLARE_ENUM_AS_BIT_SET(ExtraEngineFlags);
 
struct EngineInfo {
  TimerGameCalendar::Date base_intro;    
  TimerGameCalendar::Year lifelength;    
  TimerGameCalendar::Year base_life;     
  byte decay_speed;
  byte load_amount;
  byte climates;      
  CargoID cargo_type;
  CargoTypes refit_mask;
  byte refit_cost;
  byte misc_flags;         
  uint16_t callback_mask;    
  int8_t retire_early;       
  StringID string_id;      
  uint16_t cargo_age_period; 
  EngineID variant_id;     
  ExtraEngineFlags extra_flags;
};
 
enum EngineMiscFlags {
  EF_RAIL_TILTS = 0, 
  EF_ROAD_TRAM  = 0, 
  EF_USES_2CC   = 1, 
  EF_RAIL_IS_MU = 2, 
  EF_RAIL_FLIPS = 3, 
  EF_AUTO_REFIT = 4, 
  EF_NO_DEFAULT_CARGO_MULTIPLIER = 5, 
  EF_NO_BREAKDOWN_SMOKE          = 6, 
  EF_SPRITE_STACK                = 7, 
};
 
enum EngineFlags {
  ENGINE_AVAILABLE         = 1, 
  ENGINE_EXCLUSIVE_PREVIEW = 2, 
};
 
enum EngineNameContext : uint8_t {
  Generic                 = 0x00, 
  VehicleDetails          = 0x11, 
  PurchaseList            = 0x20, 
  PreviewNews             = 0x21, 
  AutoreplaceVehicleInUse = 0x22, 
};
 
inline uint64_t PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32_t extra_data = 0)
{
  return engine_id | (static_cast<uint64_t>(context) << 32) | (static_cast<uint64_t>(extra_data) << 40);
}
 
static const uint MAX_LENGTH_ENGINE_NAME_CHARS = 32; 
 
static const EngineID INVALID_ENGINE = 0xFFFF; 
 
#endif /* ENGINE_TYPE_H */