Commands
description: Use carwipe commands, the admin panel, and resource exports.
Commands
Commands
| Command | Who uses it | Description |
|---|---|---|
/carwipe | Admin (ACE) | Opens the modern admin UI panel. |
/carwipe [seconds] | Admin (ACE) | Starts a wipe directly with a custom countdown, skipping the panel. |
/cancelcarwipe | Admin (ACE) | Cancels the currently active wipe countdown. |
/carwipestatus | Admin (ACE) | Shows the remaining time of the active wipe (or that none is active). |
All commands (and the equivalent panel actions) go through the same ACE permission check — see Config.AcePermission in Configuration.
/carwipe
- Run with no arguments from in-game → opens the admin panel (
yei-carwipe:openAdminPanel), where staff can see live stats (active vehicle count, total wipes performed, current countdown), start/pause a wipe, and change the default countdown time (persists in memory until the resource restarts). - Run with a number (
/carwipe 60) → starts a countdown directly with that many seconds, clamped between 30 and 1800. - Run from the server console → always starts directly (the panel only makes sense in-game), using the argument if provided or the default countdown otherwise.
When a wipe starts, every player sees the countdown card (position/colors from Config.UI), and the actual cleanup runs once the timer hits zero:
- Every vehicle is checked — those with a driver or passengers are skipped.
- Vehicles inside an
IgnoreZoneszone are skipped. - Vehicles whose model is in
BlackListVehiclesare skipped. - Everything else gets deleted.
- If
Config.Objectsis enabled, props are cleaned up the same way againstIgnoreZonesObjects. - A completion log is sent to Discord with the number of vehicles (and objects) removed.
/cancelcarwipe
Immediately stops the active countdown and hides the card for every player. Sends a "canceled" log to Discord.
/carwipestatus
Sends a chat/notify message with the remaining time in MM:SS format, or lets the requester know no wipe is active.
Admin Panel actions
The in-game panel (opened via /carwipe with no arguments) exposes the same actions through NUI callbacks instead of chat commands:
| Panel action | Equivalent to |
|---|---|
| Execute Wipe (with optional custom time) | forceStart → same as /carwipe [seconds] |
| Pause/Stop | stopCarwipe → same as /cancelcarwipe |
| Save (Config tab) | setDefaultTime → updates the in-memory default countdown used by /carwipe with no arguments, the panel, and automatic wipes |
Exports
For other resources to integrate with, yei-carwipe exposes:
exports['yei-carwipe']:StartCarwipe(seconds) -- starts a wipe (seconds optional)
exports['yei-carwipe']:StopCarwipe() -- cancels the active wipe
exports['yei-carwipe']:IsCarwipeActive() -- returns true/false
exports['yei-carwipe']:GetCountdownTime() -- returns remaining seconds
Last updated on July 27, 2026
← Back to the store