# 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 "sprite.h"
    00020 #include "cargo_type.h"
    00021 #include "station_type.h"
    00022 #include "rail_type.h"
    00023
    00024 enum StationClassID {
    00025   STAT_CLASS_BEGIN = 0,
    00026   STAT_CLASS_DFLT = 0,
    00027   STAT_CLASS_WAYP,
    00028   STAT_CLASS_MAX = 32,
    00029 };
    00030 typedef SimpleTinyEnumT<StationClassID, byte> StationClassIDByte;
    00031 template <> struct EnumPropsT<StationClassID> : MakeEnumPropsT<StationClassID, byte, STAT_CLASS_BEGIN, STAT_CLASS_MAX, STAT_CLASS_MAX, 8> {};
    00032
    00034 DECLARE_POSTFIX_INCREMENT(StationClassID)
    00035
    00036 enum StationSpecFlags {
    00037   SSF_SEPARATE_GROUND,
    00038   SSF_DIV_BY_STATION_SIZE,
    00039   SSF_CB141_RANDOM_BITS,
    00040   SSF_CUSTOM_FOUNDATIONS,
    00041   SSF_EXTENDED_FOUNDATIONS,
    00042 };
    00043
    00044 /* Station layout for given dimensions - it is a two-dimensional array
    00045  * where index is computed as (x * platforms) + platform. */
    00046 typedef byte *StationLayout;
    00047
    00049 struct StationSpec {
    00056   GRFFilePropsBase<NUM_CARGO + 3> grf_prop;
    00057   StationClassID cls_id;
    00058   StringID name;
    00059
    00064   byte disallowed_platforms;
    00069   byte disallowed_lengths;
    00070
    00079   uint tiles;
    00080   DrawTileSprites *renderdata;
    00081
    00086   uint16 cargo_threshold;
    00087
    00088   uint32 cargo_triggers;
    00089
    00090   byte callback_mask;
    00091
    00092   byte flags;
    00093
    00094   byte pylons;
    00095   byte wires;
    00096   byte blocked;
    00097
    00098   AnimationInfo animation;
    00099
    00100   byte lengths;
    00101   byte *platforms;
    00102   StationLayout **layouts;
    00103   bool copied_layouts;
    00104 };
    00105
    00107 typedef NewGRFClass<StationSpec, StationClassID, STAT_CLASS_MAX> StationClass;
    00108
    00109 const StationSpec *GetStationSpec(TileIndex t);
    00110
    00111 /* Evaluate a tile's position within a station, and return the result a bitstuffed format. */
    00112 uint32 GetPlatformInfo(Axis axis, byte tile, int platforms, int length, int x, int y, bool centred);
    00113
    00114 /* Get sprite offset for a given custom station and station structure (may be
    00115  * NULL - that means we are in a build dialog). The station structure is used
    00116  * for variational sprite groups. */
    00117 SpriteID GetCustomStationRelocation(const StationSpec *statspec, const BaseStation *st, TileIndex tile);
    00118 SpriteID GetCustomStationGroundRelocation(const StationSpec *statspec, const BaseStation *st, TileIndex tile);
    00119 SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, const BaseStation *st, TileIndex tile);
    00120 uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, const BaseStation *st, TileIndex tile);
    00121
    00122 /* Allocate a StationSpec to a Station. This is called once per build operation. */
    00123 int AllocateSpecToStation(const StationSpec *statspec, BaseStation *st, bool exec);
    00124
    00125 /* Deallocate a StationSpec from a Station. Called when removing a single station tile. */
    00126 void DeallocateSpecFromStation(BaseStation *st, byte specindex);
    00127
    00128 /* Draw representation of a station tile for GUI purposes. */
    00129 bool DrawStationTile(int x, int y, RailType railtype, Axis axis, StationClassID sclass, uint station);
    00130
    00131 void AnimateStationTile(TileIndex tile);
    00132 void TriggerStationAnimation(const BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type = CT_INVALID);
    00133 void StationUpdateAnimTriggers(BaseStation *st);
    00134
    00135 #endif /* NEWGRF_STATION_H */