# Configuration

```lua
Config = {}

Config.DuiWidth = 384
Config.DuiHeight = 512

Config.HeightMin = 6.0 
Config.ScaleFactor = 0.30 -- Height scale factor. No max height cap, beam scales infinitely with distance.

Config.FadeStartDistance = 25
Config.MapWaypoint = {
  enabled = true,
  label = "DESTINO",
  color = "#ffffffff"
}

Config.OffScreenIndicator = {
  enabled = true,
  size = 0.02,
  color = { r = 255, g = 255, b = 255, a = 255 },
  spriteDict = "commonmenu",
  spriteName = "arrowright"
}

-- Dynamic Color Configuration by Distance
Config.DistanceColors = {
  enabled = true,
  
  -- Very far (Initial color)
  far = { 
    dist = 4000.0, 
    r = 255, g = 50, b = 50 
  },
  
  -- Medium distance (Mid transition)
  mid = { 
    dist = 2000.0, 
    r = 255, g = 210, b = 50 
  },
  
  -- Very close (Color upon arrival)
  near = { 
    dist = 1000.0, 
    r = 50, g = 255, b = 200 
  }
}

-- NEW PREMIUM UPGRADES
Config.Controls = {
  command = "waypointhud", -- Command to hide/show the HUD
  defaultVisible = true
}

Config.ContextIcons = {
  ["DESTINO"] = "fas fa-location-arrow",
  ["TIENDA"] = "fas fa-shopping-cart",
  ["ROPA"] = "fas fa-tshirt",
  ["BANCO"] = "fas fa-university",
  ["CASA"] = "fas fa-home",
  ["GARAGE"] = "fas fa-car",
  ["POLICIA"] = "fas fa-shield-alt",
  ["HOSPITAL"] = "fas fa-heartbeat",
  ["MECANICO"] = "fas fa-tools",
  ["GASOLINERA"] = "fas fa-gas-pump",
}

Config.DynamicOpacity = {
  enabled = true,
  minOpacity = 30, -- Minimum opacity (%) at high speed
  maxSpeed = 120.0, -- Speed (km/h) for minimum opacity
}

Config.NightMode = {
  enabled = true,
  startHour = 20, 
  endHour = 6,    
  neonGlow = true
}







--[[
  Exports (client-side)

  local id = exports['b14ck_bfx-waypoints']:AddWaypoint(pos, {
    label      = "DELIVERY",       -- default "WAYPOINT"
    color      = "#E74C3C",        -- default "#FFFFFF"
    autoRemove = true,             -- default true
    removeDist = 5.0,              -- default 5.0
  })

  exports['b14ck_bfx-waypoints']:RemoveWaypoint(id)  --> bool
  exports['b14ck_bfx-waypoints']:UpdateWaypoint(id, { pos = vec3, label = "X", color = "#FF0000" })  --> bool
  exports['b14ck_bfx-waypoints']:GetWaypointForCoord(pos, radius?)  --> id | nil   (radius defaults to 1.0)
  exports['b14ck_bfx-waypoints']:ClearWaypoints()
]]

```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://b14ck.gitbook.io/b14ck-scripts/scripts/waypoint/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
