Client Exports

Comprehensive client exports available on exports['5M_Phone'].

Core Handset & Visibility Exports

Lua

---@return boolean
local open = exports['5M_Phone']:IsOpen()

---@return boolean
local onScreen = exports['5M_Phone']:IsPhoneOnScreen()

---@return boolean
local peeking = exports['5M_Phone']:IsPeek()

exports['5M_Phone']:Open()
exports['5M_Phone']:Close()
exports['5M_Phone']:Toggle()
exports['5M_Phone']:ToggleOpen(true, false)

Phone Number & Hardware

Lua

---@return string|nil
local phoneNumber = exports['5M_Phone']:GetPhoneNumber()
local equippedNumber = exports['5M_Phone']:GetEquippedPhoneNumber()

---@return boolean
local watchActive = exports['5M_Phone']:IsWatchEnabled()

---@return boolean
local isTorchOn = exports['5M_Phone']:GetFlashlight()
exports['5M_Phone']:ToggleFlashlight(true)

---@return number 0-100
local battery = exports['5M_Phone']:GetBattery()

Notifications & Alerts

Lua

exports['5M_Phone']:PresentAlert({
    app = 'Messages',
    title = 'Alex',
    body = 'On my way.',
    icon = 'messages',
    openApp = 'messages',
})

Dispatch Alerts

Lua

-- Quick preset alerts
exports['5M_Phone']:Shooting()
exports['5M_Phone']:Robbery()
exports['5M_Phone']:StoreRobbery()
exports['5M_Phone']:BankRobbery()
exports['5M_Phone']:VehicleTheft(vehicleEntity)
exports['5M_Phone']:OfficerBackup()
exports['5M_Phone']:OfficerDown()

-- Custom CAD ping
exports['5M_Phone']:CustomAlert({
    message = 'Store robbery',
    codeName = 'store',
    code = '10-90',
    icon = 'fas fa-store',
    priority = 1,
    vehicle = 'Sultan',
    plate = 'ABC 123',
})

Complete Advanced Client Exports Table

Export	Signature	Description
`GetConfig`	`()` -> `table`	Returns client configuration table
`GetCellTowers`	`()` -> `vector3[]`	Returns all cell tower coordinates
`FormatNumber`	`(phoneNumber: string)` -> `string`	Formats number into standard display string
`SaveToGallery`	`(data: table \| string)` -> `boolean`	Saves image/video link to photo gallery
`HasPhoneItem`	`(phoneNumber?: string)` -> `boolean`	Checks if player has phone / specific number
`AddCheck`	`(name: string, handler: function)`	Adds custom action check (e.g. `openPhone`)
`RemoveCheck`	`(name: string)`	Removes registered action check
`ToggleOpen`	`(open?: boolean, keepInput?: boolean)`	Toggles or sets phone open/closed
`IsOpen`	`()` -> `boolean`	Whether phone UI is open
`IsPhoneOnScreen`	`()` -> `boolean`	Whether phone or peek is visible on screen
`IsDisabled`	`()` -> `boolean`	Whether phone is disabled
`ToggleDisabled`	`(disabled: boolean)`	Disables or enables phone usage
`SetPhonePartiallyVisible`	`(amount?: number)`	Shows partial peek on screen (0-100)
`ToggleHomeIndicator`	`(show: boolean)`	Shows or hides the home bar indicator
`ToggleLandscape`	`(landscape: boolean)`	Rotates camera/phone into landscape
`SendNotification`	`(data: table)`	Displays on-screen notification
`DeleteNotification`	`(id: number)`	Clears notification
`ToggleFlashlight`	`(state?: boolean)` -> `boolean`	Toggles flashlight / torch
`GetFlashlight`	`()` -> `boolean`	Returns flashlight state
`SetServiceBars`	`(bars: number)`	Overrides signal strength bars (0-4)
`ReloadPhone`	`()`	Reloads phone UI frame
`SetPhoneVariation`	`(index: number)`	Sets phone casing/model variation index
`SetAnimations`	`(animations?: table)`	Customizes phone holding animations
`EnableWalkableCam`	`()`	Enables walking while camera is active
`DisableWalkableCam`	`()`	Disables walkable camera mode
`IsWalkingCamEnabled`	`()` -> `boolean`	Whether walkable camera is on
`ToggleSelfieCam`	`()` -> `boolean`	Flips camera front/rear
`ToggleCameraFrozen`	`(frozen: boolean)`	Freezes camera viewpoint
`IsCameraOpen`	`()` -> `boolean`	Whether camera app is open
`GetSettings`	`()` -> `table`	Returns player phone settings
`GetAirplaneMode`	`()` -> `boolean`	Whether airplane mode is on
`GetStreamerMode`	`()` -> `boolean`	Whether streamer mode is on
`AddKeyBind`	`(app, key, desc, cb)`	Registers app shortcut keybind
`ShowMusicTray`	`(data?: table)`	Media player tray widget
`ShowLiveTray`	`(data?: table)`	Live stream tray widget
`IsLive`	`()` -> `boolean`	Whether player is currently live streaming
`PostBirdy`	`(data: table)`	Posts directly to xBird
`AddContact`	`(data: table)`	Adds contact to address book
`OpenApp`	`(app: string, data?: table)`	Direct app navigation
`CloseApp`	`()`	Exits current app to home screen
`SetAppHidden`	`(app: string, flag: boolean)`	Hides app icon on home screen
`SetAppInstalled`	`(app: string, flag: boolean)`	Sets app installation state
`IsPhoneDead`	`()` -> `boolean`	Whether battery is dead
`GetBattery`	`()` -> `number`	Current battery percentage
`SetBattery`	`(percent: number)`	Overrides battery percentage
`ToggleCharging`	`(charging: boolean)`	Sets charging state
`GetCryptoWallet`	`()` -> `table`	Returns crypto wallet holdings
`CreateCall`	`(number: string)`	Dials phone number
`EndCall`	`()`	Hangs up current call
`IsInCall`	`()` -> `boolean`	Whether player is in active call