1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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 <http://www.gnu.org/licenses/>.
6 */
7
8 /** @file newgrf_railtype.cpp NewGRF handling of rail types. */
9
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "newgrf_railtype.h"
13 #include "date_func.h"
14 #include "depot_base.h"
15 #include "town.h"
16
17 #include "safeguards.h"
18
GetRandomBits() const19 /* virtual */ uint32 RailTypeScopeResolver::GetRandomBits() const
20 {
21 uint tmp = CountBits(this->tile + (TileX(this->tile) + TileY(this->tile)) * TILE_SIZE);
22 return GB(tmp, 0, 2);
23 }
24
GetVariable(byte variable,uint32 parameter,bool * available) const25 /* virtual */ uint32 RailTypeScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
26 {
27 if (this->tile == INVALID_TILE) {
28 switch (variable) {
29 case 0x40: return 0;
30 case 0x41: return 0;
31 case 0x42: return 0;
32 case 0x43: return _date;
33 case 0x44: return HZB_TOWN_EDGE;
34 }
35 }
36
37 switch (variable) {
38 case 0x40: return GetTerrainType(this->tile, this->context);
39 case 0x41: return 0;
40 case 0x42: return IsLevelCrossingTile(this->tile) && IsCrossingBarred(this->tile);
41 case 0x43:
42 if (IsRailDepotTile(this->tile)) return Depot::GetByTile(this->tile)->build_date;
43 return _date;
44 case 0x44: {
45 const Town *t = nullptr;
46 if (IsRailDepotTile(this->tile)) {
47 t = Depot::GetByTile(this->tile)->town;
48 } else if (IsLevelCrossingTile(this->tile)) {
49 t = ClosestTownFromTile(this->tile, UINT_MAX);
50 }
51 return t != nullptr ? GetTownRadiusGroup(t, this->tile) : HZB_TOWN_EDGE;
52 }
53 }
54
55 Debug(grf, 1, "Unhandled rail type tile variable 0x{:X}", variable);
56
57 *available = false;
58 return UINT_MAX;
59 }
60
GetFeature() const61 GrfSpecFeature RailTypeResolverObject::GetFeature() const
62 {
63 return GSF_RAILTYPES;
64 }
65
GetDebugID() const66 uint32 RailTypeResolverObject::GetDebugID() const
67 {
68 return this->railtype_scope.rti->label;
69 }
70
71 /**
72 * Resolver object for rail types.
73 * @param rti Railtype. nullptr in NewGRF Inspect window.
74 * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
75 * @param context Are we resolving sprites for the upper halftile, or on a bridge?
76 * @param rtsg Railpart of interest
77 * @param param1 Extra parameter (first parameter of the callback, except railtypes do not have callbacks).
78 * @param param2 Extra parameter (second parameter of the callback, except railtypes do not have callbacks).
79 */
RailTypeResolverObject(const RailtypeInfo * rti,TileIndex tile,TileContext context,RailTypeSpriteGroup rtsg,uint32 param1,uint32 param2)80 RailTypeResolverObject::RailTypeResolverObject(const RailtypeInfo *rti, TileIndex tile, TileContext context, RailTypeSpriteGroup rtsg, uint32 param1, uint32 param2)
81 : ResolverObject(rti != nullptr ? rti->grffile[rtsg] : nullptr, CBID_NO_CALLBACK, param1, param2), railtype_scope(*this, rti, tile, context)
82 {
83 this->root_spritegroup = rti != nullptr ? rti->group[rtsg] : nullptr;
84 }
85
86 /**
87 * Get the sprite to draw for the given tile.
88 * @param rti The rail type data (spec).
89 * @param tile The tile to get the sprite for.
90 * @param rtsg The type of sprite to draw.
91 * @param context Where are we drawing the tile?
92 * @param[out] num_results If not nullptr, return the number of sprites in the spriteset.
93 * @return The sprite to draw.
94 */
GetCustomRailSprite(const RailtypeInfo * rti,TileIndex tile,RailTypeSpriteGroup rtsg,TileContext context,uint * num_results)95 SpriteID GetCustomRailSprite(const RailtypeInfo *rti, TileIndex tile, RailTypeSpriteGroup rtsg, TileContext context, uint *num_results)
96 {
97 assert(rtsg < RTSG_END);
98
99 if (rti->group[rtsg] == nullptr) return 0;
100
101 RailTypeResolverObject object(rti, tile, context, rtsg);
102 const SpriteGroup *group = object.Resolve();
103 if (group == nullptr || group->GetNumResults() == 0) return 0;
104
105 if (num_results) *num_results = group->GetNumResults();
106
107 return group->GetResult();
108 }
109
110 /**
111 * Get the sprite to draw for a given signal.
112 * @param rti The rail type data (spec).
113 * @param tile The tile to get the sprite for.
114 * @param type Signal type.
115 * @param var Signal variant.
116 * @param state Signal state.
117 * @param gui Is the sprite being used on the map or in the GUI?
118 * @return The sprite to draw.
119 */
GetCustomSignalSprite(const RailtypeInfo * rti,TileIndex tile,SignalType type,SignalVariant var,SignalState state,bool gui)120 SpriteID GetCustomSignalSprite(const RailtypeInfo *rti, TileIndex tile, SignalType type, SignalVariant var, SignalState state, bool gui)
121 {
122 if (rti->group[RTSG_SIGNALS] == nullptr) return 0;
123
124 uint32 param1 = gui ? 0x10 : 0x00;
125 uint32 param2 = (type << 16) | (var << 8) | state;
126 RailTypeResolverObject object(rti, tile, TCX_NORMAL, RTSG_SIGNALS, param1, param2);
127
128 const SpriteGroup *group = object.Resolve();
129 if (group == nullptr || group->GetNumResults() == 0) return 0;
130
131 return group->GetResult();
132 }
133
134 /**
135 * Translate an index to the GRF-local railtype-translation table into a RailType.
136 * @param railtype Index into GRF-local translation table.
137 * @param grffile Originating GRF file.
138 * @return RailType or INVALID_RAILTYPE if the railtype is unknown.
139 */
GetRailTypeTranslation(uint8 railtype,const GRFFile * grffile)140 RailType GetRailTypeTranslation(uint8 railtype, const GRFFile *grffile)
141 {
142 if (grffile == nullptr || grffile->railtype_list.size() == 0) {
143 /* No railtype table present. Return railtype as-is (if valid), so it works for original railtypes. */
144 if (railtype >= RAILTYPE_END || GetRailTypeInfo(static_cast<RailType>(railtype))->label == 0) return INVALID_RAILTYPE;
145
146 return static_cast<RailType>(railtype);
147 } else {
148 /* Railtype table present, but invalid index, return invalid type. */
149 if (railtype >= grffile->railtype_list.size()) return INVALID_RAILTYPE;
150
151 /* Look up railtype including alternate labels. */
152 return GetRailTypeByLabel(grffile->railtype_list[railtype]);
153 }
154 }
155
156 /**
157 * Perform a reverse railtype lookup to get the GRF internal ID.
158 * @param railtype The global (OpenTTD) railtype.
159 * @param grffile The GRF to do the lookup for.
160 * @return the GRF internal ID.
161 */
GetReverseRailTypeTranslation(RailType railtype,const GRFFile * grffile)162 uint8 GetReverseRailTypeTranslation(RailType railtype, const GRFFile *grffile)
163 {
164 /* No rail type table present, return rail type as-is */
165 if (grffile == nullptr || grffile->railtype_list.size() == 0) return railtype;
166
167 /* Look for a matching rail type label in the table */
168 RailTypeLabel label = GetRailTypeInfo(railtype)->label;
169
170 int idx = find_index(grffile->railtype_list, label);
171 if (idx >= 0) return idx;
172
173 /* If not found, return as invalid */
174 return 0xFF;
175 }
176