Exports & Events

Full reference for all client and server exports, events and NUI callbacks exposed by QuanticPhone.

Client exports

Call these from client-side scripts using exports.quanticPhone:ExportName().

HasPhoneOpened() → booleanClient

Returns true if the phone UI is currently visible.

lua

if exports.quanticPhone:HasPhoneOpened() then
    print("Phone is open")
end

GetBatteryLevel() → numberClient

Returns the local player's current battery level (0–100).

lua

local level = exports.quanticPhone:GetBatteryLevel()
print("Battery:", level .. "%")

SetBatteryLevel(level)Client

Sets the local player's battery level. Pass 0–100.

lua

exports.quanticPhone:SetBatteryLevel(100)  -- fully charge

SetCharging(status)Client

Marks the phone as charging (true) or not charging (false).

lua

exports.quanticPhone:SetCharging(true)   -- start charging
exports.quanticPhone:SetCharging(false)  -- stop charging

AddCustomApp(data)Client

Registers a custom app into the phone home screen. See Custom apps guide.

lua

exports.quanticPhone:AddCustomApp({
    id          = "my-app",
    name        = "My App",
    icon        = "nui://my-app/web/icon.png",
    ui          = "nui://my-app/web/index.html",
})

AddKeyBind(keyBind)Client

Registers a custom keybind for use within the phone context.

lua

exports.quanticPhone:AddKeyBind({
    key    = "F5",
    label  = "Open my app",
    action = function() -- callback end,
})

UsePhoneItem(_, slot)Client

Manually triggers the phone-use logic for a specific inventory slot (ox_inventory integration).

lua

exports.quanticPhone:UsePhoneItem(nil, slotId)

RegisterClientCallback(event, handler)Client

Registers a client-side callback handler.

lua

exports.quanticPhone:RegisterClientCallback("myEvent", function(data, cb)
    cb({ ok = true })
end)

TriggerCallback(event, cb, ...)Client

Calls a server-side callback from the client.

lua

exports.quanticPhone:TriggerCallback("getPlayerData", function(data)
    print(data.name)
end)

AwaitCallback(event, ...) → anyClient

Async/await version of TriggerCallback.

lua

local data = exports.quanticPhone:AwaitCallback("getPlayerData")
print(data.name)

Server exports

Call these from server-side scripts using exports.quanticPhone:ExportName().

GetBattery(source) → numberServer

Returns a player's current battery level.

lua

local level = exports.quanticPhone:GetBattery(source)
print("Battery:", level)

SetBattery(source, level)Server

Sets a player's battery level (0–100).

lua

exports.quanticPhone:SetBattery(source, 50)

GetSignalTowers() → tableServer

Returns all registered signal towers.

lua

local towers = exports.quanticPhone:GetSignalTowers()

CreateSignalTower(id, data)Server

Adds a new signal tower at runtime.

lua

exports.quanticPhone:CreateSignalTower("my_tower", {
    coords = vector3(100.0, 200.0, 30.0),
    range  = 1500,
    signal = 80,
    type   = "4G",
})

RemoveSignalTower(id)Server

Removes a signal tower by ID.

lua

exports.quanticPhone:RemoveSignalTower("my_tower")

GetWifiPoints() → tableServer

Returns all registered WiFi hotspots.

lua

local points = exports.quanticPhone:GetWifiPoints()

CreateWifiPoint(id, data)Server

Adds a WiFi hotspot at runtime.

lua

exports.quanticPhone:CreateWifiPoint("cafe_wifi", {
    label    = "CafeWifi",
    coords   = vector2(200.0, -800.0),
    range    = 15.0,
    password = "coffee123",
})

RemoveWifiPoint(id)Server

Removes a WiFi hotspot by ID.

lua

exports.quanticPhone:RemoveWifiPoint("cafe_wifi")

GetEmailAddress(phoneNumber) → stringServer

Returns the email address for a given phone number.

lua

local email = exports.quanticPhone:GetEmailAddress("5511999990000")
print(email)

SendMail(data)Server

Sends an email to a player's phone inbox.

lua

exports.quanticPhone:SendMail({
    phoneNumber = "5511999990000",
    subject     = "Welcome!",
    body        = "Thanks for joining.",
    sender      = "Admin",
})

FilterMessage(text) → boolean, stringServer

Checks if a message contains blacklisted words. Returns filtered status and cleaned text.

lua

local clean, filtered = exports.quanticPhone:FilterMessage(text)
if filtered then TriggerClientEvent("chat:addMessage", src, {args={"Blocked"}}) end

IsURLAllowed(url) → booleanServer

Checks if a URL is on the browser whitelist.

lua

local ok = exports.quanticPhone:IsURLAllowed("https://youtube.com")

IsUploadDomainAllowed(domain) → booleanServer

Checks if a domain is authorized for media uploads.

lua

local ok = exports.quanticPhone:IsUploadDomainAllowed("cdn.fivemanage.com")

SetPublicPhoneSystemEnabled(enabled)Server

Enable or disable public phone booths at runtime.

lua

exports.quanticPhone:SetPublicPhoneSystemEnabled(false)

GetPublicPhoneSystemEnabled() → booleanServer

Returns whether public phones are currently active.

lua

local active = exports.quanticPhone:GetPublicPhoneSystemEnabled()

RegisterCallback(event, handler, opts?)Server

Registers a server-side NUI callback with optional rate limiting.

lua

exports.quanticPhone:RegisterCallback("myAction", function(source, data, cb)
    cb({ ok = true })
end, { rateLimit = 1000 })

TriggerClientCallback(source, event, cb, ...)Server

Calls a client-side callback from the server.

lua

exports.quanticPhone:TriggerClientCallback(source, "getHp", function(hp)
    print("Player HP:", hp)
end)

AwaitClientCallback(source, event, ...) → anyServer

Async/await version of TriggerClientCallback.

lua

local hp = exports.quanticPhone:AwaitClientCallback(source, "getHp")
print("Player HP:", hp)

Events

Event	Side	Description
quanticPhone:phoneOpened	Client	Fired when the phone UI opens
quanticPhone:phoneClosed	Client	Fired when the phone UI closes
quantic:bank:balanceUpdated	Client	Bank/cash balance changed — push a refresh
quanticPhone:updateConnectedWifi	Client	WiFi connection state changed
quanticPhone:setAirplaneMode	Client	Airplane mode toggled
quanticPhone:removePhone	Client	Phone item removed from the player
quanticPhone:client:updatePlayerFlashlight	Client	Flashlight state changed
quanticPhone:messageSent	Server	A message was sent (source, data)
quanticPhone:onItemUsed	Server	Phone item was used from inventory
quanticPhone:playerDied	Server	Phone owner died
quanticPhone:server:onLosePhone	Server	Phone item lost/removed from inventory
quanticPhone:requestNearbyPhones	Server	Client requested nearby phone list
quanticPhone:publicPhonesUpdated	Server→Client	Public phone system status changed
quanticPhone:customAppsSync	Server→Client	Custom apps list synchronized
quanticPhone:receivePhoneShareRequest	Client	Incoming phone-number share request
quanticPhone:nearbyPhonesUpdated	Client	Nearby phones list updated

NUI callbacks (call flow)

Callback	Trigger
quanticphone:startCall	Player pressed the call button
quanticphone:acceptCall	Player accepted an incoming call
quanticphone:rejectCall	Player rejected an incoming call
quanticphone:ignoreCall	Player dismissed call notification

← Settings app Custom apps →