1

/* $Id$ */

     2

     3

/** @file newgrf_engine.h Functions for NewGRF engines. */

     4

     5

#ifndef NEWGRF_ENGINE_H

     6

#define NEWGRF_ENGINE_H

     7

     8

#include "newgrf.h"

     9

#include "direction_type.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, EngineID *train_id, uint trains);

    17

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

    18

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

    19

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

    20

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

    21

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

    22

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

    23

    24

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

    25

 * elsewhere... */

    26

struct GRFFile;

    27

    28

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

    29

const struct GRFFile *GetEngineGRF(EngineID engine);

    30

uint32 GetEngineGRFID(EngineID engine);

    31

    32

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

    33

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

    34

bool UsesWagonOverride(const Vehicle *v);

    35

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

    36

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

    37

    38

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

    39

 * time) orig_value is returned */

    40

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

    41

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

    42

    43

enum VehicleTrigger {

    44

	VEHICLE_TRIGGER_NEW_CARGO     = 0x01,

    45

	/* Externally triggered only for the first vehicle in chain */

    46

	VEHICLE_TRIGGER_DEPOT         = 0x02,

    47

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

    48

	VEHICLE_TRIGGER_EMPTY         = 0x04,

    49

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

    50

	VEHICLE_TRIGGER_ANY_NEW_CARGO = 0x08,

    51

	/* Externally triggered for each vehicle in chain */

    52

	VEHICLE_TRIGGER_CALLBACK_32   = 0x10,

    53

};

    54

void TriggerVehicle(Vehicle *veh, VehicleTrigger trigger);

    55

    56

void UnloadWagonOverrides(Engine *e);

    57

    58

uint ListPositionOfEngine(EngineID engine);

    59

void AlterVehicleListOrder(EngineID engine, EngineID target);

    60

void CommitVehicleListOrderChanges();

    61

    62

EngineID GetNewEngineID(const GRFFile *file, VehicleType type, uint16 internal_id);

    63

    64

#endif /* NEWGRF_ENGINE_H */