src/newgrf_railtype.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_railtype.h NewGRF handling of rail types. */
   9
  10 #ifndef NEWGRF_RAILTYPE_H
  11 #define NEWGRF_RAILTYPE_H
  12
  13 #include "rail.h"
  14 #include "newgrf_commons.h"
  15 #include "newgrf_spritegroup.h"
  16
  17 /** Resolver for the railtype scope. */
  18 struct RailTypeScopeResolver : 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 RailTypeInfo *rti;
  22
  23         /**
  24          * Constructor of the railtype scope resolvers.
  25          * @param ro Surrounding resolver.
  26          * @param tile %Tile containing the track. For track on a bridge this is the southern bridgehead.
  27          * @param context Are we resolving sprites for the upper halftile, or on a bridge?
  28          */
  29         RailTypeScopeResolver(ResolverObject &ro, const RailTypeInfo *rti, TileIndex tile, TileContext context)
  30                 : ScopeResolver(ro), tile(tile), context(context), rti(rti)
  31         {
  32         }
  33
  34         uint32_t GetRandomBits() const override;
  35         uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
  36 };
  37
  38 /** Resolver object for rail types. */
  39 struct RailTypeResolverObject : public ResolverObject {
  40         RailTypeScopeResolver railtype_scope; ///< Resolver for the railtype scope.
  41
  42         RailTypeResolverObject(const RailTypeInfo *rti, TileIndex tile, TileContext context, RailTypeSpriteGroup rtsg, uint32_t param1 = 0, uint32_t param2 = 0);
  43
  44         ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  45         {
  46                 switch (scope) {
  47                         case VSG_SCOPE_SELF: return &this->railtype_scope;
  48                         default:             return ResolverObject::GetScope(scope, relative);
  49                 }
  50         }
  51
  52         GrfSpecFeature GetFeature() const override;
  53         uint32_t GetDebugID() const override;
  54 };
  55
  56 SpriteID GetCustomRailSprite(const RailTypeInfo *rti, TileIndex tile, RailTypeSpriteGroup rtsg, TileContext context = TCX_NORMAL, uint *num_results = nullptr);
  57 SpriteID GetCustomSignalSprite(const RailTypeInfo *rti, TileIndex tile, SignalType type, SignalVariant var, SignalState state, bool gui = false);
  58
  59 RailType GetRailTypeTranslation(uint8_t railtype, const GRFFile *grffile);
  60 uint8_t GetReverseRailTypeTranslation(RailType railtype, const GRFFile *grffile);
  61
  62 #endif /* NEWGRF_RAILTYPE_H */