1

/* $Id$ */

     2

     3

/** @file newgrf_engine.h */

     4

     5

#ifndef NEWGRF_ENGINE_H

     6

#define NEWGRF_ENGINE_H

     7

     8

#include "newgrf.h"

     9

#include "direction.h"

    10

#include "newgrf_cargo.h"

    11

    12

extern int _traininfo_vehicle_pitch;

    13

extern int _traininfo_vehicle_width;

    14

    15

    16

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

    17

const SpriteGroup *GetWagonOverrideSpriteSet(EngineID engine, CargoID cargo, byte overriding_engine);

    18

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

    19

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

    20

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

    21

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

    22

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

    23

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

    24

    25

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

    26

 * elsewhere... */

    27

struct GRFFile;

    28

    29

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

    30

const struct GRFFile *GetEngineGRF(EngineID engine);

    31

uint32 GetEngineGRFID(EngineID engine);

    32

    33

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

    34

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

    35

bool UsesWagonOverride(const Vehicle *v);

    36

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

    37

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

    38

    39

/* Handler to Evaluate callback 36. If the callback fails (i.e. most of the

    40

 * time) orig_value is returned */

    41

uint GetVehicleProperty(const Vehicle *v, uint8 property, uint orig_value);

    42

uint GetEngineProperty(EngineID engine, uint8 property, uint orig_value);

    43

    44

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

};

    53

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

    54

    55

void SetCustomEngineName(EngineID engine, StringID name);

    56

StringID GetCustomEngineName(EngineID engine);

    57

    58

void UnloadWagonOverrides();

    59

void UnloadRotorOverrideSprites();

    60

void UnloadCustomEngineSprites();

    61

void UnloadCustomEngineNames();

    62

    63

void ResetEngineListOrder();

    64

EngineID GetRailVehAtPosition(EngineID pos);

    65

uint16 ListPositionOfEngine(EngineID engine);

    66

void AlterRailVehListOrder(EngineID engine, EngineID target);

    67

    68

#endif /* NEWGRF_ENGINE_H */