author | peter1138 |
Thu, 14 Dec 2006 19:10:46 +0000 | |
changeset 5334 | 12140f2008c8 |
parent 5037 | 7d956200ee71 |
permissions | -rw-r--r-- |
2186 | 1 |
/* $Id$ */ |
2 |
||
2962
dbd168a4703a
(svn r3524) - Split newgrf features from engine.[ch] into newgrf_engine.[ch], and add the new files to project files.
peter1138
parents:
2848
diff
changeset
|
3 |
#ifndef NEWGRF_ENGINE_H |
dbd168a4703a
(svn r3524) - Split newgrf features from engine.[ch] into newgrf_engine.[ch], and add the new files to project files.
peter1138
parents:
2848
diff
changeset
|
4 |
#define NEWGRF_ENGINE_H |
0 | 5 |
|
4656
acffecd6f484
(svn r6532) - Feature: Add support for NewGRF sound effects. Currently sound priority isn't supported.
peter1138
parents:
4344
diff
changeset
|
6 |
#include "newgrf.h" |
3157
40de8616c04c
(svn r3783) Replace further ints and magic numbers by Direction, DiagDirection and friends
tron
parents:
2982
diff
changeset
|
7 |
#include "direction.h" |
3866
113de2b20059
(svn r4902) Newgrf : Introduction of the newgrf_cargo files.
belugas
parents:
3845
diff
changeset
|
8 |
#include "newgrf_cargo.h" |
3157
40de8616c04c
(svn r3783) Replace further ints and magic numbers by Direction, DiagDirection and friends
tron
parents:
2982
diff
changeset
|
9 |
|
2962
dbd168a4703a
(svn r3524) - Split newgrf features from engine.[ch] into newgrf_engine.[ch], and add the new files to project files.
peter1138
parents:
2848
diff
changeset
|
10 |
/** @file newgrf_engine.h |
dbd168a4703a
(svn r3524) - Split newgrf features from engine.[ch] into newgrf_engine.[ch], and add the new files to project files.
peter1138
parents:
2848
diff
changeset
|
11 |
*/ |
0 | 12 |
|
3785
1becd6b333fe
(svn r4781) - NewGRF: give _traininfo_vehicle_pitch a proper declaration
peter1138
parents:
3726
diff
changeset
|
13 |
extern int _traininfo_vehicle_pitch; |
3845
c3cd4b825c2f
(svn r4869) - NewGRF: support setting train list vehicle width to 32 instead of 29 pixels, for sets which use 32 pixel long engines/wagons.
peter1138
parents:
3785
diff
changeset
|
14 |
extern int _traininfo_vehicle_width; |
3785
1becd6b333fe
(svn r4781) - NewGRF: give _traininfo_vehicle_pitch a proper declaration
peter1138
parents:
3726
diff
changeset
|
15 |
|
3866
113de2b20059
(svn r4902) Newgrf : Introduction of the newgrf_cargo files.
belugas
parents:
3845
diff
changeset
|
16 |
extern const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO]; |
113de2b20059
(svn r4902) Newgrf : Introduction of the newgrf_cargo files.
belugas
parents:
3845
diff
changeset
|
17 |
extern const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE]; |
113de2b20059
(svn r4902) Newgrf : Introduction of the newgrf_cargo files.
belugas
parents:
3845
diff
changeset
|
18 |
extern const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID]; |
113de2b20059
(svn r4902) Newgrf : Introduction of the newgrf_cargo files.
belugas
parents:
3845
diff
changeset
|
19 |
extern const uint32 cargo_classes[16]; |
0 | 20 |
|
4869
cded5f3a83c9
(svn r6795) - NewGRF: Add support for cargo-specific wagon overrides.
peter1138
parents:
4812
diff
changeset
|
21 |
void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, byte *train_id, int trains); |
3693
af2ee9b328e6
(svn r4629) - NewGRF: constify more code that deals with sprite groups, now that ref counting is gone.
peter1138
parents:
3684
diff
changeset
|
22 |
void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group); |
3695
aae28fa7190e
(svn r4632) - NewGRF: support loading of helicopter rotor sprites (mart3p)
peter1138
parents:
3693
diff
changeset
|
23 |
void SetRotorOverrideSprites(EngineID engine, const struct SpriteGroup *group); |
3684
c5dfac322f16
(svn r4609) - NewGRF: give GetCustomEngineSprite the correct return type
peter1138
parents:
3648
diff
changeset
|
24 |
SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle* v, Direction direction); |
4056
30ceffc75059
(svn r5336) - NewGRF: draw custom helicopter rotor sprites in vehicle info window, ensuring the correct direction is used (inspiration from mart3p)
peter1138
parents:
3924
diff
changeset
|
25 |
SpriteID GetRotorOverrideSprite(EngineID engine, const Vehicle* v, bool info_view); |
30ceffc75059
(svn r5336) - NewGRF: draw custom helicopter rotor sprites in vehicle info window, ensuring the correct direction is used (inspiration from mart3p)
peter1138
parents:
3924
diff
changeset
|
26 |
#define GetCustomRotorSprite(v, i) GetRotorOverrideSprite(v->engine_type, v, i) |
30ceffc75059
(svn r5336) - NewGRF: draw custom helicopter rotor sprites in vehicle info window, ensuring the correct direction is used (inspiration from mart3p)
peter1138
parents:
3924
diff
changeset
|
27 |
#define GetCustomRotorIcon(et) GetRotorOverrideSprite(et, NULL, true) |
3648
1574c89384cb
(svn r4559) - NewGRF: keep a record of which grf an engine is defined in. Will be used in the future.
peter1138
parents:
3604
diff
changeset
|
28 |
|
3924
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
29 |
/* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h |
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
30 |
* elsewhere... */ |
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
31 |
struct GRFFile; |
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
32 |
|
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
33 |
void SetEngineGRF(EngineID engine, const struct GRFFile *file); |
de86db4fbd1e
(svn r5059) - NewGRF: store a GRFFile pointer reference for each pointer, instead of just the GRF ID.
peter1138
parents:
3866
diff
changeset
|
34 |
const struct GRFFile *GetEngineGRF(EngineID engine); |
3648
1574c89384cb
(svn r4559) - NewGRF: keep a record of which grf an engine is defined in. Will be used in the future.
peter1138
parents:
3604
diff
changeset
|
35 |
uint32 GetEngineGRFID(EngineID engine); |
1574c89384cb
(svn r4559) - NewGRF: keep a record of which grf an engine is defined in. Will be used in the future.
peter1138
parents:
3604
diff
changeset
|
36 |
|
3725
1b5ce8c7b51f
(svn r4698) - When selecting files to commit, select the correct ones... missed header file update in r4697
peter1138
parents:
3695
diff
changeset
|
37 |
uint16 GetVehicleCallback(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v); |
3726
a446208c7296
(svn r4702) - NewGRF: add support for 'special' vehicle callbacks that use a different vehicle for parent scope than the first vehicle in the consist.
peter1138
parents:
3725
diff
changeset
|
38 |
uint16 GetVehicleCallbackParent(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent); |
1908
bc48a30aba72
(svn r2414) - Feature: [newgrf] Implement powered wagons, and the callback that goes with it.
hackykid
parents:
1895
diff
changeset
|
39 |
bool UsesWagonOverride(const Vehicle *v); |
414
e18cc252e2ea
(svn r611) -newgrf: Change GetCustomEngineSprite() calling convention (invisible to users of GetCustomVehicle*() wrappers). Needed for deterministic spritegroups support (pasky).
darkvater
parents:
405
diff
changeset
|
40 |
#define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction) |
e18cc252e2ea
(svn r611) -newgrf: Change GetCustomEngineSprite() calling convention (invisible to users of GetCustomVehicle*() wrappers). Needed for deterministic spritegroups support (pasky).
darkvater
parents:
405
diff
changeset
|
41 |
#define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction) |
0 | 42 |
|
1477 | 43 |
typedef enum VehicleTrigger { |
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:
4056
diff
changeset
|
44 |
VEHICLE_TRIGGER_NEW_CARGO = 1, |
445
0e3fa3da3899
(svn r654) Hopefully complete support for randomized variational spritegroups (i.e. the cars transporter in DBSetXL gets different cars each time) (pasky)
tron
parents:
414
diff
changeset
|
45 |
// Externally triggered only for the first vehicle in chain |
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:
4056
diff
changeset
|
46 |
VEHICLE_TRIGGER_DEPOT = 2, |
445
0e3fa3da3899
(svn r654) Hopefully complete support for randomized variational spritegroups (i.e. the cars transporter in DBSetXL gets different cars each time) (pasky)
tron
parents:
414
diff
changeset
|
47 |
// Externally triggered only for the first vehicle in chain, only if whole chain is empty |
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:
4056
diff
changeset
|
48 |
VEHICLE_TRIGGER_EMPTY = 4, |
445
0e3fa3da3899
(svn r654) Hopefully complete support for randomized variational spritegroups (i.e. the cars transporter in DBSetXL gets different cars each time) (pasky)
tron
parents:
414
diff
changeset
|
49 |
// Not triggered externally (called for the whole chain if we got NEW_CARGO) |
0e3fa3da3899
(svn r654) Hopefully complete support for randomized variational spritegroups (i.e. the cars transporter in DBSetXL gets different cars each time) (pasky)
tron
parents:
414
diff
changeset
|
50 |
VEHICLE_TRIGGER_ANY_NEW_CARGO = 8, |
1477 | 51 |
} VehicleTrigger; |
52 |
void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger); |
|
445
0e3fa3da3899
(svn r654) Hopefully complete support for randomized variational spritegroups (i.e. the cars transporter in DBSetXL gets different cars each time) (pasky)
tron
parents:
414
diff
changeset
|
53 |
|
3604
d28877422030
(svn r4496) - NewGRF: switch custom engine names from storing a char* to using the new StringID based text system. Vehicle name
peter1138
parents:
3390
diff
changeset
|
54 |
void SetCustomEngineName(EngineID engine, StringID name); |
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
|
55 |
StringID GetCustomEngineName(EngineID engine); |
0 | 56 |
|
2491
dfe9542f783e
(svn r3017) -NewGRF: Implement sprite group unreferencing and unloading.
peter1138
parents:
2477
diff
changeset
|
57 |
void UnloadWagonOverrides(void); |
3695
aae28fa7190e
(svn r4632) - NewGRF: support loading of helicopter rotor sprites (mart3p)
peter1138
parents:
3693
diff
changeset
|
58 |
void UnloadRotorOverrideSprites(void); |
2491
dfe9542f783e
(svn r3017) -NewGRF: Implement sprite group unreferencing and unloading.
peter1138
parents:
2477
diff
changeset
|
59 |
void UnloadCustomEngineSprites(void); |
2769
acea0abd2195
(svn r3316) - NewGRF: Unload engine names before loading grf files. This fixes names in climates where the engines don't get loaded. Renamed function to reflect its purpose.
peter1138
parents:
2763
diff
changeset
|
60 |
void UnloadCustomEngineNames(void); |
2491
dfe9542f783e
(svn r3017) -NewGRF: Implement sprite group unreferencing and unloading.
peter1138
parents:
2477
diff
changeset
|
61 |
|
2971
9b62397dbd56
(svn r3546) - NewGRF feature: Implement rail vehicle 'property' 0x1A: allows shuffling order of rail vehicle purchase list (and replace vehicle list)
peter1138
parents:
2962
diff
changeset
|
62 |
void ResetEngineListOrder(void); |
9b62397dbd56
(svn r3546) - NewGRF feature: Implement rail vehicle 'property' 0x1A: allows shuffling order of rail vehicle purchase list (and replace vehicle list)
peter1138
parents:
2962
diff
changeset
|
63 |
EngineID GetRailVehAtPosition(EngineID pos); |
4812
dab5a9855b72
(svn r6736) - Add a function to get the list position of an engine ID, for use with sorting. This is basically a reversed version of GetRailVehAtPosition()
peter1138
parents:
4656
diff
changeset
|
64 |
uint16 ListPositionOfEngine(EngineID engine); |
2971
9b62397dbd56
(svn r3546) - NewGRF feature: Implement rail vehicle 'property' 0x1A: allows shuffling order of rail vehicle purchase list (and replace vehicle list)
peter1138
parents:
2962
diff
changeset
|
65 |
void AlterRailVehListOrder(EngineID engine, EngineID target); |
9b62397dbd56
(svn r3546) - NewGRF feature: Implement rail vehicle 'property' 0x1A: allows shuffling order of rail vehicle purchase list (and replace vehicle list)
peter1138
parents:
2962
diff
changeset
|
66 |
|
2962
dbd168a4703a
(svn r3524) - Split newgrf features from engine.[ch] into newgrf_engine.[ch], and add the new files to project files.
peter1138
parents:
2848
diff
changeset
|
67 |
#endif /* NEWGRF_ENGINE_H */ |