Skip to Content
Cobalt

Types

Classes and aliases used by export parameters and return values.

Named types from each resource's types/ folder. Fields marked optional may be nil.

cobalt_core

BanIdentifier

'license' | 'discord' | 'steam'

BanOptions

FieldTypeOptionalDescription
reasonstringNo
bannedBystringNo
expireintegerYesunix time the ban ends, permanent when nil
identifiersBanIdentifier[]Yeswhich of the player's identifiers to ban, all three when nil

CardItemMetadata

FieldTypeOptionalDescription
citizenidstringNo
firstnamestringNo
lastnamestringNo
birthdatestringNoYYYY-MM-DD
genderintegerNo0 male, 1 female
nationalitystringNo
licencestringYesthe licence key, such as driver or weapon; missing on an ID card
issuedstringNoYYYY-MM-DD, the day the card was made

CharInfo

FieldTypeOptionalDescription
firstnamestringNo
lastnamestringNo
birthdatestringNo
gender0 | 1No
nationalitystringNo
phonestringYes
accountstringYes

Commands

FieldTypeOptionalDescription
Listtable<string, table>No
IgnoreListtable<string, boolean>No

Core

The table GetCoreObject() returns. Players, Commands and Player exist on the server only; PlayerData on the client only.

FieldTypeOptionalDescription
FunctionsFunctionsNo
SharedSharedNo
Playerstable<integer, CorePlayer>No
PlayersByCidtable<string, CorePlayer>No
PlayersByLicensetable<string, CorePlayer>No
PlayersByPhonetable<string, CorePlayer>Noonline characters by PlayerData.phone_number
PlayerPlayerModuleNo
CommandsCommandsNo
Player_Bucketstable<integer, { id: integer, bucket: integer }>No
Entity_Bucketstable<integer, { id: integer, bucket: integer }>No
PlayerDataPlayerDataNo

CoreAccount

FieldTypeOptionalDescription
licensestringNo
namestringYesthe connected player's name, or else the name saved with the most recently changed character
stateidintegerYesthe permanent number from state_ids, nil when the license has never connected
onlineCoreAccountOnlineYesnil when the license isn't connected
charactersCoreAccountCharacter[]Noevery character on the license, by slot
bansCoreAccountBan[]Nobans on the license, newest first, active and expired

CoreAccountBan

FieldTypeOptionalDescription
idintegerNothe bans id, which Unban takes
reasonstringYes
bystringNowho banned the license
expiresintegerYesunix time the ban ends, nil when permanent
activebooleanNofalse once it has expired; the connect check deletes expired bans of a player who joins
createdAtintegerNounix time of the ban

CoreAccountCharacter

FieldTypeOptionalDescription
citizenidstringNo
cidintegerNothe character's slot on the license
namestringYesfirst and last name, nil when the character has neither
charinfoCharInfoNo
phone_numberstringYesthe number npwd stored in players.phone_number, nil until npwd gives the character one
jobJobYescobalt_management's job, nil when it never set one
gangGangYescobalt_management's gang, nil when it never set one
moneytable<MoneyType, integer>Nothe wallets in players.money; the bank balance is cobalt_banking's
metadataPlayerMetadataNoevery metadata key, licences, needs and status included
positionvector3 | vector4 | tableYeswhere the character was last saved
lastPlayedintegerNounix time the row last changed, or the time of the call for the character being played
onlinebooleanNowhether this is the character being played, read from memory instead of players

CoreAccountOnline

FieldTypeOptionalDescription
sourceintegerNothe connected player's server id
citizenidstringYesthe character being played, nil while the player is still choosing one

CoreJobDefinition

FieldTypeOptionalDescription
labelstringNo
type'leo' | 'ems' | 'mechanic'Yes
societybooleanYes
defaultDutybooleanNo
offDutyPaybooleanNo
gradestable<string, JobGradeDefinition>No

CorePlayer

Server. A loaded or offline character. Methods are on both Player:Name(...) and Player.Functions.Name(...).

FieldTypeOptionalDescription
PlayerDataPlayerDataNo
OfflinebooleanNo
deletedbooleanYesset once the character is deleted, so no save writes its row again
FunctionsPlayerFunctionsNo

CoreProgressProps

Extends InterfaceProgressProps.

FieldTypeOptionalDescription
onFinishfunctionYes
onCancelfunctionYes

CriminalRecord

FieldTypeOptionalDescription
hasRecordbooleanNo
datestringYes

Functions

Cobalt.Functions, called with a dot. Each entry is tagged with the side it exists on.

Gang

FieldTypeOptionalDescription
namestringNo
labelstringNo
isbossbooleanNo
gradeGradeNo

GangDefinition

FieldTypeOptionalDescription
labelstringNo
societybooleanYes
gradestable<string, GangGradeDefinition>No

GangGradeDefinition

FieldTypeOptionalDescription
namestringNo
isbossbooleanYes

Grade

FieldTypeOptionalDescription
namestringNo
levelintegerNo
paymentintegerYes
isbossbooleanYes

Job

FieldTypeOptionalDescription
namestringNo
labelstringNo
type'none' | 'leo' | 'ems' | 'mechanic' | stringYes
ondutybooleanNo
isbossbooleanNo
gradeGradeNo

JobGradeDefinition

FieldTypeOptionalDescription
namestringNo
paymentintegerNo
isbossbooleanYes

Licences

FieldTypeOptionalDescription
driverbooleanNo
businessbooleanNo
weaponbooleanNo

LicenseRecord

FieldTypeOptionalDescription
heldbooleanNo
grantedAtintegerYesunix time of the grant, missing for grants made before it was recorded
grantedBystringYeswho granted it, such as LSPD or the DMV
revokedAtintegerYesunix time of the last revocation, while it is not held
pointsintegerNopoints on it, kept after the points limit revokes it and cleared by a new grant
pointsLimitintegerYes

LicenseType

FieldTypeOptionalDescription
labelstringNo
pointsLimitintegerYespoints that revoke it, missing for a licence without points

LogLevel

'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'security'

MoneyType

'cash' | 'bank' | 'crypto' | string

NotifyType

'primary' | 'inform' | 'info' | 'success' | 'warning' | 'warn' | 'error'

OrgResult

'success' | 'invalid_job_name' | 'job_exists' | 'job_not_exists' | 'invalid_gang_name' | 'gang_exists' | 'gang_not_exists' | 'invalid_method_name' | 'invalid_field_name'

PlayerData

FieldTypeOptionalDescription
sourceintegerYesnil on a character loaded from the database
citizenidstringNo
licensestringNo
phone_numberstringYesthe number npwd stored in players.phone_number, nil until npwd gives the character one
stateidintegerNothe player's permanent number across all their characters, issued in join order; also on the player's replicated cobalt:stateid state bag
namestringNo
cidintegerNo
charinfoCharInfoNo
moneytable<MoneyType, integer>No
jobJobYesthe same table as metadata.job; SetMetaData sets both
gangGangYesthe same table as metadata.gang; SetMetaData sets both
metadataPlayerMetadataNo
positionvector3 | vector4No
[string]anyNo

PlayerFunctions

PlayerMetadata

FieldTypeOptionalDescription
cashintegerNo
hungernumberNo0 to 100
thirstnumberNo0 to 100
stressnumberNo
isdeadbooleanNo
inlaststandbooleanNo
armornumberNo
ishandcuffedbooleanNoset while cobalt_police has the character restrained
optinbooleanNoadmins with this on receive player reports
statustableNo
reptable<string, integer>No
callsignstringNo
bloodtypestringNo
fingerprintstringNo
walletidstringNo
criminalrecordCriminalRecordNo
licencesLicencesNo
starterApartmentstringYes
jobJobYescobalt_management's job; players.job_name indexes its name
gangGangYescobalt_management's gang; players.gang_name indexes its name
secondjobstable<string, table>Nocobalt_management's second jobs, keyed by job name
[string]anyNo

PlayerModule

Server. Cobalt.Player: loading, saving and deleting characters.

Shared

FieldTypeOptionalDescription
Jobstable<string, CoreJobDefinition>No
Gangstable<string, GangDefinition>No
Vehiclestable<string, SharedVehicle>No
VehicleHashestable<integer, SharedVehicle>No
LocationstableNo
ForceJobDefaultDutyAtLoginbooleanNo
MaleNoGlovestable<integer, true>No
FemaleNoGlovestable<integer, true>No

SharedVehicle

FieldTypeOptionalDescription
modelstringNo
spawncodestringNo
namestringNo
brandstringNo
priceintegerNo
categorystringNovehicle class name, such as 'compacts' or 'super'
classintegerYesGTA vehicle class number of category, 0 to 22; nil for a category GTA has no class for
typestringNovehicle type, such as 'automobile' or 'boat'
hashintegerNo
shopsstring[]Yesdealerships that sell it; without it, every dealership selling its category does
shopstring[]Yessame as shops, for qb-core scripts
imagestringYesdealership preview image for add-on cars
enabledbooleanYesfalse stops dealerships selling it

StreetName

FieldTypeOptionalDescription
mainstringNo
crossstringNo

TempJob

FieldTypeOptionalDescription
namestringNo
labelstringNo
datatable?No
resourcestringNothe resource that set it; the job clears when that resource stops

cobalt_management

GangPermission

'vault_view' | 'vault_deposit' | 'vault_withdraw' | 'vault_audit' | 'gang_invite'

ManagementEmployee

FieldTypeOptionalDescription
citizenidstringNo
namestringNo
gradeintegerNo
rankstringNo
payintegerNoper payday, after the boss's pay changes
isBossbooleanNo
onlinebooleanNo
onDutybooleanNo
onLeavebooleanNo
joinedAtstringYesISO 8601 UTC
shiftStartedAtstringYesISO 8601 UTC
weekMinutesintegerNo
lastWeekMinutesintegerNo
monthBonusesintegerNo
sourceintegerYesserver id when online

ManagementFleetVehicle

FieldTypeOptionalDescription
platestringNo
modelstringNo
labelstringNo
minGradeintegerNolowest grade that may drive it

ManagementGang

FieldTypeOptionalDescription
namestringNo
labelstringNo
isbossbooleanNo
gradetableNo
sinceintegerYesunix seconds when the character joined the gang; nil outside a gang
permissionsGangPermission[]Yesserver only: what the member's rank can do
founderCidstringYesserver only

ManagementJob

FieldTypeOptionalDescription
namestringNo
labelstringNo
typestringNoleo, ems, mechanic, or the job's own type
ondutybooleanNo
isbossbooleanNo
gradetableNo
sinceintegerYesunix seconds when the character joined the job

ManagementJobStatus

FieldTypeOptionalDescription
openbooleanNofalse while staff keep the job closed
paidTodayintegerNodollars paid out for the job since midnight, server time

ManagementMenu

'job' | 'gang' | 'gangAdmin' | 'apply' | 'charter'

ManagementPermission

'open_menu' | 'view_dashboard' | 'give_bonus' | 'society'

cobalt_interfaces

AlertProps

FieldTypeOptionalDescription
headerstringNo
contentstringYes
type'confirm' | 'danger'Yes
iconstringYes
cancelbooleanYes
labelstableYes

ContextMenu

FieldTypeOptionalDescription
idstringNo
titlestringNo
menustringYesid of the parent menu; shows a back button
canClosebooleanYes
onExitfunctionYes
onBackfunctionYes
optionstable | ContextOption[]No

ContextOption

FieldTypeOptionalDescription
titlestringYes
descriptionstringYes
iconstringYesPhosphor icon name (common Font Awesome names also resolve)
iconColorstringYes
progressnumberYes0 to 100
colorSchemestringYeshex, or blue, green, yellow, orange, red
arrowbooleanYes
menustringYesid of a submenu to open
disabledbooleanYes
readOnlybooleanYes
onSelectfunctionYes
eventstringYes
serverEventstringYes
argsanyYes

InputOptions

FieldTypeOptionalDescription
allowCancelbooleanYes
iconstringYes
descriptionstringYes
submitTextstringYes
cancelTextstringYes

InputRow

FieldTypeOptionalDescription
type'input' | 'number' | 'select' | 'multi-select' | 'slider' | 'checkbox' | 'textarea' | 'date' | 'color'Yes
labelstringNo
descriptionstringYes
placeholderstringYes
iconstringYes
prefixstringYes
requiredbooleanYes
disabledbooleanYes
defaultanyYes
checkedbooleanYes
passwordbooleanYes
minnumberYes
maxnumberYes
stepnumberYes
optionstable[]Yes
returnStringbooleanYes

InterfaceNotifyProps

FieldTypeOptionalDescription
idstringYesreplaces a visible notification with the same id
titlestringYes
descriptionstringYes
type'success' | 'error' | 'warning' | 'info' | 'inform'Yes
durationnumberYesmilliseconds, 5000 by default
iconstringYesPhosphor icon name
iconColorstringYes

InterfaceProgressProps

FieldTypeOptionalDescription
labelstringYes
durationnumberNomilliseconds
iconstringYesPhosphor icon name
useWhileDeadbooleanYes
allowRagdollbooleanYes
allowCuffedbooleanYes
allowFallingbooleanYes
allowSwimmingbooleanYes
canCancelbooleanYes
animtableYes
proptableYessame shape as ox_lib's progress props
disabletableYes

InterfaceRadialItem

FieldTypeOptionalDescription
idstringNo
labelstringNo
iconstringYesPhosphor icon name
menustringYesid of a menu from registerRadial, opened in place
onSelectfunctionYes
eventstringYes
serverEventstringYes
argsanyYes
keepOpenbooleanYes
disabledboolean | functionYes
canInteractfunctionYes

InterfaceTextUIOptions

FieldTypeOptionalDescription
keystringYeskeycap label; "[E] - Open trunk" also works
iconstringYesPhosphor icon name, shown when there is no key
position'left-center' | 'right-center' | 'top-center' | 'bottom-center'Yes

RadialMenu

FieldTypeOptionalDescription
idstringNo
labelstringYes
itemsInterfaceRadialItem[]No

SkillCheckDifficulty

'easy' | 'medium' | 'hard' | table

cobalt_inventory

InventoryAccessMode

'readonly' | 'remove' | 'full'

InventoryCarryAction

ValueDescription
'sprint'
'jump'
'enterVehicle'getting into a vehicle
'combat'aiming, shooting and melee

InventoryContainer

FieldTypeOptionalDescription
slotsintegerNocells in the inventory the item opens
maxWeightintegerNograms it holds
whiteliststring[]Yesthe only item names it takes; nil takes any item but another container

InventoryGroups

job or gang names, or names mapped to the lowest grade allowed or to a list of the grades allowed

string[] | table<string, integer | integer[]>

InventoryItem

FieldTypeOptionalDescription
idstringNouuid, stable across moves
namestringNo
labelstringNo
descriptionstringYes
xintegerNogrid column, 0 to 4
yintegerNogrid row, 0-based
rotatedbooleanNo
amountintegerNo
metadataInventoryItemMetadataNo

InventoryItemCarry

FieldTypeOptionalDescription
modelstringNoprop model
boneintegerNoped bone the prop attaches to
posvector3Noattach offset
rotvector3Noattach rotation
animtableYeslooped while carrying; use an upper-body flag such as 49 so the player can walk
disableInventoryCarryAction[]Yeswhat the player can't do while carrying it

InventoryItemClient

FieldTypeOptionalDescription
usetimeItemRangeYesprogress bar length in ms
labelstringYeskey in locales/en.json for the progress bar text; default "Using <label>"
animtableYes
propInventoryItemProp | InventoryItemProp[]Yesheld while the progress bar runs
imagestringYesimage file in _nui/images, or a full URL; ox_inventory callers read it as a full path
disabletable<string, boolean>Yescontrols disabled during the progress, default { combat = true }
cancelbooleanYesthe progress can be cancelled, default true
statustableYesapplied on the server after the item is removed; negative stress relieves it
notificationstringYeskey in locales/en.json for the text shown after use, beside the "Used" item box
exportstringYesresource.Export, called on the client as (event, item, slot), or as (data, { name, slot, metadata }) when the export's resource is neither a cobalt_ resource nor authored by Project Cobalt
exportStyle'cobalt' | 'ox'Yeswhich call export gets, overriding the guess from its resource's author
eventstringYesclient event fired with (data, { name, slot, metadata }); the handler calls useItem to go ahead
[string]anyNoextra data the export reads from item.client

InventoryItemDef

FieldTypeOptionalDescription
namestringNo
labelstringNo
descriptionstringYes
weightintegerNograms per unit
consumeintegerYestaken from the stack on use, 0 keeps it; defaults to 1 when the item has status, usetime or an export
closebooleanYescloses the inventory on use, default true
stackfalseYeseach one takes its own cell, as in ox_inventory; containers and weapons other than throwables never stack
containerInventoryContainerYesthe item is a bag, case or wallet that opens this inventory
weapontrueYesthe item is the GTA weapon of the same name, set at start for each weapon data/weapons.lua lists
throwabletrueYesa thrown weapon, one throw per item, that stacks and has no serial or durability
clientInventoryItemClientYes
serverInventoryItemServerYes
carryInventoryItemCarryYesheld in the hands while the player has any of the item

InventoryItemMetadata

FieldTypeOptionalDescription
durabilitynumberYes0 to 100, set on weapons
serialstringYesset on weapons
ammointegerYesrounds loaded in a weapon
ammoTypestringYes
[string]anyNo

InventoryItemProp

FieldTypeOptionalDescription
modelstringNo
boneintegerNoped bone the prop attaches to
posvector3No
rotvector3No

InventoryItemServer

FieldTypeOptionalDescription
exportstringYesresource.Export, called on the server as (event, item, inventory, slot, data), or as ox_inventory calls it, (event, item, inventory, slot) in ox's shapes, when the export's resource is neither a cobalt_ resource nor authored by Project Cobalt
exportStyle'cobalt' | 'ox'Yeswhich call export gets, overriding the guess from its resource's author
[string]anyNoextra data the export reads from item.server

InventorySearchOptions

FieldTypeOptionalDescription
modeInventoryAccessModeYesdefault readonly

InventoryShop

FieldTypeOptionalDescription
labelstringNothe name on the shop's header
itemstable<string, InventoryShopItem>Nokeyed by item name
payment'cash' | 'bank' | ('cash' | 'bank')[]Yeshow players may pay; nil takes both
groupsstring | InventoryGroupsYesthe jobs or gangs that may open it, at a grade; nil lets anyone
licensestringYesa cobalt_core licence the player must hold to open it

InventoryShopItem

FieldTypeOptionalDescription
pricenumberNodollars for one
stockintegerYeshow many it holds until cobalt_inventory restarts; nil for unlimited
tagsstring[]Yesfilter tags, each a shop_tag.<tag> key in cobalt_inventory's locales/en.json
licensestringYesa cobalt_core licence the buyer must hold
groupsInventoryGroupsYesthe jobs or gangs that may buy it
metadatatableYesmetadata on every one sold

InventoryStash

FieldTypeOptionalDescription
labelstringNothe name on the inventory header; in data/stashes.lua a key in locales/en.json
slotsintegerNocells, laid out 5 to a row
maxWeightintegerNograms it holds
ownertrue | stringYeswhose copy opens: true gives each character their own copy, a citizenid or a license keeps one copy under that owner, nil keeps one shared copy. It never limits who opens the stash
groupsstring | InventoryGroupsYesthe jobs or gangs that may open it, at a grade; nil lets anyone
coordsvector3 | vector3[]Yeswhere it opens: players must be within 5 meters of a point. data/stashes.lua also puts an ox_target zone at each point; a registered stash relies on the calling resource's own prompt
whiteliststring[]Yesthe only item names it takes; nil takes any item
instanceinteger | stringYesthe routing bucket players must be in to open it; nil or 0 for any

InventoryWeapon

FieldTypeOptionalDescription
namestringNoweapon item name, e.g. weapon_pistol
invNamestringNo
itemIdstringNo
metadataInventoryItemMetadataNo

ItemRange

number | table

cobalt_banking

BankingAccessibleAccount

FieldTypeOptionalDescription
accountIdBankingAccountIdNo
typeBankingAccountTypeNo
namestringNothe account label, or the org's label for a society account
balanceintegerNo
primarybooleanNo
roleBankingMemberRoleNoon a society account: owner for a boss, member with the society rank permission, viewer for the rest of the org

BankingAccount

FieldTypeOptionalDescription
idBankingAccountIdNo
accountIdBankingAccountIdNo
typeBankingAccountTypeNo
labelstring?No
balanceintegerNo
ownerCidstring?No
createdAtintegerNoepoch seconds
membersBankingAccountMember[]Yesonly on rows the bank app loads with their members

BankingAccountId

string

BankingAccountMember

FieldTypeOptionalDescription
cidstringNo
roleBankingMemberRoleNo
addedAtintegerNoepoch seconds

BankingAccountRef

an account id (CB 1234 5678, also read without spaces, or society_<org>), or a citizenid for that character's personal account

BankingAccountId | string

BankingAccountType

'personal' | 'shared' | 'society'

BankingCashPointView

FieldTypeOptionalDescription
xnumberNo
ynumberNo
znumberNo
labelstringNo
atmbooleanNo

BankingDetails

FieldTypeOptionalDescription
notestringYesthe line shown on the statement
initiatorstringYesrecorded as initiated_by: a citizenid, or a system tag such as payroll or ems, which statements show with no name

BankingFailure

ValueDescription
'invalid_amount'
'not_found'
'no_permission'
'same_account'
'insufficient_funds'
'already_member'
'member_limit'
'invalid_invoice'a malformed invoice, filter, payment method or void reason
'settled'the invoice is already paid or void
'payer_offline'a cash payment needs the payer online

BankingInvoice

FieldTypeOptionalDescription
idintegerNo
issuerstringNothe job, gang or kind that sent it, such as ambulance
citizenidstringNothe character who owes it
payerNamestringNo
payeeBankingAccountIdNothe account it pays into
issuerCitizenidstring?Nothe character who wrote it; nil when the system sent it or that character was deleted
issuerNamestring?No
summarystringNowhat it's for, shown on the bank statement; may be empty
amountintegerNo
statusBankingInvoiceStatusNo
dataBankingInvoiceDataNo
dueAtintegerNoepoch seconds
createdAtintegerNoepoch seconds
declinedAtinteger?Noepoch seconds the payer last turned it down or their bank couldn't cover it
paidAtinteger?Noepoch seconds
voidReasonstring?No

BankingInvoiceData

FieldTypeOptionalDescription
linesBankingInvoiceLine[]Yesthe itemized charges behind amount
reportIdintegerYesthe issuer's report the invoice bills for
[string]anyNoanything else the issuer keeps on it

BankingInvoiceInput

FieldTypeOptionalDescription
issuerstringNothe job, gang or kind sending it, up to 32 characters
citizenidstringNothe character who owes it
amountnumberNoa whole amount from 1 to 1000000000
summarystringYesup to 255 characters
payeeBankingAccountRefYesthe account it pays into; defaults to society_<issuer>
issuerCitizenidstringYesthe character writing it
issuerNamestringYesup to 120 characters; defaults to the name of issuerCitizenid
dueDaysintegerYes1 to 365; defaults to InvoiceDueDays in the config
dataBankingInvoiceDataYes

BankingInvoiceLine

FieldTypeOptionalDescription
labelstringNo
amountintegerNo

BankingInvoiceMethod

ValueDescription
'bank'from the payer's personal account; a short balance records declinedAt
'cash'from the payer's pocket; needs them online
'cash_or_bank'cash when they're online and carry enough, the bank otherwise
'manual'marks it paid without moving money, for payment taken some other way

BankingInvoicePayment

FieldTypeOptionalDescription
methodBankingInvoiceMethodYesdefault bank

BankingInvoiceQuery

FieldTypeOptionalDescription
citizenidstring | string[]Yes
issuerstringYes
statusBankingInvoiceStatusYesunpaid includes overdue ones
datatable<string, string|number|boolean>Yestop-level data keys that must equal these values
limitintegerYes1 to 500, default 50
beforeintegerYesan invoice id; returns older ones, for paging

BankingInvoiceResult

table | BankingRefusal

BankingInvoiceStatus

ValueDescription
'unpaid'
'overdue'unpaid past dueAt
'paid'
'void'

BankingInvoiceTotals

FieldTypeOptionalDescription
unpaidintegerNodollars on unpaid invoices, overdue ones included
unpaidCountintegerNo
overdueintegerNo
overdueCountintegerNo
billedintegerNodollars invoiced since since, void ones excluded
paidintegerNodollars paid since since
owedtable<string, integer>Nounpaid dollars per citizenid in the filter, for those who owe any

BankingInvoiceTotalsQuery

FieldTypeOptionalDescription
citizenidstring | string[]Yesalso fills owed for these characters
issuerstringYes
sinceintegerYesepoch seconds that start the billed and paid window; default 7 days ago

BankingMember

FieldTypeOptionalDescription
citizenidstringNo
namestringNo
roleBankingMemberRoleNo
rankstringYesthe org rank, on society members

BankingMemberList

FieldTypeOptionalDescription
oktrueNo
accountIdBankingAccountIdNo
typeBankingAccountTypeNo
roleBankingMemberRoleNothe caller's role
canManagebooleanNo
maxMembersintegerNo
membersBankingMember[]No

BankingMemberRole

'owner' | 'admin' | 'member' | 'viewer'

BankingParty

FieldTypeOptionalDescription
accountIdBankingAccountIdNo
typeBankingAccountType?No
namestring?No

BankingRecipient

FieldTypeOptionalDescription
accountIdBankingAccountIdNo
typeBankingAccountTypeNo
labelstringYesthe account's own label, on FindRecipient results
namestringNo
lastAtintegerYesepoch seconds of the last transfer, on GetRecentRecipients rows

BankingRefusal

FieldTypeOptionalDescription
okfalseNo
reasonBankingFailureNo

BankingStatementEntry

FieldTypeOptionalDescription
idintegerNo
accountIdBankingAccountIdNo
typeBankingTransactionTypeNo
amountintegerNonegative for money out
notestring?No
balanceAfterinteger?No
receiptstring?No
counterpartyBankingParty?No
initiatortable?Noname is nil for system initiators such as payroll
createdAtintegerNoepoch seconds

BankingStatementPage

FieldTypeOptionalDescription
oktrueNo
entriesBankingStatementEntry[]Nonewest first
nextCursorinteger?No

BankingStatementQuery

FieldTypeOptionalDescription
limitintegerYes1 to 50, default 20
beforeintegerYesthe nextCursor of the previous page
direction'all' | 'in' | 'out'Yes

BankingTransactionType

ValueDescription
'deposit'
'withdrawal'
'transfer_in'
'transfer_out'
'fee'
'paycheck'
'bill_paid'a character paying an invoice, or a Transfer with bill = true
'bill_received'the payee's side of that bill
'admin_credit'
'admin_debit'

BankingTransferDetails

Extends BankingDetails.

FieldTypeOptionalDescription
billbooleanYesrecord bill_paid and bill_received instead of transfer_out and transfer_in

BankingTransferReceipt

FieldTypeOptionalDescription
oktrueNo
balanceintegerNothe source account's balance after the transfer and fee
feeintegerNo
receiptstringNo
transactionIdintegerNothe source account's transfer_out entry
toAccountIdBankingAccountIdNo

BankingTransferRequest

FieldTypeOptionalDescription
fromBankingAccountIdNo
tostringNoaccount number or citizen ID, which sends to that character's personal account
amountintegerNo
notestringYes

BankingTransferResult

BankingTransferReceipt | BankingRefusal

cobalt_housing

HousingBoxZone

FieldTypeOptionalDescription
kind'box'No
coordsvector3No
sizevector3No
rotationnumberNo

HousingPolyZone

FieldTypeOptionalDescription
kind'poly'No
pointsvector3[]No
thicknessnumberNo

HousingProperty

Extends HousingPropertySummary.

FieldTypeOptionalDescription
ownerstringYescitizenid
priceintegerNo
zoneHousingZoneYes

HousingPropertySummary

FieldTypeOptionalDescription
idintegerNo
namestringNo
shellstringNo
doorvector4No
garagevector4Yes

HousingZone

HousingPolyZone | HousingBoxZone

cobalt_police

PoliceBlip

'default' | 'panic' | 'robbery' | 'shooting' | 'vehicle' | 'medical' | 'call' | 'explosion'

PoliceCall

FieldTypeOptionalDescription
idintegerNo
codestringNo
titlestringNo
descriptionstringNo
locationstringNo
platestringYes
coordsvector3Yes
priority1 | 2 | 3No
jobsPoliceDispatchJob[]No
blipstringNo
callertableYes
raisedBystringYes
respondersPoliceCallResponder[]No
notestable[]No
status'open' | 'closed'No
createdAtintegerNoepoch seconds

PoliceCallResponder

FieldTypeOptionalDescription
citizenidstringNo
namestringNo
callsignstringNo

PoliceCuffType

'cuffs' | 'zipties'

PoliceDispatchInput

FieldTypeOptionalDescription
titlestringNo
codestringYesdefaults to '10-80'
descriptionstringYes
locationstringYesstreet and area; clients fill it from coords when empty
coordsvector3Yes
priority1 | 2 | 3Yes1 is the most urgent, defaults to 2
jobsPoliceDispatchJob[]Yesdefaults to { 'leo' }
blipPoliceBlipYes
callertableYes
raisedBystringYes

PoliceDispatchJob

'leo' | 'ems'

PoliceMdtPage

'dashboard' | 'dispatch' | 'citizens' | 'vehicles' | 'weapons' | 'properties' | 'incidents' | 'warrants' | 'bolos' | 'evidence' | 'penalcode' | 'roster' | 'management'

cobalt_ambulancejob

AmbulancePrescription

FieldTypeOptionalDescription
idintegerNo
citizenidstringNo
patientNamestringNo
medicationstringNo
dosestringNo
reasonstringNo
refillsintegerNofills allowed after the first
refillsUsedintegerNorefills taken, 0 until the second fill
controlledbooleanNo
prescriberstringNo
createdAtintegerNoepoch seconds
endsAtintegerNoepoch seconds
status'active' | 'expired' | 'cancelled'No
lastFilltableYesthe latest pharmacy fill, at in epoch seconds; nil until first filled

AmbulanceReportSummary

FieldTypeOptionalDescription
idintegerNo
citizenidstring?No
patientNamestringNo
summarystringNo
medicstringNo
medicCitizenidstring?No
outcome'scene' | 'transported' | 'deceased' | 'respawned'No
status'draft' | 'filed'No
billing'pending' | 'billed' | 'waived'No
billedinteger?No
createdAtintegerNoepoch seconds

AmbulanceReviveStateName

'alive' | 'knocked_out' | 'down' | 'dead'

cobalt_cityhall

CrewMemberView

FieldTypeOptionalDescription
idintegerNo
namestringNo
leaderbooleanNo
earnedintegerNo

ShiftView

FieldTypeOptionalDescription
jobstringNo
startedAtintegerNounix seconds
earnedintegerNo
doneintegerNo
crewCrewMemberView[]No
taskTaskViewYes
vehicleintegerYesnetwork id
carryingbooleanYesholding a trash bag

TaskView

FieldTypeOptionalDescription
titlestringNo
labelstringNo
coordsvector3No
radiusnumberNo
stepstringYes
stagestringYes
progresstableYes
openbooleanYesthe back of the crew vehicle is open
taskstringYesthe stop's task key
headingnumberYesthe way the player faces for the work
markerbooleanYes
passengervector4Yesthe pavement a taxi fare waits on at a pickup and walks to at a drop-off
distanceintegerYesmeters from the player, filled in on the client

cobalt_sound

SoundData

FieldTypeOptionalDescription
soundstringNofile in sounds/ (alert or alert.ogg) or an http(s) URL on an allowed host
coordsvector3Yes
entityintegerYesnetwork id
playerintegerYesserver id, or -1 for everyone
bucketintegerYesrouting bucket of a coords sound, default 0; an entity sound plays in the entity's bucket
volumenumberYes0 to 1, default 1
distancenumberYesmeters
falloffnumberYescurve exponent, 1 is linear
loopbooleanYes
pausedbooleanYes
offsetnumberYesseconds to start from

cobalt_weather

WeatherReport

Extends WeatherState.

FieldTypeOptionalDescription
blackoutbooleanNo

WeatherState

FieldTypeOptionalDescription
currentWeatherTypeNo
nextWeatherTypeYes
transitionnumberNoseconds
changesAtintegerYesunix time of the next change
frozenbooleanNo

WeatherTime

FieldTypeOptionalDescription
hourintegerNo0 to 23
minuteintegerNo0 to 59
frozenbooleanNo

WeatherType

'EXTRASUNNY' | 'CLEAR' | 'NEUTRAL' | 'SMOG' | 'FOGGY' | 'OVERCAST' | 'CLOUDS' | 'CLEARING' | 'RAIN' | 'THUNDER' | 'SNOW' | 'BLIZZARD' | 'SNOWLIGHT' | 'XMAS' | 'HALLOWEEN'

cobalt_map

MapPostal

FieldTypeOptionalDescription
codestringNo
xnumberNo
ynumberNo

cobalt_chat

ChatLegacyMessage

FieldTypeOptionalDescription
argsany[]Yes{ author, text }, or { text } for a message from System
colorinteger[]Yes
multilinebooleanYes
templatestringYes

ox_doorlock

OxDoorlockAuthorizationPayload

FieldTypeOptionalDescription
sourceintegerNo
doortableNo
lockpickbooleanYes
authorisedboolean | stringYes

OxDoorlockClientDoor

Extends OxDoorlockDoor.

FieldTypeOptionalDescription
entityintegerYes
distancenumberNo
hideUibooleanYes

OxDoorlockDoor

FieldTypeOptionalDescription
idintegerNo
namestringNo
state0 | 1No0 unlocked, 1 locked
coordsvector3No
charactersstring[]Yes
groupstable<string, integer>Yesgroup name to minimum grade
itemstable[]Yesremove takes the item on use
maxDistancenumberNo

OxDoorlockHookOptions

FieldTypeOptionalDescription
printbooleanYesprint each time the hook runs
nameFilterstringYesLua pattern the door name must match

ox_lib

SkillCheckDifficulity

'easy' | 'medium' | 'hard' | table

On this page

cobalt_coreBanIdentifierBanOptionsCardItemMetadataCharInfoCommandsCoreCoreAccountCoreAccountBanCoreAccountCharacterCoreAccountOnlineCoreJobDefinitionCorePlayerCoreProgressPropsCriminalRecordFunctionsGangGangDefinitionGangGradeDefinitionGradeJobJobGradeDefinitionLicencesLicenseRecordLicenseTypeLogLevelMoneyTypeNotifyTypeOrgResultPlayerDataPlayerFunctionsPlayerMetadataPlayerModuleSharedSharedVehicleStreetNameTempJobcobalt_managementGangPermissionManagementEmployeeManagementFleetVehicleManagementGangManagementJobManagementJobStatusManagementMenuManagementPermissioncobalt_interfacesAlertPropsContextMenuContextOptionInputOptionsInputRowInterfaceNotifyPropsInterfaceProgressPropsInterfaceRadialItemInterfaceTextUIOptionsRadialMenuSkillCheckDifficultycobalt_inventoryInventoryAccessModeInventoryCarryActionInventoryContainerInventoryGroupsInventoryItemInventoryItemCarryInventoryItemClientInventoryItemDefInventoryItemMetadataInventoryItemPropInventoryItemServerInventorySearchOptionsInventoryShopInventoryShopItemInventoryStashInventoryWeaponItemRangecobalt_bankingBankingAccessibleAccountBankingAccountBankingAccountIdBankingAccountMemberBankingAccountRefBankingAccountTypeBankingCashPointViewBankingDetailsBankingFailureBankingInvoiceBankingInvoiceDataBankingInvoiceInputBankingInvoiceLineBankingInvoiceMethodBankingInvoicePaymentBankingInvoiceQueryBankingInvoiceResultBankingInvoiceStatusBankingInvoiceTotalsBankingInvoiceTotalsQueryBankingMemberBankingMemberListBankingMemberRoleBankingPartyBankingRecipientBankingRefusalBankingStatementEntryBankingStatementPageBankingStatementQueryBankingTransactionTypeBankingTransferDetailsBankingTransferReceiptBankingTransferRequestBankingTransferResultcobalt_housingHousingBoxZoneHousingPolyZoneHousingPropertyHousingPropertySummaryHousingZonecobalt_policePoliceBlipPoliceCallPoliceCallResponderPoliceCuffTypePoliceDispatchInputPoliceDispatchJobPoliceMdtPagecobalt_ambulancejobAmbulancePrescriptionAmbulanceReportSummaryAmbulanceReviveStateNamecobalt_cityhallCrewMemberViewShiftViewTaskViewcobalt_soundSoundDatacobalt_weatherWeatherReportWeatherStateWeatherTimeWeatherTypecobalt_mapMapPostalcobalt_chatChatLegacyMessageox_doorlockOxDoorlockAuthorizationPayloadOxDoorlockClientDoorOxDoorlockDoorOxDoorlockHookOptionsox_libSkillCheckDifficulity