void_cmd.cpp File Reference

Handling of void tiles. More...

#include "stdafx.h"
#include "landscape.h"
#include "command_func.h"
#include "viewport_func.h"
#include "slope_func.h"
#include "water.h"
#include "table/strings.h"
#include "table/sprites.h"
#include "safeguards.h"

Go to the source code of this file.

Functions
static void	DrawTile_Void (TileInfo *ti)
	Tile callback function signature for drawing a tile and its contents to the screen.
static int	GetSlopePixelZ_Void (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.
static void	GetTileDesc_Void (TileIndex tile, TileDesc &td)
	Tile callback function signature for obtaining a tile description.
static void	TileLoop_Void (TileIndex tile)
	Tile callback function signature for running periodic tile updates.

Variables
const TileTypeProcs	_tile_type_void_procs
	TileTypeProcs definitions for TileType::Void tiles.

Detailed Description

Handling of void tiles.

Definition in file void_cmd.cpp.

Function Documentation

DrawTile_Void()

void DrawTile_Void ( TileInfo * ti )

static

Tile callback function signature for drawing a tile and its contents to the screen.

Parameters

ti	Information about the tile to draw

Definition at line 23 of file void_cmd.cpp.

References _settings_game, DrawGroundSprite(), PALETTE_ALL_BLACK, SlopeToSpriteOffset(), and TileInfo::tileh.

GetSlopePixelZ_Void()

int GetSlopePixelZ_Void ( TileIndex tile, uint x, uint y, bool ground_vehicle )

static

Tile callback function signature for obtaining the world Z coordinate of a given point of a tile.

Parameters

tile	The queries tile for the Z coordinate.
x	World X coordinate in tile "units".
y	World Y coordinate in tile "units".
ground_vehicle	Whether to get the Z coordinate of the ground vehicle, or the ground.

Returns

World Z coordinate at tile ground (vehicle) level, including slopes and foundations.

See also

GetSlopePixelZ

Definition at line 34 of file void_cmd.cpp.

References GetPartialPixelZ(), and GetTilePixelSlopeOutsideMap().

GetTileDesc_Void()

void GetTileDesc_Void ( TileIndex tile, TileDesc & td )

static

Tile callback function signature for obtaining a tile description.

Parameters

tile	Tile being queried
td	Storage pointer for returned tile description

See also

GetTileDesc

Definition at line 44 of file void_cmd.cpp.

References TileDesc::owner, OWNER_NONE, and TileDesc::str.

TileLoop_Void()

void TileLoop_Void ( TileIndex tile )

static

Tile callback function signature for running periodic tile updates.

Parameters

tile	The tile to update.

See also

RunTileLoop

Definition at line 51 of file void_cmd.cpp.

References TileLoop_Water().

Variable Documentation

_tile_type_void_procs

const TileTypeProcs _tile_type_void_procs

extern

Initial value:

                                                 = {
  .draw_tile_proc = DrawTile_Void,
  .get_slope_pixel_z_proc = GetSlopePixelZ_Void,
  .clear_tile_proc = [](TileIndex, DoCommandFlags) { return CommandCost(STR_ERROR_OFF_EDGE_OF_MAP); },
  .get_tile_desc_proc = GetTileDesc_Void,
  .tile_loop_proc = TileLoop_Void,
  .terraform_tile_proc = [](TileIndex, DoCommandFlags, int, Slope) { return CommandCost(STR_ERROR_OFF_EDGE_OF_MAP); },
}

TileTypeProcs definitions for TileType::Void tiles.

Definition at line 59 of file landscape.cpp.