Vehicle.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __TRINITY_VEHICLE_H
#define __TRINITY_VEHICLE_H
 
#include "Object.h"
#include "UniqueTrackablePtr.h"
#include "Unit.h"
#include "VehicleDefines.h"
#include <list>
 
struct VehicleEntry;
class Unit;
class VehicleJoinEvent;
 
class TC_GAME_API Vehicle final : public TransportBase
{
 public:
 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();
 void Uninstall();
 void Reset(bool evading = false);
 void InstallAllAccessories(bool evading);
 void ApplyAllImmunities();
 void InstallAccessory(uint32 entry, int8 seatId, bool minion, uint8 type, uint32 summonTime); // May be called from scripts
 
 Unit* GetBase() const { return _me; }
 VehicleEntry const* GetVehicleInfo() const { return _vehicleInfo; }
 uint32 GetCreatureEntry() const { return _creatureEntry; }
 
 bool HasEmptySeat(int8 seatId) const;
 Unit* GetPassenger(int8 seatId) const;
 SeatMap::const_iterator GetNextEmptySeat(int8 seatId, bool next) const;
 VehicleSeatAddon const* GetSeatAddonForSeatOfPassenger(Unit const* passenger) const;
 uint8 GetAvailableSeatCount() const;
 
 bool AddVehiclePassenger(Unit* unit, int8 seatId = -1);
 Vehicle* RemovePassenger(WorldObject* passenger) override;
 void RelocatePassengers();
 void RemoveAllPassengers();
 bool IsVehicleInUse() const;
 bool IsControllableVehicle() const;
 
 SeatMap::iterator GetSeatIteratorForPassenger(Unit* passenger);
 SeatMap Seats; 
 
 VehicleSeatEntry const* GetSeatForPassenger(Unit const* passenger) const;
 
 void RemovePendingEventsForPassenger(Unit* passenger);
 
 Milliseconds GetDespawnDelay();
 
 std::string GetDebugInfo() const;
 
 Trinity::unique_weak_ptr<Vehicle> GetWeakPtr() const;
 
 protected:
 friend class VehicleJoinEvent;
 uint32 UsableSeatNum; 
 
 private:
 enum Status
 {
 STATUS_NONE,
 STATUS_INSTALLED,
 STATUS_UNINSTALLING,
 };
 
 void InitMovementInfoForBase();
 
 ObjectGuid GetTransportGUID() const override { return GetBase()->GetGUID(); }
 
 float GetTransportOrientation() const override { return GetBase()->GetOrientation(); }
 
 void AddPassenger(WorldObject* /*passenger*/) override { ABORT_MSG("Vehicle cannot directly gain passengers without auras"); }
 
 void CalculatePassengerPosition(float& x, float& y, float& z, float* o /*= nullptr*/) const override
 {
 TransportBase::CalculatePassengerPosition(x, y, z, o,
 GetBase()->GetPositionX(), GetBase()->GetPositionY(),
 GetBase()->GetPositionZ(), GetBase()->GetOrientation());
 }
 
 void CalculatePassengerOffset(float& x, float& y, float& z, float* o /*= nullptr*/) const override
 {
 TransportBase::CalculatePassengerOffset(x, y, z, o,
 GetBase()->GetPositionX(), GetBase()->GetPositionY(),
 GetBase()->GetPositionZ(), GetBase()->GetOrientation());
 }
 
 int32 GetMapIdForSpawning() const override { return GetBase()->GetMapId(); }
 
 void RemovePendingEvent(VehicleJoinEvent* e);
 void RemovePendingEventsForSeat(int8 seatId);
 
 bool HasPendingEventForSeat(int8 seatId) const;
 
 private:
 Unit* _me; 
 VehicleEntry const* _vehicleInfo; 
 GuidSet vehiclePlayers;
 
 uint32 _creatureEntry; 
 Status _status; 
 
 typedef std::list<VehicleJoinEvent*> PendingJoinEventContainer;
 PendingJoinEventContainer _pendingJoinEvents; 
};
 
class TC_GAME_API VehicleJoinEvent : public BasicEvent
{
 friend class Vehicle;
 protected:
 VehicleJoinEvent(Vehicle* v, Unit* u) : Target(v), Passenger(u), Seat(Target->Seats.end()) { }
 bool Execute(uint64, uint32) override;
 void Abort(uint64) override;
 
 Vehicle* Target;
 Unit* Passenger;
 SeatMap::iterator Seat;
};
 
#endif