Commands and Exports

Commands#

Command	Who	What it does
`phone:toggle`	Everyone	Opens or closes the phone. Bound to F1 (`Config.Phone.openKey`).
`phone_peek_call_accept / phone_peek_call_reject`	Everyone	Answer (Q) or decline (E) an incoming call with the phone closed.

Commands and Exports | Quasar Store

Export	Returns	What it does
`IsPhoneOpen()`	boolean	Whether the phone is open.
`ToggleDisabled(disabled)`	—	Blocks the phone (`true`) or allows it again. Use it in jails, minigames or cutscenes.
`IsDisabled()`	boolean	Whether the phone is blocked.
`OpenPhoneApp(appId)`	boolean	Opens an app while the phone is open. `false` if the phone is closed or the id is wrong.
`call(number, callType, opts)`	table	Starts an `'audio'` or `'video'` call.
`GetSignalLevel()`	string	`'full'`, `'mid'`, `'low'` or `'none'` where the player stands.
`BatteryRegisterHousingCharger(houseId, coords, radius)`	—	Adds a charger inside a house.
`BatteryUnregisterHousingCharger(houseId)`	—	Removes it.

lua

-- Block the phone while the player is in jail
exports['qs-smartphone']:ToggleDisabled(true)

-- Start a call from your script
local result = exports['qs-smartphone']:call('555-0100', 'audio', {
    callerNumberOverride = '555-9999', -- optional
})
if not result.success then
    print(result.error, result.message)
end

-- House charger for qs-housing
exports['qs-smartphone']:BatteryRegisterHousingCharger(houseId, vector3(x, y, z), 2.0)

lua

exports['qs-smartphone']:showDynamicIsland({
    id = 'delivery-status',
    icon = 'tram_fill',      -- Framework7 icon name
    title = 'Delivery',
    subtitle = 'On the way',
    color = '#22c55e',
    progress = 45,           -- optional 0-100 bar
    priority = 65,
    duration = 8000,         -- optional auto-hide (ms)
    persistent = true,       -- stays when the phone closes
    expandedContent = {
        lines = { { label = 'ETA', value = '4 min' } },
        actions = { { id = 'track', label = 'Track', icon = 'map' } },
    },
    onClick = function() end,
    onDismiss = function() end,
})

exports['qs-smartphone']:updateDynamicIsland('delivery-status', { progress = 80 })
exports['qs-smartphone']:hideDynamicIsland('delivery-status')

AddEventHandler('phone:dynamicIsland:action', function(islandId, actionId)
    if islandId == 'delivery-status' and actionId == 'track' then
        -- set a waypoint
    end
end)

Export	What it does
`addCustomApp(payload)`	Registers one app. Returns `success, errorCode`. See Integrations.
`addCustomAppsBatch(payloads)`	Registers several apps at once.
`updateCustomApp(appId, patch)`	Changes fields, for example `{ price = 900 }`.
`removeCustomApp(appId)`	Removes an app.
`getCustomApps()`	Lists every registered app.

lua

-- The player's active number
local number = exports['qs-smartphone']:GetCurrentPhoneNumber(source)

-- The player's phone id (device), needed for notifications by scope
local scopeId = exports['qs-smartphone']:getPhoneScopeIdentifier(source)

-- Push notification to a player
exports['qs-smartphone']:sendPhoneNotification(source, {
    appId = 'my_app',
    title = 'New order',
    text = 'Your package is ready for pickup.',
    closeTimeout = 5000,
})

-- Same, by phone id
exports['qs-smartphone']:sendPhoneNotificationToScope(scopeId, { appId = 'my_app', title = 'Hello', text = 'World' })

-- Block or allow a player's phone
exports['qs-smartphone']:ToggleDisabled(source, true)

lua

-- Short form: by number or by player id
exports['qs-smartphone']:SendNewMessageFromApp('555-0100', 'Bank', 'Your account has been credited with $500.')
exports['qs-smartphone']:SendNewMessageFromApp(source, 'Job Center', 'Your application has been approved.')

-- Full form
local result = exports['qs-smartphone']:SendNewMessageFromApp({
    source = source,          -- or targetPhone = '555-0100'
    appLabel = 'City Hall',   -- sender name
    message = 'You have been hired as a mechanic.', -- max 4096 characters
    requireOnline = false,    -- true = fail if the player is offline
    push = { title = 'City Hall', text = 'You have a new message' }, -- false = no notification
})

if not result.ok then
    print(result.error) -- e.g. TARGET_PHONE_NOT_FOUND
end

lua

-- Short form
exports['qs-smartphone']:SendMail(source, 'Parking fine', 'You have been fined $500.', 'City Hall')
exports['qs-smartphone']:SendMail('[email protected]', 'Welcome', 'Thanks for joining the server.')

-- Full form
local result = exports['qs-smartphone']:SendMail({
    targetSource = source,              -- or to = '[email protected]' / { ... }, or targetIdentifier
    subject = 'Service notice',         -- max 500 characters
    body = 'Your impound fee is due.',  -- max 60000 characters
    fromName = 'LSPD',
    fromEmail = '[email protected]',
    push = true,                        -- false = no notification
})

-- Does the player have a Mail account?
local account = exports['qs-smartphone']:GetMailAccount(source) -- nil, or { id, email, displayName, ownerIdentifier }

lua

-- Built-in billing only; with another billing script use its own API
local billId, err = exports['qs-smartphone']:CreateBill(targetSource, {
    title = 'EMS',
    subtitle = 'Medical treatment',
    price = 500,
    job = 'ambulance',             -- uses Config.BillingJobs.ambulance as the icon
    avatar = 'f7:cross_case_fill', -- optional
})

local bills = exports['qs-smartphone']:GetBills(source) -- { { id, title, subtitle, price, avatar, job }, ... }
local ok = exports['qs-smartphone']:PayBill(source, billId)

Export	Returns
`JobExists(jobName)`	Whether a shop uses that job.
`IsPlayerOnDuty(source)`	Whether the player is on duty.
`GetDutyJob(source)`	The job they are on duty as, or nil.
`SetDuty(source, jobName?)`	Clock in for that job, or out with no job. `false` if the player is not logged in to Marketplace or has a different job.
`IsJobOnDuty(jobName)`	Whether anyone is on duty for that job.

lua

exports['qs-smartphone']:registerCallInterceptor('555-1234', function(callData)
    -- callData: sessionId, callerSource, callerNumber, callerDisplayName,
    --           calleeSource, calleeNumber, calleeDisplayName, callType

    return { action = 'allow' }   -- ring normally
    -- return { action = 'reject' } -- reject silently
    -- return { action = 'handle' } -- hold the call; you accept or reject it within 30 s
    -- return { action = 'reroute', reroute_target = playerId }
    -- return { action = 'reroute', reroute_targets = { id1, id2 }, reroute_label = 'Mechanic' }
end, { priority = 10 })

-- '*' sees every call (runs after the specific numbers)
exports['qs-smartphone']:registerCallInterceptor('*', function(callData)
    print(('[CALL] %s -> %s'):format(callData.callerNumber, callData.calleeNumber))
    return { action = 'allow' }
end, { priority = -100 })

Export	What it does
`acceptInterceptedCall(sessionId)`	Connects a held call.
`rejectInterceptedCall(sessionId, reason)`	Rejects it.
`letInterceptedCallRing(sessionId)`	Lets it ring the original number.
`getInterceptedCallData(sessionId)`	The held call's data.
`unregisterCallInterceptor(number)`	Removes your interceptor. Also done when your resource stops.
`hasCallInterceptor(number) · getRegisteredCallInterceptors()`	Check what is registered.
`isPlayerInCall(source)`	Whether the player is in a call.
`getActiveCallSession(source)`	The current call: `id`, `phase`, `callerNumber`…
`endCallBySource(source, reason)`	Hangs up the player's call.

Event	Side	When
`phone:opened`	Client, server	The phone opened. Client: `(payload)` with `mode` ('full' or 'peek'). Server: `(source, payload)`. Both carry `phoneNumber`, `scopeId`, `phoneId`, `ownerIdentifier`.
`phone:closed`	Client, server	The phone closed. `payload.reason` is 'user', 'logout' (client) or 'disconnect' (server).
`phone:incomingCall · phone:callState`	Client	A call arrives, or its state changes.
`phone:usable:open`	Client	The player used the phone item.
`phone:device:phoneChanged`	Client	The player switched to another phone item.
`phone:dynamicIsland:action`	Client	A button on your Dynamic Island was pressed.
`qs-smartphone:marketplace:dutyChanged`	Server	Marketplace duty changed: `(accountId, jobName or nil, source)`.
`phone:call:preRing · phone:call:intercepted · phone:call:interceptAccepted · phone:call:interceptRejected`	Server	The steps of an intercepted call.

lua

-- Hide your HUD while the phone is open
AddEventHandler('phone:opened', function(payload)
    if payload.mode == 'full' then
        -- hide HUD
    end
end)

AddEventHandler('phone:closed', function(payload)
    -- show HUD
end)

Commands#

Commands and Exports

Commands and Exports

Commands#

Client Exports#

Dynamic Island#

Custom apps#

Server Exports#

Phone and notifications#

Messages#

Mail#

Bills#

Marketplace duty#

Inventory item use#

Call Interception#

Events#