1

/* $Id$ */

     2

     3

/** @file newgrf_fsmports.h Header file for NewGRF Finite FSMPORTSe Machine Ports (airports, seaports, landports??) */

     4

     5

#ifndef NEWGRF_FSMPORTS_H

     6

#define NEWGRF_FSMPORTS_H

     7

     8

#include "core/enum_type.hpp"

     9

#include "tile_type.h"

    10

#include "map_type.h"

    11

#include "map_func.h"

    12

#include "tile_map.h"

    13

#include "newgrf_cargo.h"

    14

#include "sprite.h"

    15

#include "airport.h"

    16

#include "station_type.h"

    17

#include "strings_func.h"

    18

#include "widgets/dropdown_type.h"

    19

    20

enum FSMportClass {

    21

	SYSTEM_HIDDEN_CLASS = 0x53595354  ///< SYST is a hidden class for things like oilrigs that need FSMs, but should not appear in picker lists

    22

};

    23

    24

enum FSMportsClassID {

    25

	FSMPORTS_CLASS_BEGIN = 0,    ///< the lowest valid value

    26

	FSMPORTS_CLASS_DFLT = 0,     ///< Default FSMports class.

    27

	FSMPORTS_CLASS_SYST = 31,    ///< SYST hidden class

    28

	FSMPORTS_CLASS_MAX = 32,     ///< Maximum number of classes.

    29

};

    30

    31

/** Define basic enum properties */

    32

template <> struct EnumPropsT<FSMportsClassID> : MakeEnumPropsT<FSMportsClassID, byte, FSMPORTS_CLASS_BEGIN, FSMPORTS_CLASS_MAX, FSMPORTS_CLASS_MAX> {};

    33

typedef TinyEnumT<FSMportsClassID> FSMportsClassIDByte;

    34

    35

/** Allow incrementing of FSMportsClassID variables */

    36

DECLARE_POSTFIX_INCREMENT(FSMportsClassID);

    37

    38

/* FSMports layout for given dimensions - it is a two-dimensional array

    39

 * where index is computed as (x * platforms) + platform. */

    40

typedef byte *FSMportsLayout;

    41

    42

struct FSMportsSpec {

    43

	const struct GRFFile *grffile; ///< ID of GRF file FSMports belongs to.

    44

	int localidx; ///< Index within GRF file of FSMports.

    45

    46

	bool allocated; ///< Flag whether this FSMport has been added to a FSMports class list

    47

    48

	FSMportsClassID sclass; ///< The class to which this spec belongs.

    49

	StringID name; ///< Name of this FSMport.

    50

    51

	/** Number of tile layouts.

    52

	 * A minimum of 8 is required is required for FSMportss.

    53

	 * 0-1 = plain platform

    54

	 * 2-3 = platform with building

    55

	 * 4-5 = platform with roof, left side

    56

	 * 6-7 = platform with roof, right side

    57

	 */

    58

	uint tiles;

    59

	DrawTileSprites *renderdata; ///< Array of tile layouts.

    60

	bool copied_renderdata;

    61

    62

	/** Cargo threshold for choosing between little and lots of cargo

    63

	 * @note little/lots are equivalent to the moving/loading FSMPORTSes for vehicles

    64

	 */

    65

	uint16 cargo_threshold;

    66

    67

	uint32 cargo_triggers; ///< Bitmask of cargo types which cause trigger re-randomizing

    68

    69

	byte callbackmask; ///< Bitmask of callbacks to use, @see newgrf_callbacks.h

    70

    71

	byte flags; ///< Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by FSMports size

    72

    73

	byte *size_x;

    74

	byte *size_y;

    75

    76

	byte numlayouts;

    77

	FSMportsLayout *layouts;

    78

	bool copied_layouts;

    79

    80

	FSMportsLayout *layout_mask;

    81

    82

	AirportFTAClass *portFSM;

    83

    84

	uint8  anim_frames;

    85

	uint8  anim_status;

    86

	uint8  anim_speed;

    87

	uint16 anim_triggers;

    88

    89

	/**

    90

	 * NUM_CARGO real cargo plus three pseudo cargo sprite groups.

    91

	 * Used for obtaining the sprite offset of custom sprites, and for

    92

	 * evaluating callbacks.

    93

	 */

    94

	const struct SpriteGroup *spritegroup[NUM_CARGO + 3];

    95

};

    96

    97

/**

    98

 * Struct containing information relating to FSMports classes.

    99

 */

   100

struct FSMportsClass {

   101

	uint32 id;          ///< ID of this class, e.g. 'DFLT', 'WAYP', etc.

   102

	StringID name;      ///< Name of this class.

   103

	uint FSMports;      ///< Number of FSMports in this class.

   104

	FSMportsSpec **spec; ///< Array of FSMports specifications.

   105

};

   106

   107

void ResetFSMportsClasses();

   108

FSMportsClassID AllocateFSMportsClass(uint32 cls);

   109

void SetFSMportsClassName(FSMportsClassID sclass, StringID name);

   110

StringID GetFSMportsClassName(FSMportsClassID sclass);

   111

DropDownList *BuildFSMportsClassDropdown();

   112

   113

uint GetNumFSMportsClasses();

   114

uint GetNumCustomFSMports(FSMportsClassID sclass);

   115

   116

void SetCustomFSMportsSpec(FSMportsSpec *FSMPORTSspec);

   117

FSMportsSpec *GetCustomFSMportsSpec(FSMportsClassID sclass, uint FSMports);

   118

const FSMportsSpec *GetCustomFSMportsSpecByGrf(uint32 grfid, byte localidx);

   119

   120

/* Rotate a position depending on the FSM_orientation */

   121

TileIndexDiffC RotateFSMPosition(TileIndexDiffC position, byte size_x, byte size_y, byte FSM_orientation);

   122

   123

/* Get sprite offset for a given custom FSMports and FSMports structure (may be

   124

 * NULL - that means we are in a build dialog). The FSMports structure is used

   125

 * for variational sprite groups. */

   126

SpriteID GetCustomFSMportsRelocation(const FSMportsSpec *FSMPORTSspec, const Station *st, TileIndex tile);

   127

SpriteID GetCustomFSMportsGroundRelocation(const FSMportsSpec *FSMPORTSspec, const Station *st, TileIndex tile);

   128

uint16 GetFSMportsCallback(CallbackID callback, uint32 param1, uint32 param2, const FSMportsSpec *FSMPORTSspec, const Station *st, TileIndex tile);

   129

   130

/* Allocate a FSMportsSpec to a Station. This is called once per build operation. */

   131

int AllocateFSMportsSpecToStation(const FSMportsSpec *FSMPORTSspec, Station *st, bool exec);

   132

   133

/* Deallocate a FSMportsSpec from a Station. */

   134

void DeallocateSpecFromFSMports(Station* st, byte specindex);

   135

   136

/* Deallocate a FSMportsSpec from a Station, referenced by the spec itself. Use when specindex unknown. */

   137

void RemoveFSMSpecFromStationList(Station *st, const FSMportsSpec *fsmportspec);

   138

   139

/* Set the spec index, and mark tile as an fsmport */

   140

static inline void SetCustomFSMportsSpecIndex(TileIndex t, byte specindex)

   141

{

   142

	assert(IsTileType(t, MP_STATION));

   143

	_m[t].m4 = specindex;

   144

	_m[t].m6 |= 0x80; // set top bit of m6 to indicate it is an fsmport

   145

}

   146

   147

/* Check if tile has a specindex and is an fsmport */

   148

static inline bool IsCustomFSMportsSpecIndex(TileIndex t)

   149

{

   150

	return ((_m[t].m4 != 0) && ((_m[t].m6 & 0x80) == 0x80));

   151

}

   152

   153

/* Draw representation of a FSMports tile for GUI purposes. */

   154

bool DrawFSMportsTile(int x, int y, byte tile, FSMportsClassID sclass, uint FSMports);

   155

   156

#endif /* NEWGRF_FSMPORTS_H */