New Website Sale - 15% OFF everything

๐ŸŽซ Builder Commands

The builder commands let you lay a scene out visually and capture it. They are a build-time tool.

The commands are disabled by default. Enable them only on a development server: set Config.Commands = true in configs/sh.config.lua and restart the resource. Turn them back off before going live.

Once captured, a scene is placed at runtime from your own resource with the exports โ€” no commands required.

Exports

/createzone

Lua
/createzone <uid>
  • Description: Creates a ground zone with the given unique id. The four corner coordinates and the moveStep / maxHeight are read from the gridConfig defined inside the /createzone command in configs/c.commands.lua โ€” edit those to your own location before running it.
  • Example: /createzone warehouse1

/createvehiclezone

Lua
/createvehiclezone <uid>
  • Description: Creates a zone attached to the vehicle you are currently sitting in, so its props move and rotate with the vehicle. You must be in a vehicle to run it.
  • Example: /createvehiclezone van1

/spawnpropgrid

Lua
/spawnpropgrid <model> <uid>
  • Description: Enters the placement editor for <model> in zone <uid>. The model must be registered in gridProps (or gridPropsVehicle for vehicle zones). Position the prop with the controls below and press Enter to place it. Run it again for each prop you want to add.
  • Example: /spawnpropgrid ex_prop_adv_case_sm warehouse1

Placement editor controls

KeyAction
Arrow keysMove the prop across the grid
Page Up / Page DownRaise / lower the prop
HRotate the prop 90ยฐ
NSnap next to the nearest placed prop
BCycle the move-step size
GToggle the grid overlay
EnterPlace the prop
ESCCancel and exit

/removepropgrid

Lua
/removepropgrid <uid>
  • Description: Enters removal mode for the zone. Press E to cycle through the removable props, Enter to remove the highlighted one, G to toggle the grid, and ESC to exit.
  • Example: /removepropgrid warehouse1

/dumpzoneprops

Lua
/dumpzoneprops <uid>
  • Description: Prints a copy-pasteable Lua block of every prop currently placed in the zone โ€” model, zone-local position, and rotation, with a data = nil slot on each line to fill in. Paste the block into your own resource and replay it with PlaceGridProps.
  • Example: /dumpzoneprops warehouse1

Demo commands

configs/c.commands.lua also ships three commands that exercise the placement exports end to end. They are labelled as test/demo helpers โ€” remove them before production.

Lua
/testgridproduction <uid>   -- creates a 4x4m zone at your feet and drops a batch of props via the exports
/testgridplace <uid>        -- places a single prop via the export
/deletegridzone <uid>       -- deletes a zone and all its props
  • Description: A quick way to verify the exports work anywhere without laying out a scene by hand. <uid> is optional and defaults to testscene.