author | KUDr |
Sun, 31 Dec 2006 02:53:23 +0000 | |
branch | custombridgeheads |
changeset 5611 | 11da6bafbfb9 |
parent 5588 | 1bcb6b4c01d8 |
permissions | -rw-r--r-- |
2186 | 1 |
/* $Id$ */ |
2 |
||
0 | 3 |
#ifndef ENGINE_H |
4 |
#define ENGINE_H |
|
5 |
||
4549
60410aa1aa88
(svn r6381) -Cleanup: make the '/* */' comments that span multiple lines more uniform.
rubidium
parents:
4434
diff
changeset
|
6 |
/** @file engine.h */ |
2129
9095824555e6
(svn r2639) -Add: Added the vehicle names in table/engines.h so that you know what line represents what vehicle (I hope I didn't mess that up). Added some comments while I'm at it and include the table/ directory in the Doxygen generation
celestar
parents:
1998
diff
changeset
|
7 |
|
5216
d581e4db95b6
(svn r7331) - Codechange: Rename all memory pool macro's and types to "old pool", so the new pool implementation can be committed alongside it.
matthijs
parents:
5215
diff
changeset
|
8 |
#include "oldpool.h" |
405
6830ae7a0d5d
(svn r602) -newgrf: Move DrawTileSeqStruct & co and struct SpriteGroup to sprite.h (pasky)
darkvater
parents:
389
diff
changeset
|
9 |
|
0 | 10 |
typedef struct RailVehicleInfo { |
11 |
byte image_index; |
|
12 |
byte flags; /* 1=multihead engine, 2=wagon */ |
|
13 |
byte base_cost; |
|
14 |
uint16 max_speed; |
|
15 |
uint16 power; |
|
2542
fdea27216e48
(svn r3071) -NewGRF: Add support for rail vehicle weight greater than 255 tons.
peter1138
parents:
2530
diff
changeset
|
16 |
uint16 weight; |
0 | 17 |
byte running_cost_base; |
2840
d68a605b2087
(svn r3388) - NewGRF: Allow train running cost class to differ from engine class. Also fix typo in r3384.
peter1138
parents:
2817
diff
changeset
|
18 |
byte running_cost_class; |
0 | 19 |
byte engclass; // 0: steam, 1: diesel, 2: electric |
20 |
byte capacity; |
|
3344
d86c852715fa
(svn r4128) - CodeChange: Add proper semantics for CargoID for such variables instead of using the general byte-type.
Darkvater
parents:
3113
diff
changeset
|
21 |
CargoID cargo_type; |
3022
236a3e5b3c69
(svn r3602) - Move _railveh_score data to _rail_vehicle_info->ai_rank and remove global variable to return data as we can now access this directly.
peter1138
parents:
3006
diff
changeset
|
22 |
byte ai_rank; |
1908
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
23 |
uint16 pow_wag_power; |
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
24 |
byte pow_wag_weight; |
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
25 |
byte visual_effect; // NOTE: this is not 100% implemented yet, at the moment it is only used as a 'fallback' value |
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
26 |
// for when the 'powered wagon' callback fails. But it should really also determine what |
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
27 |
// kind of visual effect to generate for a vehicle (default, steam, diesel, electric). |
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
28 |
// Same goes for the callback result, which atm is only used to check if a wagon is powered. |
4434
4175805666a5
(svn r6204) -Cleanup: replace non-indentation with spaces; like '}<TAB>else {' -> '} else {', tabs between code and comment, etc.
rubidium
parents:
4384
diff
changeset
|
29 |
byte shorten_factor; // length on main map for this type is 8 - shorten_factor |
5588
1bcb6b4c01d8
(svn r7592) -Feature: Add support for tractive effort to 'realistic' acceleration.
peter1138
parents:
5216
diff
changeset
|
30 |
byte tractive_effort; ///< Tractive effort coefficient |
3862
898c8212afa1
(svn r4896) - NewGRF: add support for vehicle property 0x25 (user defined data) used by variable 0x42.
peter1138
parents:
3750
diff
changeset
|
31 |
byte user_def_data; ///! Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles |
0 | 32 |
} RailVehicleInfo; |
33 |
||
34 |
typedef struct ShipVehicleInfo { |
|
35 |
byte image_index; |
|
36 |
byte base_cost; |
|
37 |
uint16 max_speed; |
|
3344
d86c852715fa
(svn r4128) - CodeChange: Add proper semantics for CargoID for such variables instead of using the general byte-type.
Darkvater
parents:
3113
diff
changeset
|
38 |
CargoID cargo_type; |
0 | 39 |
uint16 capacity; |
40 |
byte running_cost; |
|
41 |
byte sfx; |
|
42 |
byte refittable; |
|
43 |
} ShipVehicleInfo; |
|
44 |
||
4023
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
45 |
// Aircraft subtypes |
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
46 |
enum { |
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
47 |
AIR_CTOL = 1, // Conventional Take Off and Landing, i.e. planes |
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
48 |
AIR_FAST = 2 |
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
49 |
}; |
b65af90447d2
(svn r5262) Add symbolic names for the aircraft subtypes. not perfect, but better than raw numbers
tron
parents:
3997
diff
changeset
|
50 |
|
376
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
51 |
typedef struct AircraftVehicleInfo { |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
52 |
byte image_index; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
53 |
byte base_cost; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
54 |
byte running_cost; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
55 |
byte subtype; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
56 |
byte sfx; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
57 |
byte acceleration; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
58 |
byte max_speed; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
59 |
byte mail_capacity; |
922
fc040662bd43
(svn r1410) Replaced all occurences of 'passanger' by 'passenger' in the code
celestar
parents:
842
diff
changeset
|
60 |
uint16 passenger_capacity; |
376
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
61 |
} AircraftVehicleInfo; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
62 |
|
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
63 |
typedef struct RoadVehicleInfo { |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
64 |
byte image_index; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
65 |
byte base_cost; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
66 |
byte running_cost; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
67 |
byte sfx; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
68 |
byte max_speed; |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
69 |
byte capacity; |
3344
d86c852715fa
(svn r4128) - CodeChange: Add proper semantics for CargoID for such variables instead of using the general byte-type.
Darkvater
parents:
3113
diff
changeset
|
70 |
CargoID cargo_type; |
376
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
71 |
} RoadVehicleInfo; |
0 | 72 |
|
2129
9095824555e6
(svn r2639) -Add: Added the vehicle names in table/engines.h so that you know what line represents what vehicle (I hope I didn't mess that up). Added some comments while I'm at it and include the table/ directory in the Doxygen generation
celestar
parents:
1998
diff
changeset
|
73 |
/** Information about a vehicle |
4549
60410aa1aa88
(svn r6381) -Cleanup: make the '/* */' comments that span multiple lines more uniform.
rubidium
parents:
4434
diff
changeset
|
74 |
* @see table/engines.h |
60410aa1aa88
(svn r6381) -Cleanup: make the '/* */' comments that span multiple lines more uniform.
rubidium
parents:
4434
diff
changeset
|
75 |
*/ |
0 | 76 |
typedef struct EngineInfo { |
4289
ff1b2b915cab
(svn r5919) -Cleanup: use the type Date when the variable really is a date
rubidium
parents:
4077
diff
changeset
|
77 |
Date base_intro; |
2129
9095824555e6
(svn r2639) -Add: Added the vehicle names in table/engines.h so that you know what line represents what vehicle (I hope I didn't mess that up). Added some comments while I'm at it and include the table/ directory in the Doxygen generation
celestar
parents:
1998
diff
changeset
|
78 |
byte unk2; ///< Carriages have the highest bit set in this one |
4326
c2ae4dbc1074
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4289
diff
changeset
|
79 |
Year lifelength; |
c2ae4dbc1074
(svn r5999) -Feature: change the original date format to a 32 bits format based at the year 0.
rubidium
parents:
4289
diff
changeset
|
80 |
Year base_life; |
5211
651c9272ad22
(svn r7326) -Feature: Add support for gradual (un)loading of vehicles (Maedhros)
peter1138
parents:
5187
diff
changeset
|
81 |
byte load_amount; |
2530
b8d5a5284024
(svn r3059) Use bitfields to encode railtype and climates of engines instead of manual shifting/anding
tron
parents:
2491
diff
changeset
|
82 |
byte railtype:4; |
b8d5a5284024
(svn r3059) Use bitfields to encode railtype and climates of engines instead of manual shifting/anding
tron
parents:
2491
diff
changeset
|
83 |
byte climates:4; |
2611
65b5313bc525
(svn r3148) -NewGRF, Feature: Add support for cargo refitting specification by cargo classes.
peter1138
parents:
2602
diff
changeset
|
84 |
uint32 refit_mask; |
3997
29c77eab14a4
(svn r5201) - NewGRF: add loading of default refit costs. This information is not yet used
peter1138
parents:
3956
diff
changeset
|
85 |
byte refit_cost; |
3095
2d4498efac3b
(svn r3684) - NewGRF: Support loading of miscellaneous flags (not used yet)
peter1138
parents:
3022
diff
changeset
|
86 |
byte misc_flags; |
3956
0f43adbc293a
(svn r5105) - NewGRF: Move callbackmask from *VehicleInfo to EngineInfo. This simplifies code that works with more than one vehicle type.
peter1138
parents:
3866
diff
changeset
|
87 |
byte callbackmask; |
0 | 88 |
} EngineInfo; |
89 |
||
90 |
typedef struct Engine { |
|
4289
ff1b2b915cab
(svn r5919) -Cleanup: use the type Date when the variable really is a date
rubidium
parents:
4077
diff
changeset
|
91 |
Date intro_date; |
ff1b2b915cab
(svn r5919) -Cleanup: use the type Date when the variable really is a date
rubidium
parents:
4077
diff
changeset
|
92 |
Date age; |
0 | 93 |
uint16 reliability; |
94 |
uint16 reliability_spd_dec; |
|
95 |
uint16 reliability_start, reliability_max, reliability_final; |
|
96 |
uint16 duration_phase_1, duration_phase_2, duration_phase_3; |
|
97 |
byte lifelength; |
|
98 |
byte flags; |
|
2331
72a9f9b31e4e
(svn r2857) -Fix: PlayerID is not a valid type for a player-bit-field. Partly reverted r2290
truelight
parents:
2186
diff
changeset
|
99 |
byte preview_player; |
0 | 100 |
byte preview_wait; |
101 |
byte railtype; |
|
2331
72a9f9b31e4e
(svn r2857) -Fix: PlayerID is not a valid type for a player-bit-field. Partly reverted r2290
truelight
parents:
2186
diff
changeset
|
102 |
byte player_avail; |
4434
4175805666a5
(svn r6204) -Cleanup: replace non-indentation with spaces; like '}<TAB>else {' -> '} else {', tabs between code and comment, etc.
rubidium
parents:
4384
diff
changeset
|
103 |
byte type; // type, ie VEH_Road, VEH_Train, etc. Same as in vehicle.h |
0 | 104 |
} Engine; |
105 |
||
3113
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
106 |
/** |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
107 |
* EngineInfo.misc_flags is a bitmask, with the following values |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
108 |
*/ |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
109 |
enum { |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
110 |
EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves (unsupported) |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
111 |
EF_ROAD_TRAM = 0, ///< Road vehicle is a tram/light rail vehicle (unsup) |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
112 |
EF_USES_2CC = 1, ///< Vehicle uses two company colours |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
113 |
EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU) |
c0f312f22238
(svn r3717) - [2cc] Add 2cc colour maps and use for newgrf engines requiring them. Currently the second colour is fixed to be the player's colour.
peter1138
parents:
3095
diff
changeset
|
114 |
}; |
0 | 115 |
|
116 |
enum { |
|
117 |
RVI_MULTIHEAD = 1, |
|
118 |
RVI_WAGON = 2, |
|
119 |
}; |
|
120 |
||
1802
448f187042d3
(svn r2306) - CodeChange: Check the last commands; refits. This needed an extensive rewrite and global/local-cargo ID juggling and bitmasking. However with this done it looks better as well and is compatible with newgrf handling. Big thanks to HackyKid for doing most of the work. This also closes patch "[ 1199277 ] Command checks"
Darkvater
parents:
1786
diff
changeset
|
121 |
enum { |
448f187042d3
(svn r2306) - CodeChange: Check the last commands; refits. This needed an extensive rewrite and global/local-cargo ID juggling and bitmasking. However with this done it looks better as well and is compatible with newgrf handling. Big thanks to HackyKid for doing most of the work. This also closes patch "[ 1199277 ] Command checks"
Darkvater
parents:
1786
diff
changeset
|
122 |
NUM_VEHICLE_TYPES = 6 |
448f187042d3
(svn r2306) - CodeChange: Check the last commands; refits. This needed an extensive rewrite and global/local-cargo ID juggling and bitmasking. However with this done it looks better as well and is compatible with newgrf handling. Big thanks to HackyKid for doing most of the work. This also closes patch "[ 1199277 ] Command checks"
Darkvater
parents:
1786
diff
changeset
|
123 |
}; |
0 | 124 |
|
2848 | 125 |
enum { |
126 |
INVALID_ENGINE = 0xFFFF, |
|
127 |
}; |
|
128 |
||
1093
e8d26c7dc42f
(svn r1594) Convert all undefined parameter lists to (void) and add the appropriate warning flags in the Makefile
tron
parents:
922
diff
changeset
|
129 |
void AddTypeToEngines(void); |
e8d26c7dc42f
(svn r1594) Convert all undefined parameter lists to (void) and add the appropriate warning flags in the Makefile
tron
parents:
922
diff
changeset
|
130 |
void StartupEngines(void); |
0 | 131 |
|
132 |
||
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
133 |
void DrawTrainEngine(int x, int y, EngineID engine, uint32 image_ormod); |
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
134 |
void DrawRoadVehEngine(int x, int y, EngineID engine, uint32 image_ormod); |
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
135 |
void DrawShipEngine(int x, int y, EngineID engine, uint32 image_ormod); |
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
136 |
void DrawAircraftEngine(int x, int y, EngineID engine, uint32 image_ormod); |
0 | 137 |
|
1093
e8d26c7dc42f
(svn r1594) Convert all undefined parameter lists to (void) and add the appropriate warning flags in the Makefile
tron
parents:
922
diff
changeset
|
138 |
void LoadCustomEngineNames(void); |
e8d26c7dc42f
(svn r1594) Convert all undefined parameter lists to (void) and add the appropriate warning flags in the Makefile
tron
parents:
922
diff
changeset
|
139 |
void DeleteCustomEngineNames(void); |
0 | 140 |
|
5215
439d5ca71311
(svn r7330) -Fix (r7304): Data invalidation doesn't always happen as the local
peter1138
parents:
5211
diff
changeset
|
141 |
bool IsEngineBuildable(EngineID engine, byte type, PlayerID player); |
0 | 142 |
|
143 |
enum { |
|
144 |
NUM_NORMAL_RAIL_ENGINES = 54, |
|
4344
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
145 |
NUM_MONORAIL_ENGINES = 30, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
146 |
NUM_MAGLEV_ENGINES = 32, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
147 |
NUM_TRAIN_ENGINES = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
148 |
NUM_ROAD_ENGINES = 88, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
149 |
NUM_SHIP_ENGINES = 11, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
150 |
NUM_AIRCRAFT_ENGINES = 41, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
151 |
TOTAL_NUM_ENGINES = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
152 |
AIRCRAFT_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
153 |
SHIP_ENGINES_INDEX = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES, |
5d0e40cd67b9
(svn r6045) -Cleanup: align all table-like structures using spaces, i.e. whitespace fixes only except for a few comments to make them uniform for the whole enum/struct.
rubidium
parents:
4326
diff
changeset
|
154 |
ROAD_ENGINES_INDEX = NUM_TRAIN_ENGINES, |
0 | 155 |
}; |
156 |
VARDEF Engine _engines[TOTAL_NUM_ENGINES]; |
|
1786
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
157 |
#define FOR_ALL_ENGINES(e) for (e = _engines; e != endof(_engines); e++) |
1926
68d60188a22f
(svn r2432) Use GetEngine() instead of DEREF_ENGINE() or even _engines[]
tron
parents:
1922
diff
changeset
|
158 |
|
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
159 |
static inline Engine* GetEngine(EngineID i) |
1786
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
160 |
{ |
4077
d3022f976946
(svn r5391) Miscellaneous, mostly bracing and whitespace, nothing spectacular
tron
parents:
4023
diff
changeset
|
161 |
assert(i < lengthof(_engines)); |
d3022f976946
(svn r5391) Miscellaneous, mostly bracing and whitespace, nothing spectacular
tron
parents:
4023
diff
changeset
|
162 |
return &_engines[i]; |
1786
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
163 |
} |
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
164 |
|
0 | 165 |
VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES]; |
166 |
||
1786
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
167 |
static inline bool IsEngineIndex(uint index) |
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
168 |
{ |
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
169 |
return index < TOTAL_NUM_ENGINES; |
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
170 |
} |
a54634efeb98
(svn r2290) - CodeChange: protect the next batch of commands. This brings us to a total of 61, which is 53% :)
Darkvater
parents:
1477
diff
changeset
|
171 |
|
376
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
172 |
/* Access Vehicle Data */ |
1a4425a0a953
(svn r565) -newgrf: fixed double work of RoadVehicleInfo[]; added AircraftVehicleInfo[] as well. table/engines.h is now the same as in the _map branch.
darkvater
parents:
374
diff
changeset
|
173 |
//#include "table/engines.h" |
2463
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
174 |
extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES]; |
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
175 |
extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES]; |
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
176 |
extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES]; |
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
177 |
extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES]; |
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
178 |
extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES]; |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
179 |
|
2763 | 180 |
extern EngineInfo _engine_info[TOTAL_NUM_ENGINES]; |
181 |
extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES]; |
|
182 |
extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES]; |
|
183 |
extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES]; |
|
184 |
extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES]; |
|
2463
de2605ed3758
(svn r2989) - Make engine/vehicle information tables constant. Duplicate them so NewGRF data can be loaded without wiping out the default data.
peter1138
parents:
2436
diff
changeset
|
185 |
|
3393
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
186 |
static inline const EngineInfo *EngInfo(EngineID e) |
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
187 |
{ |
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
188 |
assert(e < lengthof(_engine_info)); |
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
189 |
return &_engine_info[e]; |
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
190 |
} |
48ce4c723a76
(svn r4201) - Codechange: Do for _engine_info[] what we do for _*_vehicle_info[]; create and use a function to retrieve data, and ensure constness.
peter1138
parents:
3344
diff
changeset
|
191 |
|
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
192 |
static inline const RailVehicleInfo* RailVehInfo(EngineID e) |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
193 |
{ |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
194 |
assert(e < lengthof(_rail_vehicle_info)); |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
195 |
return &_rail_vehicle_info[e]; |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
196 |
} |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
197 |
|
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
198 |
static inline const ShipVehicleInfo* ShipVehInfo(EngineID e) |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
199 |
{ |
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
200 |
assert(e >= SHIP_ENGINES_INDEX && e < SHIP_ENGINES_INDEX + lengthof(_ship_vehicle_info)); |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
201 |
return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX]; |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
202 |
} |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
203 |
|
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
204 |
static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e) |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
205 |
{ |
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
206 |
assert(e >= AIRCRAFT_ENGINES_INDEX && e < AIRCRAFT_ENGINES_INDEX + lengthof(_aircraft_vehicle_info)); |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
207 |
return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX]; |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
208 |
} |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
209 |
|
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
210 |
static inline const RoadVehicleInfo* RoadVehInfo(EngineID e) |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
211 |
{ |
2477
d454d5152386
(svn r3003) Change int, uint, uin16 and byte to EngineID where appropriate, plus some related changes (mostly casts)
tron
parents:
2464
diff
changeset
|
212 |
assert(e >= ROAD_ENGINES_INDEX && e < ROAD_ENGINES_INDEX + lengthof(_road_vehicle_info)); |
538
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
213 |
return &_road_vehicle_info[e - ROAD_ENGINES_INDEX]; |
5dd99f3b7eca
(svn r920) Replace vehicle info macros with inline functions and add asserts to check limits
tron
parents:
445
diff
changeset
|
214 |
} |
405
6830ae7a0d5d
(svn r602) -newgrf: Move DrawTileSeqStruct & co and struct SpriteGroup to sprite.h (pasky)
darkvater
parents:
389
diff
changeset
|
215 |
|
2848 | 216 |
/************************************************************************ |
217 |
* Engine Replacement stuff |
|
218 |
************************************************************************/ |
|
219 |
||
220 |
/** |
|
221 |
* Struct to store engine replacements. DO NOT USE outside of engine.c. Is |
|
222 |
* placed here so the only exception to this rule, the saveload code, can use |
|
223 |
* it. |
|
224 |
*/ |
|
225 |
struct EngineRenew { |
|
4348
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
226 |
EngineRenewID index; |
2848 | 227 |
EngineID from; |
228 |
EngineID to; |
|
229 |
struct EngineRenew *next; |
|
230 |
}; |
|
231 |
||
232 |
typedef struct EngineRenew EngineRenew; |
|
233 |
||
234 |
/** |
|
235 |
* Memory pool for engine renew elements. DO NOT USE outside of engine.c. Is |
|
236 |
* placed here so the only exception to this rule, the saveload code, can use |
|
237 |
* it. |
|
238 |
*/ |
|
5216
d581e4db95b6
(svn r7331) - Codechange: Rename all memory pool macro's and types to "old pool", so the new pool implementation can be committed alongside it.
matthijs
parents:
5215
diff
changeset
|
239 |
DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000) |
4348
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
240 |
|
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
241 |
/** |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
242 |
* Check if a EngineRenew really exists. |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
243 |
*/ |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
244 |
static inline bool IsValidEngineRenew(const EngineRenew *er) |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
245 |
{ |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
246 |
return er->from != INVALID_ENGINE; |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
247 |
} |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
248 |
|
4384
293c0d26294c
(svn r6137) -Codechange: some very minor cleanups:
truelight
parents:
4348
diff
changeset
|
249 |
static inline void DeleteEngineRenew(EngineRenew *er) |
293c0d26294c
(svn r6137) -Codechange: some very minor cleanups:
truelight
parents:
4348
diff
changeset
|
250 |
{ |
293c0d26294c
(svn r6137) -Codechange: some very minor cleanups:
truelight
parents:
4348
diff
changeset
|
251 |
er->from = INVALID_ENGINE; |
293c0d26294c
(svn r6137) -Codechange: some very minor cleanups:
truelight
parents:
4348
diff
changeset
|
252 |
} |
293c0d26294c
(svn r6137) -Codechange: some very minor cleanups:
truelight
parents:
4348
diff
changeset
|
253 |
|
4974
c962d0622bc1
(svn r6977) Use the pool macros for the EngineRenew pool
tron
parents:
4549
diff
changeset
|
254 |
#define FOR_ALL_ENGINE_RENEWS_FROM(er, start) for (er = GetEngineRenew(start); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) if (er->from != INVALID_ENGINE) if (IsValidEngineRenew(er)) |
4348
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
255 |
#define FOR_ALL_ENGINE_RENEWS(er) FOR_ALL_ENGINE_RENEWS_FROM(er, 0) |
95ba9ff1612e
(svn r6049) -Codechange: forgot EngineRenew in r6047
truelight
parents:
4344
diff
changeset
|
256 |
|
2848 | 257 |
|
258 |
/** |
|
259 |
* A list to group EngineRenew directives together (such as per-player). |
|
260 |
*/ |
|
261 |
typedef EngineRenew* EngineRenewList; |
|
262 |
||
263 |
/** |
|
264 |
* Remove all engine replacement settings for the player. |
|
265 |
* @param er The renewlist for a given player. |
|
266 |
* @return The new renewlist for the player. |
|
267 |
*/ |
|
268 |
void RemoveAllEngineReplacement(EngineRenewList* erl); |
|
269 |
||
270 |
/** |
|
271 |
* Retrieve the engine replacement in a given renewlist for an original engine type. |
|
272 |
* @param erl The renewlist to search in. |
|
273 |
* @param engine Engine type to be replaced. |
|
274 |
* @return The engine type to replace with, or INVALID_ENGINE if no |
|
275 |
* replacement is in the list. |
|
276 |
*/ |
|
277 |
EngineID EngineReplacement(EngineRenewList erl, EngineID engine); |
|
278 |
||
279 |
/** |
|
280 |
* Add an engine replacement to the given renewlist. |
|
281 |
* @param erl The renewlist to add to. |
|
282 |
* @param old_engine The original engine type. |
|
283 |
* @param new_engine The replacement engine type. |
|
284 |
* @param flags The calling command flags. |
|
285 |
* @return 0 on success, CMD_ERROR on failure. |
|
286 |
*/ |
|
287 |
int32 AddEngineReplacement(EngineRenewList* erl, EngineID old_engine, EngineID new_engine, uint32 flags); |
|
288 |
||
289 |
/** |
|
290 |
* Remove an engine replacement from a given renewlist. |
|
291 |
* @param erl The renewlist from which to remove the replacement |
|
292 |
* @param engine The original engine type. |
|
293 |
* @param flags The calling command flags. |
|
294 |
* @return 0 on success, CMD_ERROR on failure. |
|
295 |
*/ |
|
296 |
int32 RemoveEngineReplacement(EngineRenewList* erl, EngineID engine, uint32 flags); |
|
297 |
||
5187
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
298 |
/* Engine list manipulators - current implementation is only C wrapper of CBlobT<EngineID> class (helpers.cpp) */ |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
299 |
void EngList_Create(EngineList *el); ///< Creates engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
300 |
void EngList_Destroy(EngineList *el); ///< Deallocate and destroy engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
301 |
uint EngList_Count(const EngineList *el); ///< Returns number of items in the engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
302 |
void EngList_Add(EngineList *el, EngineID eid); ///< Append one item at the end of engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
303 |
EngineID* EngList_Items(EngineList *el); ///< Returns engine list items as C array |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
304 |
void EngList_RemoveAll(EngineList *el); ///< Removes all items from engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
305 |
typedef int CDECL EngList_SortTypeFunction(const void*, const void*); ///< argument type for EngList_Sort() |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
306 |
void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare); ///< qsort of the engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
307 |
void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list |
d1f4e447a7eb
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:
KUDr
parents:
5037
diff
changeset
|
308 |
|
2436
177cb6a8339f
(svn r2962) - const correctness for all Get* functions and most Draw* functions that don't change their pointer parameters
Darkvater
parents:
2331
diff
changeset
|
309 |
#endif /* ENGINE_H */ |