Files
@ r14662:8798e984ee81
Branch filter:
Location: cpp/openttd-patchpack/source/src/ai/api/ai_basestation.hpp - annotation
r14662:8798e984ee81
2.7 KiB
text/x-c++hdr
(svn r19251) -Codechange: add a contructor to GRFError and use it to allocating errors more uniform.
-Fix: some grf error messages didn't free the previous error messages, creating a memory leak
-Fix: some grf error messages didn't free the previous error messages, creating a memory leak
r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r13023:9f6499c8d4fb r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12562:26b69ae711bf r12562:26b69ae711bf r12562:26b69ae711bf r12562:26b69ae711bf r12562:26b69ae711bf r12562:26b69ae711bf r12562:26b69ae711bf r12561:9dd086b8fc21 r12561:9dd086b8fc21 r12561:9dd086b8fc21 | /* $Id$ */
/*
* 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 ai_basestation.hpp Base for stations/waypoint handling. */
#ifndef AI_BASESTATION_HPP
#define AI_BASESTATION_HPP
#include "ai_object.hpp"
#include "ai_error.hpp"
/**
* Base class for stations and waypoints.
*/
class AIBaseStation : public AIObject {
public:
static const char *GetClassName() { return "AIBaseStation"; }
/**
* Special station IDs for building adjacent/new stations when
* the adjacent/distant join features are enabled.
*/
enum SpecialStationIDs {
STATION_NEW = 0xFFFD, //!< Build a new station
STATION_JOIN_ADJACENT = 0xFFFE, //!< Join an neighbouring station if one exists
STATION_INVALID = 0xFFFF, //!< Invalid station id.
};
/**
* Checks whether the given basestation is valid and owned by you.
* @param station_id The station to check.
* @return True if and only if the basestation is valid.
* @note IsValidBaseStation == (IsValidStation || IsValidWaypoint).
*/
static bool IsValidBaseStation(StationID station_id);
/**
* Get the name of a basestation.
* @param station_id The basestation to get the name of.
* @pre IsValidBaseStation(station_id).
* @return The name of the station.
*/
static char *GetName(StationID station_id);
/**
* Set the name this basestation.
* @param station_id The basestation to set the name of.
* @param name The new name of the station.
* @pre IsValidBaseStation(station_id).
* @pre 'name' must have at least one character.
* @pre 'name' must have at most 30 characters.
* @exception AIError::ERR_NAME_IS_NOT_UNIQUE
* @return True if the name was changed.
*/
static bool SetName(StationID station_id, const char *name);
/**
* Get the current location of a basestation.
* @param station_id The basestation to get the location of.
* @pre IsValidBaseStation(station_id).
* @return The tile the basestation is currently on.
*/
static TileIndex GetLocation(StationID station_id);
/**
* Get the last date a station part was added to this station.
* @param station_id The station to look at.
* @return The last date some part of this station was build.
*/
static int32 GetConstructionDate(StationID station_id);
};
#endif /* AI_BASESTATION_HPP */
|