Comments and formatting

cl_plate_reader.lua

@@ -15,26 +15,30 @@ READER = {}
 ----------------------------------------------------------------------------------]]--
 READER.vars = 
 {
-    -- Whether or not the radar's UI is visible 
+    -- Whether or not the plate reader's UI is visible 
 	displayed = false,
 
-	-- Whether or not the radar should be hidden, e.g. the display is active but the player then steps
+	-- Whether or not the plate reader should be hidden, e.g. the display is active but the player then steps
 	-- out of their vehicle
     hidden = false,
 
+    -- The BOLO plate 
     boloPlate = "", 
     
+    -- Cameras, this table contains all of the data needed for operation of the front and rear plate reader 
     cams = {
+        -- Variables for the front camera
         ["front"] = {
-            plate = "", 
-            index = "", 
-            locked = false 
+            plate = "",     -- The current plate caught by the reader
+            index = "",     -- The index of the current plate
+            locked = false  -- If the reader is locked 
         }, 
 
+        -- Variables for the rear camera
         ["rear"] = {
-            plate = "", 
-            index = "", 
-            lockec = false 
+            plate = "",     -- The current plate caught by the reader
+            index = "",     -- The index of the current plate
+            locked = false  -- If the reader is locked 
         }
     }
 }
@@ -44,7 +48,7 @@ function READER:GetDisplayState()
 	return self.vars.displayed
 end 
 
--- Toggles the display state of the radar system
+-- Toggles the display state of the plate reader system
 function READER:ToggleDisplayState()
 	-- Toggle the display variable 
 	self.vars.displayed = not self.vars.displayed 
@@ -63,48 +67,63 @@ function READER:GetDisplayHidden()
 	return self.vars.hidden 
 end
 
+-- Returns the stored plate for the given reader
 function READER:GetPlate( cam )
     return self.vars.cams[cam].plate 
 end 
 
+-- Sets the plate for the given reader to the given plate 
 function READER:SetPlate( cam, plate )
     self.vars.cams[cam].plate = plate 
 end 
 
+-- Returns the stored plate index for the given reader
 function READER:GetIndex( cam )
     return self.vars.cams[cam].index
 end 
 
+-- Sets the plate index for the given reader to the given index
 function READER:SetIndex( cam, index )
     self.vars.cams[cam].index = index 
 end 
 
+-- Returns the bolo plate
 function READER:GetBoloPlate()
     return self.vars.boloPlate
 end 
 
+-- Sets the bolo plate to the given plate 
 function READER:SetBoloPlate( plate )
     self.vars.boloPlate = plate 
     UTIL:Notify( "BOLO plate set to: " .. plate )
 end 
 
+-- Returns if the given reader is locked
 function READER:GetCamLocked( cam )
     return self.vars.cams[cam].locked
 end 
 
+-- Locks the given reader
 function READER:LockCam( cam )
+    -- Check that plate readers can actually be locked
     if ( PLY:VehicleStateValid() and self:CanPerformMainTask() ) then 
+        -- Toggle the lock state 
         self.vars.cams[cam].locked = not self.vars.cams[cam].locked
 
+        -- Tell the NUI side to show/hide the lock icon 
         SendNUIMessage( { _type = "lockPlate", cam = cam, state = self:GetCamLocked( cam ) } )
+
+        -- Play a beep 
         SendNUIMessage( { _type = "audio", name = "beep", vol = RADAR:GetSettingValue( "beep" ) } )
     end 
 end 
 
+-- Returns if the plate reader system can perform tasks
 function READER:CanPerformMainTask()
     return self.vars.displayed and not self.vars.hidden
 end 
 
+-- Returns if the given relative position value is for front or rear 
 function READER:GetCamFromNum( relPos )
     if ( relPos == 1 ) then 
         return "front"
@@ -119,32 +138,56 @@ RegisterNUICallback( "togglePlateReaderDisplay", function()
 	READER:ToggleDisplayState()
 end )
 
--- Runs when the "Toggle Display" button is pressed on the plate reder box 
+-- Runs when the "Set BOLO Plate" button is pressed on the plate reader box
 RegisterNUICallback( "setBoloPlate", function( plate, cb )
+    -- Set the BOLO plate 
     READER:SetBoloPlate( plate )
 end )
 
+-- This is the main function that runs and scans all vehicles in front and behind the patrol vehicle
 function READER:Main()
+    -- Check that the system can actually run 
     if ( PLY:VehicleStateValid() and self:CanPerformMainTask() ) then 
+        -- Loop through front (1) and rear (-1)
         for i = 1, -1, -2 do 
-            local start = GetEntityCoords( PLY.veh )
-            local offset = GetOffsetFromEntityInWorldCoords( PLY.veh, 0.0, ( 40.0 * i ), 0.0 )
+            -- Get the world position of the player's vehicle
+            local pos = GetEntityCoords( PLY.veh )
+
+            -- Get a start position 5m in front/behind the player's vehicle
+            local start = GetOffsetFromEntityInWorldCoords( PLY.veh, 0.0, ( 5.0 * i ), 0.0 )
+
+            -- Get the end position 40m in front/behind the player's vehicle
+            local offset = GetOffsetFromEntityInWorldCoords( PLY.veh, -2.5, ( 50.0 * i ), 0.0 )
+
+            -- Run the ray trace to get a vehicle 
             local veh = UTIL:GetVehicleInDirection( PLY.veh, start, offset )
 
+            -- Get the plate reader text for front/rear
             local cam = self:GetCamFromNum( i )
             
+            -- Only proceed to read a plate if the hit entity is a valid vehicle and the current camera isn't locked
             if ( DoesEntityExist( veh ) and IsEntityAVehicle( veh ) and not self:GetCamLocked( cam ) ) then 
+                -- Get the licence plate text from the vehicle 
                 local plate = GetVehicleNumberPlateText( veh )
+
+                -- Get the licence plate index from the vehicle 
                 local index = GetVehicleNumberPlateTextIndex( veh )
 
+                -- Only update the stored plate if it's different, otherwise we'd keep sending a NUI message to update the displayed
+                -- plate and image even though they're the same 
                 if ( self:GetPlate( cam ) ~= plate ) then 
+                    -- Set the plate for the current reader
                     self:SetPlate( cam, plate )
+
+                    -- Set the plate index for the current reader
                     self:SetIndex( cam, index )
 
+                    -- Automatically lock the plate if the scanned plate matches the BOLO
                     if ( plate == self:GetBoloPlate() ) then 
                         self:LockCam( cam )
                     end 
 
+                    -- Send the plate information to the NUI side to update the UI
                     SendNUIMessage( { _type = "changePlate", cam = cam, plate = plate, index = index } )
                 end 
             end 
@@ -152,14 +195,20 @@ function READER:Main()
     end 
 end 
 
+-- Main thread
 Citizen.CreateThread( function()
     while ( true ) do
+        -- Run the main plate reader function
         READER:Main()
 
+        -- Wait half a second
         Citizen.Wait( 500 )
     end 
 end )
 
+-- This function is pretty much straight from WraithRS, it does the job so I didn't see the point in not 
+-- using it. Hides the radar UI when certain criteria is met, e.g. in pause menu or stepped out ot the 
+-- patrol vehicle 
 function READER:RunDisplayValidationCheck()
 	if ( ( ( PLY.veh == 0 or ( PLY.veh > 0 and not PLY.vehClassValid ) ) and self:GetDisplayState() and not self:GetDisplayHidden() ) or IsPauseMenuActive() and self:GetDisplayState() ) then
 		self:SetDisplayHidden( true ) 
@@ -170,12 +219,15 @@ function READER:RunDisplayValidationCheck()
 	end 
 end
 
+-- Runs the display validation check for the radar
 Citizen.CreateThread( function() 
 	Citizen.Wait( 100 )
 
-	while ( true ) do 
+    while ( true ) do 
+        -- Run the check 
 		READER:RunDisplayValidationCheck()
 
+        -- Wait half a second 
 		Citizen.Wait( 500 )
 	end 
 end )