vehicle_func.h File Reference

Functions related to vehicles. More...

#include "gfx_type.h"
#include "direction_type.h"
#include "command_type.h"
#include "vehicle_type.h"
#include "engine_type.h"
#include "transport_type.h"
#include "newgrf_config.h"
#include "company_type.h"
#include "track_type.h"
#include "livery.h"

Go to the source code of this file.

Data Structures

struct  GetNewVehiclePosResult
 Position information of a vehicle after it moved. More...

Defines

#define is_custom_sprite(x)   (x >= 0xFD)
#define IS_CUSTOM_FIRSTHEAD_SPRITE(x)   (x == 0xFD)
#define IS_CUSTOM_SECONDHEAD_SPRITE(x)   (x == 0xFE)

Typedefs

typedef VehicleVehicleFromPosProc (Vehicle *v, void *data)
typedef SmallVector< VehicleID, 2 > VehicleSet

Functions

void VehicleServiceInDepot (Vehicle *v)
uint CountVehiclesInChain (const Vehicle *v)
void CountCompanyVehicles (CompanyID cid, uint counts[4])
 Count the number of vehicles of a company.
void FindVehicleOnPos (TileIndex tile, void *data, VehicleFromPosProc *proc)
 Find a vehicle from a specific location.
void FindVehicleOnPosXY (int x, int y, 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.
bool HasVehicleOnPosXY (int x, int y, void *data, VehicleFromPosProc *proc)
 Checks whether a vehicle in on a specific location.
void CallVehicleTicks ()
uint8 CalcPercentVehicleFilled (const Vehicle *v, StringID *colour)
 Calculates how full a vehicle is.
byte VehicleRandomBits ()
 Get a value for a vehicle's random_bits.
void ResetVehiclePosHash ()
void ResetVehicleColourMap ()
byte GetBestFittingSubType (Vehicle *v_from, Vehicle *v_for)
 Get the best fitting subtype when 'cloning'/'replacing' v_from with v_for.
void ViewportAddVehicles (DrawPixelInfo *dpi)
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.
CommandCost TunnelBridgeIsFree (TileIndex tile, TileIndex endtile, const Vehicle *ignore=NULL)
 Finds vehicle in tunnel / bridge.
void DecreaseVehicleValue (Vehicle *v)
void CheckVehicleBreakdown (Vehicle *v)
void AgeVehicle (Vehicle *v)
 Update age of a vehicle.
void VehicleEnteredDepotThisTick (Vehicle *v)
 Adds a vehicle to the list of vehicles that visited a depot this tick.
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);.
UnitID GetFreeUnitNumber (VehicleType type)
 Get an unused unit number for a vehicle (if allowed).
void VehicleEnterDepot (Vehicle *v)
bool CanBuildVehicleInfrastructure (VehicleType type)
 Check whether we can build infrastructure for the given vehicle type.
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)
static bool IsCompanyBuildableVehicleType (VehicleType type)
 Is the given vehicle type buildable by a company?
static bool IsCompanyBuildableVehicleType (const BaseVehicle *v)
 Is the given vehicle buildable by a company?
LiveryScheme GetEngineLiveryScheme (EngineID engine_type, EngineID parent_engine_type, const Vehicle *v)
 Determines the LiveryScheme for a vehicle.
struct LiveryGetEngineLivery (EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting)
 Determines the livery for a vehicle.
SpriteID GetEnginePalette (EngineID engine_type, CompanyID company)
 Get the colour map for an engine.
SpriteID GetVehiclePalette (const Vehicle *v)
 Get the colour map for a vehicle.
uint GetVehicleCapacity (const Vehicle *v, uint16 *mail_capacity=NULL)
 Determines capacity of a given vehicle from scratch.
static uint32 GetCmdBuildVeh (VehicleType type)
static uint32 GetCmdBuildVeh (const BaseVehicle *v)
static uint32 GetCmdSellVeh (VehicleType type)
static uint32 GetCmdSellVeh (const BaseVehicle *v)
static uint32 GetCmdRefitVeh (VehicleType type)
static uint32 GetCmdRefitVeh (const BaseVehicle *v)
static uint32 GetCmdSendToDepot (VehicleType type)
static uint32 GetCmdSendToDepot (const BaseVehicle *v)
CommandCost EnsureNoVehicleOnGround (TileIndex tile)
 Ensure there is no vehicle at the ground at the given position.
CommandCost EnsureNoTrainOnTrackBits (TileIndex tile, TrackBits track_bits)
 Tests if a vehicle interacts with the specified track bits.
void StopAllVehicles ()
bool CanVehicleUseStation (EngineID engine_type, const struct Station *st)
bool CanVehicleUseStation (const Vehicle *v, const struct Station *st)
void ReleaseDisastersTargetingVehicle (VehicleID vehicle)
 Notify disasters that we are about to delete a vehicle.
void GetVehicleSet (VehicleSet &set, Vehicle *v, uint8 num_vehicles)
 Calculates the set of vehicles that will be affected by a given selection.

Variables

const uint32 _veh_build_proc_table []
const uint32 _veh_sell_proc_table []
const uint32 _veh_refit_proc_table []
const uint32 _send_to_depot_proc_table []
VehicleID _vehicle_id_ctr_day
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?

Detailed Description

Functions related to vehicles.

Definition in file vehicle_func.h.


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 1133 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(), max(), Vehicle::Next(), OLFB_NO_LOAD, Vehicle::vehicle_flags, and VF_CARGO_UNLOADING.

Referenced by LoadUnloadVehicle(), and ProcessConditionalOrder().

bool CanBuildVehicleInfrastructure ( VehicleType  type  ) 
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 601 of file vehicle.cpp.

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

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

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 483 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 421 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().

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 380 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 320 of file vehicle.cpp.

References VehicleFromPosXY().

Referenced by CheckTrainCollision().

byte GetBestFittingSubType ( Vehicle v_from,
Vehicle v_for 
)

Get the best fitting subtype when 'cloning'/'replacing' v_from with v_for.

Assuming they are going to carry the same cargo ofcourse!

Parameters:
v_from the vehicle to match the subtype from
v_for the vehicle to get the subtype for
Returns:
the best sub type

Definition at line 219 of file vehicle_gui.cpp.

References CALLBACK_FAILED, EngineInfo::callback_mask, Engine::CanCarryCargo(), Vehicle::cargo_subtype, Vehicle::cargo_type, CBID_VEHICLE_CARGO_SUFFIX, CBM_VEHICLE_CARGO_SUFFIX, Vehicle::First(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), GetCargoSubtypeText(), GetVehicleCallback(), HasBit(), and Vehicle::InvalidateNewGRFCache().

Referenced by BuildReplacementVehicle(), and CmdCloneVehicle().

struct 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 1599 of file vehicle.cpp.

References _local_company, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, 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 1509 of file vehicle.cpp.

References AIR_CTOL, Vehicle::cargo_type, CC_PASSENGERS, CT_INVALID, EF_RAIL_IS_MU, EF_ROAD_TRAM, Vehicle::First(), SpecializedVehicle< Train, Type >::From(), CargoSpec::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_engine_pool >::Get(), HasBit(), IsCargoInClass(), RAILVEH_WAGON, UsesWagonOverride(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by FinaliseEngineArray(), and GetEngineLivery().

SpriteID 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 1661 of file vehicle.cpp.

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 1435 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 1337 of file vehicle.cpp.

References Vehicle::direction, GetNewVehiclePosResult::new_tile, GetNewVehiclePosResult::old_tile, Vehicle::tile, 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 
)
SpriteID GetVehiclePalette ( const Vehicle v  ) 

Get the colour map for a vehicle.

Parameters:
v Vehicle to get colour map for
Returns:
A ready-to-use palette modifier

Definition at line 1666 of file vehicle.cpp.

References GroundVehicleCache::first_engine, Vehicle::GetGroundVehicleCache(), Vehicle::IsGroundVehicle(), and Vehicle::owner.

Referenced by DepotWindow::DepotClick(), DoDrawVehicle(), DrawAircraftImage(), DrawRoadVehImage(), DrawShipImage(), DrawTrainDetails(), DrawTrainImage(), and VehicleGroupWindow::OnClick().

void GetVehicleSet ( VehicleSet set,
Vehicle v,
uint8  num_vehicles 
)

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

Parameters:
set Set of affected vehicles.
v First vehicle of the selection.
num_vehicles Number of vehicles in the selection.
Precondition:
set must be empty.
Postcondition:
set will contain the vehicles that will be refitted.

Definition at line 2306 of file vehicle.cpp.

References SpecializedVehicle< Train, Type >::From(), Train::GetFirstEnginePart(), Train::GetNextArticPart(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, Train::IsArticulatedPart(), 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 395 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 336 of file vehicle.cpp.

References VehicleFromPosXY().

static bool IsCompanyBuildableVehicleType ( const BaseVehicle v  )  [inline, static]

Is the given vehicle buildable by a company?

Parameters:
v Vehicle being queried.
Returns:
Vehicle is buildable by a company.

Definition at line 100 of file vehicle_func.h.

References IsCompanyBuildableVehicleType(), and BaseVehicle::type.

static bool IsCompanyBuildableVehicleType ( VehicleType  type  )  [inline, static]
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 1327 of file vehicle.cpp.

References MarkAllViewportsDirty().

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

void ReleaseDisastersTargetingVehicle ( VehicleID  vehicle  ) 

Notify disasters that we are about to delete a vehicle.

So make them head elsewhere.

Parameters:
vehicle deleted vehicle

Definition at line 958 of file disaster_cmd.cpp.

References Vehicle::age, Vehicle::current_order, Vehicle::dest_tile, Order::GetDestination(), RandomTile, Order::SetDestination(), Vehicle::subtype, and Vehicle::z_pos.

Referenced by Vehicle::PreDestructor().

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 201 of file vehicle.cpp.

References _networking, CMD_PAUSE, DC_EXEC, DEBUG, DoCommand(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, 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 450 of file vehicle.cpp.

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

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

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 749 of file vehicle.cpp.

References Vehicle::vehstatus, and VS_STOPPED.

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.

Parameters:
v vehicle to move
update_viewport whether to dirty the viewport

Definition at line 1292 of file vehicle.cpp.

References Vehicle::cur_image, Sprite::height, MarkAllViewportsDirty(), max(), min(), RemapCoords(), ST_NORMAL, Sprite::width, Sprite::x_offs, Vehicle::x_offs, Vehicle::x_pos, Sprite::y_offs, Vehicle::y_offs, Vehicle::y_pos, and Vehicle::z_pos.

Referenced by AfterLoadVehicles(), CmdBuildAircraft(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdBuildRoadVehicle(), CmdBuildShip(), DisasterTick_Helicopter_Rotors(), InitializeDisasterVehicle(), SetAircraftPosition(), and SpecializedVehicle< RoadVehicle, Type >::UpdateViewport().

byte VehicleRandomBits (  ) 

Get a value for a vehicle's random_bits.

Returns:
A random value from 0 to 255.

Definition at line 245 of file vehicle.cpp.

References GB().

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


Generated on Sun Jan 9 16:02:29 2011 for OpenTTD by  doxygen 1.6.1