VCORE Ecosystem StudioFrameworkServerClipr
VCORE Studio›Products›Vcore Framework›Resources
DocsResourcesAPIVCORE Server
Vcore Framework / Developer DocumentationDocumentation
Docs/Resources/Base/polyzone
Base Resource

Vcore-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.

Resource folder: polyzonev1.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

ResourceTypePackage status
coreReferenced resourceIncluded in Base

Cross-resource export calls

ResourceFunctions called
coregetCoreObject

Installation / Start Order

Install the resource with its required dependencies, then enable it in your resource start order.

server.cfg
ensure polyzone

Configuration

Config files

  • creation/server/config.lua

Top-level config keys

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 callbacks are documented for this resource.

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

This resource does not include a resource-local SQL file.

This resource does not define its own CREATE TABLE statements.

Vcore also includes the consolidated VCORE_INSTALL.sql.

Source Layout

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

Troubleshooting

  • Confirm all manifest dependencies are started before polyzone.
  • Confirm the resource is enabled in the correct start order.
  • 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.