src/autoslope.h
author rubidium
Mon, 31 Mar 2008 22:09:27 +0000
branch0.6
changeset 9357 bafe57f3402a
parent 8750 fdd6054e7bae
child 10222 b6919c94cc77
permissions -rw-r--r--
(svn r12524) [0.6] -Update: some documentation.
/* $Id$ */

/** @file autoslope.h */

#ifndef AUTOSLOPE_H
#define AUTOSLOPE_H

#include "depot.h"
#include "settings_type.h"
#include "player_func.h"

/**
 * Autoslope check for tiles with an entrance on an edge.
 * E.g. depots and non-drive-through-road-stops.
 *
 * The test succeeds if the slope is not steep and at least one corner of the entrance edge is on the TileMaxZ() level.
 *
 * @note The test does not check if autoslope is enabled at all.
 *
 * @param tile The tile.
 * @param z_new New TileZ.
 * @param tileh_new New TileSlope.
 * @param entrance Entrance edge.
 * @return true iff terraforming is allowed.
 */
static inline bool AutoslopeCheckForEntranceEdge(TileIndex tile, uint z_new, Slope tileh_new, DiagDirection entrance)
{
	if (IsSteepSlope(tileh_new) || (GetTileMaxZ(tile) != z_new + GetSlopeMaxZ(tileh_new))) return false;
	return ((tileh_new == SLOPE_FLAT) || CanBuildDepotByTileh(entrance, tileh_new));
}

/**
 * Tests if autoslope is enabled for _current_player.
 *
 * Autoslope is disabled for town/industry construction and old ai players.
 *
 * @return true iff autoslope is enabled.
 */
static inline bool AutoslopeEnabled()
{
	return (_patches.autoslope &&
	        ((IsValidPlayer(_current_player) && !_is_old_ai_player) ||
	         (_current_player == OWNER_NONE && _game_mode == GM_EDITOR)));
}

#endif /* AUTOSLOPE_H */