1

/* $Id$ */

     2

     3

#ifndef NEWGRF_ENGINE_H

     4

#define NEWGRF_ENGINE_H

     5

     6

/** @file newgrf_engine.h

     7

 */

     8

     9

// This enum lists the implemented callbacks

    10

// Use as argument for the GetCallBackResult function (see comments there)

    11

enum CallbackID {

    12

	// Powered wagons, if the result is lower as 0x40 then the wagon is powered

    13

	// TODO: interpret the rest of the result, aka "visual effects"

    14

	CBID_WAGON_POWER = 0x10,

    15

    16

	// Vehicle length, returns the amount of 1/8's the vehicle is shorter

    17

	// only for train vehicles

    18

	CBID_VEH_LENGTH = 0x11,

    19

    20

	// Refit capacity, the passed vehicle needs to have its ->cargo_type set to

    21

	// the cargo we are refitting to, returns the new cargo capacity

    22

	CBID_REFIT_CAP = 0x15,

    23

    24

	CBID_ARTIC_ENGINE = 0x16,

    25

};

    26

    27

// bit positions for rvi->callbackmask, indicates which callbacks are used by an engine

    28

// (some callbacks are always used, and dont appear here)

    29

enum CallbackMask {

    30

	CBM_WAGON_POWER = 0,

    31

	CBM_VEH_LENGTH = 1,

    32

	CBM_REFIT_CAP = 3,

    33

	CBM_ARTIC_ENGINE = 4,

    34

};

    35

    36

enum {

    37

	CALLBACK_FAILED = 0xFFFF

    38

};

    39

    40

VARDEF const uint32 _default_refitmasks[NUM_VEHICLE_TYPES];

    41

VARDEF const CargoID _global_cargo_id[NUM_LANDSCAPE][NUM_CARGO];

    42

VARDEF const uint32 _landscape_global_cargo_mask[NUM_LANDSCAPE];

    43

VARDEF const CargoID _local_cargo_id_ctype[NUM_GLOBAL_CID];

    44

VARDEF const uint32 cargo_classes[16];

    45

    46

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

    47

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

    48

// loaded is in percents, overriding_engine 0xffff is none

    49

int GetCustomEngineSprite(EngineID engine, const Vehicle *v, byte direction);

    50

uint16 GetCallBackResult(uint16 callback_info, EngineID engine, const Vehicle *v);

    51

bool UsesWagonOverride(const Vehicle *v);

    52

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

    53

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

    54

    55

typedef enum VehicleTrigger {

    56

	VEHICLE_TRIGGER_NEW_CARGO = 1,

    57

	// Externally triggered only for the first vehicle in chain

    58

	VEHICLE_TRIGGER_DEPOT = 2,

    59

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

    60

	VEHICLE_TRIGGER_EMPTY = 4,

    61

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

    62

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 8,

    63

} VehicleTrigger;

    64

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

    65

    66

void SetCustomEngineName(EngineID engine, const char *name);

    67

StringID GetCustomEngineName(EngineID engine);

    68

    69

void UnloadWagonOverrides(void);

    70

void UnloadCustomEngineSprites(void);

    71

void UnloadCustomEngineNames(void);

    72

    73

#endif /* NEWGRF_ENGINE_H */