Vehicle Class Reference

#include <Vehicle.h>

Public Member Functions
	Vehicle (Unit *unit, VehicleEntry const *vehInfo, uint32 creatureEntry)
	~Vehicle ()
	Vehicle (Vehicle const &right)=delete
	Vehicle (Vehicle &&right)=delete
Vehicle &	operator= (Vehicle const &right)=delete
Vehicle &	operator= (Vehicle &&right)=delete
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
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	AddVehiclePassenger (Unit *unit, int8 seatId=-1)
Vehicle *	RemovePassenger (WorldObject *passenger) override
	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
SeatMap::iterator	GetSeatIteratorForPassenger (Unit *passenger)
	Gets seat iterator for specified passenger.
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
Public Member Functions inherited from TransportBase
virtual ObjectGuid	GetTransportGUID () const =0
virtual void	CalculatePassengerPosition (float &x, float &y, float &z, float *o=nullptr) const =0
	This method transforms supplied transport offsets into global coordinates.
virtual void	CalculatePassengerOffset (float &x, float &y, float &z, float *o=nullptr) const =0
	This method transforms supplied global coordinates into local offsets.
virtual float	GetTransportOrientation () const =0
virtual void	AddPassenger (WorldObject *passenger)=0
virtual TransportBase *	RemovePassenger (WorldObject *passenger)=0
void	UpdatePassengerPosition (Map *map, WorldObject *passenger, float x, float y, float z, float o, bool setHomePosition)
virtual int32	GetMapIdForSpawning () const =0

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
void	InitMovementInfoForBase ()
	Sets correct MovementFlags2 based on VehicleFlags from DBC.
ObjectGuid	GetTransportGUID () const override
float	GetTransportOrientation () const override
void	AddPassenger (WorldObject *) override
	Attempts to add a passenger to the vehicle on 'seatId'.
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.
int32	GetMapIdForSpawning () const override
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
Static Public 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)
Protected Member Functions inherited from TransportBase
	TransportBase ()
virtual	~TransportBase ()

Detailed Description

Definition at line 30 of file Vehicle.h.

Member Typedef Documentation

PendingJoinEventContainer

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

private

Definition at line 127 of file Vehicle.h.

Member Enumeration Documentation

Status

enum Vehicle::Status

private

Enumerator
STATUS_NONE
STATUS_INSTALLED
STATUS_UNINSTALLING

Definition at line 81 of file Vehicle.h.

 {
 STATUS_NONE,
 STATUS_INSTALLED,
 STATUS_UNINSTALLING,
 };

Constructor & Destructor Documentation

Vehicle() [1/3]

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

Definition at line 36 of file Vehicle.cpp.

 :
UsableSeatNum(0), _me(unit), _vehicleInfo(vehInfo), _creatureEntry(creatureEntry), _status(STATUS_NONE)
{
 for (int8 i = 0; i < MAX_VEHICLE_SEATS; ++i)
 {
 if (uint32 seatId = _vehicleInfo->SeatID[i])
 if (VehicleSeatEntry const* veSeat = sVehicleSeatStore.LookupEntry(seatId))
 {
 VehicleSeatAddon const* addon = sObjectMgr->GetVehicleSeatAddon(seatId);
 Seats.insert(std::make_pair(i, VehicleSeat(veSeat, addon)));
 if (veSeat->CanEnterOrExit())
 ++UsableSeatNum;
 }
 }
 
 // Set or remove correct flags based on available seats. Will overwrite db data (if wrong).
 if (UsableSeatNum)
 _me->SetNpcFlag((_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));
 else
 _me->RemoveNpcFlag((_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));
 
 InitMovementInfoForBase();
}

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.

{
 ASSERT(_status == STATUS_UNINSTALLING);
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); ++itr)
 ASSERT(itr->second.IsEmpty());
}

Vehicle() [2/3]

Vehicle::Vehicle ( Vehicle const &  right )

delete

Vehicle() [3/3]

Vehicle::Vehicle ( Vehicle &&  right )

delete

Member Function Documentation

AddPassenger()

bool Vehicle::AddPassenger ( WorldObject *  )

inlineoverrideprivatevirtual

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.

Implements TransportBase.

Definition at line 94 of file Vehicle.h.

{ ABORT_MSG("Vehicle cannot directly gain passengers without auras"); }

AddVehiclePassenger()

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

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

Definition at line 420 of file Vehicle.cpp.

{
 if (_status == STATUS_UNINSTALLING)
 {
 TC_LOG_ERROR("entities.vehicle", "Passenger {}, attempting to board vehicle {} during uninstall! SeatId: {}",
 unit->GetGUID().ToString(), _me->GetGUID().ToString(), (int32)seatId);
 return false;
 }
 
 TC_LOG_DEBUG("entities.vehicle", "Unit {} scheduling enter vehicle (entry: {}, vehicleId: {}, guid: {} on seat {}",
 unit->GetName(), _me->GetEntry(), _vehicleInfo->ID, _me->GetGUID().ToString(), (int32)seatId);
 
 // The seat selection code may kick other passengers off the vehicle.
 // While the validity of the following may be arguable, it is possible that when such a passenger
 // exits the vehicle will dismiss. That's why the actual adding the passenger to the vehicle is scheduled
 // asynchronously, so it can be cancelled easily in case the vehicle is uninstalled meanwhile.
 SeatMap::iterator seat;
 VehicleJoinEvent* e = new VehicleJoinEvent(this, unit);
 unit->m_Events.AddEvent(e, unit->m_Events.CalculateTime(0s));
 
 if (seatId < 0) // no specific seat requirement
 {
 for (seat = Seats.begin(); seat != Seats.end(); ++seat)
 if (seat->second.IsEmpty() && !HasPendingEventForSeat(seat->first) && (seat->second.SeatInfo->CanEnterOrExit() || seat->second.SeatInfo->IsUsableByOverride()))
 break;
 
 if (seat == Seats.end()) // no available seat
 {
 e->ScheduleAbort();
 return false;
 }
 
 e->Seat = seat;
 _pendingJoinEvents.push_back(e);
 }
 else
 {
 seat = Seats.find(seatId);
 if (seat == Seats.end())
 {
 e->ScheduleAbort();
 return false;
 }
 
 e->Seat = seat;
 _pendingJoinEvents.push_back(e);
 if (!seat->second.IsEmpty())
 {
 Unit* passenger = ObjectAccessor::GetUnit(*GetBase(), seat->second.Passenger.Guid);
 ASSERT(passenger);
 passenger->ExitVehicle();
 }
 
 ASSERT(seat->second.IsEmpty());
 }
 
 return true;
}

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.

{
 // This couldn't be done in DB, because some spells have MECHANIC_NONE
 
 // Vehicles should be immune on Knockback ...
 _me->ApplySpellImmune(0, IMMUNITY_EFFECT, SPELL_EFFECT_KNOCK_BACK, true);
 _me->ApplySpellImmune(0, IMMUNITY_EFFECT, SPELL_EFFECT_KNOCK_BACK_DEST, true);
 
 // Mechanical units & vehicles ( which are not Bosses, they have own immunities in DB ) should be also immune on healing ( exceptions in switch below )
 if (_me->ToCreature() && _me->ToCreature()->GetCreatureTemplate()->type == CREATURE_TYPE_MECHANICAL && !_me->ToCreature()->isWorldBoss())
 {
 // Heal & dispel ...
 _me->ApplySpellImmune(0, IMMUNITY_EFFECT, SPELL_EFFECT_HEAL, true);
 _me->ApplySpellImmune(0, IMMUNITY_EFFECT, SPELL_EFFECT_HEAL_PCT, true);
 _me->ApplySpellImmune(0, IMMUNITY_EFFECT, SPELL_EFFECT_DISPEL, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_PERIODIC_HEAL, true);
 
 // ... Shield & Immunity grant spells ...
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_SCHOOL_IMMUNITY, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_UNATTACKABLE, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_SCHOOL_ABSORB, true);
 _me->ApplySpellImmune(0, IMMUNITY_MECHANIC, MECHANIC_BANISH, true);
 _me->ApplySpellImmune(0, IMMUNITY_MECHANIC, MECHANIC_SHIELD, true);
 _me->ApplySpellImmune(0, IMMUNITY_MECHANIC, MECHANIC_IMMUNE_SHIELD, true);
 
 // ... Resistance, Split damage, Change stats ...
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_DAMAGE_SHIELD, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_SPLIT_DAMAGE_PCT, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_RESISTANCE, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_STAT, true);
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_DAMAGE_PERCENT_TAKEN, true);
 }
 
 // Different immunities for vehicles goes below
 switch (GetVehicleInfo()->ID)
 {
 // code below prevents a bug with movable cannons
 case 160: // Strand of the Ancients
 case 244: // Wintergrasp
 case 510: // Isle of Conquest
 case 452: // Isle of Conquest
 case 543: // Isle of Conquest
 _me->SetControlled(true, UNIT_STATE_ROOT);
 // why we need to apply this? we can simple add immunities to slow mechanic in DB
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_DECREASE_SPEED, true);
 break;
 case 335: // Salvaged Chopper
 case 336: // Salvaged Siege Engine
 case 338: // Salvaged Demolisher
 _me->ApplySpellImmune(0, IMMUNITY_STATE, SPELL_AURA_MOD_DAMAGE_PERCENT_TAKEN, false); // Battering Ram
 break;
 default:
 break;
 }
}

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 105 of file Vehicle.h.

 {
 TransportBase::CalculatePassengerOffset(x, y, z, o,
 GetBase()->GetPositionX(), GetBase()->GetPositionY(),
 GetBase()->GetPositionZ(), GetBase()->GetOrientation());
 }

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 97 of file Vehicle.h.

 {
 TransportBase::CalculatePassengerPosition(x, y, z, o,
 GetBase()->GetPositionX(), GetBase()->GetPositionY(),
 GetBase()->GetPositionZ(), GetBase()->GetOrientation());
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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.

{
 uint8 ret = 0;
 SeatMap::const_iterator itr;
 for (itr = Seats.begin(); itr != Seats.end(); ++itr)
 if (itr->second.IsEmpty() && !HasPendingEventForSeat(itr->first) && (itr->second.SeatInfo->CanEnterOrExit() || itr->second.SeatInfo->IsUsableByOverride()))
 ++ret;
 
 return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetBase()

Unit * Vehicle::GetBase ( ) const

inline

Definition at line 48 of file Vehicle.h.

{ return _me; }

Here is the caller graph for this function:

GetCreatureEntry()

uint32 Vehicle::GetCreatureEntry ( ) const

inline

Definition at line 50 of file Vehicle.h.

{ return _creatureEntry; }

Here is the caller graph for this function:

GetDebugInfo()

std::string Vehicle::GetDebugInfo

(

)

const

Definition at line 967 of file Vehicle.cpp.

{
 std::stringstream sstr;
 sstr << "Vehicle seats:\n";
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); itr++)
 {
 sstr << "seat " << std::to_string(itr->first) << ": " << (itr->second.IsEmpty() ? "empty" : itr->second.Passenger.Guid.ToString()) << "\n";
 }
 
 sstr << "Vehicle pending events:";
 
 if (_pendingJoinEvents.empty())
 {
 sstr << " none";
 }
 else
 {
 sstr << "\n";
 for (PendingJoinEventContainer::const_iterator itr = _pendingJoinEvents.begin(); itr != _pendingJoinEvents.end(); ++itr)
 {
 sstr << "seat " << std::to_string((*itr)->Seat->first) << ": " << (*itr)->Passenger->GetGUID().ToString() << "\n";
 }
 }
 
 return sstr.str();
}

Here is the caller graph for this function:

GetDespawnDelay()

Milliseconds Vehicle::GetDespawnDelay

(

)

Definition at line 959 of file Vehicle.cpp.

{
 if (VehicleTemplate const* vehicleTemplate = sObjectMgr->GetVehicleTemplate(this))
 return vehicleTemplate->DespawnDelay;
 
 return 1ms;
}

Here is the caller graph for this function:

GetMapIdForSpawning()

int32 Vehicle::GetMapIdForSpawning ( ) const

inlineoverrideprivatevirtual

Implements TransportBase.

Definition at line 112 of file Vehicle.h.

{ return GetBase()->GetMapId(); }

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 313 of file Vehicle.cpp.

{
 SeatMap::const_iterator seat = Seats.find(seatId);
 if (seat == Seats.end())
 return seat;
 
 while (!seat->second.IsEmpty() || HasPendingEventForSeat(seat->first) || (!seat->second.SeatInfo->CanEnterOrExit() && !seat->second.SeatInfo->IsUsableByOverride()))
 {
 if (next)
 {
 if (++seat == Seats.end())
 seat = Seats.begin();
 }
 else
 {
 if (seat == Seats.begin())
 seat = Seats.end();
 --seat;
 }
 
 // Make sure we don't loop indefinetly
 if (seat->first == seatId)
 return Seats.end();
 }
 
 return seat;
}

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 290 of file Vehicle.cpp.

{
 SeatMap::const_iterator seat = Seats.find(seatId);
 if (seat == Seats.end())
 return nullptr;
 
 return ObjectAccessor::GetUnit(*GetBase(), seat->second.Passenger.Guid);
}

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 354 of file Vehicle.cpp.

{
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); itr++)
 if (!itr->second.IsEmpty() && itr->second.Passenger.Guid == passenger->GetGUID())
 return itr->second.SeatAddon;
 
 return nullptr;
}

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.

{
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); ++itr)
 if (itr->second.Passenger.Guid == passenger->GetGUID())
 return itr->second.SeatInfo;
 
 return nullptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetSeatIteratorForPassenger()

SeatMap::iterator Vehicle::GetSeatIteratorForPassenger

(

Unit *

passenger

)

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.

{
 SeatMap::iterator itr;
 for (itr = Seats.begin(); itr != Seats.end(); ++itr)
 if (itr->second.Passenger.Guid == passenger->GetGUID())
 return itr;
 
 return Seats.end();
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetTransportGUID()

ObjectGuid Vehicle::GetTransportGUID ( ) const

inlineoverrideprivatevirtual

Implements TransportBase.

Definition at line 90 of file Vehicle.h.

{ return GetBase()->GetGUID(); }

GetTransportOrientation()

float Vehicle::GetTransportOrientation ( ) const

inlineoverrideprivatevirtual

Implements TransportBase.

Definition at line 92 of file Vehicle.h.

{ return GetBase()->GetOrientation(); }

GetVehicleInfo()

VehicleEntry const * Vehicle::GetVehicleInfo ( ) const

inline

Definition at line 49 of file Vehicle.h.

{ return _vehicleInfo; }

Here is the caller 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 269 of file Vehicle.cpp.

{
 SeatMap::const_iterator seat = Seats.find(seatId);
 if (seat == Seats.end())
 return false;
 return seat->second.IsEmpty();
}

Here is the caller graph for this function:

HasPendingEventForSeat()

bool Vehicle::HasPendingEventForSeat ( int8  seatId ) const

private

Definition at line 949 of file Vehicle.cpp.

{
 for (PendingJoinEventContainer::const_iterator itr = _pendingJoinEvents.begin(); itr != _pendingJoinEvents.end(); ++itr)
 {
 if ((*itr)->Seat->first == seatId)
 return true;
 }
 return false;
}

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.

{
 uint32 vehicleFlags = GetVehicleInfo()->Flags;
 
 if (vehicleFlags & VEHICLE_FLAG_NO_STRAFE)
 _me->AddExtraUnitMovementFlag(MOVEMENTFLAG2_NO_STRAFE);
 if (vehicleFlags & VEHICLE_FLAG_NO_JUMPING)
 _me->AddExtraUnitMovementFlag(MOVEMENTFLAG2_NO_JUMPING);
 if (vehicleFlags & VEHICLE_FLAG_FULLSPEEDTURNING)
 _me->AddExtraUnitMovementFlag(MOVEMENTFLAG2_FULL_SPEED_TURNING);
 if (vehicleFlags & VEHICLE_FLAG_ALLOW_PITCHING)
 _me->AddExtraUnitMovementFlag(MOVEMENTFLAG2_ALWAYS_ALLOW_PITCHING);
 if (vehicleFlags & VEHICLE_FLAG_FULLSPEEDPITCHING)
 _me->AddExtraUnitMovementFlag(MOVEMENTFLAG2_FULL_SPEED_PITCHING);
}

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.

{
 _status = STATUS_INSTALLED;
 if (GetBase()->GetTypeId() == TYPEID_UNIT)
 sScriptMgr->OnInstall(this);
}

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

{
 if (_status == STATUS_UNINSTALLING)
 {
 TC_LOG_ERROR("entities.vehicle", "Vehicle ({}, Entry: {}) attempts to install accessory (Entry: {}) on seat {} with STATUS_UNINSTALLING! "
 "Check Uninstall/PassengerBoarded script hooks for errors.", _me->GetGUID().ToString(),
 GetCreatureEntry(), entry, (int32)seatId);
 return;
 }
 
 TC_LOG_DEBUG("entities.vehicle", "Vehicle ({}, Entry {}): installing accessory (Entry: {}) on seat: {}",
 _me->GetGUID().ToString(), GetCreatureEntry(), entry, (int32)seatId);
 
 TempSummon* accessory = _me->SummonCreature(entry, *_me, TempSummonType(type), Milliseconds(summonTime));
 ASSERT(accessory);
 
 if (minion)
 accessory->AddUnitTypeMask(UNIT_MASK_ACCESSORY);
 
 _me->HandleSpellClick(accessory, seatId);
 
}

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.

{
 if (GetBase()->GetTypeId() == TYPEID_PLAYER || !evading)
 RemoveAllPassengers(); // We might have aura's saved in the DB with now invalid casters - remove
 
 VehicleAccessoryList const* accessories = sObjectMgr->GetVehicleAccessoryList(this);
 if (!accessories)
 return;
 
 for (VehicleAccessoryList::const_iterator itr = accessories->begin(); itr != accessories->end(); ++itr)
 if (!evading || itr->IsMinion) // only install minions on evade mode
 InstallAccessory(itr->AccessoryEntry, itr->SeatId, itr->IsMinion, itr->SummonedType, itr->SummonTime);
}

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.

{
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); ++itr)
 if (itr->second.SeatInfo->HasFlag(VEHICLE_SEAT_FLAG_CAN_CONTROL))
 return true;
 
 return false;
}

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.

{
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); ++itr)
 if (!itr->second.IsEmpty())
 return true;
 
 return false;
}

Here is the caller graph for this function:

operator=() [1/2]

Vehicle & Vehicle::operator= ( Vehicle &&  right )

delete

operator=() [2/2]

Vehicle & Vehicle::operator= ( Vehicle const &  right )

delete

RelocatePassengers()

void Vehicle::RelocatePassengers

(

)

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

Author

Machiavelli

Date

17-2-2013

Definition at line 553 of file Vehicle.cpp.

{
 ASSERT(_me->GetMap());
 
 std::vector<std::pair<Unit*, Position>> seatRelocation;
 seatRelocation.reserve(Seats.size());
 
 // not sure that absolute position calculation is correct, it must depend on vehicle pitch angle
 for (SeatMap::const_iterator itr = Seats.begin(); itr != Seats.end(); ++itr)
 {
 if (Unit* passenger = ObjectAccessor::GetUnit(*GetBase(), itr->second.Passenger.Guid))
 {
 ASSERT(passenger->IsInWorld());
 
 float px, py, pz, po;
 passenger->m_movementInfo.transport.pos.GetPosition(px, py, pz, po);
 CalculatePassengerPosition(px, py, pz, &po);
 
 seatRelocation.emplace_back(passenger, Position(px, py, pz, po));
 }
 }
 
 for (auto const& [passenger, position] : seatRelocation)
 UpdatePassengerPosition(_me->GetMap(), passenger, position.GetPositionX(), position.GetPositionY(), position.GetPositionZ(), position.GetOrientation(), false);
}

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 225 of file Vehicle.cpp.

{
 TC_LOG_DEBUG("entities.vehicle", "Vehicle::RemoveAllPassengers. Entry: {}, {}", _creatureEntry, _me->GetGUID().ToString());
 
 {
 Vehicle* eventVehicle = _status != STATUS_UNINSTALLING ? this : nullptr;
 
 while (!_pendingJoinEvents.empty())
 {
 VehicleJoinEvent* e = _pendingJoinEvents.front();
 e->ScheduleAbort();
 e->Target = eventVehicle;
 _pendingJoinEvents.pop_front();
 }
 }
 
 // Passengers always cast an aura with SPELL_AURA_CONTROL_VEHICLE on the vehicle
 // We just remove the aura and the unapply handler will make the target leave the vehicle.
 // We don't need to iterate over Seats
 _me->RemoveAurasByType(SPELL_AURA_CONTROL_VEHICLE);
 
 // Aura script might cause the vehicle to be despawned in the middle of handling SPELL_AURA_CONTROL_VEHICLE removal
 // In that case, aura effect has already been unregistered but passenger may still be found in Seats
 for (auto const& [_, seat] : Seats)
 if (Unit* passenger = ObjectAccessor::GetUnit(*_me, seat.Passenger.Guid))
 passenger->_ExitVehicle();
}

Here is the call graph for this function:

Here is the caller graph for this function:

RemovePassenger()

Vehicle * Vehicle::RemovePassenger ( WorldObject *  passenger )

overridevirtual

Removes the passenger from the vehicle.

Author

Machiavelli

Date

17-2-2013

Parameters

[in,out]

unit

The passenger to remove.

Implements TransportBase.

Definition at line 491 of file Vehicle.cpp.

{
 Unit* unit = passenger->ToUnit();
 if (!unit)
 return nullptr;
 
 if (unit->GetVehicle() != this)
 return nullptr;
 
 SeatMap::iterator seat = GetSeatIteratorForPassenger(unit);
 ASSERT(seat != Seats.end());
 
 TC_LOG_DEBUG("entities.vehicle", "Unit {} exit vehicle entry {} id {} guid {} seat {}",
 unit->GetName(), _me->GetEntry(), _vehicleInfo->ID, _me->GetGUID().ToString(), (int32)seat->first);
 
 if (seat->second.SeatInfo->CanEnterOrExit() && ++UsableSeatNum)
 _me->SetNpcFlag((_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));
 
 // Enable gravity for passenger when he did not have it active before entering the vehicle
 if (seat->second.SeatInfo->Flags & VEHICLE_SEAT_FLAG_DISABLE_GRAVITY && !seat->second.Passenger.IsGravityDisabled)
 unit->SetDisableGravity(false);
 
 // Remove UNIT_FLAG_UNINTERACTIBLE if passenger did not have it before entering vehicle
 if (seat->second.SeatInfo->Flags & VEHICLE_SEAT_FLAG_PASSENGER_NOT_SELECTABLE && !seat->second.Passenger.IsUninteractible)
 unit->SetUninteractible(false);
 
 seat->second.Passenger.Reset();
 
 if (_me->GetTypeId() == TYPEID_UNIT && unit->GetTypeId() == TYPEID_PLAYER && seat->second.SeatInfo->Flags & VEHICLE_SEAT_FLAG_CAN_CONTROL)
 _me->RemoveCharmedBy(unit);
 
 if (_me->IsInWorld())
 {
 if (!_me->GetTransport())
 unit->m_movementInfo.ResetTransport();
 else
 unit->m_movementInfo.transport = _me->m_movementInfo.transport;
 }
 
 // only for flyable vehicles
 if (unit->IsFlying())
 _me->CastSpell(unit, VEHICLE_SPELL_PARACHUTE, true);
 
 if (_me->GetTypeId() == TYPEID_UNIT && _me->ToCreature()->IsAIEnabled())
 _me->ToCreature()->AI()->PassengerBoarded(unit, seat->first, false);
 
 if (GetBase()->GetTypeId() == TYPEID_UNIT)
 sScriptMgr->OnRemovePassenger(this, unit);
 
 unit->SetVehicle(nullptr);
 return this;
}

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.

{
 for (PendingJoinEventContainer::iterator itr = _pendingJoinEvents.begin(); itr != _pendingJoinEvents.end(); ++itr)
 {
 if (*itr == e)
 {
 _pendingJoinEvents.erase(itr);
 break;
 }
 }
}

Here is the caller graph for this function:

RemovePendingEventsForPassenger()

void Vehicle::RemovePendingEventsForPassenger

(

Unit *

passenger

)

Definition at line 761 of file Vehicle.cpp.

{
 for (PendingJoinEventContainer::iterator itr = _pendingJoinEvents.begin(); itr != _pendingJoinEvents.end();)
 {
 if ((*itr)->Passenger == passenger)
 {
 (*itr)->ScheduleAbort();
 _pendingJoinEvents.erase(itr++);
 }
 else
 ++itr;
 }
}

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.

{
 for (PendingJoinEventContainer::iterator itr = _pendingJoinEvents.begin(); itr != _pendingJoinEvents.end();)
 {
 if ((*itr)->Seat->first == seatId)
 {
 (*itr)->ScheduleAbort();
 _pendingJoinEvents.erase(itr++);
 }
 else
 ++itr;
 }
}

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.

{
 if (GetBase()->GetTypeId() != TYPEID_UNIT)
 return;
 
 TC_LOG_DEBUG("entities.vehicle", "Vehicle::Reset (Entry: {}, {}, DBGuid: {})", GetCreatureEntry(), _me->GetGUID().ToString(), _me->ToCreature()->GetSpawnId());
 
 ApplyAllImmunities();
 if (GetBase()->IsAlive())
 InstallAllAccessories(evading);
 
 sScriptMgr->OnReset(this);
}

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.

{
 if (_status == STATUS_UNINSTALLING && !GetBase()->HasUnitTypeMask(UNIT_MASK_MINION))
 {
 TC_LOG_ERROR("entities.vehicle", "Vehicle {} Entry: {} attempts to uninstall, but already has STATUS_UNINSTALLING! "
 "Check Uninstall/PassengerBoarded script hooks for errors.", _me->GetGUID().ToString(), _creatureEntry);
 return;
 }
 
 _status = STATUS_UNINSTALLING;
 TC_LOG_DEBUG("entities.vehicle", "Vehicle::Uninstall Entry: {}, {}", _creatureEntry, _me->GetGUID().ToString());
 RemoveAllPassengers();
 
 if (GetBase()->GetTypeId() == TYPEID_UNIT)
 sScriptMgr->OnUninstall(this);
}

Here is the call graph for this function:

Friends And Related Function Documentation

VehicleJoinEvent

friend class VehicleJoinEvent

friend

Definition at line 77 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 124 of file Vehicle.h.

_me

Unit* Vehicle::_me

private

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

Definition at line 120 of file Vehicle.h.

_pendingJoinEvents

PendingJoinEventContainer Vehicle::_pendingJoinEvents

private

Collection of delayed join events for prospective passengers.

Definition at line 128 of file Vehicle.h.

_status

Status Vehicle::_status

private

Internal variable for sanity checks.

Definition at line 125 of file Vehicle.h.

_vehicleInfo

VehicleEntry const* Vehicle::_vehicleInfo

private

DBC data for vehicle.

Definition at line 121 of file Vehicle.h.

Seats

SeatMap Vehicle::Seats

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

Definition at line 66 of file Vehicle.h.

UsableSeatNum

uint32 Vehicle::UsableSeatNum

protected

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

Definition at line 78 of file Vehicle.h.

vehiclePlayers

GuidSet Vehicle::vehiclePlayers

private

Definition at line 122 of file Vehicle.h.

---

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

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