1

/* $Id$ */

     2

     3

#ifndef NEWGRF_ENGINE_H

     4

#define NEWGRF_ENGINE_H

     5

     6

#include "newgrf.h"

     7

#include "direction.h"

     8

#include "newgrf_cargo.h"

     9

    10

/** @file newgrf_engine.h

    11

 */

    12

    13

extern int _traininfo_vehicle_pitch;

    14

extern int _traininfo_vehicle_width;

    15

    16

extern const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

    17

extern const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

    18

extern const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

    19

extern const uint32 cargo_classes[16];

    20

    21

void SetWagonOverrideSprites(EngineID engine, CargoID cargo, const struct SpriteGroup *group, byte *train_id, int trains);

    22

void SetCustomEngineSprites(EngineID engine, byte cargo, const struct SpriteGroup *group);

    23

void SetRotorOverrideSprites(EngineID engine, const struct SpriteGroup *group);

    24

SpriteID GetCustomEngineSprite(EngineID engine, const Vehicle* v, Direction direction);

    25

SpriteID GetRotorOverrideSprite(EngineID engine, const Vehicle* v, bool info_view);

    26

#define GetCustomRotorSprite(v, i) GetRotorOverrideSprite(v->engine_type, v, i)

    27

#define GetCustomRotorIcon(et) GetRotorOverrideSprite(et, NULL, true)

    28

    29

/* Forward declaration of GRFFile, to avoid unnecessary inclusion of newgrf.h

    30

 * elsewhere... */

    31

struct GRFFile;

    32

    33

void SetEngineGRF(EngineID engine, const struct GRFFile *file);

    34

const struct GRFFile *GetEngineGRF(EngineID engine);

    35

uint32 GetEngineGRFID(EngineID engine);

    36

    37

uint16 GetVehicleCallback(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v);

    38

uint16 GetVehicleCallbackParent(uint16 callback, uint32 param1, uint32 param2, EngineID engine, const Vehicle *v, const Vehicle *parent);

    39

bool UsesWagonOverride(const Vehicle *v);

    40

#define GetCustomVehicleSprite(v, direction) GetCustomEngineSprite(v->engine_type, v, direction)

    41

#define GetCustomVehicleIcon(et, direction) GetCustomEngineSprite(et, NULL, direction)

    42

    43

typedef enum VehicleTrigger {

    44

	VEHICLE_TRIGGER_NEW_CARGO     = 1,

    45

	// Externally triggered only for the first vehicle in chain

    46

	VEHICLE_TRIGGER_DEPOT         = 2,

    47

	// Externally triggered only for the first vehicle in chain, only if whole chain is empty

    48

	VEHICLE_TRIGGER_EMPTY         = 4,

    49

	// Not triggered externally (called for the whole chain if we got NEW_CARGO)

    50

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

    51

} VehicleTrigger;

    52

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

    53

    54

void SetCustomEngineName(EngineID engine, StringID name);

    55

StringID GetCustomEngineName(EngineID engine);

    56

    57

void UnloadWagonOverrides(void);

    58

void UnloadRotorOverrideSprites(void);

    59

void UnloadCustomEngineSprites(void);

    60

void UnloadCustomEngineNames(void);

    61

    62

void ResetEngineListOrder(void);

    63

EngineID GetRailVehAtPosition(EngineID pos);

    64

uint16 ListPositionOfEngine(EngineID engine);

    65

void AlterRailVehListOrder(EngineID engine, EngineID target);

    66

    67

#endif /* NEWGRF_ENGINE_H */