GCMod

Configuration

Configuration reference and runtime behavior for gcm_securezone.



This resource uses static config in sh_config.lua plus dynamic per-zone options stored in database.

sh_config.lua

Config.Debug
  • Type: boolean
  • Current: false
  • Allowed: true / false
  • Impact: Enables debug behavior in zone rendering and logs.
Config.Language
  • Type: string
  • Current: 'es'
  • Allowed: 'es', 'en', plus any locale file in locales/*.json
  • Impact: Selects the locale used by locale().
Config.enableHudIndicator
  • Type: boolean
  • Current: true
  • Allowed: true / false
  • Impact: Enables the safe/red zone HUD indicator system.
Config.hudIndicatorPosition
  • Type: string
  • Current: 'center-right'
  • Allowed: top-left, top-center, top-right, center-left, center, center-right, bottom-left, bottom-center, bottom-right
  • Impact: Sets HUD indicator anchor position.
Config.ZoneThickness
  • Type: number
  • Current: 1000
  • Allowed: Positive number
  • Impact: Polygon zone vertical thickness used by lib.zones.poly.
Config.Triggers.ESX.load
  • Type: string
  • Current: 'esx:playerLoaded'
  • Allowed: Any valid ESX client load event
  • Impact: Used by framework event mapping.
Config.Triggers.QB.load
  • Type: string
  • Current: 'QBCore:Client:OnPlayerLoaded'
  • Allowed: Any valid QB/QBX client load event
  • Impact: Used by framework event mapping.
Config.GroupPermissions
  • Type: string[]
  • Current: ['god', 'admin', 'superadmin']
  • Allowed: ACE/groups supported by your framework
  • Impact: Defines who can use panel and admin zone management.
Config.Commands.panel
  • Type: string
  • Current: 'securezone'
  • Allowed: Any valid command label
  • Impact: Staff command that opens the admin panel.

Blip configuration

Config.Blips.safezone

sprite
  • Type: number
  • Current: 47
  • Impact: Blip sprite for safe zones.
color
  • Type: number
  • Current: 2
  • Impact: Blip color for safe zones.
scale
  • Type: number
  • Current: 0.8
  • Impact: Blip size.
useSharedLabel
  • Type: boolean
  • Current: true
  • Impact: If enabled, all safe zone blips use the same label.
sharedLabel
  • Type: string
  • Current: 'Safe Zone'
  • Impact: Shared label text when useSharedLabel is enabled.

Config.Blips.redzone

sprite
  • Type: number
  • Current: 161
  • Impact: Blip sprite for red zones.
color
  • Type: number
  • Current: 1
  • Impact: Blip color for red zones.
scale
  • Type: number
  • Current: 0.8
  • Impact: Blip size.
useSharedLabel
  • Type: boolean
  • Current: true
  • Impact: If enabled, all red zone blips use the same label.
sharedLabel
  • Type: string
  • Current: 'Red Zone'
  • Impact: Shared label text when useSharedLabel is enabled.

Per-zone option parameters (options)

Each zone stores an options object in DB. These keys are read by client/server runtime.

Runtime and visibility

enabled
  • Type: boolean
  • Default: true
  • Allowed: false disables zone behavior without deleting the zone
  • Impact: Enables/disables enforcement and visual active style.
showBlip
  • Type: boolean
  • Default: true
  • Allowed: false hides map blip
  • Impact: Controls blip creation for that zone.
showHud
  • Type: boolean
  • Default: true
  • Allowed: false hides enter/exit HUD indicator
  • Impact: Controls NUI indicator updates.

Whitelist controls

whitelistStaff
  • Type: boolean
  • Default: false
  • Allowed: Uses isPlayerStaff(src)
  • Impact: Exempts staff from restricted behavior.
whitelistJobs
  • Type: string[]
  • Default: []
  • Allowed: Job names normalized to lowercase
  • Impact: Exempts listed jobs from restrictions.
whitelistWeapons
  • Type: (string|number)[]
  • Default: []
  • Allowed: Weapon names (WEAPON_PISTOL) or hashes
  • Impact: Weapons allowed while disarm option is active.

Safe zone behavior flags

danios
  • Type: boolean
  • Default: false
  • UI label: Disable Damage
  • Impact: Blocks damage and firing inside safe zones.
desarmarUsuario
  • Type: boolean
  • Default: false
  • UI label: Disarm User
  • Impact: Disarms player in safe zone except whitelisted weapons.
saltos
  • Type: boolean
  • Default: false
  • UI label: Disable Jumps
  • Impact: Disables jump control.
colisiones
  • Type: boolean
  • Default: false
  • UI label: Disable Collisions
  • Impact: Disables collisions with networked peds/vehicles in zone.
noCorrer
  • Type: boolean
  • Default: false
  • UI label: No Run
  • Impact: Disables sprint control.
limitarVelocidad
  • Type: boolean
  • Default: false
  • UI label: Limit Speed
  • Impact: Enables vehicle speed cap while inside safe zone.
velocidadMaxima
  • Type: number
  • Default: 50
  • Allowed: UI range 5 to 300 (km/h)
  • Impact: Max speed applied when limitarVelocidad is enabled.

Permissions adapter (custom/server.lua)

Keep this file aligned with your framework/groups strategy:

  • isPlayerStaff(src)
  • getPlayerJobName(src)
  • isPlayerWhitelistedForZone(src, options)

If your server uses custom ACL/job metadata, adjust these helpers first.

Previous
Installation
Next
Commands