vehicle.cpp File Reference

Base implementations of all vehicles. More...

#include "stdafx.h"
#include "gui.h"
#include "roadveh.h"
#include "ship.h"
#include "spritecache.h"
#include "timetable.h"
#include "viewport_func.h"
#include "news_func.h"
#include "command_func.h"
#include "company_func.h"
#include "vehicle_gui.h"
#include "train.h"
#include "aircraft.h"
#include "newgrf_debug.h"
#include "newgrf_sound.h"
#include "newgrf_station.h"
#include "group.h"
#include "group_gui.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "date_func.h"
#include "window_func.h"
#include "vehicle_func.h"
#include "autoreplace_func.h"
#include "autoreplace_gui.h"
#include "station_base.h"
#include "ai/ai.hpp"
#include "depot_func.h"
#include "network/network.h"
#include "core/pool_func.hpp"
#include "economy_base.h"
#include "articulated_vehicles.h"
#include "roadstop_base.h"
#include "core/random_func.hpp"
#include "core/backup_type.hpp"
#include "order_backup.h"
#include "sound_func.h"
#include "effectvehicle_func.h"
#include "effectvehicle_base.h"
#include "vehiclelist.h"
#include "bridge_map.h"
#include "tunnel_map.h"
#include "depot_map.h"
#include "cargodest_func.h"
#include "table/strings.h"

Go to the source code of this file.

Defines

#define GEN_HASH(x, y)   ((GB((y), 6, 6) << 6) + GB((x), 7, 6))

Typedefs

typedef SmallMap< Vehicle
*, bool, 4 > 
AutoreplaceMap
 List of vehicles that should check for autoreplace this tick.

Functions

void VehicleServiceInDepot (Vehicle *v)
void ShowNewGrfVehicleError (EngineID engine, StringID part1, StringID part2, GRFBugs bug_type, bool critical)
 Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.
byte VehicleRandomBits ()
 Get a value for a vehicle's random_bits.
static VehicleVehicleFromHash (int xl, int yl, int xu, int yu, void *data, VehicleFromPosProc *proc, bool find_first)
static VehicleVehicleFromPosXY (int x, int y, void *data, VehicleFromPosProc *proc, bool find_first)
 Helper function for FindVehicleOnPos/HasVehicleOnPos.
void FindVehicleOnPosXY (int x, int y, void *data, VehicleFromPosProc *proc)
 Find a vehicle from a specific location.
bool HasVehicleOnPosXY (int x, int y, void *data, VehicleFromPosProc *proc)
 Checks whether a vehicle in on a specific location.
static VehicleVehicleFromPos (TileIndex tile, void *data, VehicleFromPosProc *proc, bool find_first)
 Helper function for FindVehicleOnPos/HasVehicleOnPos.
void FindVehicleOnPos (TileIndex tile, void *data, VehicleFromPosProc *proc)
 Find a vehicle from a specific location.
bool HasVehicleOnPos (TileIndex tile, void *data, VehicleFromPosProc *proc)
 Checks whether a vehicle is on a specific location.
static VehicleEnsureNoVehicleProcZ (Vehicle *v, void *data)
 Callback that returns 'real' vehicles lower or at height *(byte*)data .
CommandCost EnsureNoVehicleOnGround (TileIndex tile)
 Ensure there is no vehicle at the ground at the given position.
static VehicleGetVehicleTunnelBridgeProc (Vehicle *v, void *data)
 Procedure called for every vehicle found in tunnel/bridge in the hash map.
CommandCost TunnelBridgeIsFree (TileIndex tile, TileIndex endtile, const Vehicle *ignore)
 Finds vehicle in tunnel / bridge.
static VehicleEnsureNoTrainOnTrackProc (Vehicle *v, void *data)
CommandCost EnsureNoTrainOnTrackBits (TileIndex tile, TrackBits track_bits)
 Tests if a vehicle interacts with the specified track bits.
static void UpdateNewVehiclePosHash (Vehicle *v, bool remove)
static void UpdateVehiclePosHash (Vehicle *v, int x, int y)
void ResetVehiclePosHash ()
void ResetVehicleColourMap ()
void InitializeVehicles ()
uint CountVehiclesInChain (const Vehicle *v)
void CountCompanyVehicles (CompanyID cid, uint counts[4])
 Count the number of vehicles of a company.
void VehicleEnteredDepotThisTick (Vehicle *v)
 Adds a vehicle to the list of vehicles that visited a depot this tick.
static void RunVehicleDayProc ()
 Increases the day counter for all vehicles and calls 1-day and 32-day handlers.
void CallVehicleTicks ()
static void DoDrawVehicle (const Vehicle *v)
 Add vehicle sprite for drawing to the screen.
void ViewportAddVehicles (DrawPixelInfo *dpi)
 Add the vehicle sprites that should be drawn at a part of the screen.
VehicleCheckClickOnVehicle (const ViewPort *vp, int x, int y)
 Find the vehicle close to the clicked coordinates.
void DecreaseVehicleValue (Vehicle *v)
 Decrease the value of a vehicle.
void CheckVehicleBreakdown (Vehicle *v)
void AgeVehicle (Vehicle *v)
 Update age of a vehicle.
uint8 CalcPercentVehicleFilled (const Vehicle *v, StringID *colour)
 Calculates how full a vehicle is.
void VehicleEnterDepot (Vehicle *v)
 Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it, etc.
void VehicleMove (Vehicle *v, bool update_viewport)
 Move a vehicle in the game state; that is moving its position in the position hashes and marking its location in the viewport dirty if requested.
void MarkSingleVehicleDirty (const Vehicle *v)
 Marks viewports dirty where the vehicle's image is In fact, it equals BeginVehicleMove(v); EndVehicleMove(v);.
GetNewVehiclePosResult GetNewVehiclePos (const Vehicle *v)
 Get position information of a vehicle when moving one pixel in the direction it is facing.
Direction GetDirectionTowards (const Vehicle *v, int x, int y)
VehicleEnterTileStatus VehicleEnterTile (Vehicle *v, TileIndex tile, int x, int y)
 Call the tile callback function for a vehicle entering a tile.
UnitID GetFreeUnitNumber (VehicleType type)
 Get an unused unit number for a vehicle (if allowed).
bool CanBuildVehicleInfrastructure (VehicleType type)
 Check whether we can build infrastructure for the given vehicle type.
LiveryScheme GetEngineLiveryScheme (EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
 Determines the LiveryScheme for a vehicle.
const LiveryGetEngineLivery (EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting)
 Determines the livery for a vehicle.
static PaletteID GetEngineColourMap (EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v)
PaletteID GetEnginePalette (EngineID engine_type, CompanyID company)
 Get the colour map for an engine.
PaletteID GetVehiclePalette (const Vehicle *v)
 Get the colour map for a vehicle.
uint GetVehicleCapacity (const Vehicle *v, uint16 *mail_capacity)
 Determines capacity of a given vehicle from scratch.
void VehiclesYearlyLoop ()
bool CanVehicleUseStation (EngineID engine_type, const Station *st)
 Can this station be used by the given engine type?
bool CanVehicleUseStation (const Vehicle *v, const Station *st)
 Can this station be used by the given vehicle?
void GetVehicleSet (VehicleSet &set, Vehicle *v, uint8 num_vehicles)
 Calculates the set of vehicles that will be affected by a given selection.

Variables

VehicleID _new_vehicle_id
uint16 _returned_refit_capacity
 Stores the capacity after a refit operation.
uint16 _returned_mail_refit_capacity
 Stores the mail capacity after a refit operation (Aircraft only).
byte _age_cargo_skip_counter
 Skip aging of cargo?
VehiclePool _vehicle_pool ("Vehicle")
 The pool with all our precious vehicles.
const int HASH_BITS = 7
const int HASH_SIZE = 1 << HASH_BITS
const int HASH_MASK = HASH_SIZE - 1
const int TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2)
const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1
const int HASH_RES = 0
static Vehicle_new_vehicle_position_hash [TOTAL_HASH_SIZE]
static Vehicle_vehicle_position_hash [0x1000]
static AutoreplaceMap _vehicles_to_autoreplace
static const byte _breakdown_chance [64]
static const Direction _new_direction_table []
static const int8 _vehicle_smoke_pos [8]

Detailed Description

Base implementations of all vehicles.

Definition in file vehicle.cpp.


Typedef Documentation

typedef SmallMap<Vehicle *, bool, 4> AutoreplaceMap

List of vehicles that should check for autoreplace this tick.

Mapping of vehicle -> leave depot immediately after autoreplace.

Definition at line 588 of file vehicle.cpp.


Function Documentation

void AgeVehicle ( Vehicle v  ) 
uint8 CalcPercentVehicleFilled ( const Vehicle v,
StringID colour 
)

Calculates how full a vehicle is.

Parameters:
v The Vehicle to check. For trains, use the first engine.
colour The string to show depending on if we are unloading or loading
Returns:
A percentage of how full the Vehicle is.

Definition at line 1171 of file vehicle.cpp.

References Vehicle::cargo, Vehicle::cargo_cap, Vehicle::cargo_type, CargoList< Tinst >::Count(), Vehicle::current_order, SpecializedStation< Station, false >::GetIfValid(), Order::GetLoadType(), Station::goods, HasBit(), Vehicle::last_station_visited, max(), Vehicle::Next(), OLFB_NO_LOAD, Vehicle::vehicle_flags, and VF_CARGO_UNLOADING.

Referenced by LoadUnloadVehicle(), and ProcessConditionalOrder().

bool CanBuildVehicleInfrastructure ( VehicleType  type  ) 
bool CanVehicleUseStation ( const Vehicle v,
const Station st 
)

Can this station be used by the given vehicle?

Parameters:
v the vehicle to test
st the station to test for
Returns:
true if and only if the vehicle can use this station.

Definition at line 2469 of file vehicle.cpp.

References CanVehicleUseStation(), Vehicle::engine_type, SpecializedVehicle< RoadVehicle, Type >::From(), BaseVehicle::type, and VEH_ROAD.

bool CanVehicleUseStation ( EngineID  engine_type,
const Station st 
)

Can this station be used by the given engine type?

Parameters:
engine_type the type of vehicles to test
st the station to test for
Returns:
true if and only if the vehicle of the type can use this station.
Note:
For road vehicles the Vehicle is needed to determine whether it can use the station. This function will return true for road vehicles when at least one of the facilities is available.

Definition at line 2436 of file vehicle.cpp.

References AIR_CTOL, AirportFTAClass::AIRPLANES, Station::airport, FACIL_AIRPORT, FACIL_BUS_STOP, FACIL_DOCK, FACIL_TRAIN, FACIL_TRUCK_STOP, BaseStation::facilities, AirportFTAClass::flags, Airport::GetFTA(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::GetIfValid(), AirportFTAClass::HELICOPTERS, AircraftVehicleInfo::subtype, Engine::type, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by CanVehicleUseStation(), CheckOrders(), CmdBuildAircraft(), CmdCloneOrder(), CmdInsertOrder(), and RoadVehicle::GetOrderStationLocation().

Vehicle* CheckClickOnVehicle ( const ViewPort vp,
int  x,
int  y 
)

Find the vehicle close to the clicked coordinates.

Parameters:
vp Viewport clicked in.
x X coordinate in the viewport.
y Y coordinate in the viewport.
Returns:
Closest vehicle, or NULL if none found.

Definition at line 975 of file vehicle.cpp.

References abs(), FOR_ALL_VEHICLES, ViewPort::height, ViewPort::left, max(), ScaleByZoom(), ViewPort::top, ViewPort::virtual_left, ViewPort::virtual_top, VS_HIDDEN, VS_UNCLICKABLE, ViewPort::width, and ViewPort::zoom.

void CountCompanyVehicles ( CompanyID  cid,
uint  counts[4] 
)

Count the number of vehicles of a company.

Parameters:
c Company owning the vehicles.
[out] counts Array of counts. Contains the vehicle count ordered by type afterwards.

Definition at line 611 of file vehicle.cpp.

References FOR_ALL_VEHICLES, Vehicle::IsPrimaryVehicle(), Vehicle::owner, and BaseVehicle::type.

Referenced by CompanyWindow::DrawWidget(), GetFreeUnitNumber(), and MayCompanyTakeOver().

void DecreaseVehicleValue ( Vehicle v  ) 

Decrease the value of a vehicle.

Parameters:
v Vehicle to devaluate.

Definition at line 1009 of file vehicle.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, SetWindowDirty(), and Vehicle::value.

Referenced by Train::OnNewDay(), Ship::OnNewDay(), RoadVehicle::OnNewDay(), and Aircraft::OnNewDay().

static void DoDrawVehicle ( const Vehicle v  )  [static]
CommandCost EnsureNoTrainOnTrackBits ( TileIndex  tile,
TrackBits  track_bits 
)

Tests if a vehicle interacts with the specified track bits.

All track bits interact except parallel TRACK_BIT_HORZ or TRACK_BIT_VERT.

Parameters:
tile The tile.
track_bits The track bits.
Returns:
true if no train that interacts, is found. false if a train is found.

Definition at line 496 of file vehicle.cpp.

References return_cmd_error, BaseVehicle::type, and VehicleFromPos().

Referenced by EnsureNoTrainOnTrack(), and ExploreSegment().

CommandCost EnsureNoVehicleOnGround ( TileIndex  tile  ) 

Ensure there is no vehicle at the ground at the given position.

Parameters:
tile Position to examine.
Returns:
Succeeded command (ground is free) or failed command (a vehicle is found).

Definition at line 434 of file vehicle.cpp.

References EnsureNoVehicleProcZ(), GetTileMaxZ(), return_cmd_error, BaseVehicle::type, and VehicleFromPos().

Referenced by CheckBuildableTile(), CheckIfIndustryTilesAreFree(), CmdBuildRoad(), CmdBuildSingleRail(), CmdConvertRail(), CmdRemoveSingleRail(), IsValidTileForWaypoint(), RemoveAirport(), RemoveBuoy(), RemoveDock(), RemoveFromRailBaseStation(), RemoveLock(), RemoveRailStation(), RemoveRoad(), and RemoveRoadStop().

static Vehicle* EnsureNoVehicleProcZ ( Vehicle v,
void *  data 
) [static]

Callback that returns 'real' vehicles lower or at height *(byte*)data .

Parameters:
v Vehicle to examine.
data Pointer to height data.
Returns:
v if conditions are met, else NULL.

Definition at line 419 of file vehicle.cpp.

References AIR_SHADOW, Vehicle::subtype, BaseVehicle::type, VEH_AIRCRAFT, VEH_DISASTER, and Vehicle::z_pos.

Referenced by EnsureNoVehicleOnGround().

void FindVehicleOnPos ( TileIndex  tile,
void *  data,
VehicleFromPosProc *  proc 
)

Find a vehicle from a specific location.

It will call proc for ALL vehicles on the tile and YOU must make SURE that the "best one" is stored in the data value and is ALWAYS the same regardless of the order of the vehicles where proc was called on! When you fail to do this properly you create an almost untraceable DESYNC!

Note:
The return value of proc will be ignored.
Use this function when you have the intention that all vehicles should be iterated over.
Parameters:
tile The location on the map
data Arbitrary data passed to proc.
proc The proc that determines whether a vehicle will be "found".

Definition at line 393 of file vehicle.cpp.

References VehicleFromPos().

Referenced by CheckTrainCollision(), CmdConvertRail(), DeleteLastWagon(), FloodVehicles(), FollowTrainReservation(), GetTrainForReservation(), RoadStop::Entry::Rebuild(), and RemoveRoadStop().

void FindVehicleOnPosXY ( int  x,
int  y,
void *  data,
VehicleFromPosProc *  proc 
)

Find a vehicle from a specific location.

It will call proc for ALL vehicles on the tile and YOU must make SURE that the "best one" is stored in the data value and is ALWAYS the same regardless of the order of the vehicles where proc was called on! When you fail to do this properly you create an almost untraceable DESYNC!

Note:
The return value of proc will be ignored.
Use this when you have the intention that all vehicles should be iterated over.
Parameters:
x The X location on the map
y The Y location on the map
data Arbitrary data passed to proc
proc The proc that determines whether a vehicle will be "found".

Definition at line 333 of file vehicle.cpp.

References VehicleFromPosXY().

Referenced by CheckTrainCollision().

const Livery* GetEngineLivery ( EngineID  engine_type,
CompanyID  company,
EngineID  parent_engine_type,
const Vehicle v,
byte  livery_setting 
) [read]

Determines the livery for a vehicle.

Parameters:
engine_type EngineID of the vehicle
company Owner of the vehicle
parent_engine_type EngineID of the front vehicle. INVALID_VEHICLE if vehicle is at front itself.
v the vehicle. NULL if in purchase list etc.
livery_setting The livery settings to use for acquiring the livery information.
Returns:
livery to use

Definition at line 1650 of file vehicle.cpp.

References _local_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), GetEngineLiveryScheme(), Livery::in_use, LIT_ALL, and LIT_COMPANY.

LiveryScheme GetEngineLiveryScheme ( EngineID  engine_type,
EngineID  parent_engine_type,
const Vehicle v 
)

Determines the LiveryScheme for a vehicle.

Parameters:
engine_type EngineID of the vehicle
parent_engine_type EngineID of the front vehicle. INVALID_VEHICLE if vehicle is at front itself.
v the vehicle. NULL if in purchase list etc.
Returns:
livery scheme to use

Definition at line 1560 of file vehicle.cpp.

References AIR_CTOL, Vehicle::cargo_type, CC_PASSENGERS, CT_INVALID, EC_DIESEL, EC_ELECTRIC, EC_MAGLEV, EC_MONORAIL, EC_STEAM, EF_RAIL_IS_MU, EF_ROAD_TRAM, Vehicle::First(), CargoSpec::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), HasBit(), INVALID_ENGINE, Vehicle::IsArticulatedPart(), IsCargoInClass(), RAILVEH_WAGON, UsesWagonOverride(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by FinaliseEngineArray(), and GetEngineLivery().

PaletteID GetEnginePalette ( EngineID  engine_type,
CompanyID  company 
)

Get the colour map for an engine.

This used for unbuilt engines in the user interface.

Parameters:
engine_type ID of engine
company ID of company
Returns:
A ready-to-use palette modifier

Definition at line 1718 of file vehicle.cpp.

References INVALID_ENGINE.

Referenced by DrawEngineList(), NewsWindow::DrawWidget(), and EnginePreviewWindow::DrawWidget().

UnitID GetFreeUnitNumber ( VehicleType  type  ) 

Get an unused unit number for a vehicle (if allowed).

Parameters:
type Type of vehicle
Returns:
A unused unit number for the given type of vehicle if it is allowed to build one, else UINT16_MAX.

Definition at line 1486 of file vehicle.cpp.

References _current_company, _settings_game, CountCompanyVehicles(), lengthof, VehicleSettings::max_aircraft, VehicleSettings::max_roadveh, VehicleSettings::max_ships, VehicleSettings::max_trains, FreeUnitIDGenerator::NextID(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and GameSettings::vehicle.

Referenced by CheckNewTrain(), CmdBuildVehicle(), and NormaliseTrainHead().

GetNewVehiclePosResult GetNewVehiclePos ( const Vehicle v  ) 

Get position information of a vehicle when moving one pixel in the direction it is facing.

Parameters:
v Vehicle to move
Returns:
Position information after the move

Definition at line 1380 of file vehicle.cpp.

References Vehicle::direction, GetNewVehiclePosResult::new_tile, GetNewVehiclePosResult::old_tile, Vehicle::tile, TileVirtXY(), Vehicle::x_pos, GetNewVehiclePosResult::y, and Vehicle::y_pos.

Referenced by AircraftController(), DisasterTick_Aircraft(), DisasterTick_Big_Ufo(), DisasterTick_Big_Ufo_Destroyer(), DisasterTick_Submarine(), DisasterTick_Ufo(), DisasterTick_Zeppeliner(), and UpdateOldAircraft().

uint GetVehicleCapacity ( const Vehicle v,
uint16 *  mail_capacity 
)
PaletteID GetVehiclePalette ( const Vehicle v  ) 
void GetVehicleSet ( VehicleSet set,
Vehicle v,
uint8  num_vehicles 
)

Calculates the set of vehicles that will be affected by a given selection.

Parameters:
set [inout] Set of affected vehicles.
v First vehicle of the selection.
num_vehicles Number of vehicles in the selection (not counting articulated parts).
Precondition:
set must be empty.
Postcondition:
set will contain the vehicles that will be refitted.

Definition at line 2544 of file vehicle.cpp.

References SpecializedVehicle< Train, Type >::From(), SpecializedVehicle< T, Type >::GetFirstEnginePart(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, Vehicle::IsArticulatedPart(), GroundVehicle< T, Type >::IsMultiheaded(), SpecializedVehicle< T, Type >::Next(), BaseVehicle::type, and VEH_TRAIN.

Referenced by RefitWindow::BuildRefitList(), RefitWindow::DrawWidget(), and RefitVehicle().

bool HasVehicleOnPos ( TileIndex  tile,
void *  data,
VehicleFromPosProc *  proc 
)

Checks whether a vehicle is on a specific location.

It will call proc for vehicles until it returns non-NULL.

Note:
Use FindVehicleOnPos when you have the intention that all vehicles should be iterated over.
Parameters:
tile The location on the map
data Arbitrary data passed to proc.
proc The proc that determines whether a vehicle will be "found".
Returns:
True if proc returned non-NULL.

Definition at line 408 of file vehicle.cpp.

References VehicleFromPos().

Referenced by CheckRoadBlockedForOvertaking(), ExploreSegment(), TrainApproachingCrossing(), and UpdateLevelCrossing().

bool HasVehicleOnPosXY ( int  x,
int  y,
void *  data,
VehicleFromPosProc *  proc 
)

Checks whether a vehicle in on a specific location.

It will call proc for vehicles until it returns non-NULL.

Note:
Use FindVehicleOnPosXY when you have the intention that all vehicles should be iterated over.
Parameters:
x The X location on the map
y The Y location on the map
data Arbitrary data passed to proc
proc The proc that determines whether a vehicle will be "found".
Returns:
True if proc returned non-NULL.

Definition at line 349 of file vehicle.cpp.

References VehicleFromPosXY().

void MarkSingleVehicleDirty ( const Vehicle v  ) 

Marks viewports dirty where the vehicle's image is In fact, it equals BeginVehicleMove(v); EndVehicleMove(v);.

Parameters:
v vehicle to mark dirty
See also:
BeginVehicleMove()
EndVehicleMove()

Definition at line 1370 of file vehicle.cpp.

References Vehicle::coord, and MarkAllViewportsDirty().

Referenced by Vehicle::Crash(), CreateEffectVehicle(), InitializeDisasterVehicle(), and Vehicle::~Vehicle().

static void RunVehicleDayProc (  )  [static]

Increases the day counter for all vehicles and calls 1-day and 32-day handlers.

Each tick, it processes vehicles with "index % DAY_TICKS == _date_fract", so each day, all vehicles are processes in DAY_TICKS steps.

Definition at line 781 of file vehicle.cpp.

References _date_fract, CALLBACK_FAILED, CBID_VEHICLE_32DAY_CALLBACK, Vehicle::colourmap, Vehicle::day_counter, DAY_TICKS, Vehicle::engine_type, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >::GetPoolSize(), GetVehicleCallback(), HasBit(), and Vehicle::OnNewDay().

void ShowNewGrfVehicleError ( EngineID  engine,
StringID  part1,
StringID  part2,
GRFBugs  bug_type,
bool  critical 
)

Displays a "NewGrf Bug" error message for a engine, and pauses the game if not networking.

Parameters:
engine The engine that caused the problem
part1 Part 1 of the error message, taking the grfname as parameter 1
part2 Part 2 of the error message, taking the engine as parameter 2
bug_type Flag to check and set in grfconfig
critical Shall the "OpenTTD might crash"-message be shown when the player tries to unpause?

Definition at line 211 of file vehicle.cpp.

References _networking, CMD_PAUSE, DC_EXEC, DEBUG, DoCommand(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetGRFConfig(), GRFConfig::GetName(), GRFConfig::grf_bugs, Engine::grf_prop, GRFFilePropsBase< Tcnt >::grffile, HasBit(), lastof, PM_PAUSED_ERROR, PM_PAUSED_NORMAL, SetBit(), SetDParam(), SetDParamStr(), ShowErrorMessage(), and WL_CRITICAL.

Referenced by CheckConsistencyOfArticulatedVehicle(), RailVehicleLengthChanged(), and Vehicle::UpdateVisualEffect().

CommandCost TunnelBridgeIsFree ( TileIndex  tile,
TileIndex  endtile,
const Vehicle ignore 
)

Finds vehicle in tunnel / bridge.

Parameters:
tile first end
endtile second end
ignore Ignore this vehicle when searching
Returns:
Succeeded command (if tunnel/bridge is free) or failed command (if a vehicle is using the tunnel/bridge).

Definition at line 463 of file vehicle.cpp.

References GetVehicleTunnelBridgeProc(), return_cmd_error, BaseVehicle::type, and VehicleFromPos().

Referenced by ClearPathReservation(), CmdBuildRoad(), CmdConvertRail(), DoClearBridge(), DoClearTunnel(), and RemoveRoad().

void VehicleEnterDepot ( Vehicle v  ) 

Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it, etc.

Parameters:
v Vehicle that entered a depot.

Definition at line 1216 of file vehicle.cpp.

References _current_company, _local_company, _settings_client, AddVehicleNewsItem(), ClrBit(), Train::ConsistChanged(), Vehicle::cur_real_order_index, Vehicle::cur_speed, Vehicle::current_order, DC_EXEC, Vehicle::DeleteUnreachedAutoOrders(), Vehicle::dest_tile, DoCommand(), CommandCost::Failed(), Vehicle::First(), SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From(), SpecializedVehicle< Ship, VEH_SHIP >::From(), SpecializedVehicle< Train, Type >::From(), CommandCost::GetCost(), Order::GetDepotActionType(), Order::GetDepotOrderType(), Order::GetDestination(), Vehicle::GetOrder(), Order::GetRefitCargo(), Order::GetRefitSubtype(), GetStationIndex(), ClientSettings::gui, HandleAircraftEnterHangar(), Vehicle::IncrementAutoOrderIndex(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, INVALID_DIAGDIR, InvalidateWindowData(), Order::IsRefit(), Order::IsType(), Order::MakeDummy(), MarkTileDirtyByTile(), AI::NewEvent(), NS_ADVICE, ODATFB_HALT, ODATFB_NEAREST_DEPOT, ODTFB_PART_OF_ORDERS, Vehicle::owner, Vehicle::profit_this_year, Backup< T >::Restore(), SetDepotReservation(), SetDParam(), SetWindowClassesDirty(), SetWindowDirty(), GUISettings::show_track_reservation, ShowCostOrIncomeAnimation(), Ship::state, TFP_NONE, Vehicle::tile, TRACK_BIT_DEPOT, BaseVehicle::type, Ship::UpdateCache(), UpdateSignalsOnSegment(), UpdateVehicleTimetable(), SpecializedVehicle< T, Type >::UpdateViewport(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, Vehicle::vehstatus, VRF_TOGGLE_REVERSE, VS_HIDDEN, Train::wait_counter, Vehicle::x_pos, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by AircraftEventHandler_EnterHangar(), AircraftEventHandler_InHangar(), and VehicleEnter_Track().

void VehicleEnteredDepotThisTick ( Vehicle v  ) 

Adds a vehicle to the list of vehicles that visited a depot this tick.

Parameters:
*v vehicle to add

Definition at line 763 of file vehicle.cpp.

References Vehicle::vehstatus, and VS_STOPPED.

VehicleEnterTileStatus VehicleEnterTile ( Vehicle v,
TileIndex  tile,
int  x,
int  y 
)

Call the tile callback function for a vehicle entering a tile.

Parameters:
v Vehicle entering the tile
tile Tile entered
x X position
y Y position
Returns:
Some meta-data over the to be entered tile.
See also:
VehicleEnterTileStatus to see what the bits in the return value mean.

Definition at line 1434 of file vehicle.cpp.

References _tile_type_procs, GetTileType(), and TileTypeProcs::vehicle_enter_tile_proc.

Referenced by UpdateStatusAfterSwap().

static Vehicle* VehicleFromPos ( TileIndex  tile,
void *  data,
VehicleFromPosProc *  proc,
bool  find_first 
) [static]

Helper function for FindVehicleOnPos/HasVehicleOnPos.

Note:
Do not call this function directly!
Parameters:
tile The location on the map
data Arbitrary data passed to proc.
proc The proc that determines whether a vehicle will be "found".
find_first Whether to return on the first found or iterate over all vehicles
Returns:
the best matching or first vehicle (depending on find_first).

Definition at line 364 of file vehicle.cpp.

References GB(), Vehicle::next_new_hash, Vehicle::tile, TileX(), and TileY().

Referenced by EnsureNoTrainOnTrackBits(), EnsureNoVehicleOnGround(), FindVehicleOnPos(), HasVehicleOnPos(), and TunnelBridgeIsFree().

static Vehicle* VehicleFromPosXY ( int  x,
int  y,
void *  data,
VehicleFromPosProc *  proc,
bool  find_first 
) [static]

Helper function for FindVehicleOnPos/HasVehicleOnPos.

Note:
Do not call this function directly!
Parameters:
x The X location on the map
y The Y location on the map
data Arbitrary data passed to proc
proc The proc that determines whether a vehicle will be "found".
find_first Whether to return on the first found or iterate over all vehicles
Returns:
the best matching or first vehicle (depending on find_first).

Definition at line 306 of file vehicle.cpp.

References GB(), and TILE_SIZE.

Referenced by FindVehicleOnPosXY(), and HasVehicleOnPosXY().

void VehicleMove ( Vehicle v,
bool  update_viewport 
)
byte VehicleRandomBits (  ) 

Get a value for a vehicle's random_bits.

Returns:
A random value from 0 to 255.

Definition at line 258 of file vehicle.cpp.

References GB().

Referenced by AddArticulatedParts(), CmdBuildAircraft(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdBuildRoadVehicle(), and CmdBuildShip().

void ViewportAddVehicles ( DrawPixelInfo dpi  ) 

Add the vehicle sprites that should be drawn at a part of the screen.

Parameters:
dpi Rectangle being drawn.

Definition at line 917 of file vehicle.cpp.

References Vehicle::coord, DoDrawVehicle(), GB(), Vehicle::next_hash, Vehicle::vehstatus, and VS_HIDDEN.


Variable Documentation

const byte _breakdown_chance[64] [static]
Initial value:
 {
    3,   3,   3,   3,   3,   3,   3,   3,
    4,   4,   5,   5,   6,   6,   7,   7,
    8,   8,   9,   9,  10,  10,  11,  11,
   12,  13,  13,  13,  13,  14,  15,  16,
   17,  19,  21,  25,  28,  31,  34,  37,
   40,  44,  48,  52,  56,  60,  64,  68,
   72,  80,  90, 100, 110, 120, 130, 140,
  150, 170, 190, 210, 230, 250, 250, 250,
}

Definition at line 1015 of file vehicle.cpp.

const Direction _new_direction_table[] [static]
Initial value:

Definition at line 1398 of file vehicle.cpp.

The pool with all our precious vehicles.

const int8 _vehicle_smoke_pos[8] [static]
Initial value:
 {
  1, 1, 1, 0, -1, -1, -1, 0
}

Definition at line 2185 of file vehicle.cpp.


Generated on Sun May 8 07:30:45 2011 for OpenTTD by  doxygen 1.6.1