19 (#39)

* feat: useProxy, useRaycast, useVehicle Additions, bug fixes

* feat: usePed

* docs: changelog

* feat: vehicleHashMap, neon sync

docs/api/shared/utility.md

@@ -82,3 +82,18 @@ const distLong = Utility.vector.distance(new alt.Vector3(0, 0, 0), new alt.Vecto
 // Returns a position in front of a given player, vehicle, etc.
 const posInFrontOf = Utility.vector.getVectorInFrontOfPlayer(somePlayerOrVehicle, 5);
 ```
+
+### Vehicle Hash Map
+
+When you need vehicle names from hash values or need a large list of vehicles. This is it.
+
+```ts
+// will return 'infernus'
+const model = Utility.vehicleHashes.getNameFromHash(418536135);
+
+// Adding vehicles like this needs to be done from webview, server, and shared to be accurate
+Utility.vehicleHashes.addVehicle('infernus');
+
+// Returns a string array of vehicle model names
+const vehicleModels = Utility.vehicleHashes.getVehicles();
+```

docs/changelog.md

@@ -4,6 +4,20 @@ order: -5
 
 # Changelog
 
+## Version 19
+
+### Code Changes
+
+-   Added reverse map for vehicle model hash to vehicle model name
+-   Added function to add named models to list at runtime as well
+-   Added neon synchronization to vehicle document sync
+
+### Docs Changes
+
+-   Added vehicleHashes utility doc info
+
+---
+
 ## Version 18
 
 ### Code Changes

src/main/server/vehicle/index.ts

@@ -1,6 +1,7 @@
 import * as alt from 'alt-server';
 import { useRebar } from '../index.js';
 import { Vehicle, WheelState } from '../../shared/types/vehicle.js';
+import * as Utility from '@Shared/utility/index.js';
 
 const Rebar = useRebar();
 const db = Rebar.database.useDatabase();
@@ -54,6 +55,15 @@ export function useVehicle(vehicle: alt.Vehicle) {
             }
         }
 
+        // Synchronize neon
+        if (document.neonPlacement && document.neonColor) {
+            for (let key of Object.keys(document.neonPlacement)) {
+                vehicle.neon[key] = document.neonPlacement[key];
+            }
+
+            vehicle.neonColor = document.neonColor;
+        }
+
         // Synchronize vehicle extras
         if (document.extras) {
             for (let key of Object.keys(document.extras)) {
@@ -450,10 +460,20 @@ export function useVehicle(vehicle: alt.Vehicle) {
         apply(data);
     }
 
+    /**
+     * Get the model name of the vehicle
+     *
+     * @return
+     */
+    function getVehicleModelName() {
+        return Utility.vehicleHashes.getNameFromHash(vehicle.model);
+    }
+
     return {
         apply,
         bind,
         create,
+        getVehicleModelName,
         hasOwner,
         isBound,
         keys: {

src/main/shared/types/vehicle.ts

@@ -102,6 +102,32 @@ export interface Vehicle {
      */
     windows?: { [key: string]: number };
 
+    /**
+     * Neon color for the vehicle
+     *
+     * @type {alt.RGBA}
+     * @memberof Vehicle
+     */
+    neonColor?: alt.RGBA;
+
+    /**
+     * Where the placement of the neon is
+     *
+     * @type {{
+     *         front: boolean,
+     *         back: boolean,
+     *         left: boolean,
+     *         right: boolean
+     *     }}
+     * @memberof Vehicle
+     */
+    neonPlacement?: {
+        front: boolean;
+        back: boolean;
+        left: boolean;
+        right: boolean;
+    };
+
     stateProps?: {
         /**
          * Dirt level of the vehicle

src/main/shared/utility/index.ts

@@ -4,5 +4,6 @@ export * as flag from './flags.js';
 export * as math from './math.js';
 export * as random from './random.js';
 export * as time from './time.js';
-export * as vector from './vector.js';
 export * as uid from './uid.js';
+export * as vector from './vector.js';
+export * as vehicleHashes from './vehicleHashes.js';