Add debugBlip option to all zones

The debugBlip option will place a blip at the center of the zone, or for ComboZones, place a blip for each zone inside of it, and print a report of the amount of zones in the ComboZone by type.

Author: mkafrin

BoxZone.lua

@@ -62,6 +62,7 @@ end
 
 -- Initialization functions
 local function _initDebug(zone, options)
+  if options.debugBlip then zone:addDebugBlip() end
   if not options.debugPoly then
     return
   end

CircleZone.lua

@@ -17,6 +17,7 @@ end
 
 
 local function _initDebug(zone, options)
+  if options.debugBlip then zone:addDebugBlip() end
   if not options.debugPoly then
     return
   end

ComboZone.lua

@@ -110,6 +110,7 @@ end
 
 
 local function _initDebug(zone, options)
+  if options.debugBlip then zone:addDebugBlip() end
   if not options.debugPoly then
     return
   end
@@ -296,6 +297,28 @@ function ComboZone:onPlayerInOutExhaustive(onPointInOutCb, waitInMS)
   self:onPointInOutExhaustive(PolyZone.getPlayerPosition, onPointInOutCb, waitInMS)
 end
 
+function ComboZone:addDebugBlip()
+  local zones = self.zones
+  local polyCount, boxCount, circleCount, entityCount = 0, 0, 0, 0
+  for i=1, #zones do
+    local zone = zones[i]
+    if zone then
+      zone:addDebugBlip()
+      if zone.isPolyZone then polyCount = polyCount + 1 end
+      if zone.isBoxZone then boxCount = boxCount + 1 end
+      if zone.isCircleZone then circleCount = circleCount + 1 end
+      if zone.isEntityZone then entityCount = entityCount + 1 end
+    end
+  end
+  local name = self.name ~= nil and ("\"" .. self.name .. "\"") or nil
+  print("[PolyZone] Debug for ComboZone { name = " .. tostring(name) .. " }:")
+  print("[PolyZone]   Total zones: " .. #zones)
+  print("[PolyZone]   BoxZones: " .. boxCount)
+  print("[PolyZone]   CircleZones: " .. circleCount)
+  print("[PolyZone]   PolyZones: " .. polyCount)
+  print("[PolyZone]   EntityZones: " .. entityCount)
+end
+
 function ComboZone:setPaused(paused)
   self.paused = paused
 end

EntityZone.lua

@@ -33,15 +33,17 @@ end
 
 -- Initialization functions
 local function _initDebug(zone, options)
-  if not options.debugPoly then
+  if options.debugBlip then zone:addDebugBlip() end
+  if not options.debugPoly and not options.debugBlip then
     return
   end
 
   Citizen.CreateThread(function()
     local entity = zone.entity
+    local shouldDraw = options.debugPoly
     while not zone.destroyed do
       UpdateOffsets(entity, zone)
-      zone:draw()
+      if shouldDraw then zone:draw() end
       Citizen.Wait(0)
     end
   end)
@@ -89,6 +91,7 @@ function UpdateOffsets(entity, zone)
   if zone.useZ then
     zone.minZ, zone.maxZ = _calculateMinAndMaxZ(entity, zone.dimensions, zone.scaleZ, zone.offsetZ, pos)
   end
+  if zone.debugBlip then SetBlipCoords(zone.debugBlip, pos.x, pos.y, 0.0) end
 end
 
 
@@ -133,3 +136,9 @@ function EntityZone:destroy()
   self.damageEventHandlers = {}
   PolyZone.destroy(self)
 end
+
+function EntityZone:addDebugBlip()
+  local blip = PolyZone.addDebugBlip(self)
+  self.debugBlip = blip
+  return blip
+end

client.lua

@@ -30,6 +30,15 @@ local function _wn_inner_loop(p0, p1, p2, wn)
   return wn
 end
 
+function addBlip(pos)
+  local blip = AddBlipForCoord(pos.x, pos.y, 0.0)
+  SetBlipColour(blip, 7)
+  SetBlipDisplay(blip, 8)
+  SetBlipScale(blip, 1.0)
+  SetBlipAsShortRange(blip, true)
+  return blip
+end
+
 function clearTbl(tbl)
   -- Only works with contiguous (array-like) tables
   if tbl == nil then return end
@@ -397,6 +406,7 @@ end
 
 
 local function _initDebug(poly, options)
+  if options.debugBlip then poly:addDebugBlip() end
   local debugEnabled = options.debugPoly or options.debugGrid
   if not debugEnabled then
     return
@@ -519,6 +529,10 @@ function PolyZone:onPlayerInOut(onPointInOutCb, waitInMS)
   self:onPointInOut(PolyZone.getPlayerPosition, onPointInOutCb, waitInMS)
 end
 
+function PolyZone:addDebugBlip()
+  return addBlip(self.center or self:getBoundingBoxCenter())
+end
+
 function PolyZone:setPaused(paused)
   self.paused = paused
 end