src/newgrf_roadtype.h

   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.h NewGRF handling of road types. */
   9
  10 #ifndef NEWGRF_ROADTYPE_H
  11 #define NEWGRF_ROADTYPE_H
  12
  13 #include "road.h"
  14 #include "newgrf_commons.h"
  15 #include "newgrf_spritegroup.h"
  16
  17 /** Resolver for the railtype scope. */
  18 struct RoadTypeScopeResolver : public ScopeResolver {
  19         TileIndex tile;      ///< Tracktile. For track on a bridge this is the southern bridgehead.
  20         TileContext context; ///< Are we resolving sprites for the upper halftile, or on a bridge?
  21         const RoadTypeInfo *rti;
  22
  23         /**
  24          * Constructor of the roadtype scope resolvers.
  25          * @param ro Surrounding resolver.
  26          * @param rti Associated RoadTypeInfo.
  27          * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
  28          * @param context Are we resolving sprites for the upper halftile, or on a bridge?
  29          */
  30         RoadTypeScopeResolver(ResolverObject &ro, const RoadTypeInfo *rti, TileIndex tile, TileContext context)
  31                 : ScopeResolver(ro), tile(tile), context(context), rti(rti)
  32         {
  33         }
  34
  35         uint32_t GetRandomBits() const override;
  36         uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override;
  37 };
  38
  39 /** Resolver object for road types. */
  40 struct RoadTypeResolverObject : public ResolverObject {
  41         RoadTypeScopeResolver roadtype_scope; ///< Resolver for the roadtype scope.
  42
  43         RoadTypeResolverObject(const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32_t param1 = 0, uint32_t param2 = 0);
  44
  45         ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
  46         {
  47                 switch (scope) {
  48                         case VSG_SCOPE_SELF: return &this->roadtype_scope;
  49                         default:             return ResolverObject::GetScope(scope, relative);
  50                 }
  51         }
  52
  53         GrfSpecFeature GetFeature() const override;
  54         uint32_t GetDebugID() const override;
  55 };
  56
  57 SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadTypeSpriteGroup rtsg, TileContext context = TCX_NORMAL, uint *num_results = nullptr);
  58
  59 RoadType GetRoadTypeTranslation(RoadTramType rtt, uint8_t tracktype, const GRFFile *grffile);
  60 uint8_t GetReverseRoadTypeTranslation(RoadType roadtype, const GRFFile *grffile);
  61
  62 #endif /* NEWGRF_ROADTYPE_H */