newgrf_station.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NEWGRF_STATION_H
#define NEWGRF_STATION_H
 
#include "core/enum_type.hpp"
#include "newgrf_animation_type.h"
#include "newgrf_badge_type.h"
#include "newgrf_callbacks.h"
#include "newgrf_class.h"
#include "newgrf_commons.h"
#include "cargo_type.h"
#include "station_type.h"
#include "rail_type.h"
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"
 
struct StationScopeResolver : public ScopeResolver {
  TileIndex tile;                     
  struct BaseStation *st;             
  const struct StationSpec *statspec; 
  CargoType cargo_type;                 
  Axis axis;                          
 
  StationScopeResolver(ResolverObject &ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
    : ScopeResolver(ro), tile(tile), st(st), statspec(statspec), cargo_type(INVALID_CARGO), axis(INVALID_AXIS)
  {
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetTriggers() const override;
 
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
};
 
struct StationResolverObject : public ResolverObject {
  StationScopeResolver station_scope; 
  std::optional<TownScopeResolver> town_scope = std::nullopt; 
 
  StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
      CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
 
  TownScopeResolver *GetTown();
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF:
        return &this->station_scope;
 
      case VSG_SCOPE_PARENT: {
        TownScopeResolver *tsr = this->GetTown();
        if (tsr != nullptr) return tsr;
        [[fallthrough]];
      }
 
      default:
        return ResolverObject::GetScope(scope, relative);
    }
  }
 
  const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const override;
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
};
 
static const uint32_t STATION_CLASS_LABEL_DEFAULT = 'DFLT';
static const uint32_t STATION_CLASS_LABEL_WAYPOINT = 'WAYP';
 
enum StationClassID : uint16_t {
  STAT_CLASS_BEGIN = 0, 
  STAT_CLASS_DFLT = 0, 
  STAT_CLASS_WAYP, 
  STAT_CLASS_MAX = UINT16_MAX, 
};
 
DECLARE_INCREMENT_DECREMENT_OPERATORS(StationClassID)
 
enum class StationSpecFlag : uint8_t {
  SeparateGround = 0, 
  DivByStationSize = 1, 
  Cb141RandomBits = 2, 
  CustomFoundations = 3, 
  ExtendedFoundations = 4, 
};
using StationSpecFlags = EnumBitSet<StationSpecFlag, uint8_t>;
 
enum StationRandomTrigger : uint8_t {
  SRT_NEW_CARGO,        
  SRT_CARGO_TAKEN,      
  SRT_TRAIN_ARRIVES,    
  SRT_TRAIN_DEPARTS,    
  SRT_TRAIN_LOADS,      
  SRT_PATH_RESERVATION, 
};
 
struct StationSpec : NewGRFSpecBase<StationClassID> {
  StationSpec() : name(0),
    disallowed_platforms(0), disallowed_lengths(0),
    cargo_threshold(0), cargo_triggers(0),
    callback_mask(0), flags(0),
    animation({0, 0, 0, 0}) {}
  VariableGRFFileProps grf_prop;
  StringID name;             
 
  uint8_t disallowed_platforms;
  uint8_t disallowed_lengths;
 
  std::vector<NewGRFSpriteLayout> renderdata; 
 
  uint16_t cargo_threshold;
 
  CargoTypes cargo_triggers; 
 
  StationCallbackMasks callback_mask; 
 
  StationSpecFlags flags; 
 
  enum class TileFlag : uint8_t {
    Pylons = 0, 
    NoWires = 1, 
    Blocked = 2, 
  };
  using TileFlags = EnumBitSet<TileFlag, uint8_t>;
  std::vector<TileFlags> tileflags; 
 
  AnimationInfo animation;
 
  std::unordered_map<uint16_t, std::vector<uint8_t>> layouts;
 
  std::vector<BadgeID> badges;
};
 
using StationClass = NewGRFClass<StationSpec, StationClassID, STAT_CLASS_MAX>;
 
const StationSpec *GetStationSpec(TileIndex t);
 
inline uint16_t GetStationLayoutKey(uint8_t platforms, uint8_t length)
{
  return (length << 8U) | platforms;
}
 
inline bool IsWaypointClass(const StationClass &cls)
{
  return cls.global_id == STATION_CLASS_LABEL_WAYPOINT || GB(cls.global_id, 24, 8) == UINT8_MAX;
}
 
/* Evaluate a tile's position within a station, and return the result a bitstuffed format. */
uint32_t GetPlatformInfo(Axis axis, uint8_t tile, int platforms, int length, int x, int y, bool centred);
 
SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10 = 0);
SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info);
uint16_t GetStationCallback(CallbackID callback, uint32_t param1, uint32_t param2, const StationSpec *statspec, BaseStation *st, TileIndex tile);
CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, uint8_t plat_len, uint8_t numtracks);
 
/* Allocate a StationSpec to a Station. This is called once per build operation. */
int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec);
 
/* Deallocate a StationSpec from a Station. Called when removing a single station tile. */
void DeallocateSpecFromStation(BaseStation *st, uint8_t specindex);
 
/* Draw representation of a station tile for GUI purposes. */
bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);
 
void AnimateStationTile(TileIndex tile);
void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoType cargo_type = INVALID_CARGO);
void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoType cargo_type = INVALID_CARGO);
void StationUpdateCachedTriggers(BaseStation *st);
 
#endif /* NEWGRF_STATION_H */