elrail_data.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef ELRAIL_DATA_H
#define ELRAIL_DATA_H

enum TileLocationGroup : uint8_t {
  XEVEN_YEVEN = 0,
  XEVEN_YODD  = 1,
  XODD_YEVEN  = 2,
  XODD_YODD   = 3,
  TLG_END
};

enum TileSource : uint8_t {
  TS_HOME      = 0,
  TS_NEIGHBOUR = 1,
 
  TS_END
};
 
static const uint NUM_TRACKS_AT_PCP = 6;

static const Directions _allowed_ppp_on_pcp[DIAGDIR_END] = {
  {DIR_N, DIR_E, DIR_SE, DIR_S, DIR_W, DIR_NW},
  {DIR_N, DIR_NE, DIR_E, DIR_S, DIR_SW, DIR_W},
  {DIR_N, DIR_E, DIR_SE, DIR_S, DIR_W, DIR_NW},
  {DIR_N, DIR_NE, DIR_E, DIR_S, DIR_SW, DIR_W},
};

static const Directions _owned_ppp_on_pcp[DIAGDIR_END] = {
  {DIR_SE, DIR_S, DIR_SW, DIR_W},
  {DIR_N, DIR_SW, DIR_W, DIR_NW},
  {DIR_N, DIR_NE, DIR_E, DIR_NW},
  {DIR_NE, DIR_E, DIR_SE, DIR_S},
};

static const DiagDirection _pcp_positions[TRACK_END][2] = {
  {DIAGDIR_NE, DIAGDIR_SW}, // X
  {DIAGDIR_SE, DIAGDIR_NW}, // Y
  {DIAGDIR_NW, DIAGDIR_NE}, // UPPER
  {DIAGDIR_SE, DIAGDIR_SW}, // LOWER
  {DIAGDIR_SW, DIAGDIR_NW}, // LEFT
  {DIAGDIR_NE, DIAGDIR_SE}, // RIGHT
};

static const Directions _preferred_ppp_of_track_at_pcp[TRACK_END][DIAGDIR_END] = {
  { // X
    {DIR_NE, DIR_SE, DIR_NW}, // NE
    DIRECTIONS_ALL,           // SE
    {DIR_SE, DIR_SW, DIR_NW}, // SW
    DIRECTIONS_ALL            // NE
  },
  { // Y
    DIRECTIONS_ALL,
    {DIR_NE, DIR_SE, DIR_SW},
    DIRECTIONS_ALL,
    {DIR_SW, DIR_NW, DIR_NE},
  },
  { // UPPER
    {DIR_E, DIR_N, DIR_S},
    DIRECTIONS_ALL,
    DIRECTIONS_ALL,
    {DIR_W, DIR_N, DIR_S},
  },
  { // LOWER
    DIRECTIONS_ALL,
    {DIR_E, DIR_N, DIR_S},
    {DIR_W, DIR_N, DIR_S},
    DIRECTIONS_ALL,
  },
  { // LEFT
    DIRECTIONS_ALL,
    DIRECTIONS_ALL,
    {DIR_S, DIR_E, DIR_W},
    {DIR_N, DIR_E, DIR_W},
  },
  { // RIGHT
    {DIR_N, DIR_E, DIR_W},
    {DIR_S, DIR_E, DIR_W},
    DIRECTIONS_ALL,
    DIRECTIONS_ALL,
  },
};
 
#define NUM_IGNORE_GROUPS 3
static const Directions _ignored_pcp[NUM_IGNORE_GROUPS][TLG_END][DIAGDIR_END] = {
  {   // Ignore group 1, X and Y tracks
    {     // X even, Y even
      DIRECTIONS_ALL,
      {DIR_NE, DIR_SW},
      {DIR_NW, DIR_SE},
      DIRECTIONS_ALL,
    }, { // X even, Y odd
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_NW, DIR_SE},
      {DIR_NE, DIR_SW},
    }, { // X odd,  Y even
      {DIR_NW, DIR_SE},
      {DIR_NE, DIR_SW},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
    }, { // X odd,  Y odd
      {DIR_NW, DIR_SE},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_NE, DIR_SW},
    }
  },
  {   // Ignore group 2, LEFT and RIGHT tracks
    {
      {DIR_E, DIR_W},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_E, DIR_W},
    }, {
      DIRECTIONS_ALL,
      {DIR_E, DIR_W},
      {DIR_E, DIR_W},
      DIRECTIONS_ALL,
    }, {
      DIRECTIONS_ALL,
      {DIR_E, DIR_W},
      {DIR_E, DIR_W},
      DIRECTIONS_ALL,
    }, {
      {DIR_E, DIR_W},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_E, DIR_W},
    }
  },
  {   // Ignore group 3, UPPER and LOWER tracks
    {
      {DIR_N, DIR_S},
      {DIR_N, DIR_S},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
    }, {
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_N, DIR_S},
      {DIR_N, DIR_S},
    }, {
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
      {DIR_N, DIR_S},
      {DIR_N, DIR_S},
    }, {
      {DIR_N, DIR_S},
      {DIR_N, DIR_S},
      DIRECTIONS_ALL,
      DIRECTIONS_ALL,
    }
  }
};

static const Directions _disallowed_ppp_of_track_at_pcp[TRACK_END][DIAGDIR_END] = {
  {{DIR_SW, DIR_NE}, {},               {DIR_SW, DIR_NE}, {}              }, // X
  {{},               {DIR_NW, DIR_SE}, {},               {DIR_NW, DIR_SE}}, // Y
  {{DIR_W, DIR_E},   {},               {},               {DIR_W, DIR_E}  }, // UPPER
  {{},               {DIR_W, DIR_E},   {DIR_W, DIR_E},   {}              }, // LOWER
  {{},               {},               {DIR_S, DIR_N},   {DIR_N, DIR_S}  }, // LEFT
  {{DIR_S, DIR_N},   {DIR_S, DIR_N},   {},               {},             }, // RIGHT
};

static const Track _tracks_at_pcp[DIAGDIR_END][NUM_TRACKS_AT_PCP] = {
  {TRACK_X, TRACK_X, TRACK_UPPER, TRACK_LOWER, TRACK_LEFT, TRACK_RIGHT},
  {TRACK_Y, TRACK_Y, TRACK_UPPER, TRACK_LOWER, TRACK_LEFT, TRACK_RIGHT},
  {TRACK_X, TRACK_X, TRACK_UPPER, TRACK_LOWER, TRACK_LEFT, TRACK_RIGHT},
  {TRACK_Y, TRACK_Y, TRACK_UPPER, TRACK_LOWER, TRACK_LEFT, TRACK_RIGHT},
};

static const TileSource _track_source_tile[DIAGDIR_END][NUM_TRACKS_AT_PCP] = {
  {TS_HOME, TS_NEIGHBOUR, TS_HOME     , TS_NEIGHBOUR, TS_NEIGHBOUR, TS_HOME     },
  {TS_HOME, TS_NEIGHBOUR, TS_NEIGHBOUR, TS_HOME     , TS_NEIGHBOUR, TS_HOME     },
  {TS_HOME, TS_NEIGHBOUR, TS_NEIGHBOUR, TS_HOME     , TS_HOME     , TS_NEIGHBOUR},
  {TS_HOME, TS_NEIGHBOUR, TS_HOME     , TS_NEIGHBOUR, TS_HOME     , TS_NEIGHBOUR},
};

static const Direction _ppp_order[DIAGDIR_END][TLG_END][DIR_END] = {    //  X  -  Y
  {   // PCP 0
    {DIR_NE, DIR_NW, DIR_SE, DIR_SW, DIR_N, DIR_E, DIR_S, DIR_W}, // evn - evn
    {DIR_NE, DIR_SE, DIR_SW, DIR_NW, DIR_S, DIR_W, DIR_N, DIR_E}, // evn - odd
    {DIR_SW, DIR_NW, DIR_NE, DIR_SE, DIR_S, DIR_W, DIR_N, DIR_E}, // odd - evn
    {DIR_SW, DIR_SE, DIR_NE, DIR_NW, DIR_N, DIR_E, DIR_S, DIR_W}, // odd - odd
  }, {// PCP 1
    {DIR_NE, DIR_NW, DIR_SE, DIR_SW, DIR_S, DIR_E, DIR_N, DIR_W}, // evn - evn
    {DIR_NE, DIR_SE, DIR_SW, DIR_NW, DIR_N, DIR_W, DIR_S, DIR_E}, // evn - odd
    {DIR_SW, DIR_NW, DIR_NE, DIR_SE, DIR_N, DIR_W, DIR_S, DIR_E}, // odd - evn
    {DIR_SW, DIR_SE, DIR_NE, DIR_NW, DIR_S, DIR_E, DIR_N, DIR_W}, // odd - odd
  }, {// PCP 2
    {DIR_NE, DIR_NW, DIR_SE, DIR_SW, DIR_S, DIR_W, DIR_N, DIR_E}, // evn - evn
    {DIR_NE, DIR_SE, DIR_SW, DIR_NW, DIR_N, DIR_E, DIR_S, DIR_W}, // evn - odd
    {DIR_SW, DIR_NW, DIR_NE, DIR_SE, DIR_N, DIR_E, DIR_S, DIR_W}, // odd - evn
    {DIR_SW, DIR_SE, DIR_NE, DIR_NW, DIR_S, DIR_W, DIR_N, DIR_E}, // odd - odd
  }, {// PCP 3
    {DIR_NE, DIR_NW, DIR_SE, DIR_SW, DIR_N, DIR_W, DIR_S, DIR_E}, // evn - evn
    {DIR_NE, DIR_SE, DIR_SW, DIR_NW, DIR_S, DIR_E, DIR_N, DIR_W}, // evn - odd
    {DIR_SW, DIR_NW, DIR_NE, DIR_SE, DIR_S, DIR_E, DIR_N, DIR_W}, // odd - evn
    {DIR_SW, DIR_SE, DIR_NE, DIR_NW, DIR_N, DIR_W, DIR_S, DIR_E}, // odd - odd
  }
};

static const int8_t _x_pcp_offsets[DIAGDIR_END] = {0,  8, 16, 8};
static const int8_t _y_pcp_offsets[DIAGDIR_END] = {8, 16,  8, 0};
static const int8_t _x_ppp_offsets[DIR_END] = {-2, -4, -2,  0,  2,  4,  2,  0};
static const int8_t _y_ppp_offsets[DIR_END] = {-2,  0,  2,  4,  2,  0, -2, -4};

enum PylonSpriteOffset : uint8_t {
  PSO_Y_NE,
  PSO_Y_SW,
  PSO_X_NW,
  PSO_X_SE,
  PSO_EW_N,
  PSO_EW_S,
  PSO_NS_W,
  PSO_NS_E,
};

static const uint8_t _pylon_sprites[] = {
  PSO_EW_N,
  PSO_Y_NE,
  PSO_NS_E,
  PSO_X_SE,
  PSO_EW_S,
  PSO_Y_SW,
  PSO_NS_W,
  PSO_X_NW,
};

enum WireSpriteOffset : uint8_t {
  WSO_X_SHORT,
  WSO_Y_SHORT,
  WSO_EW_SHORT,
  WSO_NS_SHORT,
  WSO_X_SHORT_DOWN,
  WSO_Y_SHORT_UP,
  WSO_X_SHORT_UP,
  WSO_Y_SHORT_DOWN,
 
  WSO_X_SW,
  WSO_Y_SE,
  WSO_EW_E,
  WSO_NS_S,
  WSO_X_SW_DOWN,
  WSO_Y_SE_UP,
  WSO_X_SW_UP,
  WSO_Y_SE_DOWN,
 
  WSO_X_NE,
  WSO_Y_NW,
  WSO_EW_W,
  WSO_NS_N,
  WSO_X_NE_DOWN,
  WSO_Y_NW_UP,
  WSO_X_NE_UP,
  WSO_Y_NW_DOWN,
 
  WSO_ENTRANCE_SW,
  WSO_ENTRANCE_NW,
  WSO_ENTRANCE_NE,
  WSO_ENTRANCE_SE,
};
 
struct SortableSpriteStruct : SpriteBounds {
  uint8_t image_offset;
 
  constexpr SortableSpriteStruct(uint8_t image_offset, const SpriteBounds &bounds) : SpriteBounds(bounds), image_offset(image_offset) {}
  constexpr SortableSpriteStruct(uint8_t image_offset, int8_t x_offset, int8_t y_offset, uint8_t x_size, uint8_t y_size, uint8_t z_size, int8_t z_offset) :
    SpriteBounds({x_offset, y_offset, z_offset}, {x_size, y_size, z_size}, {}), image_offset(image_offset) {}
};

static const uint ELRAIL_ELEVATION = 10;
static const uint ELRAIL_ELEVRAISE = ELRAIL_ELEVATION + TILE_HEIGHT + 1;
static const uint ELRAIL_ELEVLOWER = ELRAIL_ELEVATION - 1;
 
static const SortableSpriteStruct _rail_catenary_sprite_data[] = {
/* X direction
   * Flat tiles:
     * Wires */
  { WSO_X_SW,          0,  7, 15,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_X_NE,          0,  7, 15,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_X_SHORT,       0,  7, 15,  1,  1, ELRAIL_ELEVATION }, 
 
  /* "up" tiles
     * Wires */
  { WSO_X_SW_UP,       0,  7, 15,  8,  1, ELRAIL_ELEVRAISE }, 
  { WSO_X_NE_UP,       0,  7, 15,  8,  1, ELRAIL_ELEVRAISE }, 
  { WSO_X_SHORT_UP,    0,  7, 15,  8,  1, ELRAIL_ELEVRAISE }, 
 
  /* "down" tiles
     * Wires */
  { WSO_X_SW_DOWN,     0,  7, 15,  8,  1, ELRAIL_ELEVLOWER }, 
  { WSO_X_NE_DOWN,     0,  7, 15,  8,  1, ELRAIL_ELEVLOWER }, 
  { WSO_X_SHORT_DOWN,  0,  7, 15,  8,  1, ELRAIL_ELEVLOWER }, 
 
 
/* Y direction
   * Flat tiles:
     * Wires */
  { WSO_Y_SE,          7,  0,  1, 15,  1, ELRAIL_ELEVATION }, 
  { WSO_Y_NW,          7,  0,  1, 15,  1, ELRAIL_ELEVATION }, 
  { WSO_Y_SHORT,       7,  0,  1, 15,  1, ELRAIL_ELEVATION }, 
 
  /* "up" tiles
     * Wires */
  { WSO_Y_SE_UP,       7,  0,  8, 15,  1, ELRAIL_ELEVRAISE }, 
  { WSO_Y_NW_UP,       7,  0,  8, 15,  1, ELRAIL_ELEVRAISE }, 
  { WSO_Y_SHORT_UP,    7,  0,  8, 15,  1, ELRAIL_ELEVRAISE }, 
 
  /* "down" tiles
     * Wires */
  { WSO_Y_SE_DOWN,     7,  0,  8, 15,  1, ELRAIL_ELEVLOWER }, 
  { WSO_Y_NW_DOWN,     7,  0,  8, 15,  1, ELRAIL_ELEVLOWER }, 
  { WSO_Y_SHORT_DOWN,  7,  0,  8, 15,  1, ELRAIL_ELEVLOWER }, 
 
/* NS Direction */
  { WSO_NS_SHORT,      8,  0,  8,  8,  1, ELRAIL_ELEVATION }, 
  { WSO_NS_SHORT,      0,  8,  8,  8,  1, ELRAIL_ELEVATION }, 
 
  { WSO_NS_N,          8,  0,  8,  8,  1, ELRAIL_ELEVATION }, 
  { WSO_NS_N,          0,  8,  8,  8,  1, ELRAIL_ELEVATION }, 
 
  { WSO_NS_S,          8,  0,  8,  8,  1, ELRAIL_ELEVATION }, 
  { WSO_NS_S,          0,  8,  8,  8,  1, ELRAIL_ELEVATION }, 
 
/* EW Direction */
  { WSO_EW_SHORT,      7,  0,  1,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_EW_SHORT,     15,  8,  3,  3,  1, ELRAIL_ELEVATION }, 
 
  { WSO_EW_W,          7,  0,  1,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_EW_W,         15,  8,  3,  3,  1, ELRAIL_ELEVATION }, 
 
  { WSO_EW_E,          7,  0,  1,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_EW_E,         15,  8,  3,  3,  1, ELRAIL_ELEVATION }  
};
 
static const SortableSpriteStruct _rail_catenary_sprite_data_depot[] = {
  { WSO_ENTRANCE_NE,   0,  7, 15,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_ENTRANCE_SE,   7,  0,  1, 15,  1, ELRAIL_ELEVATION }, 
  { WSO_ENTRANCE_SW,   0,  7, 15,  1,  1, ELRAIL_ELEVATION }, 
  { WSO_ENTRANCE_NW,   7,  0,  1, 15,  1, ELRAIL_ELEVATION }  
};

static const int8_t ELRAIL_TUNNEL_OFFSET = ELRAIL_ELEVATION - BB_Z_SEPARATOR;
 
static const SortableSpriteStruct _rail_catenary_sprite_data_tunnel[] = {
  { WSO_ENTRANCE_SW, {{0, 0, BB_Z_SEPARATOR}, {16, 15, 1}, {0, 7, ELRAIL_TUNNEL_OFFSET}} }, 
  { WSO_ENTRANCE_NW, {{0, 0, BB_Z_SEPARATOR}, {15, 16, 1}, {7, 0, ELRAIL_TUNNEL_OFFSET}} }, 
  { WSO_ENTRANCE_NE, {{0, 0, BB_Z_SEPARATOR}, {16, 15, 1}, {0, 7, ELRAIL_TUNNEL_OFFSET}} }, 
  { WSO_ENTRANCE_SE, {{0, 0, BB_Z_SEPARATOR}, {15, 16, 1}, {7, 0, ELRAIL_TUNNEL_OFFSET}} }  
};
 

enum RailCatenarySprite : uint8_t {
  WIRE_X_FLAT_SW,
  WIRE_X_FLAT_NE,
  WIRE_X_FLAT_BOTH,
 
  WIRE_X_UP_SW,
  WIRE_X_UP_NE,
  WIRE_X_UP_BOTH,
 
  WIRE_X_DOWN_SW,
  WIRE_X_DOWN_NE,
  WIRE_X_DOWN_BOTH,
 
  WIRE_Y_FLAT_SE,
  WIRE_Y_FLAT_NW,
  WIRE_Y_FLAT_BOTH,
 
  WIRE_Y_UP_SE,
  WIRE_Y_UP_NW,
  WIRE_Y_UP_BOTH,
 
  WIRE_Y_DOWN_SE,
  WIRE_Y_DOWN_NW,
  WIRE_Y_DOWN_BOTH,
 
  WIRE_NS_W_BOTH,
  WIRE_NS_E_BOTH,
 
  WIRE_NS_W_N,
  WIRE_NS_E_N,
 
  WIRE_NS_W_S,
  WIRE_NS_E_S,
 
  WIRE_EW_N_BOTH,
  WIRE_EW_S_BOTH,
 
  WIRE_EW_N_W,
  WIRE_EW_S_W,
 
  WIRE_EW_N_E,
  WIRE_EW_S_E,
 
  INVALID_CATENARY = 0xFF
};

static const RailCatenarySprite _rail_wires[5][TRACK_END][4] = {
  { // Tileh == 0
    {INVALID_CATENARY, WIRE_X_FLAT_NE,   WIRE_X_FLAT_SW,   WIRE_X_FLAT_BOTH},
    {INVALID_CATENARY, WIRE_Y_FLAT_SE,   WIRE_Y_FLAT_NW,   WIRE_Y_FLAT_BOTH},
    {INVALID_CATENARY, WIRE_EW_N_W,      WIRE_EW_N_E,      WIRE_EW_N_BOTH},
    {INVALID_CATENARY, WIRE_EW_S_E,      WIRE_EW_S_W,      WIRE_EW_S_BOTH},
    {INVALID_CATENARY, WIRE_NS_W_S,      WIRE_NS_W_N,      WIRE_NS_W_BOTH},
    {INVALID_CATENARY, WIRE_NS_E_N,      WIRE_NS_E_S,      WIRE_NS_E_BOTH},
  }, { // Tileh == 3
    {INVALID_CATENARY, WIRE_X_UP_NE,     WIRE_X_UP_SW,     WIRE_X_UP_BOTH},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
  }, { // Tileh == 6
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, WIRE_Y_UP_SE,     WIRE_Y_UP_NW,     WIRE_Y_UP_BOTH},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
  }, { // Tileh == 9
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, WIRE_Y_DOWN_SE,   WIRE_Y_DOWN_NW,   WIRE_Y_DOWN_BOTH},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
  }, { // Tileh == 12
    {INVALID_CATENARY, WIRE_X_DOWN_NE,   WIRE_X_DOWN_SW,   WIRE_X_DOWN_BOTH},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
    {INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY, INVALID_CATENARY},
  }
};
 
#endif /* ELRAIL_DATA_H */