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         RoadTypeScopeResolver(ResolverObject &ro, const RoadTypeInfo *rti, TileIndex tile, TileContext context);
  24
  25         /* virtual */ uint32 GetRandomBits() const;
  26         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  27 };
  28
  29 /** Resolver object for road types. */
  30 struct RoadTypeResolverObject : public ResolverObject {
  31         RoadTypeScopeResolver roadtype_scope; ///< Resolver for the roadtype scope.
  32
  33         RoadTypeResolverObject(const RoadTypeInfo *rti, TileIndex tile, TileContext context, RoadTypeSpriteGroup rtsg, uint32 param1 = 0, uint32 param2 = 0);
  34
  35         ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
  36         {
  37                 switch (scope) {
  38                         case VSG_SCOPE_SELF: return &this->roadtype_scope;
  39                         default:             return ResolverObject::GetScope(scope, relative);
  40                 }
  41         }
  42
  43         GrfSpecFeature GetFeature() const override;
  44         uint32 GetDebugID() const override;
  45 };
  46
  47 SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadTypeSpriteGroup rtsg, TileContext context = TCX_NORMAL, uint *num_results = nullptr);
  48
  49 RoadType GetRoadTypeTranslation(RoadTramType rtt, uint8 tracktype, const GRFFile *grffile);
  50 uint8 GetReverseRoadTypeTranslation(RoadType roadtype, const GRFFile *grffile);
  51
  52 #endif /* NEWGRF_ROADTYPE_H */