vehicles.hpp

/*
 *  This Source Code Form is subject to the terms of the Mozilla Public License,
 *  v. 2.0. If a copy of the MPL was not distributed with this file, You can
 *  obtain one at http://mozilla.org/MPL/2.0/.
 *
 *  The original code is copyright (c) 2022, open.mp team and contributors.
 */

#pragma once

#include <chrono>
#include <list>
#include <sdk.hpp>

struct IPlayer;

struct VehicleSpawnData
{
	Seconds respawnDelay;
	int modelID;
	Vector3 position;
	float zRotation;
	int colour1;
	int colour2;
	bool siren;
	int interior;
};

struct UnoccupiedVehicleUpdate
{
	uint8_t seat;
	Vector3 position;
	Vector3 velocity;
};

enum VehicleSCMEvent : uint32_t
{
	VehicleSCMEvent_SetPaintjob = 1,
	VehicleSCMEvent_AddComponent,
	VehicleSCMEvent_SetColour,
	VehicleSCMEvent_EnterExitModShop
};

struct VehicleModelInfo
{
	Vector3 Size;
	Vector3 FrontSeat;
	Vector3 RearSeat;
	Vector3 PetrolCap;
	Vector3 FrontWheel;
	Vector3 RearWheel;
	Vector3 MidWheel;
	float FrontBumperZ;
	float RearBumperZ;
};

enum VehicleComponentSlot
{
	VehicleComponent_None = -1,
	VehicleComponent_Spoiler = 0,
	VehicleComponent_Hood = 1,
	VehicleComponent_Roof = 2,
	VehicleComponent_SideSkirt = 3,
	VehicleComponent_Lamps = 4,
	VehicleComponent_Nitro = 5,
	VehicleComponent_Exhaust = 6,
	VehicleComponent_Wheels = 7,
	VehicleComponent_Stereo = 8,
	VehicleComponent_Hydraulics = 9,
	VehicleComponent_FrontBumper = 10,
	VehicleComponent_RearBumper = 11,
	VehicleComponent_VentRight = 12,
	VehicleComponent_VentLeft = 13,
	VehicleComponent_FrontBullbar = 14,
	VehicleComponent_RearBullbar = 15,
};

enum VehicleVelocitySetType : uint8_t
{
	VehicleVelocitySet_Normal = 0,
	VehicleVelocitySet_Angular
};

enum VehicleModelInfoType
{
	VehicleModelInfo_Size = 1,
	VehicleModelInfo_FrontSeat,
	VehicleModelInfo_RearSeat,
	VehicleModelInfo_PetrolCap,
	VehicleModelInfo_WheelsFront,
	VehicleModelInfo_WheelsRear,
	VehicleModelInfo_WheelsMid,
	VehicleModelInfo_FrontBumperZ,
	VehicleModelInfo_RearBumperZ
};

struct VehicleParams
{
	int8_t engine = -1;
	int8_t lights = -1;
	int8_t alarm = -1;
	int8_t doors = -1;
	int8_t bonnet = -1;
	int8_t boot = -1;
	int8_t objective = -1;
	int8_t siren = -1;
	int8_t doorDriver = -1;
	int8_t doorPassenger = -1;
	int8_t doorBackLeft = -1;
	int8_t doorBackRight = -1;
	int8_t windowDriver = -1;
	int8_t windowPassenger = -1;
	int8_t windowBackLeft = -1;
	int8_t windowBackRight = -1;

	bool isSet()
	{
		return engine != -1 || lights != -1 || alarm != -1 || doors != -1 || bonnet != -1 || boot != -1 || objective != -1 || siren != -1 || doorDriver != -1
			|| doorPassenger != -1 || doorBackLeft != -1 || doorBackRight != -1 || windowDriver != -1 || windowPassenger != -1 || windowBackLeft != -1 || windowBackRight != -1;
	}

	void setZero()
	{
		engine = 0;
		lights = 0;
		alarm = 0;
		doors = 0;
		bonnet = 0;
		boot = 0;
		objective = 0;
		siren = 0;
		doorDriver = 0;
		doorPassenger = 0;
		doorBackLeft = 0;
		doorBackRight = 0;
		windowDriver = 0;
		windowPassenger = 0;
		windowBackLeft = 0;
		windowBackRight = 0;
	}
};

struct VehicleDriverSyncPacket
{
	int PlayerID;
	uint16_t VehicleID;
	uint16_t LeftRight;
	uint16_t UpDown;
	uint16_t Keys;
	GTAQuat Rotation;
	Vector3 Position;
	Vector3 Velocity;
	float Health;
	Vector2 PlayerHealthArmour;
	uint8_t Siren;
	uint8_t LandingGear;
	uint16_t TrailerID;
	bool HasTrailer;

	union
	{
		uint8_t AdditionalKeyWeapon;
		struct
		{
			uint8_t WeaponID : 6;
			uint8_t AdditionalKey : 2;
		};
	};

	union
	{
		uint32_t HydraThrustAngle;
		float TrainSpeed;
	};
};

struct VehiclePassengerSyncPacket
{
	int PlayerID;
	int VehicleID;

	union
	{
		uint16_t DriveBySeatAdditionalKeyWeapon;
		struct
		{
			uint8_t SeatID : 6;
			uint8_t DriveBy : 1;
			uint8_t Cuffed : 1;
			uint8_t WeaponID : 6;
			uint8_t AdditionalKey : 2;
		};
	};
	uint16_t Keys;

	Vector2 HealthArmour;
	uint16_t LeftRight;
	uint16_t UpDown;
	Vector3 Position;
};

struct VehicleUnoccupiedSyncPacket
{
	int VehicleID;
	int PlayerID;
	uint8_t SeatID;
	Vector3 Roll;
	Vector3 Rotation;
	Vector3 Position;
	Vector3 Velocity;
	Vector3 AngularVelocity;
	float Health;
};

struct VehicleTrailerSyncPacket
{
	int VehicleID;
	int PlayerID;
	Vector3 Position;
	Vector4 Quat;
	Vector3 Velocity;
	Vector3 TurnVelocity;
};

/// A vehicle interface
struct IVehicle : public IExtensible, public IEntity
{

	/// Set the inital spawn data of the vehicle
	virtual void setSpawnData(const VehicleSpawnData& data) = 0;

	/// Get the initial spawn data of the vehicle
	virtual const VehicleSpawnData& getSpawnData() = 0;

	/// Checks if player has the vehicle streamed in for themselves
	virtual bool isStreamedInForPlayer(const IPlayer& player) const = 0;

	/// Streams in the vehicle for a specific player
	virtual void streamInForPlayer(IPlayer& player) = 0;

	/// Streams out the vehicle for a specific player
	virtual void streamOutForPlayer(IPlayer& player) = 0;

	/// Set the vehicle's colour
	virtual void setColour(int col1, int col2) = 0;

	/// Get the vehicle's colour
	virtual Pair<int, int> getColour() const = 0;

	/// Set the vehicle's health
	virtual void setHealth(float Health) = 0;

	/// Get the vehicle's health
	virtual float getHealth() = 0;

	/// Update the vehicle from a sync packet
	virtual bool updateFromDriverSync(const VehicleDriverSyncPacket& vehicleSync, IPlayer& player) = 0;

	/// Update the vehicle from a passenger sync packet
	virtual bool updateFromPassengerSync(const VehiclePassengerSyncPacket& passengerSync, IPlayer& player) = 0;

	/// Update the vehicle from an unoccupied sync packet
	virtual bool updateFromUnoccupied(const VehicleUnoccupiedSyncPacket& unoccupiedSync, IPlayer& player) = 0;

	/// Update the vehicle from a trailer sync packet
	virtual bool updateFromTrailerSync(const VehicleTrailerSyncPacket& unoccupiedSync, IPlayer& player) = 0;

	/// Get the players which the vehicle is streamed for
	virtual const FlatPtrHashSet<IPlayer>& streamedForPlayers() const = 0;

	/// Returns the current driver of the vehicle
	virtual IPlayer* getDriver() = 0;

	/// Returns the passengers of the vehicle
	virtual const FlatHashSet<IPlayer*>& getPassengers() = 0;

	/// Sets the vehicle's number plate
	virtual void setPlate(StringView plate) = 0;

	/// Get the vehicle's number plate
	virtual const StringView getPlate() = 0;

	/// Sets the vehicle's damage status
	virtual void setDamageStatus(int PanelStatus, int DoorStatus, uint8_t LightStatus, uint8_t TyreStatus, IPlayer* vehicleUpdater = nullptr) = 0;

	/// Gets the vehicle's damage status
	virtual void getDamageStatus(int& PanelStatus, int& DoorStatus, int& LightStatus, int& TyreStatus) = 0;

	/// Sets the vehicle's paintjob
	virtual void setPaintJob(int paintjob) = 0;

	/// Gets the vehicle's paintjob
	virtual int getPaintJob() = 0;

	/// Adds a component to the vehicle.
	virtual void addComponent(int component) = 0;

	/// Gets the vehicle's component in a designated slot
	virtual int getComponentInSlot(int slot) = 0;

	/// Removes a vehicle's component.
	virtual void removeComponent(int component) = 0;

	/// Puts the player inside this vehicle.
	virtual void putPlayer(IPlayer& player, int SeatID) = 0;

	/// Set the vehicle's Z angle.
	virtual void setZAngle(float angle) = 0;

	/// Gets the vehicle's Z angle.
	virtual float getZAngle() = 0;

	// Set the vehicle's parameters.
	virtual void setParams(const VehicleParams& params) = 0;

	// Set the vehicle's parameters for a specific player.
	virtual void setParamsForPlayer(IPlayer& player, const VehicleParams& params) = 0;

	// Get the vehicle's parameters.
	virtual VehicleParams const& getParams() = 0;

	/// Checks if the vehicle is dead.
	virtual bool isDead() = 0;

	/// Respawns the vehicle.
	virtual void respawn() = 0;

	/// Get the vehicle's respawn delay.
	virtual Seconds getRespawnDelay() = 0;

	/// Set the vehicle respawn delay.
	virtual void setRespawnDelay(Seconds delay) = 0;

	/// Checks if the vehicle is respawning.
	virtual bool isRespawning() = 0;

	// Sets (links) the vehicle to an interior.
	virtual void setInterior(int InteriorID) = 0;

	// Gets the vehicle's interior.
	virtual int getInterior() = 0;

	/// Attaches a vehicle as a trailer to this vehicle.
	virtual void attachTrailer(IVehicle& trailer) = 0;

	/// Detaches a vehicle from this vehicle.
	virtual void detachTrailer() = 0;

	/// Checks if the current vehicle is a trailer.
	virtual bool isTrailer() const = 0;

	/// Get the current vehicle's attached trailer.
	virtual IVehicle* getTrailer() const = 0;

	/// Get the current vehicle's cab.
	virtual IVehicle* getCab() const = 0;

	/// Fully repair the vehicle.
	virtual void repair() = 0;

	/// Adds a train carriage to the vehicle (ONLY FOR TRAINS).
	virtual void addCarriage(IVehicle* carriage, int pos) = 0;
	virtual void updateCarriage(Vector3 pos, Vector3 veloc) = 0;
	virtual const StaticArray<IVehicle*, MAX_VEHICLE_CARRIAGES>& getCarriages() = 0;

	/// Sets the velocity of the vehicle.
	virtual void setVelocity(Vector3 velocity) = 0;

	/// Gets the current velocity of the vehicle.
	virtual Vector3 getVelocity() = 0;

	/// Sets the angular velocity of the vehicle.
	virtual void setAngularVelocity(Vector3 velocity) = 0;

	/// Gets the current angular velocity of the vehicle.
	virtual Vector3 getAngularVelocity() = 0;

	/// Gets the current model ID of the vehicle.
	virtual int getModel() = 0;

	/// Gets the current landing gear state from a ID_VEHICLE_SYNC packet from the latest driver.
	virtual uint8_t getLandingGearState() = 0;

	/// Get if the vehicle was occupied since last spawn.
	virtual bool hasBeenOccupied() = 0;

	/// Get the last time the vehicle was occupied.
	virtual const TimePoint& getLastOccupiedTime() = 0;

	/// Get the last time the vehicle was spawned.
	virtual const TimePoint& getLastSpawnTime() = 0;

	/// Get if vehicle is occupied.
	virtual bool isOccupied() = 0;

	/// Set vehicle siren status.
	virtual void setSiren(bool status) = 0;

	/// Get vehicle siren status.
	virtual uint8_t getSirenState() const = 0;

	/// Get hydra thrust angle
	virtual uint32_t getHydraThrustAngle() const = 0;

	/// Get train speed
	virtual float getTrainSpeed() const = 0;

	/// Get last driver's pool id
	virtual int getLastDriverPoolID() const = 0;
};

/// A vehicle event handler
struct VehicleEventHandler
{
	virtual void onVehicleStreamIn(IVehicle& vehicle, IPlayer& player) { }
	virtual void onVehicleStreamOut(IVehicle& vehicle, IPlayer& player) { }
	virtual void onVehicleDeath(IVehicle& vehicle, IPlayer& player) { }
	virtual void onPlayerEnterVehicle(IPlayer& player, IVehicle& vehicle, bool passenger) { }
	virtual void onPlayerExitVehicle(IPlayer& player, IVehicle& vehicle) { }
	virtual void onVehicleDamageStatusUpdate(IVehicle& vehicle, IPlayer& player) { }
	virtual bool onVehiclePaintJob(IPlayer& player, IVehicle& vehicle, int paintJob) { return true; }
	virtual bool onVehicleMod(IPlayer& player, IVehicle& vehicle, int component) { return true; }
	virtual bool onVehicleRespray(IPlayer& player, IVehicle& vehicle, int colour1, int colour2) { return true; }
	virtual void onEnterExitModShop(IPlayer& player, bool enterexit, int interiorID) { }
	virtual void onVehicleSpawn(IVehicle& vehicle) { }
	virtual bool onUnoccupiedVehicleUpdate(IVehicle& vehicle, IPlayer& player, UnoccupiedVehicleUpdate const updateData) { return true; }
	virtual bool onTrailerUpdate(IPlayer& player, IVehicle& trailer) { return true; }
	virtual bool onVehicleSirenStateChange(IPlayer& player, IVehicle& vehicle, uint8_t sirenState) { return true; }
};

/// A vehicle pool
static const UID VehicleComponent_UID = UID(0x3f1f62ee9e22ab19);
struct IVehiclesComponent : public IPoolComponent<IVehicle>
{
	PROVIDE_UID(VehicleComponent_UID)

	/// Get the number of model instances for each model
	virtual StaticArray<uint8_t, MAX_VEHICLE_MODELS>& models() = 0;

	virtual IVehicle* create(bool isStatic, int modelID, Vector3 position, float Z = 0.0f, int colour1 = -1, int colour2 = -1, Seconds respawnDelay = Seconds(-1), bool addSiren = false) = 0;
	virtual IVehicle* create(const VehicleSpawnData& data) = 0;

	virtual IEventDispatcher<VehicleEventHandler>& getEventDispatcher() = 0;
};

/// Player vehicle data
static const UID SomePlayerData_UID = UID(0xa960485be6c70fb2);
struct IPlayerVehicleData : public IExtension
{
	PROVIDE_EXT_UID(SomePlayerData_UID)

	/// Get the player's vehicle
	/// Returns nullptr if they aren't in a vehicle
	virtual IVehicle* getVehicle() = 0;

	/// Reset player's vehicle value interally
	/// *** DO NOT USE THIS IF YOU HAVE NO IDEA WHAT IT DOES
	/// IT IS NOT FOR VEHICLE DESTRUCTION OR REMOVE PLAYER FROM ONE ***
	virtual void resetVehicle() = 0;

	/// Get the player's seat
	/// Returns -1 if they aren't in a vehicle.
	virtual int getSeat() const = 0;

	/// Checks if player is in a mod shop
	virtual bool isInModShop() const = 0;

	/// Check if passenger is in drive-by mode or not
	virtual bool isInDriveByMode() const = 0;

	/// Check if passenger is cuffed or not
	virtual bool isCuffed() const = 0;
};

namespace Impl
{
inline bool isValidVehicleModel(int model)
{
	if (model < 400 || model > 611)
	{
		return false;
	}
	return true;
}
}