OpenTTD Source  1.11.0-beta2
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 
16 #include "table/strings.h"
17 #include "table/sprites.h"
18 
19 #include "safeguards.h"
20 
21 static void DrawTile_Void(TileInfo *ti)
22 {
23  DrawGroundSprite(SPR_FLAT_BARE_LAND + SlopeToSpriteOffset(ti->tileh), PALETTE_ALL_BLACK);
24 }
25 
26 
27 static int GetSlopePixelZ_Void(TileIndex tile, uint x, uint y)
28 {
29  /* This function may be called on tiles outside the map, don't assume
30  * that 'tile' is a valid tile index. See GetSlopePixelZOutsideMap. */
31  int z;
32  Slope tileh = GetTilePixelSlopeOutsideMap(x >> 4, y >> 4, &z);
33 
34  return z + GetPartialPixelZ(x & 0xF, y & 0xF, tileh);
35 }
36 
37 static Foundation GetFoundation_Void(TileIndex tile, Slope tileh)
38 {
39  return FOUNDATION_NONE;
40 }
41 
42 static CommandCost ClearTile_Void(TileIndex tile, DoCommandFlag flags)
43 {
44  return_cmd_error(STR_ERROR_OFF_EDGE_OF_MAP);
45 }
46 
47 
48 static void GetTileDesc_Void(TileIndex tile, TileDesc *td)
49 {
50  td->str = STR_EMPTY;
51  td->owner[0] = OWNER_NONE;
52 }
53 
54 static void TileLoop_Void(TileIndex tile)
55 {
56  /* not used */
57 }
58 
59 static void ChangeTileOwner_Void(TileIndex tile, Owner old_owner, Owner new_owner)
60 {
61  /* not used */
62 }
63 
64 static TrackStatus GetTileTrackStatus_Void(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
65 {
66  return 0;
67 }
68 
69 static CommandCost TerraformTile_Void(TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
70 {
71  return_cmd_error(STR_ERROR_OFF_EDGE_OF_MAP);
72 }
73 
74 extern const TileTypeProcs _tile_type_void_procs = {
75  DrawTile_Void, // draw_tile_proc
76  GetSlopePixelZ_Void, // get_slope_z_proc
77  ClearTile_Void, // clear_tile_proc
78  nullptr, // add_accepted_cargo_proc
79  GetTileDesc_Void, // get_tile_desc_proc
80  GetTileTrackStatus_Void, // get_tile_track_status_proc
81  nullptr, // click_tile_proc
82  nullptr, // animate_tile_proc
83  TileLoop_Void, // tile_loop_proc
84  ChangeTileOwner_Void, // change_tile_owner_proc
85  nullptr, // add_produced_cargo_proc
86  nullptr, // vehicle_enter_tile_proc
87  GetFoundation_Void, // get_foundation_proc
88  TerraformTile_Void, // terraform_tile_proc
89 };
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
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:42
TileDesc::owner
Owner owner[4]
Name of the owner(s)
Definition: tile_cmd.h:53
GetPartialPixelZ
uint GetPartialPixelZ(int x, int y, Slope corners)
Determines height at given coordinate of a slope.
Definition: landscape.cpp:215
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:19
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:51
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
Foundation
Foundation
Enumeration for Foundations.
Definition: slope_type.h:93
SlopeToSpriteOffset
static uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition: slope_func.h:415
TileInfo::tileh
Slope tileh
Slope of the tile.
Definition: tile_cmd.h:45
return_cmd_error
#define return_cmd_error(errcode)
Returns from a function with a specific StringID as error.
Definition: command_func.h:33
CommandCost
Common return value for all commands.
Definition: command_type.h:23
slope_func.h
safeguards.h
sprites.h
FOUNDATION_NONE
@ FOUNDATION_NONE
The tile has no foundation, the slope remains unchanged.
Definition: slope_type.h:94
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:77
stdafx.h
landscape.h
TileTypeProcs
Set of callback functions for performing tile operations of a given tile type.
Definition: tile_cmd.h:145
viewport_func.h
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:52
PALETTE_ALL_BLACK
static const PaletteID PALETTE_ALL_BLACK
Exchange any color by black, needed for painting fictive tiles outside map.
Definition: sprites.h:1600
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:576