EffectVehicle Struct Reference

A special vehicle is one of the following: More...

#include <effectvehicle_base.h>

Inheritance diagram for EffectVehicle:

Public Member Functions
	EffectVehicle ()
	We don't want GCC to zero our struct! It already is zeroed and has an index!
virtual	~EffectVehicle ()=default
	We want to 'destruct' the right class.
void	UpdateDeltaXY () override
	Updates the x and y offsets and the size of the sprite used for this vehicle.
bool	Tick () override
	Calls the tick handler of the vehicle.
TransparencyOption	GetTransparencyOption () const
	Determines the transparency option affecting the effect.
Public Member Functions inherited from SpecializedVehicle< EffectVehicle, VEH_EFFECT >
	SpecializedVehicle ()
	Set vehicle type correctly.
EffectVehicle *	First () const
	Get the first vehicle in the chain.
EffectVehicle *	Last ()
	Get the last vehicle in the chain.
const EffectVehicle *	Last () const
	Get the last vehicle in the chain.
EffectVehicle *	Next () const
	Get next vehicle in the chain.
EffectVehicle *	Previous () const
	Get previous vehicle in the chain.
EffectVehicle *	GetNextArticulatedPart ()
	Get the next part of an articulated engine.
EffectVehicle *	GetNextArticulatedPart () const
	Get the next part of an articulated engine.
EffectVehicle *	GetFirstEnginePart ()
	Get the first part of an articulated engine.
const EffectVehicle *	GetFirstEnginePart () const
	Get the first part of an articulated engine.
EffectVehicle *	GetLastEnginePart ()
	Get the last part of an articulated engine.
EffectVehicle *	GetNextVehicle () const
	Get the next real (non-articulated part) vehicle in the consist.
EffectVehicle *	GetPrevVehicle () const
	Get the previous real (non-articulated part) vehicle in the consist.
void	UpdateViewport (bool force_update, bool update_delta)
	Update vehicle sprite- and position caches.
Public Member Functions inherited from Vehicle
virtual uint16_t	GetMaxWeight () const
	Calculates the weight value that this vehicle will have when fully loaded with its current cargo.
	Vehicle (VehicleType type=VEH_INVALID)
	Vehicle constructor.
void	PreDestructor ()
	Destroy all stuff that (still) needs the virtual functions to work properly.
virtual	~Vehicle ()
	We want to 'destruct' the right class.
void	BeginLoading ()
	Prepare everything to begin the loading when arriving at a station.
void	CancelReservation (StationID next, Station *st)
	Return all reserved cargo packets to the station and reset all packets staged for transfer.
void	LeaveStation ()
	Perform all actions when leaving a station.
GroundVehicleCache *	GetGroundVehicleCache ()
	Access the ground vehicle cache of the vehicle.
const GroundVehicleCache *	GetGroundVehicleCache () const
	Access the ground vehicle cache of the vehicle.
uint16_t &	GetGroundVehicleFlags ()
	Access the ground vehicle flags of the vehicle.
const uint16_t &	GetGroundVehicleFlags () const
	Access the ground vehicle flags of the vehicle.
void	DeleteUnreachedImplicitOrders ()
	Delete all implicit orders which were not reached.
void	HandleLoading (bool mode=false)
	Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all other cases.
virtual void	MarkDirty ()
	Marks the vehicles to be redrawn and updates cached variables.
uint	GetOldAdvanceSpeed (uint speed)
	Determines the effective direction-specific vehicle movement speed.
uint	GetAdvanceDistance ()
	Determines the vehicle "progress" needed for moving a step.
virtual ExpensesType	GetExpenseType (bool income) const
	Sets the expense type associated to this vehicle type.
virtual void	PlayLeaveStationSound (bool force=false) const
	Play the sound associated with leaving the station.
virtual bool	IsPrimaryVehicle () const
	Whether this is the primary vehicle in the chain.
const Engine *	GetEngine () const
	Retrieves the engine of the vehicle.
virtual void	GetImage (Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
	Gets the sprite to show for the given direction.
const GRFFile *	GetGRF () const
	Retrieve the NewGRF the vehicle is tied to.
uint32_t	GetGRFID () const
	Retrieve the GRF ID of the NewGRF the vehicle is tied to.
void	InvalidateNewGRFCache ()
	Invalidates cached NewGRF variables.
void	InvalidateNewGRFCacheOfChain ()
	Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle)
debug_inline bool	IsGroundVehicle () const
	Check if the vehicle is a ground vehicle.
virtual int	GetDisplaySpeed () const
	Gets the speed in km-ish/h that can be sent into SetDParam for string processing.
virtual int	GetDisplayMaxSpeed () const
	Gets the maximum speed in km-ish/h that can be sent into SetDParam for string processing.
virtual int	GetCurrentMaxSpeed () const
	Calculates the maximum speed of the vehicle under its current conditions.
virtual Money	GetRunningCost () const
	Gets the running cost of a vehicle.
virtual bool	IsInDepot () const
	Check whether the vehicle is in the depot.
virtual bool	IsChainInDepot () const
	Check whether the whole vehicle chain is in the depot.
bool	IsStoppedInDepot () const
	Check whether the vehicle is in the depot and stopped.
virtual void	OnNewCalendarDay ()
	Calls the new calendar day handler of the vehicle.
virtual void	OnNewEconomyDay ()
	Calls the new economy day handler of the vehicle.
void	ShiftDates (TimerGameEconomy::Date interval)
	Shift all dates by given interval.
virtual uint	Crash (bool flooded=false)
	Crash the (whole) vehicle chain.
virtual Trackdir	GetVehicleTrackdir () const
	Returns the Trackdir on which the vehicle is currently located.
Money	GetDisplayRunningCost () const
	Gets the running cost of a vehicle that can be sent into SetDParam for string processing.
Money	GetDisplayProfitThisYear () const
	Gets the profit vehicle had this year.
Money	GetDisplayProfitLastYear () const
	Gets the profit vehicle had last year.
void	SetNext (Vehicle *next)
	Set the next vehicle of this vehicle.
Vehicle *	Next () const
	Get the next vehicle of this vehicle.
Vehicle *	Previous () const
	Get the previous vehicle of this vehicle.
Vehicle *	First () const
	Get the first vehicle of this vehicle chain.
Vehicle *	Last ()
	Get the last vehicle of this vehicle chain.
const Vehicle *	Last () const
	Get the last vehicle of this vehicle chain.
Vehicle *	Move (int n)
	Get the vehicle at offset n of this vehicle chain.
const Vehicle *	Move (int n) const
	Get the vehicle at offset n of this vehicle chain.
Order *	GetFirstOrder () const
	Get the first order of the vehicles order list.
void	AddToShared (Vehicle *shared_chain)
	Adds this vehicle to a shared vehicle chain.
void	RemoveFromShared ()
	Removes the vehicle from the shared order list.
Vehicle *	NextShared () const
	Get the next vehicle of the shared vehicle chain.
Vehicle *	PreviousShared () const
	Get the previous vehicle of the shared vehicle chain.
Vehicle *	FirstShared () const
	Get the first vehicle of this vehicle chain.
bool	IsOrderListShared () const
	Check if we share our orders with another vehicle.
VehicleOrderID	GetNumOrders () const
	Get the number of orders this vehicle has.
VehicleOrderID	GetNumManualOrders () const
	Get the number of manually added orders this vehicle has.
StationIDStack	GetNextStoppingStation () const
	Get the next station the vehicle will stop at.
void	ResetRefitCaps ()
	Reset all refit_cap in the consist to cargo_cap.
void	ReleaseUnitNumber ()
	Release the vehicle's unit number.
void	CopyVehicleConfigAndStatistics (Vehicle *src)
	Copy certain configurations and statistics of a vehicle after successful autoreplace/renew The function shall copy everything that cannot be copied by a command (like orders / group etc), and that shall not be resetted for the new vehicle.
bool	HandleBreakdown ()
	Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate.
bool	NeedsAutorenewing (const Company *c, bool use_renew_setting=true) const
	Function to tell if a vehicle needs to be autorenewed.
bool	NeedsServicing () const
	Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement.
bool	NeedsAutomaticServicing () const
	Checks if the current order should be interrupted for a service-in-depot order.
virtual TileIndex	GetOrderStationLocation (StationID station)
	Determine the location for the station where the vehicle goes to next.
virtual TileIndex	GetCargoTile () const
virtual ClosestDepot	FindClosestDepot ()
	Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should reverse.
virtual void	SetDestTile (TileIndex tile)
CommandCost	SendToDepot (DoCommandFlag flags, DepotCommand command)
	Send this vehicle to the depot using the given command(s).
void	UpdateVisualEffect (bool allow_power_change=true)
	Update the cached visual effect.
void	ShowVisualEffect () const
	Draw visual effects (smoke and/or sparks) for a vehicle chain.
void	UpdatePosition ()
	Update the position of the vehicle.
void	UpdateViewport (bool dirty)
	Update the vehicle on the viewport, updating the right hash and setting the new coordinates.
void	UpdateBoundingBoxCoordinates (bool update_cache) const
	Update the bounding box co-ordinates of the vehicle.
void	UpdatePositionAndViewport ()
	Update the position of the vehicle, and update the viewport.
bool	MarkAllViewportsDirty () const
	Marks viewports dirty where the vehicle's image is.
uint16_t	GetServiceInterval () const
void	SetServiceInterval (uint16_t interval)
bool	ServiceIntervalIsCustom () const
bool	ServiceIntervalIsPercent () const
void	SetServiceIntervalIsCustom (bool on)
void	SetServiceIntervalIsPercent (bool on)
bool	HasFullLoadOrder () const
	Check if the current vehicle has a full load order.
bool	HasConditionalOrder () const
	Check if the current vehicle has a conditional order.
bool	HasUnbunchingOrder () const
	Check if the current vehicle has an unbunching order.
void	LeaveUnbunchingDepot ()
	Leave an unbunching depot and calculate the next departure time for shared order vehicles.
bool	IsWaitingForUnbunching () const
	Check whether a vehicle inside a depot is waiting for unbunching.
void	IncrementImplicitOrderIndex ()
	Increments cur_implicit_order_index, keeps care of the wrap-around and invalidates the GUI.
void	IncrementRealOrderIndex ()
	Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates the GUI.
void	UpdateRealOrderIndex ()
	Skip implicit orders until cur_real_order_index is a non-implicit order.
Order *	GetOrder (int index) const
	Returns order 'index' of a vehicle or nullptr when it doesn't exists.
Order *	GetLastOrder () const
	Returns the last order of a vehicle, or nullptr if it doesn't exists.
bool	IsEngineCountable () const
	Check if a vehicle is counted in num_engines in each company struct.
bool	HasEngineType () const
	Check whether Vehicle::engine_type has any meaning.
bool	HasDepotOrder () const
	Checks if a vehicle has a depot in its order list.
void	HandlePathfindingResult (bool path_found)
	Handle the pathfinding result, especially the lost status.
debug_inline bool	IsFrontEngine () const
	Check if the vehicle is a front engine.
bool	IsArticulatedPart () const
	Check if the vehicle is an articulated part of an engine.
bool	HasArticulatedPart () const
	Check if an engine has an articulated part.
Vehicle *	GetNextArticulatedPart () const
	Get the next part of an articulated engine.
Vehicle *	GetFirstEnginePart ()
	Get the first part of an articulated engine.
const Vehicle *	GetFirstEnginePart () const
	Get the first part of an articulated engine.
Vehicle *	GetLastEnginePart ()
	Get the last part of an articulated engine.
Vehicle *	GetNextVehicle () const
	Get the next real (non-articulated part) vehicle in the consist.
Vehicle *	GetPrevVehicle () const
	Get the previous real (non-articulated part) vehicle in the consist.
IterateWrapper	Orders () const
	Returns an iterable ensemble of orders of a vehicle.
uint32_t	GetDisplayMaxWeight () const
	Calculates the maximum weight of the ground vehicle when loaded.
uint32_t	GetDisplayMinPowerToWeight () const
	Calculates the minimum power-to-weight ratio using the maximum weight of the ground vehicle.
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
void *	operator new (size_t size)
	Allocates space for new Titem.
void *	operator new (size_t size, size_t index)
	Allocates space for new Titem with given index.
void *	operator new (size_t, void *ptr)
	Allocates space for new Titem at given memory address.
void	operator delete (void *p)
	Marks Titem as free.
Public Member Functions inherited from BaseConsist
void	CopyConsistPropertiesFrom (const BaseConsist *src)
	Copy properties of other BaseConsist.
void	ResetDepotUnbunching ()
	Resets all the data used for depot unbunching.

Data Fields
uint16_t	animation_state
	State primarily used to change the graphics/behaviour.
uint8_t	animation_substate
	Sub state to time the change of the graphics/behaviour.
Data Fields inherited from Vehicle
TileIndex	tile
	Current tile index.
TileIndex	dest_tile
	Heading for this tile.
Money	profit_this_year
	Profit this year << 8, low 8 bits are fract.
Money	profit_last_year
	Profit last year << 8, low 8 bits are fract.
Money	value
	Value of the vehicle.
CargoPayment *	cargo_payment
	The cargo payment we're currently in.
Rect	coord
	NOSAVE: Graphical bounding box of the vehicle, i.e. what to redraw on moves.
Vehicle *	hash_viewport_next
	NOSAVE: Next vehicle in the visual location hash.
Vehicle **	hash_viewport_prev
	NOSAVE: Previous vehicle in the visual location hash.
Vehicle *	hash_tile_next
	NOSAVE: Next vehicle in the tile location hash.
Vehicle **	hash_tile_prev
	NOSAVE: Previous vehicle in the tile location hash.
Vehicle **	hash_tile_current
	NOSAVE: Cache of the current hash chain.
SpriteID	colourmap
	NOSAVE: cached colour mapping.
TimerGameCalendar::Year	build_year
	Year the vehicle has been built.
TimerGameCalendar::Date	age
	Age in calendar days.
TimerGameEconomy::Date	economy_age
	Age in economy days.
TimerGameCalendar::Date	max_age
	Maximum age.
TimerGameEconomy::Date	date_of_last_service
	Last economy date the vehicle had a service at a depot.
TimerGameCalendar::Date	date_of_last_service_newgrf
	Last calendar date the vehicle had a service at a depot, unchanged by the date cheat to protect against unsafe NewGRF behavior.
uint16_t	reliability
	Reliability.
uint16_t	reliability_spd_dec
	Reliability decrease speed.
uint8_t	breakdown_ctr
	Counter for managing breakdown events.
uint8_t	breakdown_delay
	Counter for managing breakdown length.
uint8_t	breakdowns_since_last_service
	Counter for the amount of breakdowns.
uint8_t	breakdown_chance
	Current chance of breakdowns.
int32_t	x_pos
	x coordinate.
int32_t	y_pos
	y coordinate.
int32_t	z_pos
	z coordinate.
Direction	direction
	facing
Owner	owner
	Which company owns the vehicle?
uint8_t	spritenum
	currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == reserved for another custom sprite
uint8_t	x_extent
	x-extent of vehicle bounding box
uint8_t	y_extent
	y-extent of vehicle bounding box
uint8_t	z_extent
	z-extent of vehicle bounding box
int8_t	x_bb_offs
	x offset of vehicle bounding box
int8_t	y_bb_offs
	y offset of vehicle bounding box
int8_t	x_offs
	x offset for vehicle sprite
int8_t	y_offs
	y offset for vehicle sprite
EngineID	engine_type
	The type of engine used for this vehicle.
TextEffectID	fill_percent_te_id
	a text-effect id to a loading indicator object
UnitID	unitnumber
	unit number, for display purposes only
uint16_t	cur_speed
	current speed
uint8_t	subspeed
	fractional speed
uint8_t	acceleration
	used by train & aircraft
uint32_t	motion_counter
	counter to occasionally play a vehicle sound.
uint8_t	progress
	The percentage (if divided by 256) this vehicle already crossed the tile unit.
uint8_t	waiting_triggers
	Triggers to be yet matched before rerandomizing the random bits.
uint16_t	random_bits
	Bits used for randomized variational spritegroups.
StationID	last_station_visited
	The last station we stopped at.
StationID	last_loading_station
	Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
TimerGameTick::TickCounter	last_loading_tick
	Last TimerGameTick::counter tick that the vehicle has stopped at a station and could possibly leave with any cargo loaded.
VehicleCargoList	cargo
	The cargo this vehicle is carrying.
CargoID	cargo_type
	type of cargo this vehicle is carrying
uint8_t	cargo_subtype
	Used for livery refits (NewGRF variations)
uint16_t	cargo_cap
	total capacity
uint16_t	refit_cap
	Capacity left over from before last refit.
uint16_t	cargo_age_counter
	Ticks till cargo is aged next.
int8_t	trip_occupancy
	NOSAVE: Occupancy of vehicle of the current trip (updated after leaving a station).
uint8_t	day_counter
	Increased by one for each day.
uint8_t	tick_counter
	Increased by one for each tick.
uint8_t	running_ticks
	Number of ticks this vehicle was not stopped this day.
uint16_t	load_unload_ticks
	Ticks to wait before starting next cycle.
uint8_t	vehstatus
	Status.
uint8_t	subtype
	subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubtypeFlags)
Order	current_order
	The current order (+ status, like: loading)
union {
OrderList *   orders
	Pointer to the order list for this vehicle. More...
Order *   old_orders
	Only used during conversion of old save games. More...
};
NewGRFCache	grf_cache
	Cache of often used calculated NewGRF values.
VehicleCache	vcache
	Cache of often used vehicle values.
GroupID	group_id
	Index of group Pool array.
MutableSpriteCache	sprite_cache
	Cache of sprites and values related to recalculating them, see MutableSpriteCache.
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
Tindex	index
	Index of this pool item.
Data Fields inherited from BaseVehicle
VehicleType	type
	Type of vehicle.
Data Fields inherited from BaseConsist
std::string	name
	Name of vehicle.
TimerGameTick::Ticks	current_order_time
	How many ticks have passed since this order started.
TimerGameTick::Ticks	lateness_counter
	How many ticks late (or early if negative) this vehicle is.
TimerGameTick::TickCounter	timetable_start
	At what tick of TimerGameTick::counter the vehicle should start its timetable.
TimerGameTick::TickCounter	depot_unbunching_last_departure
	When the vehicle last left its unbunching depot.
TimerGameTick::TickCounter	depot_unbunching_next_departure
	When the vehicle will next try to leave its unbunching depot.
TimerGameTick::Ticks	round_trip_time
	How many ticks for a single circumnavigation of the orders.
uint16_t	service_interval
	The interval for (automatic) servicing; either in days or %.
VehicleOrderID	cur_real_order_index
	The index to the current real (non-implicit) order.
VehicleOrderID	cur_implicit_order_index
	The index to the current implicit order.
uint16_t	vehicle_flags
	Used for gradual loading and other miscellaneous things (.

Additional Inherited Members
Public Types inherited from SpecializedVehicle< EffectVehicle, VEH_EFFECT >
typedef SpecializedVehicle< EffectVehicle, Type >	SpecializedVehicleBase
	Our type.
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >	Pool
	Type of the pool this item is going to be part of.
Static Public Member Functions inherited from SpecializedVehicle< EffectVehicle, VEH_EFFECT >
static bool	IsValidID (size_t index)
	Tests whether given index is a valid index for vehicle of this type.
static EffectVehicle *	Get (size_t index)
	Gets vehicle with given index.
static EffectVehicle *	GetIfValid (size_t index)
	Returns vehicle if the index is a valid index for this vehicle type.
static EffectVehicle *	From (Vehicle *v)
	Converts a Vehicle to SpecializedVehicle with type checking.
static const EffectVehicle *	From (const Vehicle *v)
	Converts a const Vehicle to const SpecializedVehicle with type checking.
static Pool::IterateWrapper< EffectVehicle >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid vehicles of type T.
Static Public Member Functions inherited from Vehicle
static uint	GetAdvanceSpeed (uint speed)
	Determines the effective vehicle movement speed.
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_vehicle_pool >
static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no.
static bool	IsValidID (size_t index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem *	Get (size_t index)
	Returns Titem with given index.
static Titem *	GetIfValid (size_t index)
	Returns Titem with given index.
static size_t	GetPoolSize ()
	Returns first unused index.
static size_t	GetNumItems ()
	Returns number of valid items in the pool.
static void	PostDestructor (size_t index)
	Dummy function called after destructor of each member.
static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem.
Static Public Attributes inherited from SpecializedVehicle< EffectVehicle, VEH_EFFECT >
static const VehicleType	EXPECTED_TYPE
	Specialized type.

Detailed Description

A special vehicle is one of the following:

• smoke
• electric sparks for trains
• explosions
• bulldozer (road works)
• bubbles (industry)

Definition at line 24 of file effectvehicle_base.h.

Constructor & Destructor Documentation

EffectVehicle()

EffectVehicle::EffectVehicle ( )

inline

We don't want GCC to zero our struct! It already is zeroed and has an index!

Definition at line 29 of file effectvehicle_base.h.

Member Function Documentation

GetTransparencyOption()

TransparencyOption EffectVehicle::GetTransparencyOption

(

)

const

Determines the transparency option affecting the effect.

Returns

Transparency option, or TO_INVALID if none.

Definition at line 633 of file effectvehicle.cpp.

References _effect_procs, and Vehicle::subtype.

Referenced by DoDrawVehicle().

Tick()

bool EffectVehicle::Tick ( )

overridevirtual

Calls the tick handler of the vehicle.

Returns

is this vehicle still valid?

Reimplemented from Vehicle.

Definition at line 615 of file effectvehicle.cpp.

References _effect_procs, and Vehicle::subtype.

UpdateDeltaXY()

void EffectVehicle::UpdateDeltaXY ( )

overridevirtual

Updates the x and y offsets and the size of the sprite used for this vehicle.

Reimplemented from Vehicle.

Definition at line 620 of file effectvehicle.cpp.

References Vehicle::x_extent, Vehicle::x_offs, Vehicle::y_extent, Vehicle::y_offs, and Vehicle::z_extent.

Referenced by CreateEffectVehicle().

Field Documentation

animation_state

uint16_t EffectVehicle::animation_state

State primarily used to change the graphics/behaviour.

Definition at line 25 of file effectvehicle_base.h.

Referenced by Vehicle::HandleBreakdown().

animation_substate

uint8_t EffectVehicle::animation_substate

Sub state to time the change of the graphics/behaviour.

Definition at line 26 of file effectvehicle_base.h.

---

The documentation for this struct was generated from the following files:

• src/effectvehicle_base.h
• src/effectvehicle.cpp