OpenTTD/src/pathfinder/pathfinder_type.h

57 lines
2.2 KiB
C

/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file pathfinder_type.h General types related to pathfinders. */
#ifndef PATHFINDER_TYPE_H
#define PATHFINDER_TYPE_H
#include "../tile_type.h"
#include "aystar.h"
/** Length (penalty) of one tile with YAPF */
static const int YAPF_TILE_LENGTH = 100;
/** Length (penalty) of a corner with YAPF */
static const int YAPF_TILE_CORNER_LENGTH = 71;
/**
* This penalty is the equivalent of "infinite", which means that paths that
* get this penalty will be chosen, but only if there is no other route
* without it. Be careful with not applying this penalty too often, or the
* total path cost might overflow.
*/
static const int YAPF_INFINITE_PENALTY = 1000 * YAPF_TILE_LENGTH;
/** Maximum segments of road vehicle path cache */
static const int YAPF_ROADVEH_PATH_CACHE_SEGMENTS = 8;
/** Distance from destination road stops to not cache any further */
static const int YAPF_ROADVEH_PATH_CACHE_DESTINATION_LIMIT = 8;
/**
* Helper container to find a depot
*/
struct FindDepotData {
TileIndex tile; ///< The tile of the depot
uint best_length; ///< The distance towards the depot in penalty, or UINT_MAX if not found
bool reverse; ///< True if reversing is necessary for the train to get to this depot
/**
* Create an instance of this structure.
* @param tile the tile of the depot
* @param best_length the distance towards the depot, or UINT_MAX if not found
* @param reverse whether we need to reverse first.
*/
FindDepotData(TileIndex tile = INVALID_TILE, uint best_length = UINT_MAX, bool reverse = false) :
tile(tile), best_length(best_length), reverse(reverse)
{
}
};
#endif /* PATHFINDER_TYPE_H */