Files
@ r24444:628513f2f77f
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_station.h - annotation
r24444:628513f2f77f
8.1 KiB
text/x-c
Update: Translations from eints
korean: 29 changes by telk5093
finnish: 8 changes by hpiirai
slovak: 6 changes by FuryPapaya
french: 6 changes by glx22
korean: 29 changes by telk5093
finnish: 8 changes by hpiirai
slovak: 6 changes by FuryPapaya
french: 6 changes by glx22
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15925:9a7fe46227a0 r7327:28855024ff6c r15729:fa8bb219ec5a r15723:ad33e41446a6 r14248:a9050881acd7 r14248:a9050881acd7 r14248:a9050881acd7 r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19738:837a139219f0 r19729:89a1eb41481c r19738:837a139219f0 r19738:837a139219f0 r19738:837a139219f0 r19738:837a139219f0 r19738:837a139219f0 r19729:89a1eb41481c r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r22756:8ffd1846f871 r19729:89a1eb41481c r23497:a0ab44ebd2fa r23497:a0ab44ebd2fa r19729:89a1eb41481c r23497:a0ab44ebd2fa r19729:89a1eb41481c r19729:89a1eb41481c r19738:837a139219f0 r19729:89a1eb41481c r19738:837a139219f0 r19738:837a139219f0 r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r23497:a0ab44ebd2fa r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r23607:36c15679007d r22850:1d6a79ca3a7c r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r19737:d7c69e3b4bd4 r19729:89a1eb41481c r19729:89a1eb41481c r19729:89a1eb41481c r23497:a0ab44ebd2fa r24069:49625df81342 r24069:49625df81342 r24069:49625df81342 r19729:89a1eb41481c r5475:3f5cd13d1b63 r23673:16c415388ae0 r5587:034e5e185dc2 r5587:034e5e185dc2 r5587:034e5e185dc2 r23673:16c415388ae0 r6248:b940b09d7ab8 r15027:bb71fdfcc554 r5587:034e5e185dc2 r5587:034e5e185dc2 r14900:c679fdaeebe6 r5587:034e5e185dc2 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r11580:d95a638b75a9 r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r19949:26fad1c62a1b r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15643:20875bb0d1bd r6248:b940b09d7ab8 r15752:bd75e688da94 r15752:bd75e688da94 r15752:bd75e688da94 r15752:bd75e688da94 r15752:bd75e688da94 r15752:bd75e688da94 r15752:bd75e688da94 r15727:185692d46434 r15727:185692d46434 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r19944:25a78576fb5e r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r19944:25a78576fb5e r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15610:623a23fb6560 r15610:623a23fb6560 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r17671:6321f2c5c4f2 r5475:3f5cd13d1b63 r15610:623a23fb6560 r15610:623a23fb6560 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r22867:9bff1c966805 r5475:3f5cd13d1b63 r13026:0c3f00ec0a74 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r15925:9a7fe46227a0 r15925:9a7fe46227a0 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r6248:b940b09d7ab8 r5475:3f5cd13d1b63 r15729:fa8bb219ec5a r15729:fa8bb219ec5a r5475:3f5cd13d1b63 r9714:24e754d1822b r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r17763:551bbcddf83e r17764:e13d0288c811 r17762:129a62225055 r17853:b905f907c347 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r12452:737113301015 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r12452:737113301015 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r5475:3f5cd13d1b63 r9003:0b0148ae8377 r17762:129a62225055 r19949:26fad1c62a1b r19949:26fad1c62a1b r9003:0b0148ae8377 r5475:3f5cd13d1b63 | /*
* 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 "newgrf_animation_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"
/** Scope resolver for stations. */
struct StationScopeResolver : public ScopeResolver {
TileIndex tile; ///< %Tile of the station.
struct BaseStation *st; ///< Instance of the station.
const struct StationSpec *statspec; ///< Station (type) specification.
CargoID cargo_type; ///< Type of cargo of the station.
Axis axis; ///< Station axis, used only for the slope check callback.
/**
* Constructor for station scopes.
* @param ro Surrounding resolver.
* @param statspec Station (type) specification.
* @param st Instance of the station.
* @param tile %Tile of the station.
*/
StationScopeResolver(ResolverObject &ro, const StationSpec *statspec, BaseStation *st, TileIndex tile)
: ScopeResolver(ro), tile(tile), st(st), statspec(statspec), cargo_type(CT_INVALID), axis(INVALID_AXIS)
{
}
uint32 GetRandomBits() const override;
uint32 GetTriggers() const override;
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override;
};
/** Station resolver. */
struct StationResolverObject : public ResolverObject {
StationScopeResolver station_scope; ///< The station scope resolver.
TownScopeResolver *town_scope; ///< The town scope resolver (created on the first call).
StationResolverObject(const StationSpec *statspec, BaseStation *st, TileIndex tile,
CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
~StationResolverObject();
TownScopeResolver *GetTown();
ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte 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 GetDebugID() const override;
};
enum StationClassID : byte {
STAT_CLASS_BEGIN = 0, ///< the lowest valid value
STAT_CLASS_DFLT = 0, ///< Default station class.
STAT_CLASS_WAYP, ///< Waypoint class.
STAT_CLASS_MAX = 255, ///< Maximum number of classes.
};
template <> struct EnumPropsT<StationClassID> : MakeEnumPropsT<StationClassID, byte, STAT_CLASS_BEGIN, STAT_CLASS_MAX, STAT_CLASS_MAX, 8> {};
/** 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.
};
/** Randomisation triggers for stations */
enum StationRandomTrigger {
SRT_NEW_CARGO, ///< Trigger station on new cargo arrival.
SRT_CARGO_TAKEN, ///< Trigger station when cargo is completely taken.
SRT_TRAIN_ARRIVES, ///< Trigger platform when train arrives.
SRT_TRAIN_DEPARTS, ///< Trigger platform when train leaves.
SRT_TRAIN_LOADS, ///< Trigger platform when train loads/unloads.
SRT_PATH_RESERVATION, ///< Trigger platform when train reserves path.
};
/* Station layout for given dimensions - it is a two-dimensional array
* where index is computed as (x * platforms) + platform. */
typedef byte *StationLayout;
/** Station specification. */
struct StationSpec {
/**
* Properties related the the grf file.
* NUM_CARGO real cargo plus three pseudo cargo sprite groups.
* Used for obtaining the sprite offset of custom sprites, and for
* evaluating callbacks.
*/
GRFFilePropsBase<NUM_CARGO + 3> grf_prop;
StationClassID cls_id; ///< The class to which this spec belongs.
StringID name; ///< Name of this station.
/**
* Bitmask of number of platforms available for the station.
* 0..6 correspond to 1..7, while bit 7 corresponds to >7 platforms.
*/
byte disallowed_platforms;
/**
* Bitmask of platform lengths available for the station.
* 0..6 correspond 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;
NewGRFSpriteLayout *renderdata; ///< Array of tile layouts.
/**
* 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;
CargoTypes 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
AnimationInfo animation;
byte lengths;
byte *platforms;
StationLayout **layouts;
bool copied_layouts;
};
/** Struct containing information relating to station classes. */
typedef NewGRFClass<StationSpec, StationClassID, STAT_CLASS_MAX> StationClass;
const StationSpec *GetStationSpec(TileIndex t);
/* 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);
SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32 var10 = 0);
SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info);
uint16 GetStationCallback(CallbackID callback, uint32 param1, uint32 param2, const StationSpec *statspec, BaseStation *st, TileIndex tile);
CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, byte plat_len, byte 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, 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);
void AnimateStationTile(TileIndex tile);
void TriggerStationAnimation(BaseStation *st, TileIndex tile, StationAnimationTrigger trigger, CargoID cargo_type = CT_INVALID);
void TriggerStationRandomisation(Station *st, TileIndex tile, StationRandomTrigger trigger, CargoID cargo_type = CT_INVALID);
void StationUpdateCachedTriggers(BaseStation *st);
#endif /* NEWGRF_STATION_H */
|