/* $Id$ */ /* * 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/>. */ /** @file newgrf_station.h Header file for NewGRF stations */ #ifndef NEWGRF_STATION_H #define NEWGRF_STATION_H #include "engine_type.h" #include "newgrf_callbacks.h" #include "tile_type.h" #include "station_type.h" #include "strings_type.h" #include "sprite.h" #include "direction_type.h" #include "newgrf.h" enum StationClassID { STAT_CLASS_BEGIN = 0, ///< the lowest valid value STAT_CLASS_DFLT = 0, ///< Default station class. STAT_CLASS_WAYP, ///< Waypoint class. STAT_CLASS_MAX = 32, ///< Maximum number of classes. }; typedef SimpleTinyEnumT<StationClassID, byte> StationClassIDByte; /** Allow incrementing of StationClassID variables */ DECLARE_POSTFIX_INCREMENT(StationClassID); enum StationSpecFlags { SSF_SEPARATE_GROUND, ///< Use different sprite set for ground sprites. SSF_DIV_BY_STATION_SIZE, ///< Divide cargo amount by station size. SSF_CB141_RANDOM_BITS, ///< Callback 141 needs random bits. SSF_CUSTOM_FOUNDATIONS, ///< Draw custom foundations. SSF_EXTENDED_FOUNDATIONS, ///< Extended foundation block instead of simple. }; /* Station layout for given dimensions - it is a two-dimensional array * where index is computed as (x * platforms) + platform. */ typedef byte *StationLayout; struct StationSpec { const struct GRFFile *grffile; ///< ID of GRF file station belongs to. int localidx; ///< Index within GRF file of station. bool allocated; ///< Flag whether this station has been added to a station class list StationClassID sclass; ///< The class to which this spec belongs. StringID name; ///< Name of this station. /** * Bitmask of number of platforms available for the station. * 0..6 correpsond to 1..7, while bit 7 corresponds to >7 platforms. */ byte disallowed_platforms; /** * Bitmask of platform lengths available for the station. * 0..6 correpsond to 1..7, while bit 7 corresponds to >7 tiles long. */ byte disallowed_lengths; /** Number of tile layouts. * A minimum of 8 is required is required for stations. * 0-1 = plain platform * 2-3 = platform with building * 4-5 = platform with roof, left side * 6-7 = platform with roof, right side */ uint tiles; DrawTileSprites *renderdata; ///< Array of tile layouts. bool copied_renderdata; /** Cargo threshold for choosing between little and lots of cargo * @note little/lots are equivalent to the moving/loading states for vehicles */ uint16 cargo_threshold; uint32 cargo_triggers; ///< Bitmask of cargo types which cause trigger re-randomizing byte callback_mask; ///< Bitmask of station callbacks that have to be called byte flags; ///< Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size byte pylons; ///< Bitmask of base tiles (0 - 7) which should contain elrail pylons byte wires; ///< Bitmask of base tiles (0 - 7) which should contain elrail wires byte blocked; ///< Bitmask of base tiles (0 - 7) which are blocked to trains byte lengths; byte *platforms; StationLayout **layouts; bool copied_layouts; uint8 anim_frames; uint8 anim_status; uint8 anim_speed; uint16 anim_triggers; /** * NUM_CARGO real cargo plus three pseudo cargo sprite groups. * Used for obtaining the sprite offset of custom sprites, and for * evaluating callbacks. */ const struct SpriteGroup *spritegroup[NUM_CARGO + 3]; }; /** * Struct containing information relating to station classes. */ struct StationClass { uint32 id; ///< ID of this class, e.g. 'DFLT', 'WAYP', etc. StringID name; ///< Name of this class. uint stations; ///< Number of stations in this class. StationSpec **spec; ///< Array of station specifications. }; void ResetStationClasses(); StationClassID AllocateStationClass(uint32 cls); void SetStationClassName(StationClassID sclass, StringID name); StringID GetStationClassName(StationClassID sclass); const StationSpec *GetStationSpec(TileIndex t); uint GetNumStationClasses(); uint GetNumCustomStations(StationClassID sclass); void SetCustomStationSpec(StationSpec *statspec); const StationSpec *GetCustomStationSpec(StationClassID sclass, uint station); const StationSpec *GetCustomStationSpecByGrf(uint32 grfid, byte localidx, int *index); /* Evaluate a tile's position within a station, and return the result a bitstuffed format. */ uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred); /* Get sprite offset for a given custom station and station structure (may be * NULL - that means we are in a build dialog). The station structure is used * for variational sprite groups. */ SpriteID GetCustomStationRelocation(const StationSpec *statspec, const BaseStation *st, TileIndex tile); SpriteID GetCustomStationGroundRelocation(const StationSpec *statspec, const BaseStation *st, TileIndex tile); uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, const BaseStation *st, TileIndex tile); /* 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, byte specindex); /* Draw representation of a station tile for GUI purposes. */ bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station); enum StatAnimTrigger { STAT_ANIM_BUILT, STAT_ANIM_NEW_CARGO, STAT_ANIM_CARGO_TAKEN, STAT_ANIM_TRAIN_ARRIVES, STAT_ANIM_TRAIN_DEPARTS, STAT_ANIM_TRAIN_LOADS, STAT_ANIM_250_TICKS, }; void AnimateStationTile(TileIndex tile); void StationAnimationTrigger(const BaseStation *st, TileIndex tile, StatAnimTrigger trigger, CargoID cargo_type = CT_INVALID); void StationUpdateAnimTriggers(BaseStation *st); #endif /* NEWGRF_STATION_H */