OpenTTD Source 20250905-master-g122023be8d
tile_cmd.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10#ifndef TILE_CMD_H
11#define TILE_CMD_H
12
14#include "command_type.h"
15#include "vehicle_type.h"
16#include "cargo_type.h"
17#include "track_type.h"
18#include "tile_map.h"
20
21enum class VehicleEnterTileState : uint8_t {
25};
26
28
34
36struct TileDesc {
38 uint64_t dparam = 0;
39 std::array<Owner, 4> owner{};
40 std::array<StringID, 4> owner_type{};
47 std::optional<std::string> grf = std::nullopt;
49 uint16_t rail_speed = 0;
51 uint16_t road_speed = 0;
53 uint16_t tram_speed = 0;
54 std::optional<bool> town_can_upgrade = std::nullopt;
55};
56
61typedef void DrawTileProc(TileInfo *ti);
62
74typedef int GetSlopeZProc(TileIndex tile, uint x, uint y, bool ground_vehicle);
75typedef CommandCost ClearTileProc(TileIndex tile, DoCommandFlags flags);
76
83typedef void AddAcceptedCargoProc(TileIndex tile, CargoArray &acceptance, CargoTypes &always_accepted);
84
90typedef void GetTileDescProc(TileIndex tile, TileDesc &td);
91
105typedef TrackStatus GetTileTrackStatusProc(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side);
106
112typedef void AddProducedCargoProc(TileIndex tile, CargoArray &produced);
113typedef bool ClickTileProc(TileIndex tile);
114typedef void AnimateTileProc(TileIndex tile);
115typedef void TileLoopProc(TileIndex tile);
116typedef void ChangeTileOwnerProc(TileIndex tile, Owner old_owner, Owner new_owner);
117
118typedef VehicleEnterTileStates VehicleEnterTileProc(Vehicle *v, TileIndex tile, int x, int y);
119typedef Foundation GetFoundationProc(TileIndex tile, Slope tileh);
120
136typedef CommandCost TerraformTileProc(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new);
137
146using CheckBuildAboveProc = CommandCost(TileIndex tile, DoCommandFlags flags, Axis axis, int height);
147
154 GetSlopeZProc *get_slope_z_proc;
155 ClearTileProc *clear_tile_proc;
159 ClickTileProc *click_tile_proc;
160 AnimateTileProc *animate_tile_proc;
161 TileLoopProc *tile_loop_proc;
162 ChangeTileOwnerProc *change_tile_owner_proc;
164 VehicleEnterTileProc *vehicle_enter_tile_proc;
165 GetFoundationProc *get_foundation_proc;
167 CheckBuildAboveProc *check_build_above_proc;
168};
169
170extern const TileTypeProcs * const _tile_type_procs[16];
171
172TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side = INVALID_DIAGDIR);
174void ChangeTileOwner(TileIndex tile, Owner old_owner, Owner new_owner);
175void GetTileDesc(TileIndex tile, TileDesc &td);
176
177inline void AddAcceptedCargo(TileIndex tile, CargoArray &acceptance, CargoTypes *always_accepted)
178{
180 if (proc == nullptr) return;
181 CargoTypes dummy = 0; // use dummy bitmask so there don't need to be several 'always_accepted != nullptr' checks
182 proc(tile, acceptance, always_accepted == nullptr ? dummy : *always_accepted);
183}
184
185inline void AddProducedCargo(TileIndex tile, CargoArray &produced)
186{
188 if (proc == nullptr) return;
189 proc(tile, produced);
190}
191
197inline bool MayAnimateTile(TileIndex tile)
198{
199 return _tile_type_procs[GetTileType(tile)]->animate_tile_proc != nullptr;
200}
201
202inline void AnimateTile(TileIndex tile)
203{
204 AnimateTileProc *proc = _tile_type_procs[GetTileType(tile)]->animate_tile_proc;
205 assert(proc != nullptr);
206 proc(tile);
207}
208
209inline bool ClickTile(TileIndex tile)
210{
211 ClickTileProc *proc = _tile_type_procs[GetTileType(tile)]->click_tile_proc;
212 if (proc == nullptr) return false;
213 return proc(tile);
214}
215
216#endif /* TILE_CMD_H */
Types related to cargoes...
Common return value for all commands.
Enum-as-bit-set wrapper.
static constexpr TimerGame< struct Calendar >::Date INVALID_DATE
Representation of an invalid date.
Types related to commands.
Axis
Allow incrementing of DiagDirDiff variables.
DiagDirection
Enumeration for diagonal directions.
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
All geometry types in OpenTTD.
Slope
Enumeration for the slope-type.
Definition slope_type.h:48
Foundation
Enumeration for Foundations.
Definition slope_type.h:93
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Class for storing amounts of cargo.
Definition cargo_type.h:113
A coordinate with three dimensions.
Tile description for the 'land area information' tool.
Definition tile_cmd.h:36
uint16_t rail_speed
Speed limit of rail (bridges and track)
Definition tile_cmd.h:49
std::optional< std::string > grf
newGRF used for the tile contents
Definition tile_cmd.h:47
StringID station_name
Type of station within the class.
Definition tile_cmd.h:43
StringID str
Description of the tile.
Definition tile_cmd.h:37
TimerGameCalendar::Date build_date
Date of construction of tile contents.
Definition tile_cmd.h:41
std::array< Owner, 4 > owner
Name of the owner(s)
Definition tile_cmd.h:39
uint64_t dparam
Parameter of the str string.
Definition tile_cmd.h:38
StringID airport_class
Name of the airport class.
Definition tile_cmd.h:44
StringID airport_name
Name of the airport.
Definition tile_cmd.h:45
uint16_t tram_speed
Speed limit of tram (bridges and track)
Definition tile_cmd.h:53
StringID roadtype
Type of road on the tile.
Definition tile_cmd.h:50
StringID tramtype
Type of tram on the tile.
Definition tile_cmd.h:52
StringID railtype
Type of rail on the tile.
Definition tile_cmd.h:48
uint16_t road_speed
Speed limit of road (bridges and track)
Definition tile_cmd.h:51
std::array< StringID, 4 > owner_type
Type of each owner.
Definition tile_cmd.h:40
std::optional< bool > town_can_upgrade
Whether the town can upgrade this house during town growth.
Definition tile_cmd.h:54
StringID airport_tile_name
Name of the airport tile.
Definition tile_cmd.h:46
StringID station_class
Class of station.
Definition tile_cmd.h:42
Tile information, used while rendering the tile.
Definition tile_cmd.h:30
Slope tileh
Slope of the tile.
Definition tile_cmd.h:31
TileIndex tile
Tile index.
Definition tile_cmd.h:32
Set of callback functions for performing tile operations of a given tile type.
Definition tile_cmd.h:152
VehicleEnterTileProc * vehicle_enter_tile_proc
Called when a vehicle enters a tile.
Definition tile_cmd.h:164
DrawTileProc * draw_tile_proc
Called to render the tile and its contents to the screen.
Definition tile_cmd.h:153
AddAcceptedCargoProc * add_accepted_cargo_proc
Adds accepted cargo of the tile to cargo array supplied as parameter.
Definition tile_cmd.h:156
GetTileDescProc * get_tile_desc_proc
Get a description of a tile (for the 'land area information' tool)
Definition tile_cmd.h:157
TerraformTileProc * terraform_tile_proc
Called when a terraforming operation is about to take place.
Definition tile_cmd.h:166
GetTileTrackStatusProc * get_tile_track_status_proc
Get available tracks and status of a tile.
Definition tile_cmd.h:158
AddProducedCargoProc * add_produced_cargo_proc
Adds produced cargo of the tile to cargo array supplied as parameter.
Definition tile_cmd.h:163
ClickTileProc * click_tile_proc
Called when tile is clicked.
Definition tile_cmd.h:159
Vehicle data structure.
VehicleEnterTileState
Definition tile_cmd.h:21
@ EnteredStation
The vehicle entered a station.
@ CannotEnter
The vehicle cannot enter the tile.
@ EnteredWormhole
The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/...
void AddProducedCargoProc(TileIndex tile, CargoArray &produced)
Tile callback function signature for obtaining the produced cargo of a tile.
Definition tile_cmd.h:112
void DrawTileProc(TileInfo *ti)
Tile callback function signature for drawing a tile and its contents to the screen.
Definition tile_cmd.h:61
VehicleEnterTileStates VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y)
Call the tile callback function for a vehicle entering a tile.
Definition vehicle.cpp:1819
void ChangeTileOwner(TileIndex tile, Owner old_owner, Owner new_owner)
Change the owner of a tile.
void AddAcceptedCargoProc(TileIndex tile, CargoArray &acceptance, CargoTypes &always_accepted)
Tile callback function signature for obtaining cargo acceptance of a tile.
Definition tile_cmd.h:83
int GetSlopeZProc(TileIndex tile, uint x, uint y, bool ground_vehicle)
Tile callback function signature for obtaining the world Z coordinate of a given point of a tile.
Definition tile_cmd.h:74
TrackStatus GetTileTrackStatusProc(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Tile callback function signature for getting the possible tracks that can be taken on a given tile by...
Definition tile_cmd.h:105
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Definition landscape.cpp:66
CommandCost(TileIndex tile, DoCommandFlags flags, Axis axis, int height) CheckBuildAboveProc
Tile callback function signature to test if a bridge can be built above a tile.
Definition tile_cmd.h:146
CommandCost TerraformTileProc(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
Tile callback function signature of the terraforming callback.
Definition tile_cmd.h:136
void GetTileDescProc(TileIndex tile, TileDesc &td)
Tile callback function signature for obtaining a tile description.
Definition tile_cmd.h:90
bool MayAnimateTile(TileIndex tile)
Test if a tile may be animated.
Definition tile_cmd.h:197
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side=INVALID_DIAGDIR)
Returns information about trackdirs and signal states.
Map writing/reading functions for tiles.
static debug_inline TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
Definition of the game-calendar-timer.
All types related to tracks.
TransportType
Available types of transport.
Types related to vehicles.