whitespace, some documentation added

lib/client/points.lua

@@ -11,52 +11,58 @@ local CELL_BUFFER = 1 -- Number of adjacent cells to check
 -- Consider adding these optimizations
 local ADAPTIVE_WAIT = true -- Adjust wait time based on player speed
 
+---This is an internal function, do not call this externally
 function Point.GetCellKey(coords)
     local cellX = math.floor(coords.x / GRID_SIZE)
     local cellY = math.floor(coords.y / GRID_SIZE)
     return cellX .. ":" .. cellY
 end
 
+---This is an internal function, do not call this externally
 function Point.RegisterInGrid(point)
     local cellKey = Point.GetCellKey(point.coords)
-    
+
     -- Initialize cell if it doesn't exist
     GridCells[cellKey] = GridCells[cellKey] or {
         points = {},
         count = 0
     }
-    
+
     -- Add point to cell
     GridCells[cellKey].points[point.id] = point
     GridCells[cellKey].count = GridCells[cellKey].count + 1
-    
+
     -- Store cell reference in point
     point.cellKey = cellKey
 end
 
+---This is an internal function, do not call this externally
 function Point.UpdateInGrid(point, oldCellKey)
     -- Remove from old cell if cell key changed
     if oldCellKey and oldCellKey ~= point.cellKey then
         if GridCells[oldCellKey] and GridCells[oldCellKey].points[point.id] then
             GridCells[oldCellKey].points[point.id] = nil
             GridCells[oldCellKey].count = GridCells[oldCellKey].count - 1
-            
+
             -- Clean up empty cells
             if GridCells[oldCellKey].count <= 0 then
                 GridCells[oldCellKey] = nil
             end
         end
-        
+
         -- Add to new cell
         Point.RegisterInGrid(point)
     end
 end
 
+---Gets nearby cells based on the coords
+---@param coords table
+---@return table
 function Point.GetNearbyCells(coords)
     local cellX = math.floor(coords.x / GRID_SIZE)
     local cellY = math.floor(coords.y / GRID_SIZE)
     local nearbyCells = {}
-    
+
     -- Get current and adjacent cells
     for x = cellX - CELL_BUFFER, cellX + CELL_BUFFER do
         for y = cellY - CELL_BUFFER, cellY + CELL_BUFFER do
@@ -66,14 +72,18 @@ function Point.GetNearbyCells(coords)
             end
         end
     end
-    
+
     return nearbyCells
 end
 
+---Returns all points in the same cell as the given point
+---This will require you to pass the point object
+---@param point table
+---@return table
 function Point.CheckPointsInSameCell(point)
     local cellKey = point.cellKey
     if not GridCells[cellKey] then return {} end
-    
+
     local nearbyPoints = {}
     for id, otherPoint in pairs(GridCells[cellKey].points) do
         if id ~= point.id then
@@ -83,14 +93,15 @@ function Point.CheckPointsInSameCell(point)
             end
         end
     end
-    
+
     return nearbyPoints
 end
 
+---Internal function that starts the loop. Do not call this function directly.
 function Point.StartLoop()
     if LoopStarted then return false end
     LoopStarted = true
-    
+
     CreateThread(function()
         while LoopStarted do
             local playerPed = PlayerPedId()
@@ -102,7 +113,7 @@ function Point.StartLoop()
             local targetsExist = false
             local playerCellKey = Point.GetCellKey(playerCoords)
             local nearbyCells = Point.GetNearbyCells(playerCoords)
-            
+
             local playerSpeed = GetEntitySpeed(playerPed)
             local maxWeight = 1000
             local waitTime = ADAPTIVE_WAIT and math.max(maxWeight/10, maxWeight - playerSpeed * maxWeight/10) or maxWeight
@@ -111,7 +122,7 @@ function Point.StartLoop()
                 if GridCells[cellKey] then
                     for id, point in pairs(GridCells[cellKey].points) do
                         targetsExist = true
-                        
+
                         -- Update entity position if needed
                         local oldCellKey = point.cellKey
                         if point.isEntity then
@@ -119,9 +130,9 @@ function Point.StartLoop()
                             point.cellKey = Point.GetCellKey(point.coords)
                             Point.UpdateInGrid(point, oldCellKey)
                         end
-                        
+
                         local distance = #(playerCoords - point.coords)
-                        
+
                         -- Check if player entered/exited the point
                         if distance < point.distance then
                             if not point.inside then
@@ -134,7 +145,7 @@ function Point.StartLoop()
                             point.inside = false
                             point.onExit(point)
                         end
-                        if point.onNearby then                            
+                        if point.onNearby then
                             point.onNearby(GridCells[cellKey]?.points, waitTime)
                         end
                     end
@@ -152,8 +163,16 @@ function Point.StartLoop()
     return true
 end
 
+---Create a point based on a vector or entityID
+---@param id string
+---@param target number || vector3
+---@param distance number
+---@param _onEnter function
+---@param _onExit function
+---@param _onNearby function
+---@param data self
+---@return table
 function Point.Register(id, target, distance, _onEnter, _onExit, _onNearby, data)
-    
     local isEntity = type(target) == "number"
     local coords = isEntity and GetEntityCoords(target) or target
 
@@ -174,6 +193,8 @@ function Point.Register(id, target, distance, _onEnter, _onExit, _onNearby, data
     return self
 end
 
+---Remove an exsisting point by its id
+---@param id string
 function Point.Remove(id)
     local point = ActivePoints[id]
     if point then
@@ -181,25 +202,31 @@ function Point.Remove(id)
         if GridCells[cellKey] and GridCells[cellKey].points[id] then
             GridCells[cellKey].points[id] = nil
             GridCells[cellKey].count = GridCells[cellKey].count - 1
-            
+
             if GridCells[cellKey].count <= 0 then
                 GridCells[cellKey] = nil
             end
         end
-        
+
         ActivePoints[id] = nil
     end
 end
 
+---Returnes a point by its id
+---@param id string
+---@return table
 function Point.Get(id)
     return ActivePoints[id]
 end
 
+---Returns all points
+---@return table
 function Point.GetAll()
     return ActivePoints
 end
 
 -- Usage example for checking nearby points
+-- This is fucking hot. +20 points for crowley
 --[[
 Point.Register("point1", vector3(100, 100, 30), 5.0, 
     function(point)
@@ -217,5 +244,4 @@ Point.Register("point1", vector3(100, 100, 30), 5.0,
 )
 --]]
 
-return Point
-
+return Point