# newgrf_station.h

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * 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.
    00006  * 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.
    00007  * 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/>.
    00008  */
    00009
    00012 #ifndef NEWGRF_STATION_H
    00013 #define NEWGRF_STATION_H
    00014
    00015 #include "newgrf_animation_type.h"
    00016 #include "newgrf_callbacks.h"
    00017 #include "newgrf_class.h"
    00018 #include "newgrf_commons.h"
    00019 #include "cargo_type.h"
    00020 #include "station_type.h"
    00021 #include "rail_type.h"
    00022
    00023 enum StationClassID {
    00024   STAT_CLASS_BEGIN = 0,
    00025   STAT_CLASS_DFLT = 0,
    00026   STAT_CLASS_WAYP,
    00027   STAT_CLASS_MAX = 32,
    00028 };
    00029 typedef SimpleTinyEnumT<StationClassID, byte> StationClassIDByte;
    00030 template <> struct EnumPropsT<StationClassID> : MakeEnumPropsT<StationClassID, byte, STAT_CLASS_BEGIN, STAT_CLASS_MAX, STAT_CLASS_MAX, 8> {};
    00031
    00033 DECLARE_POSTFIX_INCREMENT(StationClassID)
    00034
    00035 enum StationSpecFlags {
    00036   SSF_SEPARATE_GROUND,
    00037   SSF_DIV_BY_STATION_SIZE,
    00038   SSF_CB141_RANDOM_BITS,
    00039   SSF_CUSTOM_FOUNDATIONS,
    00040   SSF_EXTENDED_FOUNDATIONS,
    00041 };
    00042
    00043 /* Station layout for given dimensions - it is a two-dimensional array
    00044  * where index is computed as (x * platforms) + platform. */
    00045 typedef byte *StationLayout;
    00046
    00048 struct StationSpec {
    00055   GRFFilePropsBase<NUM_CARGO + 3> grf_prop;
    00056   StationClassID cls_id;
    00057   StringID name;
    00058
    00063   byte disallowed_platforms;
    00068   byte disallowed_lengths;
    00069
    00078   uint tiles;
    00079   NewGRFSpriteLayout *renderdata;
    00080
    00085   uint16 cargo_threshold;
    00086
    00087   uint32 cargo_triggers;
    00088
    00089   byte callback_mask;
    00090
    00091   byte flags;
    00092
    00093   byte pylons;
    00094   byte wires;
    00095   byte blocked;
    00096
    00097   AnimationInfo animation;
    00098
    00099   byte lengths;
    00100   byte *platforms;
    00101   StationLayout **layouts;
    00102   bool copied_layouts;
    00103 };
    00104
    00106 typedef NewGRFClass<StationSpec, StationClassID, STAT_CLASS_MAX> StationClass;
    00107
    00108 const StationSpec *GetStationSpec(TileIndex t);
    00109
    00110 /* Evaluate a tile's position within a station, and return the result a bitstuffed format. */
    00111 uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred);
    00112
    00113 SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10 = 0);
    00114 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info);
    00115 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile);
    00116 CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte numtracks);
    00117
    00118 /* Allocate a StationSpec to a Station. This is called once per build operation. */
    00119 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec);
    00120
    00121 /* Deallocate a StationSpec from a Station. Called when removing a single station tile. */
    00122 void DeallocateSpecFromStation(BaseStation *st, byte specindex);
    00123
    00124 /* Draw representation of a station tile for GUI purposes. */
    00125 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);
    00126
    00127 void AnimateStationTile(TileIndex tile);
    00128 void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type = CT_INVALID);
    00129 void StationUpdateAnimTriggers(BaseStation *st);
    00130
    00131 #endif /* NEWGRF_STATION_H */