4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
10 /** @file newgrf_railtype.cpp NewGRF handling of rail types. */
14 #include "newgrf_railtype.h"
15 #include "date_func.h"
16 #include "depot_base.h"
20 /* virtual */ uint32
RailTypeScopeResolver::GetRandomBits() const
22 uint tmp
= CountBits(this->tile
+ (TileX(this->tile
) + TileY(this->tile
)) * TILE_SIZE
);
26 /* virtual */ uint32
RailTypeScopeResolver::GetVariable(byte variable
, uint32 parameter
, bool *available
) const
28 if (this->tile
== INVALID_TILE
) {
33 case 0x43: return _date
;
34 case 0x44: return HZB_TOWN_EDGE
;
39 case 0x40: return GetTerrainType(this->tile
, this->context
);
41 case 0x42: return IsLevelCrossingTile(this->tile
) && IsCrossingBarred(this->tile
);
43 if (IsRailDepotTile(this->tile
)) return Depot::GetByTile(this->tile
)->build_date
;
47 if (IsRailDepotTile(this->tile
)) {
48 t
= Depot::GetByTile(this->tile
)->town
;
49 } else if (IsLevelCrossingTile(this->tile
)) {
50 t
= ClosestTownFromTile(this->tile
);
52 return t
!= NULL
? GetTownRadiusGroup(t
, this->tile
) : HZB_TOWN_EDGE
;
56 DEBUG(grf
, 1, "Unhandled rail type tile variable 0x%X", variable
);
62 /* virtual */ const SpriteGroup
*RailTypeResolverObject::ResolveReal(const RealSpriteGroup
*group
) const
64 return group
->get_first (true);
68 * Constructor of the railtype scope resolvers.
69 * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
70 * @param context Are we resolving sprites for the upper halftile, or on a bridge?
72 RailTypeScopeResolver::RailTypeScopeResolver (TileIndex tile
, TileContext context
)
76 this->context
= context
;
80 * Resolver object for rail types.
81 * @param rti Railtype. NULL in NewGRF Inspect window.
82 * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
83 * @param context Are we resolving sprites for the upper halftile, or on a bridge?
84 * @param rtsg Railpart of interest
85 * @param param1 Extra parameter (first parameter of the callback, except railtypes do not have callbacks).
86 * @param param2 Extra parameter (second parameter of the callback, except railtypes do not have callbacks).
88 RailTypeResolverObject::RailTypeResolverObject(const RailtypeInfo
*rti
, TileIndex tile
, TileContext context
, RailTypeSpriteGroup rtsg
, uint32 param1
, uint32 param2
)
89 : ResolverObject(rti
!= NULL
? rti
->grffile
[rtsg
] : NULL
, CBID_NO_CALLBACK
, param1
, param2
),
90 railtype_scope(tile
, context
)
94 static inline const SpriteGroup
*RailTypeResolve (const RailtypeInfo
*rti
,
95 TileIndex tile
, TileContext context
, RailTypeSpriteGroup rtsg
,
96 uint32 param1
= 0, uint32 param2
= 0)
98 RailTypeResolverObject
object (rti
, tile
, context
, rtsg
, param1
, param2
);
99 const SpriteGroup
*root
= rti
!= NULL
? rti
->group
[rtsg
] : NULL
;
100 return SpriteGroup::Resolve (root
, object
);
104 * Get the sprite group to draw for the given tile.
105 * @param rti The rail type data (spec).
106 * @param tile The tile to get the sprite for.
107 * @param rtsg The type of sprite to draw.
108 * @param content Where are we drawing the tile?
109 * @return The sprite group to draw.
111 const SpriteGroup
*GetCustomRailSpriteGroup (const RailtypeInfo
*rti
, TileIndex tile
, RailTypeSpriteGroup rtsg
, TileContext context
)
113 assert(rtsg
< RTSG_END
);
115 if (rti
->group
[rtsg
] == NULL
) return NULL
;
117 const SpriteGroup
*group
= RailTypeResolve (rti
, tile
, context
, rtsg
);
118 if (group
== NULL
|| group
->GetNumResults() == 0) return NULL
;
124 * Get the sprite to draw for the given tile.
125 * @param rti The rail type data (spec).
126 * @param tile The tile to get the sprite for.
127 * @param rtsg The type of sprite to draw.
128 * @param content Where are we drawing the tile?
129 * @return The sprite to draw.
131 SpriteID
GetCustomRailSprite(const RailtypeInfo
*rti
, TileIndex tile
, RailTypeSpriteGroup rtsg
, TileContext context
)
133 const SpriteGroup
*group
= GetCustomRailSpriteGroup (rti
, tile
, rtsg
, context
);
134 return (group
!= NULL
) ? group
->GetResult() : 0;
138 * Get the sprite to draw for a given signal.
139 * @param rti The rail type data (spec).
140 * @param tile The tile to get the sprite for.
141 * @param type Signal type.
142 * @param var Signal variant.
143 * @param state Signal state.
144 * @param gui Is the sprite being used on the map or in the GUI?
145 * @return The sprite to draw.
147 SpriteID
GetCustomSignalSprite(const RailtypeInfo
*rti
, TileIndex tile
, SignalType type
, SignalVariant var
, SignalState state
, bool gui
)
149 if (rti
->group
[RTSG_SIGNALS
] == NULL
) return 0;
151 uint32 param1
= gui
? 0x10 : 0x00;
152 uint32 param2
= (type
<< 16) | (var
<< 8) | state
;
154 const SpriteGroup
*group
= RailTypeResolve (rti
, tile
, TCX_NORMAL
, RTSG_SIGNALS
, param1
, param2
);
155 if (group
== NULL
|| group
->GetNumResults() == 0) return 0;
157 return group
->GetResult();
161 * Perform a reverse railtype lookup to get the GRF internal ID.
162 * @param railtype The global (OpenTTD) railtype.
163 * @param grffile The GRF to do the lookup for.
164 * @return the GRF internal ID.
166 uint8
GetReverseRailTypeTranslation(RailType railtype
, const GRFFile
*grffile
)
168 /* No rail type table present, return rail type as-is */
169 if (grffile
== NULL
|| grffile
->railtype_list
.Length() == 0) return railtype
;
171 /* Look for a matching rail type label in the table */
172 RailTypeLabel label
= GetRailTypeInfo(railtype
)->label
;
173 int index
= grffile
->railtype_list
.FindIndex(label
);
174 if (index
>= 0) return index
;
176 /* If not found, return as invalid */