Comment on page
Unit Status
Allows you to change a unit's status in the CAD.
This plugin utilizes API endpoints that require the standard version of Sonoran CAD or higher. For more information, view our pricing page.
- 1.
- 1.
This script provides a status set command by default. Players will need the
command.setstatus
ACE permission (or whatever you configure the command to be).Example
add_ace builtin.everyone command.setstatus allow
This line in your
config.cfg
file will allow everyone to access the command. We highly reccomend creating proper ace permission groups to prevent users from spamming.Option | Description | Default |
setStatusCommand | Command that will allow units to set their own status. | setstatus |
statusCodes | Array of status codes, configurable to be community-specific | Default SonoranCAD setup |
Command | Description |
setstatus <STATUS> | Update your unit status in the CAD. Ex: setstatus AVAILABLE |
This is a server-side function only and is exported as
cadSetUnitStatus
. Use setUnitStatus
if using with other plugins.cadSetUnitStatus(<apiId>, <status>, [player])
- apiId: The identifier attached to the unit
- status: A status, can be the actual string or a number, based on configuration
- player (optional): server ID of the player, used to send a client event
--[[
Event Name: SonoranCAD::unitstatus:UpdateStatus
Arguments:
statusText: Text or number of the status to set
]]
Last modified 2mo ago