Vcore Framework / Developer DocumentationDocumentation
Docs/Resources/Base/polyzone
Base Resource

polyzone

Shared spatial-zone library used by VCore resources. Start it before resources that create zones. Use Core’s VCORE.Functions zone helpers where possible. Direct exports include AddBoxZone, AddCircleZone, AddPolyZone, AddEntityZone, RemoveZone, IsInZone and coordinate checks. Zone creation commands: /pzcreate, /pzadd, /pzundo, /pzfinish, /pzlast and /pzcancel. /pzdebug [distance] draws nearby zones. Generated definitions are written to polyzonecreatedzones.txt. Geometry derives from mkafrin/PolyZone and remains covered by the included MIT licence.

v1.0.0VCore FrameworkRuntime and framework prerequisites

Introduction

Shared spatial-zone library used by VCore resources. Start it before resources that create zones. Use Core’s VCORE.Functions zone helpers where possible. Direct exports include AddBoxZone, AddCircleZone, AddPolyZone, AddEntityZone, RemoveZone, IsInZone and coordinate checks. Zone creation commands: /pzcreate, /pzadd, /pzundo, /pzfinish, /pzlast and /pzcancel. /pzdebug [distance] draws nearby zones. Generated definitions are written to polyzonecreatedzones.txt. Geometry derives from mkafrin/PolyZone and remains covered by the included MIT licence.

7Client Lua
3Server Lua
17Exports
17Events
0SQL tables

No manifest UI page detected.

Dependencies & References

ResourceDetected asPackage status
coreReferenced by sourceIncluded in Base

Cross-resource export calls

ResourceFunctions called
coregetCoreObject

Installation / Start Order

The supplied server.cfg enables this resource in the Runtime and framework prerequisites stage at enabled-resource position 11. Base installation also depends on the global prerequisites and consolidated VCORE_INSTALL.sql documented in Getting Started.

server.cfg
ensure polyzone

Configuration

Config files

  • creation/server/config.lua

Top-level config keys detected

ConfigFormatEnabled

Events, Exports & Callbacks

Exports

Client exports16
  • AddBoxZone
  • AddCircleZone
  • AddEntityZone
  • AddPolyZone
  • AddZoneEvent
  • BoxZone
  • CircleZone
  • ComboZone
  • DrawZoneById
  • EntityZone
  • IsCoordsInPoly
  • IsCoordsInZoneByName
  • IsInZone
  • PolyZone
  • RemoveZone
  • StopZoneDraw
Server exports1
  • TriggerZoneEvent

Callbacks

No Vcore callback registrations were detected.

Registered network events

Client registered events12
  • VCORE:Client:OnPlayerLoaded
  • VCORE:Client:OnPlayerSpawned
  • VCORE:Client:OnPlayerUnload
  • polyzone:client:addZone
  • polyzone:client:removeZone
  • polyzone:pzadd
  • polyzone:pzcancel
  • polyzone:pzcreate
  • polyzone:pzfinish
  • polyzone:pzlast
  • polyzone:pzundo
  • polyzone:toggledebug
Server registered events5
  • PolyZone:TriggerZoneEvent
  • polyzone:printBox
  • polyzone:printCircle
  • polyzone:printPoly
  • polyzone:server:toggledebug

Commands

Client commands7
  • pzadd
  • pzcancel
  • pzcomboinfo
  • pzcreate
  • pzfinish
  • pzlast
  • pzundo
Server commands1
  • pzdebug

Database / SQL

No resource-local SQL file was detected.

No CREATE TABLE statements detected inside this resource.

The root Base package also ships the consolidated VCORE_INSTALL.sql.

Source Layout

AreaDetected files
Client Lua7
Server Lua3
Other/shared Lua6
JavaScript0
HTML0
CSS0
SQL0

Troubleshooting

  • Confirm all manifest dependencies are started before polyzone.
  • Check the supplied start-order note above; resources absent from server.cfg need an explicit decision before enabling.
  • If database queries fail, import the consolidated Base SQL and any resource-local SQL listed above.
  • If the UI fails, verify the resource's NUI files and ui_page when one is declared.