Vehicle Class Reference

#include <Vehicle.h>

Public Member Functions
void	Install ()
	Initializes power type for vehicle. Nothing more. More...
void	Uninstall ()
	Removes all passengers and sets status to STATUS_UNINSTALLING. No new passengers can be added to the vehicle after this call. More...
void	Reset (bool evading=false)
	Reapplies immunities and reinstalls accessories. Only has effect for creatures. More...
void	InstallAllAccessories (bool evading)
void	ApplyAllImmunities ()
	Applies specific immunities that cannot be set in DB. More...
void	InstallAccessory (uint32 entry, int8 seatId, bool minion, uint8 type, uint32 summonTime)
	Installs an accessory. More...
Unit *	GetBase () const
	May be called from scripts. More...
VehicleEntry const *	GetVehicleInfo () const
uint32	GetCreatureEntry () const
bool	HasEmptySeat (int8 seatId) const
	Checks if vehicle's seat specified by 'seatId' is empty. More...
Unit *	GetPassenger (int8 seatId) const
	Gets a passenger on specified seat. More...
SeatMap::const_iterator	GetNextEmptySeat (int8 seatId, bool next) const
	Gets the next empty seat based on current seat. More...
uint8	GetAvailableSeatCount () const
	Gets the available seat count. More...
bool	AddPassenger (Unit *passenger, int8 seatId=-1)
	Attempts to add a passenger to the vehicle on 'seatId'. More...
void	EjectPassenger (Unit *passenger, Unit *controller)
Vehicle *	RemovePassenger (Unit *passenger)
	Removes the passenger from the vehicle. More...
void	RelocatePassengers ()
	Relocate passengers. Must be called after m_base::Relocate. More...
void	RemoveAllPassengers ()
	Removes all current and pending passengers from the vehicle. More...
bool	IsVehicleInUse () const
	Returns information whether the vehicle is currently used by any unit. More...
void	SetLastShootPos (Position const &pos)
Position const &	GetLastShootPos () const
VehicleSeatEntry const *	GetSeatForPassenger (Unit const *passenger) const
	Returns information on the seat of specified passenger, represented by the format in VehicleSeat.dbc. More...
void	RemovePendingEventsForPassenger (Unit *passenger)

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

Protected Member Functions
	Vehicle (Unit *unit, VehicleEntry const *vehInfo, uint32 creatureEntry)
	~Vehicle ()
Protected Member Functions inherited from TransportBase
	TransportBase ()
virtual	~TransportBase ()

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

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. More...
void	InitMovementInfoForBase ()
	Sets correct MovementFlags2 based on VehicleFlags from DBC. More...
void	CalculatePassengerPosition (float &x, float &y, float &z, float *o) const override
	This method transforms supplied transport offsets into global coordinates. More...
void	CalculatePassengerOffset (float &x, float &y, float &z, float *o) const override
	This method transforms supplied global coordinates into local offsets. More...
void	RemovePendingEvent (VehicleJoinEvent *e)
	Removes objects from pending join event store. This method only removes it after it's executed or aborted to prevent leaving pointers to deleted events. More...
void	RemovePendingEventsForSeat (int8 seatId)
	Removes any pending events for given seatId. Executed when a ::Execute is called. More...

Private Attributes
Unit *	_me
	The underlying unit with the vehicle kit. Can be player or creature. More...
VehicleEntry const *	_vehicleInfo
	DBC data for vehicle. More...
GuidSet	vehiclePlayers
uint32	_creatureEntry
	Can be different than the entry of _me in case of players. More...
Status	_status
	Internal variable for sanity checks. More...
Position	_lastShootPos
PendingJoinEventContainer	_pendingJoinEvents
	Collection of delayed join events for prospective passengers. More...

Friends
class	VehicleJoinEvent
bool	Unit::CreateVehicleKit (uint32 id, uint32 creatureEntry, bool)
void	Unit::RemoveVehicleKit (bool)

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)

Member Typedef Documentation

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

private

Member Enumeration Documentation

enum Vehicle::Status

private

Enumerator
STATUS_NONE
STATUS_INSTALLED
STATUS_UNINSTALLING

 {
 STATUS_NONE,
 STATUS_INSTALLED,
 STATUS_UNINSTALLING,
 };

Constructor & Destructor Documentation

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

protected

 :
UsableSeatNum(0), _me(unit), _vehicleInfo(vehInfo), _creatureEntry(creatureEntry), _status(STATUS_NONE), _lastShootPos()
{
 for (uint32 i = 0; i < MAX_VEHICLE_SEATS; ++i)
 {
 if (uint32 seatId = _vehicleInfo->SeatID[i])
 if (VehicleSeatEntry const* veSeat = sVehicleSeatStore.LookupEntry(seatId))
 {
 Seats.insert(std::make_pair(i, VehicleSeat(veSeat)));
 if (veSeat->CanEnterOrExit())
 ++UsableSeatNum;
 }
 }

 // Set or remove correct flags based on available seats. Will overwrite db data (if wrong).
 if (UsableSeatNum)
 _me->SetFlag64(UNIT_NPC_FLAGS, (_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));
 else
 _me->RemoveFlag64(UNIT_NPC_FLAGS, (_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));

 InitMovementInfoForBase();
}

Here is the call graph for this function:

Vehicle::~Vehicle ( )

protected

must be called before this.

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

Member Function Documentation

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

[in,out]	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.

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

{
 if (_status == STATUS_UNINSTALLING)
 {
 TC_LOG_ERROR("entities.vehicle", "Passenger %s, Entry: %u, attempting to board %s, Entry: %u during uninstall! SeatId: %d",
 unit->GetGUID().ToString().c_str(), unit->GetEntry(), _me->GetGUID().ToString().c_str(), _me->GetEntry(), (int32)seatId);
 return false;
 }

 TC_LOG_DEBUG("entities.vehicle", "Unit %s scheduling enter vehicle (entry: %u, vehicleId: %u, %s (dbguid: " UI64FMTD ") on seat %d",
 unit->GetName().c_str(), _me->GetEntry(), _vehicleInfo->ID, _me->GetGUID().ToString().c_str(),
 uint64(_me->GetTypeId() == TYPEID_UNIT ? _me->ToCreature()->GetSpawnId() : UI64LIT(0)), (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(0));

 if (seatId < 0) // no specific seat requirement
 {
 for (seat = Seats.begin(); seat != Seats.end(); ++seat)
 if (seat->second.IsEmpty() && (seat->second.SeatInfo->CanEnterOrExit() || seat->second.SeatInfo->IsUsableByOverride()))
 break;

 if (seat == Seats.end()) // no available seat
 {
 e->to_Abort = true;
 return false;
 }

 e->Seat = seat;
 _pendingJoinEvents.push_back(e);
 }
 else
 {
 seat = Seats.find(seatId);
 if (seat == Seats.end())
 {
 e->to_Abort = true;
 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:

void Vehicle::ApplyAllImmunities

(

)

Applies specific immunities that cannot be set in DB.

Author

Machiavelli

Date

17-2-2013

{
 // 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_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;
 default:
 break;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

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

inlineoverrideprivatevirtual

This method transforms supplied global coordinates into local offsets.

Implements TransportBase.

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

Here is the call graph for this function:

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

inlineoverrideprivatevirtual

This method transforms supplied transport offsets into global coordinates.

Implements TransportBase.

 {
 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:

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

uint8 Vehicle::GetAvailableSeatCount

(

)

const

Gets the available seat count.

Author

Machiavelli

Date

17-2-2013

Returns

The available seat count.

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

 return ret;
}

Here is the caller graph for this function:

Unit* Vehicle::GetBase ( ) const

inline

May be called from scripts.

{ return _me; }

Here is the caller graph for this function:

uint32 Vehicle::GetCreatureEntry ( ) const

inline

{ return _creatureEntry; }

Here is the caller graph for this function:

Position const& Vehicle::GetLastShootPos ( ) const

inline

{ return _lastShootPos; }

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.

{
 SeatMap::const_iterator seat = Seats.find(seatId);
 if (seat == Seats.end())
 return seat;

 while (!seat->second.IsEmpty() || (!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 caller graph for this function:

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

{
 SeatMap::const_iterator seat = Seats.find(seatId);
 if (seat == Seats.end())
 return NULL;

 return ObjectAccessor::GetUnit(*GetBase(), seat->second.Passenger.Guid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

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.

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

 return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

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).

{
 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:

VehicleEntry const* Vehicle::GetVehicleInfo ( ) const

inline

{ return _vehicleInfo; }

Here is the caller graph for this function:

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.

{
 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:

void Vehicle::InitMovementInfoForBase ( )

private

Sets correct MovementFlags2 based on VehicleFlags from DBC.

Author

Machiavelli

Date

17-2-2013

{
 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:

void Vehicle::Install

(

)

Initializes power type for vehicle. Nothing more.

Author

Machiavelli

Date

17-2-2013

{
 if (_me->GetTypeId() == TYPEID_UNIT)
 {
 if (PowerDisplayEntry const* powerDisplay = sPowerDisplayStore.LookupEntry(_vehicleInfo->PowerDisplayID[0]))
 _me->setPowerType(Powers(powerDisplay->PowerType));
 else if (_me->getClass() == CLASS_ROGUE)
 _me->setPowerType(POWER_ENERGY);
 }

 _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:

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 .
summonTime	Time after which the minion is despawned in case of a timed despawn specified.

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 ::Abort

{
 if (_status == STATUS_UNINSTALLING)
 {
 TC_LOG_ERROR("entities.vehicle", "Vehicle (%s, Entry: %u) attempts to install accessory (Entry: %u) on seat %d with STATUS_UNINSTALLING! "
 "Check Uninstall/PassengerBoarded script hooks for errors.", _me->GetGUID().ToString().c_str(), GetCreatureEntry(), entry, (int32)seatId);
 return;
 }

 TC_LOG_DEBUG("entities.vehicle", "Vehicle (%s, Entry %u): installing accessory (Entry: %u) on seat: %d",
 _me->GetGUID().ToString().c_str(), GetCreatureEntry(), entry, (int32)seatId);

 TempSummon* accessory = _me->SummonCreature(entry, *_me, TempSummonType(type), summonTime);
 ASSERT(accessory);

 if (minion)
 accessory->AddUnitTypeMask(UNIT_MASK_ACCESSORY);

 (void)_me->HandleSpellClick(accessory, seatId);

}

Here is the call graph for this function:

Here is the caller graph for this function:

void Vehicle::InstallAllAccessories

(

bool

evading

)

{
 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:

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.

{
 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:

void Vehicle::RelocatePassengers

(

)

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

Author

Machiavelli

Date

17-2-2013

{
    ASSERT(_me->GetMap());

    // 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);

            passenger->UpdatePosition(px, py, pz, po);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

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 ::Abort to be executed on next ::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

{
    TC_LOG_DEBUG("entities.vehicle", "Vehicle::RemoveAllPassengers. Entry: %u, %s", _creatureEntry, _me->GetGUID().ToString().c_str());

    {
        Vehicle* eventVehicle = _status != STATUS_UNINSTALLING ? this : NULL;

        while (!_pendingJoinEvents.empty())
        {
            VehicleJoinEvent* e = _pendingJoinEvents.front();
            e->to_Abort = true;
            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);

    // Following the above logic, this assertion should NEVER fail.
    // Even in 'hacky' cases, there should at least be VEHICLE_SPELL_RIDE_HARDCODED on us.
    // SeatMap::const_iterator itr;
    // for (itr = Seats.begin(); itr != Seats.end(); ++itr)
    //    ASSERT(!itr->second.passenger);
}

Here is the call graph for this function:

Here is the caller graph for this function:

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.

{
    if (unit->GetVehicle() != this)
        return NULL;

    SeatMap::iterator seat = GetSeatIteratorForPassenger(unit);
    ASSERT(seat != Seats.end());

    TC_LOG_DEBUG("entities.vehicle", "Unit %s exit vehicle entry %u id %u %s seat %d",
        unit->GetName().c_str(), _me->GetEntry(), _vehicleInfo->ID, _me->GetGUID().ToString().c_str(), (int32)seat->first);

    if (seat->second.SeatInfo->CanEnterOrExit() && ++UsableSeatNum)
        _me->SetFlag64(UNIT_NPC_FLAGS, (_me->GetTypeId() == TYPEID_PLAYER ? UNIT_NPC_FLAG_PLAYER_VEHICLE : UNIT_NPC_FLAG_SPELLCLICK));

    // Remove UNIT_FLAG_NOT_SELECTABLE if passenger did not have it before entering vehicle
    if (seat->second.SeatInfo->Flags & VEHICLE_SEAT_FLAG_PASSENGER_NOT_SELECTABLE && !seat->second.Passenger.IsUnselectable)
        unit->RemoveFlag(UNIT_FIELD_FLAGS, UNIT_FLAG_NOT_SELECTABLE);

    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(NULL);
    return this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Vehicle::RemovePendingEvent ( VehicleJoinEvent *  e )

private

Removes 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.

{
    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:

void Vehicle::RemovePendingEventsForPassenger

(

Unit *

passenger

)

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

Here is the caller graph for this function:

void Vehicle::RemovePendingEventsForSeat ( int8  seatId )

private

Removes any pending events for given seatId. Executed when a ::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.

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

Here is the caller graph for this function:

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

{
    if (GetBase()->GetTypeId() != TYPEID_UNIT)
        return;

    TC_LOG_DEBUG("entities.vehicle", "Vehicle::Reset (Entry: %u, %s, DBGuid: " UI64FMTD ")", GetCreatureEntry(), _me->GetGUID().ToString().c_str(), _me->ToCreature()->GetSpawnId());

    ApplyAllImmunities();
    InstallAllAccessories(evading);

    sScriptMgr->OnReset(this);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Vehicle::SetLastShootPos ( Position const &  pos )

inline

{ _lastShootPos.Relocate(pos); }

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

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

{
    if (_status == STATUS_UNINSTALLING && !GetBase()->HasUnitTypeMask(UNIT_MASK_MINION))
    {
        TC_LOG_ERROR("entities.vehicle", "%s, Entry: %u attempts to uninstall, but already has STATUS_UNINSTALLING! "
            "Check Uninstall/PassengerBoarded script hooks for errors.", _me->GetGUID().ToString().c_str(), _creatureEntry);
        return;
    }

    _status = STATUS_UNINSTALLING;
    TC_LOG_DEBUG("entities.vehicle", "Vehicle::Uninstall Entry: %u, %s", _creatureEntry, _me->GetGUID().ToString().c_str());
    RemoveAllPassengers();

    if (GetBase()->GetTypeId() == TYPEID_UNIT)
        sScriptMgr->OnUninstall(this);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

bool Unit::CreateVehicleKit ( uint32  id, uint32  creatureEntry, bool    )

friend

void Unit::RemoveVehicleKit ( bool  )

friend

friend class VehicleJoinEvent

friend

Member Data Documentation

uint32 Vehicle::_creatureEntry

private

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

Position Vehicle::_lastShootPos

private

Unit* Vehicle::_me

private

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

PendingJoinEventContainer Vehicle::_pendingJoinEvents

private

Collection of delayed join events for prospective passengers.

Status Vehicle::_status

private

Internal variable for sanity checks.

VehicleEntry const* Vehicle::_vehicleInfo

private

DBC data for vehicle.

SeatMap Vehicle::Seats

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

uint32 Vehicle::UsableSeatNum

protected

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

GuidSet Vehicle::vehiclePlayers

private

---

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