#include <Vehicle.h>

Inheritance diagram for Vehicle:

Public Member Functions
	Vehicle (Unit unit, VehicleEntry const vehInfo, uint32 creatureEntry)

	~Vehicle ()

void	Install ()
	Initializes power type for vehicle. Nothing more.

void	Uninstall ()
	Removes all passengers and sets status to STATUS_UNINSTALLING. No new passengers can be added to the vehicle after this call.

void	Reset (bool evading=false)
	Reapplies immunities and reinstalls accessories. Only has effect for creatures.

void	InstallAllAccessories (bool evading)

void	ApplyAllImmunities ()
	Applies specific immunities that cannot be set in DB.

void	InstallAccessory (uint32 entry, int8 seatId, bool minion, uint8 type, uint32 summonTime)
	Installs an accessory.

Unit *	GetBase () const
	May be called from scripts.

VehicleEntry const *	GetVehicleInfo () const

uint32	GetCreatureEntry () const

bool	HasEmptySeat (int8 seatId) const
	Checks if vehicle's seat specified by 'seatId' is empty.

Unit *	GetPassenger (int8 seatId) const
	Gets a passenger on specified seat.

SeatMap::const_iterator	GetNextEmptySeat (int8 seatId, bool next) const
	Gets the next empty seat based on current seat.

VehicleSeatAddon const *	GetSeatAddonForSeatOfPassenger (Unit const *passenger) const
	Gets the vehicle seat addon data for the seat of a passenger.

uint8	GetAvailableSeatCount () const
	Gets the available seat count.

bool	AddPassenger (Unit *passenger, int8 seatId=-1)
	Attempts to add a passenger to the vehicle on 'seatId'.

void	EjectPassenger (Unit passenger, Unit controller)

Vehicle *	RemovePassenger (Unit *passenger)
	Removes the passenger from the vehicle.

void	RelocatePassengers ()
	Relocate passengers. Must be called after m_base::Relocate.

void	RemoveAllPassengers ()
	Removes all current and pending passengers from the vehicle.

bool	IsVehicleInUse () const
	Returns information whether the vehicle is currently used by any unit.

bool	IsControllableVehicle () const

VehicleSeatEntry const *	GetSeatForPassenger (Unit const *passenger) const
	Returns information on the seat of specified passenger, represented by the format in VehicleSeat.dbc.

void	RemovePendingEventsForPassenger (Unit *passenger)

Milliseconds	GetDespawnDelay ()

std::string	GetDebugInfo () const

Trinity::unique_weak_ptr< Vehicle >	GetWeakPtr () const

Public Attributes
SeatMap	Seats
	The collection of all seats on the vehicle. Including vacant ones.

Protected Attributes
uint32	UsableSeatNum
	Number of seats that match VehicleSeatEntry::UsableByPlayer, used for proper display flags.

Private Types
enum	Status { STATUS_NONE , STATUS_INSTALLED , STATUS_UNINSTALLING }

typedef std::list< VehicleJoinEvent * >	PendingJoinEventContainer

Private Member Functions
SeatMap::iterator	GetSeatIteratorForPassenger (Unit *passenger)
	Gets seat iterator for specified passenger.

void	InitMovementInfoForBase ()
	Sets correct MovementFlags2 based on VehicleFlags from DBC.

void	CalculatePassengerPosition (float &x, float &y, float &z, float *o) const override
	This method transforms supplied transport offsets into global coordinates.

void	CalculatePassengerOffset (float &x, float &y, float &z, float *o) const override
	This method transforms supplied global coordinates into local offsets.

void	RemovePendingEvent (VehicleJoinEvent *e)
	Removes @VehicleJoinEvent objects from pending join event store. This method only removes it after it's executed or aborted to prevent leaving pointers to deleted events.

void	RemovePendingEventsForSeat (int8 seatId)
	Removes any pending events for given seatId. Executed when a @VehicleJoinEvent::Execute is called.

bool	HasPendingEventForSeat (int8 seatId) const

Private Attributes
Unit *	_me
	The underlying unit with the vehicle kit. Can be player or creature.

VehicleEntry const *	_vehicleInfo
	DBC data for vehicle.

GuidSet	vehiclePlayers

uint32	_creatureEntry
	Can be different than the entry of _me in case of players.

Status	_status
	Internal variable for sanity checks.

PendingJoinEventContainer	_pendingJoinEvents
	Collection of delayed join events for prospective passengers.

Friends
class	VehicleJoinEvent

Additional Inherited Members
Protected Member Functions inherited from TransportBase
	TransportBase ()

virtual	~TransportBase ()

Static Protected Member Functions inherited from TransportBase
static void	CalculatePassengerPosition (float &x, float &y, float &z, float *o, float transX, float transY, float transZ, float transO)

static void	CalculatePassengerOffset (float &x, float &y, float &z, float *o, float transX, float transY, float transZ, float transO)

Detailed Description

Definition at line 32 of file Vehicle.h.

Member Typedef Documentation

◆ PendingJoinEventContainer

typedef std::list<VehicleJoinEvent*> Vehicle::PendingJoinEventContainer

private

Definition at line 119 of file Vehicle.h.

Member Enumeration Documentation

◆ Status

enum Vehicle::Status

private

Enumerator
STATUS_NONE
STATUS_INSTALLED
STATUS_UNINSTALLING

Definition at line 80 of file Vehicle.h.

Constructor & Destructor Documentation

◆ Vehicle()

Vehicle::Vehicle	(	Unit *	unit,
		VehicleEntry const *	vehInfo,
		uint32	creatureEntry
	)

Definition at line 36 of file Vehicle.cpp.

Here is the call graph for this function:

◆ ~Vehicle()

Vehicle::~Vehicle ( )

@Uninstall must be called before this.

Definition at line 60 of file Vehicle.cpp.

Member Function Documentation

◆ AddPassenger()

bool Vehicle::AddPassenger	(	Unit *	unit,
		int8	seatId = `-1`
	)

Attempts to add a passenger to the vehicle on 'seatId'.

Author: Machiavelli

Date: 17-2-2013

Parameters

unit	The prospective passenger.
seatId	Identifier for the seat. Value of -1 indicates the next available seat.

Returns: true if it succeeds, false if it fails.

@Prevent adding passengers when vehicle is uninstalling. (Bad script in OnUninstall/OnRemovePassenger/PassengerBoarded hook.)

Definition at line 426 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyAllImmunities()

void Vehicle::ApplyAllImmunities ( )

Applies specific immunities that cannot be set in DB.

Author: Machiavelli

Date: 17-2-2013

Definition at line 160 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculatePassengerOffset()

void Vehicle::CalculatePassengerOffset	(	float &	x,
		float &	y,
		float &	z,
		float *	o
	)		const

inlineoverrideprivatevirtual

This method transforms supplied global coordinates into local offsets.

Implements TransportBase.

Definition at line 99 of file Vehicle.h.

Here is the call graph for this function:

◆ CalculatePassengerPosition()

void Vehicle::CalculatePassengerPosition	(	float &	x,
		float &	y,
		float &	z,
		float *	o
	)		const

inlineoverrideprivatevirtual

This method transforms supplied transport offsets into global coordinates.

Implements TransportBase.

Definition at line 91 of file Vehicle.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EjectPassenger()

void Vehicle::EjectPassenger	(	Unit *	passenger,
		Unit *	controller
	)

◆ GetAvailableSeatCount()

uint8 Vehicle::GetAvailableSeatCount ( ) const

Gets the available seat count.

Author: Machiavelli

Date: 17-2-2013

Returns: The available seat count.

Definition at line 689 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBase()

Unit * Vehicle::GetBase ( ) const

inline

May be called from scripts.

Definition at line 45 of file Vehicle.h.

Here is the caller graph for this function:

◆ GetCreatureEntry()

uint32 Vehicle::GetCreatureEntry ( ) const

inline

Definition at line 47 of file Vehicle.h.

Here is the caller graph for this function:

◆ GetDebugInfo()

std::string Vehicle::GetDebugInfo ( ) const

Definition at line 969 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ GetDespawnDelay()

Milliseconds Vehicle::GetDespawnDelay ( )

Definition at line 961 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ GetNextEmptySeat()

SeatMap::const_iterator Vehicle::GetNextEmptySeat	(	int8	seatId,
		bool	next
	)		const

Gets the next empty seat based on current seat.

Author: Machiavelli

Date: 17-2-2013

Parameters

seatId	Identifier for the current seat.
next	true if iterating forward, false means iterating backwards.

Returns: The next empty seat.

Definition at line 319 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPassenger()

Unit * Vehicle::GetPassenger ( int8 seatId ) const

Gets a passenger on specified seat.

Author: Machiavelli

Date: 17-2-2013

Parameters

seatId Seat to look on.

Returns: null if it not found, else pointer to passenger if in world

Definition at line 296 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSeatAddonForSeatOfPassenger()

VehicleSeatAddon const * Vehicle::GetSeatAddonForSeatOfPassenger ( Unit const * passenger ) const

Gets the vehicle seat addon data for the seat of a passenger.

Author: Ovahlord

Date: 28-1-2020

Parameters

passenger Identifier for the current seat user

Returns: The seat addon data for the currently used seat of a passenger

Definition at line 360 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSeatForPassenger()

VehicleSeatEntry const * Vehicle::GetSeatForPassenger ( Unit const * passenger ) const

Returns information on the seat of specified passenger, represented by the format in VehicleSeat.dbc.

Author: Machiavelli

Date: 17-2-2013

Parameters

[in,out] The passenger for which we check the seat info.

Returns: null if passenger not found on vehicle, else the DBC record for the seat.

Definition at line 646 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSeatIteratorForPassenger()

SeatMap::iterator Vehicle::GetSeatIteratorForPassenger ( Unit * passenger )

private

Gets seat iterator for specified passenger.

Author: Machiavelli

Date: 17-2-2013

Parameters

[in,out] passenger Passenger to look up.

Returns: The seat iterator for specified passenger if it's found on the vehicle. Otherwise Seats.end() (invalid iterator).

Definition at line 668 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVehicleInfo()

VehicleEntry const * Vehicle::GetVehicleInfo ( ) const

inline

Definition at line 46 of file Vehicle.h.

Here is the caller graph for this function:

◆ GetWeakPtr()

Trinity::unique_weak_ptr< Vehicle > Vehicle::GetWeakPtr ( ) const

Definition at line 996 of file Vehicle.cpp.

Here is the call graph for this function:

◆ HasEmptySeat()

bool Vehicle::HasEmptySeat ( int8 seatId ) const

Checks if vehicle's seat specified by 'seatId' is empty.

Author: Machiavelli

Date: 17-2-2013

Parameters

seatId Identifier for the seat.

Returns: true if empty seat, false if not.

Definition at line 275 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ HasPendingEventForSeat()

bool Vehicle::HasPendingEventForSeat ( int8 seatId ) const

private

Definition at line 951 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ InitMovementInfoForBase()

void Vehicle::InitMovementInfoForBase ( )

private

Sets correct MovementFlags2 based on VehicleFlags from DBC.

Author: Machiavelli

Date: 17-2-2013

Definition at line 617 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Install()

void Vehicle::Install ( )

Initializes power type for vehicle. Nothing more.

Author: Machiavelli

Date: 17-2-2013

Definition at line 77 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallAccessory()

void Vehicle::InstallAccessory	(	uint32	entry,
		int8	seatId,
		bool	minion,
		uint8	type,
		uint32	summonTime
	)

Installs an accessory.

Author: Machiavelli

Date: 17-2-2013

Parameters

entry	The NPC entry of accessory.
seatId	Identifier for the seat to add the accessory to.
minion	true if accessory considered a 'minion'. Implies that the accessory will despawn when the vehicle despawns. Essentially that it has no life without the vehicle. Their fates are bound.
type	See enum @SummonType.
summonTime	Time after which the minion is despawned in case of a timed despawn @type specified.

@Prevent adding accessories when vehicle is uninstalling. (Bad script in OnUninstall/OnRemovePassenger/PassengerBoarded hook.)

If for some reason adding accessory to vehicle fails it will unsummon in @VehicleJoinEvent::Abort

Definition at line 386 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InstallAllAccessories()

void Vehicle::InstallAllAccessories ( bool evading )

Definition at line 84 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsControllableVehicle()

bool Vehicle::IsControllableVehicle ( ) const

Definition at line 599 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ IsVehicleInUse()

bool Vehicle::IsVehicleInUse ( ) const

Returns information whether the vehicle is currently used by any unit.

Author: Shauren

Date: 26-2-2013

Returns: true if any passenger is boarded on vehicle, false otherwise.

Definition at line 590 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ RelocatePassengers()

void Vehicle::RelocatePassengers ( )

Relocate passengers. Must be called after m_base::Relocate.

Author: Machiavelli

Date: 17-2-2013

Definition at line 554 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveAllPassengers()

void Vehicle::RemoveAllPassengers ( )

Removes all current and pending passengers from the vehicle.

Author: Machiavelli

Date: 17-2-2013

Setting to_Abort to true will cause @VehicleJoinEvent::Abort to be executed on next @Unit::UpdateEvents call This will properly "reset" the pending join process for the passenger.

Update vehicle pointer in every pending join event - Abort may be called after vehicle is deleted

Definition at line 231 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemovePassenger()

Vehicle * Vehicle::RemovePassenger ( Unit * unit )

Removes the passenger from the vehicle.

Author: Machiavelli

Date: 17-2-2013

Parameters

[in,out] unit The passenger to remove.

Definition at line 497 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemovePendingEvent()

void Vehicle::RemovePendingEvent ( VehicleJoinEvent * e )

private

Removes @VehicleJoinEvent objects from pending join event store. This method only removes it after it's executed or aborted to prevent leaving pointers to deleted events.

Author: Shauren

Date: 22-2-2013

Parameters

[in] e The VehicleJoinEvent* to remove from pending event store.

Definition at line 713 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ RemovePendingEventsForPassenger()

void Vehicle::RemovePendingEventsForPassenger ( Unit * passenger )

Definition at line 761 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ RemovePendingEventsForSeat()

void Vehicle::RemovePendingEventsForSeat ( int8 seatId )

private

Removes any pending events for given seatId. Executed when a @VehicleJoinEvent::Execute is called.

Removes any pending events for given passenger. Executed when vehicle control aura is removed while adding passenger is in progress.

Author: Machiavelli

Date: 23-2-2013

Parameters

seatId Identifier for the seat.

Author: Shauren

Date: 13-2-2013

Parameters

passenger Unit that is supposed to enter the vehicle.

Definition at line 736 of file Vehicle.cpp.

Here is the caller graph for this function:

◆ Reset()

void Vehicle::Reset ( bool evading = false )

Reapplies immunities and reinstalls accessories. Only has effect for creatures.

Author: Machiavelli

Date: 17-2-2013

Parameters

evading true if called from CreatureAI::EnterEvadeMode

Definition at line 137 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Uninstall()

void Vehicle::Uninstall ( )

Removes all passengers and sets status to STATUS_UNINSTALLING. No new passengers can be added to the vehicle after this call.

Author: Machiavelli

Date: 17-2-2013

@Prevent recursive uninstall call. (Bad script in OnUninstall/OnRemovePassenger/PassengerBoarded hook.)

Definition at line 108 of file Vehicle.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ VehicleJoinEvent

friend class VehicleJoinEvent

friend

Definition at line 76 of file Vehicle.h.

Member Data Documentation

◆ _creatureEntry

uint32 Vehicle::_creatureEntry

private

Can be different than the entry of _me in case of players.

Definition at line 116 of file Vehicle.h.

◆ _me

Unit* Vehicle::_me

private

The underlying unit with the vehicle kit. Can be player or creature.

Definition at line 112 of file Vehicle.h.

◆ _pendingJoinEvents

PendingJoinEventContainer Vehicle::_pendingJoinEvents

private

Collection of delayed join events for prospective passengers.

Definition at line 120 of file Vehicle.h.

◆ _status

Status Vehicle::_status

private

Internal variable for sanity checks.

Definition at line 117 of file Vehicle.h.

◆ _vehicleInfo

VehicleEntry const* Vehicle::_vehicleInfo

private

DBC data for vehicle.

Definition at line 113 of file Vehicle.h.

◆ Seats

SeatMap Vehicle::Seats

The collection of all seats on the vehicle. Including vacant ones.

Definition at line 63 of file Vehicle.h.

◆ UsableSeatNum

uint32 Vehicle::UsableSeatNum

protected

Number of seats that match VehicleSeatEntry::UsableByPlayer, used for proper display flags.

Definition at line 77 of file Vehicle.h.

◆ vehiclePlayers

GuidSet Vehicle::vehiclePlayers

private

Definition at line 114 of file Vehicle.h.

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

server/game/Entities/Vehicle/Vehicle.h
server/game/Entities/Vehicle/Vehicle.cpp

Public Member Functions

Public Attributes

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PendingJoinEventContainer

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ Vehicle()

◆ ~Vehicle()

Member Function Documentation

◆ AddPassenger()

◆ ApplyAllImmunities()

◆ CalculatePassengerOffset()

◆ CalculatePassengerPosition()

◆ EjectPassenger()

◆ GetAvailableSeatCount()

◆ GetBase()

◆ GetCreatureEntry()

◆ GetDebugInfo()

◆ GetDespawnDelay()

◆ GetNextEmptySeat()

◆ GetPassenger()

◆ GetSeatAddonForSeatOfPassenger()

◆ GetSeatForPassenger()

◆ GetSeatIteratorForPassenger()

◆ GetVehicleInfo()

◆ GetWeakPtr()

◆ HasEmptySeat()

◆ HasPendingEventForSeat()

◆ InitMovementInfoForBase()

◆ Install()

◆ InstallAccessory()

◆ InstallAllAccessories()

◆ IsControllableVehicle()

◆ IsVehicleInUse()

◆ RelocatePassengers()

◆ RemoveAllPassengers()

◆ RemovePassenger()

◆ RemovePendingEvent()

◆ RemovePendingEventsForPassenger()

◆ RemovePendingEventsForSeat()

◆ Reset()

◆ Uninstall()

Friends And Related Symbol Documentation

◆ VehicleJoinEvent

Member Data Documentation

◆ _creatureEntry

◆ _me

◆ _pendingJoinEvents

◆ _status

◆ _vehicleInfo

◆ Seats

◆ UsableSeatNum

◆ vehiclePlayers