OpenTTD Source  14.0-beta3
void_cmd.cpp
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 #include "stdafx.h"
11 #include "landscape.h"
12 #include "command_func.h"
13 #include "viewport_func.h"
14 #include "slope_func.h"
15 #include "water.h"
16 
17 #include "table/strings.h"
18 #include "table/sprites.h"
19 
20 #include "safeguards.h"
21 
22 static void DrawTile_Void(TileInfo *ti)
23 {
24  DrawGroundSprite(SPR_FLAT_BARE_LAND + SlopeToSpriteOffset(ti->tileh), PALETTE_ALL_BLACK);
25 }
26 
27 
28 static int GetSlopePixelZ_Void(TileIndex, uint x, uint y, bool)
29 {
30  /* This function may be called on tiles outside the map, don't assume
31  * that 'tile' is a valid tile index. See GetSlopePixelZOutsideMap. */
32  int z;
33  Slope tileh = GetTilePixelSlopeOutsideMap(x >> 4, y >> 4, &z);
34 
35  return z + GetPartialPixelZ(x & 0xF, y & 0xF, tileh);
36 }
37 
38 static Foundation GetFoundation_Void(TileIndex, Slope)
39 {
40  return FOUNDATION_NONE;
41 }
42 
43 static CommandCost ClearTile_Void(TileIndex, DoCommandFlag)
44 {
45  return_cmd_error(STR_ERROR_OFF_EDGE_OF_MAP);
46 }
47 
48 
49 static void GetTileDesc_Void(TileIndex, TileDesc *td)
50 {
51  td->str = STR_EMPTY;
52  td->owner[0] = OWNER_NONE;
53 }
54 
55 static void TileLoop_Void(TileIndex tile)
56 {
57  /* Floods adjacent edge tile to prevent maps without water. */
58  TileLoop_Water(tile);
59 }
60 
61 static void ChangeTileOwner_Void(TileIndex, Owner, Owner)
62 {
63  /* not used */
64 }
65 
66 static TrackStatus GetTileTrackStatus_Void(TileIndex, TransportType, uint, DiagDirection)
67 {
68  return 0;
69 }
70 
71 static CommandCost TerraformTile_Void(TileIndex, DoCommandFlag, int, Slope)
72 {
73  return_cmd_error(STR_ERROR_OFF_EDGE_OF_MAP);
74 }
75 
76 extern const TileTypeProcs _tile_type_void_procs = {
77  DrawTile_Void, // draw_tile_proc
78  GetSlopePixelZ_Void, // get_slope_z_proc
79  ClearTile_Void, // clear_tile_proc
80  nullptr, // add_accepted_cargo_proc
81  GetTileDesc_Void, // get_tile_desc_proc
82  GetTileTrackStatus_Void, // get_tile_track_status_proc
83  nullptr, // click_tile_proc
84  nullptr, // animate_tile_proc
85  TileLoop_Void, // tile_loop_proc
86  ChangeTileOwner_Void, // change_tile_owner_proc
87  nullptr, // add_produced_cargo_proc
88  nullptr, // vehicle_enter_tile_proc
89  GetFoundation_Void, // get_foundation_proc
90  TerraformTile_Void, // terraform_tile_proc
91 };
water.h
command_func.h
GetTilePixelSlopeOutsideMap
Slope GetTilePixelSlopeOutsideMap(int x, int y, int *h)
Return the slope of a given tile, also for tiles outside the map (virtual "black" tiles).
Definition: tile_map.cpp:82
TileInfo
Tile information, used while rendering the tile.
Definition: tile_cmd.h:43
TileDesc::owner
Owner owner[4]
Name of the owner(s)
Definition: tile_cmd.h:55
GetPartialPixelZ
uint GetPartialPixelZ(int x, int y, Slope corners)
Determines height at given coordinate of a slope.
Definition: landscape.cpp:224
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
TileDesc
Tile description for the 'land area information' tool.
Definition: tile_cmd.h:52
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:369
Foundation
Foundation
Enumeration for Foundations.
Definition: slope_type.h:93
TileInfo::tileh
Slope tileh
Slope of the tile.
Definition: tile_cmd.h:46
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:38
CommandCost
Common return value for all commands.
Definition: command_type.h:23
slope_func.h
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:19
safeguards.h
sprites.h
FOUNDATION_NONE
@ FOUNDATION_NONE
The tile has no foundation, the slope remains unchanged.
Definition: slope_type.h:94
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:73
stdafx.h
landscape.h
TileTypeProcs
Set of callback functions for performing tile operations of a given tile type.
Definition: tile_cmd.h:158
viewport_func.h
TileLoop_Water
void TileLoop_Water(TileIndex tile)
Let a water tile floods its diagonal adjoining tiles called from tunnelbridge_cmd,...
Definition: water_cmd.cpp:1230
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
TileDesc::str
StringID str
Description of the tile.
Definition: tile_cmd.h:53
SlopeToSpriteOffset
uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition: slope_func.h:415
PALETTE_ALL_BLACK
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1608
DrawGroundSprite
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite for the current tile.
Definition: viewport.cpp:589