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

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

    17

extern const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

    18

extern const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

    19

extern const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

    20

extern const uint32 cargo_classes[16];

    21

    22

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

    23

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

    24

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

    25

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

    26

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

    27

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

    28

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

    29

    30

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

    31

 * elsewhere... */

    32

struct GRFFile;

    33

    34

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

    35

const struct GRFFile *GetEngineGRF(EngineID engine);

    36

uint32 GetEngineGRFID(EngineID engine);

    37

    38

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

    39

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

    40

bool UsesWagonOverride(const Vehicle *v);

    41

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

    42

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

    43

    44

typedef enum VehicleTrigger {

    45

	VEHICLE_TRIGGER_NEW_CARGO     = 1,

    46

	// Externally triggered only for the first vehicle in chain

    47

	VEHICLE_TRIGGER_DEPOT         = 2,

    48

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

    49

	VEHICLE_TRIGGER_EMPTY         = 4,

    50

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

    51

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

    52

} VehicleTrigger;

    53

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

    54

    55

void SetCustomEngineName(EngineID engine, StringID name);

    56

StringID GetCustomEngineName(EngineID engine);

    57

    58

void UnloadWagonOverrides(void);

    59

void UnloadRotorOverrideSprites(void);

    60

void UnloadCustomEngineSprites(void);

    61

void UnloadCustomEngineNames(void);

    62

    63

void ResetEngineListOrder(void);

    64

EngineID GetRailVehAtPosition(EngineID pos);

    65

void AlterRailVehListOrder(EngineID engine, EngineID target);

    66

    67

#endif /* NEWGRF_ENGINE_H */