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_roadtype.cpp NewGRF handling of road types. */
9
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "newgrf_roadtype.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 RoadTypeScopeResolver::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 RoadTypeScopeResolver::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 (IsRoadDepotTile(this->tile)) return Depot::GetByTile(this->tile)->build_date;
43 return _date;
44 case 0x44: {
45 const Town *t = nullptr;
46 if (IsRoadDepotTile(this->tile)) {
47 t = Depot::GetByTile(this->tile)->town;
48 } else {
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 road type tile variable 0x{:X}", variable);
56
57 *available = false;
58 return UINT_MAX;
59 }
60
GetFeature() const61 GrfSpecFeature RoadTypeResolverObject::GetFeature() const
62 {
63 RoadType rt = GetRoadTypeByLabel(this->roadtype_scope.rti->label, false);
64 switch (GetRoadTramType(rt)) {
65 case RTT_ROAD: return GSF_ROADTYPES;
66 case RTT_TRAM: return GSF_TRAMTYPES;
67 default: return GSF_INVALID;
68 }
69 }
70
GetDebugID() const71 uint32 RoadTypeResolverObject::GetDebugID() const
72 {
73 return this->roadtype_scope.rti->label;
74 }
75
76 /**
77 * Constructor of the roadtype scope resolvers.
78 * @param ro Surrounding resolver.
79 * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
80 * @param context Are we resolving sprites for the upper halftile, or on a bridge?
81 */
RoadTypeScopeResolver(ResolverObject & ro,const RoadTypeInfo * rti,TileIndex tile,TileContext context)82 RoadTypeScopeResolver::RoadTypeScopeResolver(ResolverObject &ro, const RoadTypeInfo *rti, TileIndex tile, TileContext context) : ScopeResolver(ro)
83 {
84 this->tile = tile;
85 this->context = context;
86 this->rti = rti;
87 }
88
89 /**
90 * Resolver object for road types.
91 * @param rti Roadtype. nullptr in NewGRF Inspect window.
92 * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
93 * @param context Are we resolving sprites for the upper halftile, or on a bridge?
94 * @param rtsg Roadpart of interest
95 * @param param1 Extra parameter (first parameter of the callback, except roadtypes do not have callbacks).
96 * @param param2 Extra parameter (second parameter of the callback, except roadtypes do not have callbacks).
97 */
RoadTypeResolverObject(const RoadTypeInfo * rti,TileIndex tile,TileContext context,RoadTypeSpriteGroup rtsg,uint32 param1,uint32 param2)98 RoadTypeResolverObject::RoadTypeResolverObject(const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32 param1, uint32 param2)
99 : ResolverObject(rti != nullptr ? rti->grffile[rtsg] : nullptr, CBID_NO_CALLBACK, param1, param2), roadtype_scope(*this, rti, tile, context)
100 {
101 this->root_spritegroup = rti != nullptr ? rti->group[rtsg] : nullptr;
102 }
103
104 /**
105 * Get the sprite to draw for the given tile.
106 * @param rti The road type data (spec).
107 * @param tile The tile to get the sprite for.
108 * @param rtsg The type of sprite to draw.
109 * @param content Where are we drawing the tile?
110 * @param [out] num_results If not nullptr, return the number of sprites in the spriteset.
111 * @return The sprite to draw.
112 */
GetCustomRoadSprite(const RoadTypeInfo * rti,TileIndex tile,RoadTypeSpriteGroup rtsg,TileContext context,uint * num_results)113 SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadTypeSpriteGroup rtsg, TileContext context, uint *num_results)
114 {
115 assert(rtsg < ROTSG_END);
116
117 if (rti->group[rtsg] == nullptr) return 0;
118
119 RoadTypeResolverObject object(rti, tile, context, rtsg);
120 const SpriteGroup *group = object.Resolve();
121 if (group == nullptr || group->GetNumResults() == 0) return 0;
122
123 if (num_results) *num_results = group->GetNumResults();
124
125 return group->GetResult();
126 }
127
128 /**
129 * Translate an index to the GRF-local road/tramtype-translation table into a RoadType.
130 * @param rtt Whether to index the road- or tramtype-table.
131 * @param tracktype Index into GRF-local translation table.
132 * @param grffile Originating GRF file.
133 * @return RoadType or INVALID_ROADTYPE if the roadtype is unknown.
134 */
GetRoadTypeTranslation(RoadTramType rtt,uint8 tracktype,const GRFFile * grffile)135 RoadType GetRoadTypeTranslation(RoadTramType rtt, uint8 tracktype, const GRFFile *grffile)
136 {
137 /* Because OpenTTD mixes RoadTypes and TramTypes into the same type,
138 * the mapping of the original road- and tramtypes does not match the default GRF-local mapping.
139 * So, this function cannot provide any similar behavior to GetCargoTranslation() and GetRailTypeTranslation()
140 * when the GRF defines no translation table.
141 * But since there is only one default road/tram-type, this makes little sense anyway.
142 * So for GRF without translation table, we always return INVALID_ROADTYPE.
143 */
144
145 if (grffile == nullptr) return INVALID_ROADTYPE;
146
147 const auto &list = rtt == RTT_TRAM ? grffile->tramtype_list : grffile->roadtype_list;
148 if (tracktype >= list.size()) return INVALID_ROADTYPE;
149
150 /* Look up roadtype including alternate labels. */
151 RoadType result = GetRoadTypeByLabel(list[tracktype]);
152
153 /* Check whether the result is actually the wanted road/tram-type */
154 if (result != INVALID_ROADTYPE && GetRoadTramType(result) != rtt) return INVALID_ROADTYPE;
155
156 return result;
157 }
158
159 /**
160 * Perform a reverse roadtype lookup to get the GRF internal ID.
161 * @param roadtype The global (OpenTTD) roadtype.
162 * @param grffile The GRF to do the lookup for.
163 * @return the GRF internal ID.
164 */
GetReverseRoadTypeTranslation(RoadType roadtype,const GRFFile * grffile)165 uint8 GetReverseRoadTypeTranslation(RoadType roadtype, const GRFFile *grffile)
166 {
167 /* No road type table present, return road type as-is */
168 if (grffile == nullptr) return roadtype;
169
170 const std::vector<RoadTypeLabel> *list = RoadTypeIsRoad(roadtype) ? &grffile->roadtype_list : &grffile->tramtype_list;
171 if (list->size() == 0) return roadtype;
172
173 /* Look for a matching road type label in the table */
174 RoadTypeLabel label = GetRoadTypeInfo(roadtype)->label;
175
176 int index = find_index(*list, label);
177 if (index >= 0) return index;
178
179 /* If not found, return as invalid */
180 return 0xFF;
181 }
182