🔲 GRID SYSTEM

The Grid System places props on an invisible, snapping grid inside a zone you define. You use it in two phases:

1. Build time — lay a scene out by hand with the in-game editor and capture every prop's position.
2. Runtime — replay that captured layout from a script with the placement exports, with no editor and no UI.

Core concepts

• Zone — a rectangular area defined by four corner coordinates plus a maximum stacking height. A zone can sit on the ground or be attached to a vehicle so its props move with it. Every prop position is stored relative to its zone.
• Zone-local coordinates — prop positions are given in meters relative to the zone, not world coordinates:
  • x — distance along the edge from corner 1 → corner 2
  • y — distance along the edge from corner 1 → corner 4
  • z — height above the zone floor These are exactly the values the editor reports and the placement exports expect. Because they are relative, a captured layout can be re-placed at any zone, anywhere in the map.
• Prop catalog — only models registered in gridProps (ground) or gridPropsVehicle (vehicle) in configs/c.config.lua can be placed. Each entry defines the prop's bounding size and offsets. Register your own models at runtime with AddGridProp / AddGridPropVehicle (see Exports).
• Ownership & lifetime — a zone is owned by a player; the zone and its props live while that player is connected and are removed when they disconnect. Choose the owner when creating the zone (RequestCreateZone(..., ownerServerId)) or reassign it later (SetZoneOwner).
• Streaming — placed props are streamed in and out automatically based on how close players are to the zone, so a large scene has no cost for players who are far away.

The build → capture → replay workflow

Pages