1

/* $Id$ */

     2

     3

/** @file engine_type.h Types related to engines. */

     4

     5

#ifndef ENGINE_TYPE_H

     6

#define ENGINE_TYPE_H

     7

     8

#include "rail_type.h"

     9

#include "cargo_type.h"

    10

#include "vehicle_type.h"

    11

#include "gfx_type.h"

    12

#include "date_type.h"

    13

#include "sound_type.h"

    14

#include "player_type.h"

    15

#include "strings_type.h"

    16

    17

#include <vector>

    18

    19

typedef uint16 EngineID;

    20

typedef uint16 EngineRenewID;

    21

typedef std::vector<EngineID> EngineList; ///< engine list type

    22

    23

struct Engine;

    24

    25

enum RailVehicleTypes {

    26

	RAILVEH_SINGLEHEAD,  ///< indicates a "standalone" locomotive

    27

	RAILVEH_MULTIHEAD,   ///< indicates a combination of two locomotives

    28

	RAILVEH_WAGON,       ///< simple wagon, not motorized

    29

};

    30

    31

enum EngineClass {

    32

	EC_STEAM,

    33

	EC_DIESEL,

    34

	EC_ELECTRIC,

    35

	EC_MONORAIL,

    36

	EC_MAGLEV,

    37

};

    38

    39

struct RailVehicleInfo {

    40

	byte image_index;

    41

	RailVehicleTypes railveh_type;

    42

	byte base_cost;

    43

	RailTypeByte railtype;

    44

	uint16 max_speed;

    45

	uint16 power;

    46

	uint16 weight;

    47

	byte running_cost;

    48

	byte running_cost_class;

    49

	EngineClass engclass;           ///< Class of engine for this vehicle

    50

	byte capacity;

    51

	CargoID cargo_type;

    52

	byte ai_rank;

    53

	byte ai_passenger_only; ///< Bit value to tell AI that this engine is for passenger use only

    54

	uint16 pow_wag_power;

    55

	byte pow_wag_weight;

    56

	byte visual_effect; // NOTE: this is not 100% implemented yet, at the moment it is only used as a 'fallback' value

    57

	                    //       for when the 'powered wagon' callback fails. But it should really also determine what

    58

	                    //       kind of visual effect to generate for a vehicle (default, steam, diesel, electric).

    59

	                    //       Same goes for the callback result, which atm is only used to check if a wagon is powered.

    60

	byte shorten_factor;   ///< length on main map for this type is 8 - shorten_factor

    61

	byte tractive_effort;  ///< Tractive effort coefficient

    62

	byte user_def_data;    ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles

    63

};

    64

    65

struct ShipVehicleInfo {

    66

	byte image_index;

    67

	byte base_cost;

    68

	uint16 max_speed;

    69

	CargoID cargo_type;

    70

	uint16 capacity;

    71

	byte running_cost;

    72

	SoundFxByte sfx;

    73

	bool refittable;

    74

};

    75

    76

/* AircraftVehicleInfo subtypes, bitmask type.

    77

 * If bit 0 is 0 then it is a helicopter, otherwise it is a plane

    78

 * in which case bit 1 tells us whether it's a big(fast) plane or not */

    79

enum {

    80

	AIR_HELI = 0,

    81

	AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes

    82

	AIR_FAST = 2

    83

};

    84

    85

struct AircraftVehicleInfo {

    86

	byte image_index;

    87

	byte base_cost;

    88

	byte running_cost;

    89

	byte subtype;

    90

	SoundFxByte sfx;

    91

	byte acceleration;

    92

	uint16 max_speed;

    93

	byte mail_capacity;

    94

	uint16 passenger_capacity;

    95

};

    96

    97

struct RoadVehicleInfo {

    98

	byte image_index;

    99

	byte base_cost;

   100

	byte running_cost;

   101

	byte running_cost_class;

   102

	SoundFxByte sfx;

   103

	byte max_speed;

   104

	byte capacity;

   105

	CargoID cargo_type;

   106

};

   107

   108

/** Information about a vehicle

   109

 *  @see table/engines.h

   110

 */

   111

struct EngineInfo {

   112

	Date base_intro;

   113

	Year lifelength;

   114

	Year base_life;

   115

	byte unk2;         ///< flag for carriage(bit 7) and decay speed(bits0..6)

   116

	byte load_amount;

   117

	byte climates;

   118

	uint32 refit_mask;

   119

	byte refit_cost;

   120

	byte misc_flags;

   121

	byte callbackmask;

   122

	int8 retire_early;  ///< Number of years early to retire vehicle

   123

	StringID string_id; ///< Default name of engine

   124

};

   125

   126

/**

   127

 * EngineInfo.misc_flags is a bitmask, with the following values

   128

 */

   129

enum {

   130

	EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves

   131

	EF_ROAD_TRAM  = 0, ///< Road vehicle is a tram/light rail vehicle

   132

	EF_USES_2CC   = 1, ///< Vehicle uses two company colours

   133

	EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)

   134

};

   135

   136

/**

   137

 * Engine.flags is a bitmask, with the following values.

   138

 */

   139

enum {

   140

	ENGINE_AVAILABLE         = 1, ///< This vehicle is available to everyone.

   141

	ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a player.

   142

	ENGINE_OFFER_WINDOW_OPEN = 4, ///< The exclusive offer window is currently open for a player.

   143

};

   144

   145

enum {

   146

	NUM_VEHICLE_TYPES = 6

   147

};

   148

   149

static const EngineID INVALID_ENGINE = 0xFFFF;

   150

   151

#endif /* ENGINE_TYPE_H */