Compatibility
Porting from other phones
A reference that maps the documented exports of other FiveM phones to the closest FX Phone exports, for porting apps by hand.
FX Phone does not ship adapters for the phones on this page. Nothing here works by changing a resource name. The tables are a guide for developers who port an app or script by hand: they show which FX Phone export does the closest job to an export of the other phone.
FX Phone does ship compatibility for two phones. See lb-phone compatibility and cylex_phone compatibility.
#How to read the tables
- The left column is the other phone's export or event, as named in its public documentation at the URL given in the "Source" line. Only public documentation was used. Names and signatures can change in later versions of those phones; check the source page.
- The middle column is the closest FX Phone export.
(client)and(server)say which side it runs on. - "No equivalent" means FX Phone has no export for that job.
- Argument order and field names usually differ. Open the linked FX Phone reference page before you change a call. The table only tells you where to look.
Three differences come up with almost every phone:
| Topic | FX Phone |
|---|---|
| Registering an app | AddCustomApp on the client with identifier, name, ui, icon. The page is an iframe. See Custom apps |
| Talking to the app page | Lua to page: SendCustomAppMessage(id, data). Page to Lua: the page calls the resource's own NUI callbacks. See Custom app API |
| Who a notification goes to | Server SendNotification(target, data): a number as target is a server id (shown now, not saved), a string is a phone number (saved, shown when online) |
#17mov Phone
Source: https://docs.17movement.net/phone/exports/global-exports/client-exports, https://docs.17movement.net/phone/exports/global-exports/server-exports, https://docs.17movement.net/phone/building-custom-apps/registering-the-application, https://docs.17movement.net/phone/exports/messages/server-exports, https://docs.17movement.net/phone/exports/email/server-exports
Resource name in their docs: 17mov_Phone.
| 17mov Phone | FX Phone | Notes |
|---|---|---|
AddApplication(appData) (client) |
AddCustomApp(def) (client) |
Their name is FX Phone's identifier, their label is name. default and preInstalled map to defaultApp. Their job object becomes the jobs list of job names |
RemoveApplication(data) |
RemoveCustomApp(id) (client) |
FX Phone takes the app id only. Apps are also removed when the owning resource stops |
OpenPhone() (client) |
ToggleOpen(true) (client) |
|
ClosePhone() (client) |
ToggleOpen(false) (client) |
|
IsPhoneOpen() (client) |
IsOpen() (client) |
|
SetPlayerPhoneBlockState(state) (client) |
ToggleDisabled(disabled) (client) |
Read back with IsDisabled(). The server form SetPlayerPhoneBlockState(src, state) has no server equivalent; trigger your own client event |
HasPhoneItem() (client) |
HasPhoneItem() (client) |
|
CreateNotification(data) (client) |
SendNotification(data) (client) |
Their message is FX Phone's content |
OpenApp(appName) (client) |
OpenApp(app, data) (client) |
|
CloseApp(appName) (client) |
CloseApp() (client) |
FX Phone closes the app in front; it takes no name |
ToggleFlashlight(state) (client) |
ToggleFlashlight(on) (client) |
|
GetFlashlightState() (client) |
GetFlashlight() (client) |
|
GetPlayerNumber() (client) |
GetPhoneNumber() (client) |
|
GetPlayerSignalLevel() (client) |
GetSignal() (client) |
Scales may differ; see Battery and signal |
GetConfig() (client, server) |
GetConfig() (client, server) |
The tables are not the same shape |
GetNumberFromPlayer(src) (server) |
GetPhoneNumber(target) (server) |
target is a server id or an identifier |
GetNumberFromIdentifier(identifier) (server) |
GetNumberFromIdentifier(identifier) (server) |
|
GetIdentifierFromNumber(number) (server) |
GetIdentifierFromNumber(number) (server) |
|
GetPlayerSrcFromActiveNumber(number) (server) |
GetSourceFromNumber(number) (server) |
Returns false when nobody online has the number |
SendNotificationToSrc(src, notification) (server) |
SendNotification(src, data) (server) |
|
SendNotificationToNumber(number, notification) (server) |
SendNotification(number, data) (server) |
Pass the number as a string |
SendNotificationToEveryone(notification) (server) |
NotifyEveryone(scope, data) (server) |
scope is 'online' or 'all' |
Messages_SendMessageToNumber(number, message, sender) (server) |
SendMessage(from, to, text, attachments) (server) |
The sender comes first in FX Phone. from is a phone number or a name such as 'Dispatch' |
Messages_SendMessageToSrc(src, message, sender) (server) |
SendMessage(from, to, text) (server) |
Look up the number with GetPhoneNumber(src) first |
Location message through Messages_SendMessageToSrc |
SendCoords(from, to, coords) (server) |
|
Email_SendSystemEmailBySrc, Email_SendSystemEmailByNumber, Email_SendEmailBySrc, Email_SendEmailByNumber (server) |
SendMail(mail) (server) |
One table: the recipient is identifier, number or to; plus sender, subject, message |
AddSimcard(playerId, number) (server) |
IssueSim(opts) (server) |
See SIM exports |
GetAllPlayerNumbersFromSrc(playerId) (server) |
GetSimsByIdentifier(identifier) (server) |
|
GeneratePhoneNumber(), ChangeUserPassword, SetPinCodeBySrc, streamer mode exports, SetPhonePosition |
No equivalent |
#High Phone
Source: https://docs.high-scripts.com/phone/exports/client, https://docs.high-scripts.com/phone/exports/server, https://docs.high-scripts.com/phone/applications/javascript
Resource name in their docs: high-phone. The public pages read for this reference describe the page-side API of a custom application (window.hphone) and point to a template repository, but do not show the registration call, so no registration row is given.
| High Phone | FX Phone | Notes |
|---|---|---|
openPhone(forced) (client) |
ToggleOpen(true) (client) |
FX Phone has no forced argument |
closePhone() (client) |
ToggleOpen(false) (client) |
|
toggleUsability(state, keepOpen) (client) |
ToggleDisabled(disabled) (client) |
The meaning is inverted: their false blocks the phone, FX Phone's true does. Disabling closes the phone |
isDisabled() (client) |
IsDisabled() (client) |
|
sendNotification(data) (client) |
SendNotification(data) (client) |
Their application is app, their duration is timeout |
sendAppNui(appName, message) (client) |
SendCustomAppMessage(id, data) (client) |
|
getSettings(settingName) (client) |
GetSettings() (client) |
FX Phone returns the whole table |
startCall(number, video) (client) |
CreateCall({ number, video }) (client) |
StartVideoCall is the video-only form |
endCall() (client) |
EndCall() (client) |
|
getSignal() (client) |
GetSignal() (client) |
Return shapes differ |
isCharging() (client) |
IsCharging() (client) |
|
setBattery(percentage) (client) |
SetBattery(level) (client) |
Their value is 0.0 to 1.0; see Battery and signal for FX Phone's range |
toggleCamera(state, facing, portrait) (client) |
OpenCamera(opts, cb) (client) |
Not the same feature: FX Phone opens the Camera app and returns the saved item |
getPlayerPhoneNumber(id) (server) |
GetPhoneNumber(target) (server) |
|
getPlayerByPhone(phoneNumber) (server) |
GetSourceFromNumber(number) (server) |
FX Phone returns the server id, not a player object |
getPlayerPhone(id) (server) |
GetUserDataBySource(src) (server) |
Fields differ |
sendNotification(receiver, data) (server) |
SendNotification(target, data) (server) |
For every phone use NotifyEveryone(scope, data) |
sendMessage(data) (server) |
SendMessage(from, to, text, attachments) (server) |
Positional arguments in place of one table. One attachment is used per message |
sendMail(data) (server) |
SendMail(mail) (server) |
|
endCall(id) (server) |
EndCall(src) (server) |
|
window.hphone.emitNui(name, payload) (page) |
fetch to the resource's own NUI callback |
See Custom app API |
window.hphone.openModal(data) (page) |
popUp message from the page |
|
setBlipName, valet exports, toggleCharging, setCameraFacing, sendNui |
No equivalent |
#GKS Phone
Source: https://docs.gkshop.org/gksphone-v2/exports-and-events/client-exports, https://docs.gkshop.org/gksphone-v2/exports-and-events/server-exports, https://docs.gkshop.org/gksphone-v2/custom-app
Resource name in their docs: gksphone (GKSPHONE V2).
| GKS Phone | FX Phone | Notes |
|---|---|---|
AddCustomApp(appData) (client) |
AddCustomApp(def) (client) |
Their name is identifier, appurl is ui, icons is icon, startapp is defaultApp, allowjob is jobs. labelLangs, blockedjobs, onOpen and onClose are not read |
onOpen / onClose fields |
Events fx-phone:customApp:opened and fx-phone:customApp:closed (client) |
See Client events |
NuiSendMessage(data) (client) |
SendCustomAppMessage(id, data) (client) |
FX Phone needs the app id |
Notification(NotifData) (client) |
SendNotification(data) (client) |
Their message is content, duration is timeout. Notification buttons are not supported |
sendNotification(src, NotifData) (server) |
SendNotification(src, data) (server) |
|
isPhoneOpen() (client) |
IsOpen() (client) |
|
PhoneOpen() (client) |
ToggleOpen(true) (client) |
|
PhoneClose() (client) |
ToggleOpen(false) (client) |
|
PhoneOpenBlock(reason), PhoneOpenUnBlock() (client) |
ToggleDisabled(disabled) (client) |
No reason text |
PhoneOpenBlockStatus() (client) |
IsDisabled() (client) |
|
PhoneNumber() (client) |
GetPhoneNumber() (client) |
|
IsCameraOpen() (client) |
IsCameraOpen() (client) |
|
ToggleFocus(status) (client) |
SetInputFocus(focused) (client) |
Check the direction of the boolean against Custom app exports |
CreateCall(data) (client) |
CreateCall({ number, hideNumber, video }) (client) |
Their videoCall is video. There is no job field |
EndCall(), IsInCall() (client) |
EndCall(), IsInCall() (client) |
|
CreateCall(source, data), EndCall(source), IsInCall(source), GetCall(callId) (server) |
CreateCall(src, number, opts), EndCall(src), IsInCall(src), GetCall(id) (server) |
The number is its own argument in FX Phone |
GetPhoneBattery(), SetPhoneBattery(battery), IsPhoneCharging() (client) |
GetBattery(), SetBattery(level), IsCharging() (client) |
|
StartLiveActivity, UpdateLiveActivity, EndLiveActivity (client) |
ShowLiveTray, UpdateLiveTray, RemoveLiveTray (client) |
Closest feature; fields differ. See Dynamic Island exports |
SendMessage(fromNumber, toNumber, message, options) (server) |
SendMessage(from, to, text, attachments) (server) |
|
SendSystemMessage(targetPhoneNumber, message, senderNumber) (server) |
SendMessage(from, to, text) (server) |
Pass a name as from for a read-only chat |
SendNewMail(src, MailData) (server) |
SendMail(mail) (server) |
Set identifier or number as the recipient. Mail buttons are not supported |
SendNewMailOffline(citizenID, MailData) (server) |
SendMail(mail) (server) |
With identifier |
NewBilling(src, label, society, senderBilling, senderID, amount) (server) |
AddInvoice(data) (server) |
{ receiver, amount, description, sender } |
IsUnpaidBillsbyCid(citizenID) (server) |
GetInvoices(identifier, true) (server) |
Test whether the returned list is empty |
BankSaveHistory(source, type, amount, description) (server) |
AddTransaction(target, amount, title, icon) (server) |
See Bank exports |
GetPhoneBySource(src) (server) |
GetPhoneNumber(target) (server) |
|
GetSourceByPhone(phoneNumber) (server) |
GetSourceFromNumber(number) (server) |
|
GetPhoneDataBySource(src) (server) |
GetUserDataBySource(src) (server) |
Fields differ |
ToggleVerified(app, username, verified) (server) |
SetSocialVerified(app, username, verified) (server) |
App ids differ |
EmergencyAlert(title, message) (server) |
NotifyEveryone(scope, data) (server) |
EmergencyNotification(src, data) targets one player |
ResetPhoneData(target, options) (server) |
FactoryReset(number) (server) |
Settings, home screen, installed apps and PIN are reset. The number and the data in the apps stay |
stockMarketAdd, stockMarketRemove (server) |
AddCrypto, RemoveCrypto (server) |
Closest feature; identifier, coin, amount |
AddCustomWidget, AddMapLocation, screen damage, phone health, jammer, custom call number exports |
No equivalent |
#Codem Phone
Source: https://codem.gitbook.io/codem-documentation/m-series/essentials/mphone-2.5/exports-and-events/client-exports, https://codem.gitbook.io/codem-documentation/m-series/essentials/mphone-2.5/exports-and-events/server-exports, https://codem.gitbook.io/codem-documentation/m-series/essentials/mphone-2.5/custom-app
Resource name in their docs: codem-phone (mPhone 2.5). On some of their pages the heading and the code example use different export names; the names below are the ones in their code examples.
| Codem Phone | FX Phone | Notes |
|---|---|---|
AddCustomApp(def) |
AddCustomApp(def) (client) |
identifier, name, ui, icon, description, defaultApp, developer and fixBlur have the same names. Their swiperItems is images. In FX Phone ui is a file path or URL, and jobs is a plain list of job names. onOpen, onClose, notification and addAppStore are not read: an app without defaultApp is offered in the App Store |
onOpen / onClose fields |
Events fx-phone:customApp:opened and fx-phone:customApp:closed (client) |
|
OpenPhone() (client) |
ToggleOpen(true) (client) |
|
ClosePhone() (client) |
ToggleOpen(false) (client) |
|
TogglePhone() (client) |
ToggleOpen() (client) |
Called with no argument it toggles |
IsPhoneOpen() (client) |
IsOpen() (client) |
|
SetFlashlight(state) (client) |
ToggleFlashlight(on) (client) |
|
SetInputFocus(focused) (client) |
SetInputFocus(focused) (client) |
|
GetConfig() (client) |
GetConfig() (client) |
The tables are not the same shape |
GetBatteryLevel(phoneNumber), SetBatteryLevel(phoneNumber, level) (client) |
GetBattery(), SetBattery(level) (client) |
The local player's phone only |
GetCellSignal() (client) |
GetSignal() (client) |
Return shapes differ |
CheckBilling() (client) |
No client equivalent | On the server use GetInvoices(identifier, true) |
GetPhoneNumberBySource(source) (server) |
GetPhoneNumber(target) (server) |
|
GetPhoneNumberByIdentifier(identifier) (server) |
GetNumberFromIdentifier(identifier) (server) |
|
GetSourceFromNumber(phoneNumber) (server) |
GetSourceFromNumber(number) (server) |
Returns false, not nil, when nobody online has the number |
SendNotify(src, data) (server) |
SendNotification(src, data) (server) |
Their message is content |
SendMessageFromBySource(senderPhone, source, message) (server) |
SendMessage(from, to, text) (server) |
to is a phone number; look it up with GetPhoneNumber(src) |
SendMessageCoords(senderPhone, source, coords) (server) |
SendCoords(from, to, coords) (server) |
|
SendMail(data), SendMailBySource(src, data) (server) |
SendMail(mail) (server) |
Their title is subject, description is message. The recipient is identifier, number or to |
CreateCall(callerInfo, calleeNumber, options) (server) |
CreateCall(src, number, opts) (server) |
|
EndCall(callId) (server) |
EndCall(src) (server) |
FX Phone takes the player, not the call id |
IsInCall(source), GetCall(callId) (server) |
IsInCall(src), GetCall(id) (server) |
|
CreateBillingCustom(source, amount, reason, ...) (server) |
AddInvoice(data) (server) |
|
CheckBilling(source) (server) |
GetInvoices(identifier, true) (server) |
|
GetGallery(source) (server) |
GetPhotos(target) (server) |
|
GetSocialMediaUsername(phoneNumber, app) (server) |
GetActiveSocialAccount(src, app) (server) |
Takes the player, not the number |
ToggleVerified(app, username, verified) (server) |
SetSocialVerified(app, username, verified) (server) |
App ids differ |
HasAirplaneMode, ToggleMute, ToggleSpeaker, PostTwix, GetCellTowers |
No equivalent |
#TGIANN Phone
Source: https://tgiann.gitbook.io/tgiann/scripts/tgiann-phone/exports, https://tgiann.gitbook.io/tgiann/scripts/tgiann-phone/lb-phone-api
Resource name in their docs: tgiann-phone. Their documentation states that the phone also supports the lb-phone API. An app written against that lb-phone API can be ported with the lb-phone compatibility page instead of this table.
| TGIANN Phone | FX Phone | Notes |
|---|---|---|
AddPhoneApp(app) (client) |
AddCustomApp(def) (client) |
Both return ok, err |
RemovePhoneApp(id) (client) |
RemoveCustomApp(id) (client) |
|
SendPhoneAppMessage(id, data) (client) |
SendCustomAppMessage(id, data) (client) |
FX Phone has no "any" target |
SetPhoneAppInstalled(id, installed) (client) |
SetAppInstalled(id, installed) (client) |
|
SetPhoneAppHidden(appId, hidden) (client) |
SetAppHidden(id, hidden) (client) |
|
OpenPhone(), ClosePhone(), TogglePhone(open) (client) |
ToggleOpen(open) (client) |
|
IsPhoneOpen() (client) |
IsOpen() (client) |
|
IsPhoneOnScreen() (client) |
IsPhoneOnScreen() (client) |
In FX Phone this is a second name for IsOpen |
SetPhoneDisabled(disabled), IsPhoneDisabled() (client) |
ToggleDisabled(disabled), IsDisabled() (client) |
|
HasPhone(number) (client) |
HasPhoneItem() (client) |
No number argument |
GetPhoneNumber() (client) |
GetPhoneNumber() (client) |
|
GetPhoneSettings() (client) |
GetSettings() (client) |
Fields differ |
OpenPhoneApp(appId), ClosePhoneApp(appId) (client) |
OpenApp(app, data), CloseApp() (client) |
|
AddNotification(data) (client) |
SendNotification(data) (client) |
|
ShowPhonePopUp(data) (client) |
SetPopUp(data) (client) |
See Dialog exports |
ShowPhoneContextMenu(data) (client) |
SetContextMenu(data) (client) |
|
StartCall(number, options), IsInCall() (client) |
CreateCall({ number }), IsInCall() (client) |
|
OpenPhoneCamera(), IsPhoneCameraOpen() (client) |
OpenCamera(opts, cb), IsCameraOpen() (client) |
|
SaveToPhoneGallery(url) (client) |
SaveToGallery(url, kind, thumbnail) (client) |
|
AddContact(data) (client) |
AddContact({ number, firstname, lastname, avatar }) (client) |
|
SetPhoneFlashlight(on), IsPhoneFlashlightOn() (client) |
ToggleFlashlight(on), GetFlashlight() (client) |
|
SetAppCall(call) (client) |
ShowLiveTray(opts) (client) |
Closest feature only |
GetPhoneNumber(target) (server) |
GetPhoneNumber(target) (server) |
|
GetSourceByNumber(phoneNumber) (server) |
GetSourceFromNumber(number) (server) |
|
GetNumberOwner(number) (server) |
GetIdentifierFromNumber(number) (server) |
FX Phone also has a GetNumberOwner export for SIM lines; see SIM exports |
FactoryResetPhone(phoneNumber) (server) |
FactoryReset(number) (server) |
|
AddNotification(src, data) (server) |
SendNotification(src, data) (server) |
Not saved when the target is a server id |
AddNotificationToNumber(phoneNumber, data) (server) |
SendNotification(number, data) (server) |
|
AddNotificationToEveryone(data, save) (server) |
NotifyEveryone(scope, data) (server) |
'all' saves it for every phone |
StartCall(source, target, options), GetCall(callId), IsInCall(source), EndCall(source) (server) |
CreateCall(src, number, opts), GetCall(id), IsInCall(src), EndCall(src) (server) |
|
AddContact(phoneNumber, data) (server) |
AddContact(number, data) (server) |
|
SendSms(fromNumber, toNumber, data) (server) |
SendMessage(from, to, text, attachments) (server) |
|
SendLocationMessage(fromNumber, toNumber, x, y, label) (server) |
SendCoords(from, to, coords) (server) |
|
SendMail(data) (server) |
SendMail(mail) (server) |
Fields differ |
SaveGalleryImage(source, base64, filename) (server) |
AddGalleryPhoto(target, data) (server) |
FX Phone takes a link, not base64 data |
SendInvoice(src, targetSrc, amount, reason, senderType), CreateInvoice(data) (server) |
AddInvoice(data) (server) |
|
GetUnpaidInvoices(citizenid), HasUnpaidInvoices(citizenid) (server) |
GetInvoices(identifier, true) (server) |
|
CancelInvoice(id) (server) |
DeleteInvoice(id) (server) |
|
SetKiwitterVerified(profile, verified) (server) |
SetSocialVerified(app, username, verified) (server) |
|
Event tgiann-phone:hook:visibility (client) |
Event fx-phone:phoneToggled (client) |
Argument: open |
Map pin, Kiwitter post and plan, city tax, mail account, RefundInvoice exports |
No equivalent |
#SD Phone
Source: https://docs.samueldev.shop/resources/phone/custom-apps, https://docs.samueldev.shop/resources/phone/exports-client, https://docs.samueldev.shop/resources/phone/exports-server
Resource name in their docs: sd-phone. Their documentation describes a compatibility layer that answers exports['lb-phone']. An app that uses those lb-phone names can be ported with the lb-phone compatibility page instead of this table.
| SD Phone | FX Phone | Notes |
|---|---|---|
addCustomApp(app) (client) |
AddCustomApp(def) (client) |
identifier, name, description, developer, defaultApp, ui, icon, images, size, price and fixBlur have the same names. Their job becomes the jobs list. devices, requires, widgets, wifi and the onOpen, onClose, onDelete callbacks are not read |
Event sd-phone:ready (client) |
Event fx-phone:client:phoneLoaded (client) |
FX Phone keeps a registered app until its resource stops |
removeCustomApp(identifier) (client) |
RemoveCustomApp(id) (client) |
|
sendCustomAppMessage(identifier, payload) |
SendCustomAppMessage(id, data) (client) |
The payload is posted to the page as it is |
isOpen() (client) |
IsOpen() (client) |
|
open() (client) |
ToggleOpen(true) (client) |
|
close() (client) |
ToggleOpen(false) (client) |
|
setDisabled(disabled), isDisabled() (client) |
ToggleDisabled(disabled), IsDisabled() (client) |
|
showNotification(data) (client) |
SendNotification(data) (client) |
Their body is content, image is thumbnail |
openApp(appId, link) (client) |
OpenApp(app, data) (client) |
|
getPhoneNumber(source) (server) |
GetPhoneNumber(target) (server) |
|
getPhoneNumberByIdentifier(citizenid) (server) |
GetNumberFromIdentifier(identifier) (server) |
|
getIdentifierByNumber(number) (server) |
GetIdentifierFromNumber(number) (server) |
|
getSourceByNumber(number) (server) |
GetSourceFromNumber(number) (server) |
Returns false, not nil, when nobody online has the number |
notify(source, data) (server) |
SendNotification(src, data) (server) |
|
notifyNumber(number, data) (server) |
SendNotification(number, data) (server) |
|
emergencyAlert(source, data) (server) |
EmergencyNotification(src, data) (server) |
For every phone use NotifyEveryone |
sendSystemMessage(senderNumber, senderName, targetNumber, body, opts) (server) |
SendMessage(from, to, text) (server) |
|
sendMessage(source, payload) (server) |
SendMessage(from, to, text, attachments) (server) |
FX Phone takes the sender's number, not the player |
messageCompany(source, payload) (server) |
SendCompanyMessage(job, fromNumber, text) (server) |
|
sendMail(mail) (server) |
SendMail(mail) (server) |
Their body is message, from is sender |
startCall(source, number) (server) |
CreateCall(src, number, opts) (server) |
|
isInCall(source) (server) |
IsInCall(src) (server) |
|
endCallFor(source) (server) |
EndCall(src) (server) |
|
addContact(source, fields) (server) |
AddContact(number, data) (server) |
FX Phone takes the phone number of the phone that receives the contact |
addBankTransaction(identifier, data) (server) |
AddTransaction(target, amount, title, icon) (server) |
|
getPhotos(source, opts), getPhotosByIdentifier(citizenid, opts) (server) |
GetPhotos(target) (server) |
|
addPhoto(source, url) (server) |
AddGalleryPhoto(target, data) (server) |
|
fetchNui(event) (page) |
fetch to the resource's own NUI callback |
|
startGroupCall, logCall, mail account and mailbox exports, uploadMedia, lock screen widget exports |
No equivalent |
#YSeries
Source: https://teamsgg.dev/docs/paid-scripts/phone/custom-apps, https://teamsgg.dev/docs/paid-scripts/phone/exports/client-side/general, https://teamsgg.dev/docs/paid-scripts/phone/exports/client-side/misc, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/identify-player, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/notifications, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/messages, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/mail, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/calls, https://teamsgg.dev/docs/paid-scripts/phone/exports/server-side/misc
Resource name in their docs: yseries. The public documentation was found for the yseries resource only. No separate export documentation was found under the names yphone or yflip-phone, so this section covers yseries.
YSeries identifies a phone by IMEI in several exports. FX Phone has no IMEI: use the phone number or the character identifier.
| YSeries | FX Phone | Notes |
|---|---|---|
AddCustomApp(def) (client) |
AddCustomApp(def) (client) |
Their key is identifier. name, defaultApp, ui and icon have the same names. Their allowedJobs becomes jobs; there is no disabledJobs |
Config.CustomApps |
Config.CustomApps in config.lua |
Same idea, FX Phone's fields. See Custom apps |
RemoveCustomApp(key) (client) |
RemoveCustomApp(id) (client) |
|
SendAppMessage(appId, data) (client) |
SendCustomAppMessage(id, data) (client) |
|
ToggleOpen(open) (client) |
ToggleOpen(open, noFocus) (client) |
|
IsOpen() (client) |
IsOpen() (client) |
|
IsDisabled(), ToggleDisabled(disable) (client) |
IsDisabled(), ToggleDisabled(disabled) (client) |
|
ToggleDisabled(sourceId, disabled), IsDisabled(sourceId) (server) |
No server equivalent | Trigger your own client event and call the client exports there |
CloseApp() (client) |
CloseApp() (client) |
|
ToggleFlashlight(enabled), GetFlashlightState() (client) |
ToggleFlashlight(on), GetFlashlight() (client) |
|
ToggleLandscape(state) (client) |
SetLandscape(state) (client) |
FX Phone's ToggleLandscape() takes no argument and flips the state |
SetNuiFocusKeepInput(focus) (client) |
ToggleFocusKeepInput(keepInput) (client) |
SetInputFocus(focused) is the inverse |
IsAppInstalled, GetCurrentAppId, AirplaneModeEnabled, streamer mode exports (client) |
No equivalent | GetSettings() returns the phone's settings table |
GetPhoneNumberBySourceId(source) (server) |
GetPhoneNumber(target) (server) |
|
GetPhoneNumberByIdentifier(identifier) (server) |
GetNumberFromIdentifier(identifier) (server) |
|
GetPlayerSourceIdByPhoneNumber(phoneNumber) (server) |
GetSourceFromNumber(number) (server) |
|
GetPlayerSourceIdByIdentifier, the ...ByPhoneImei and GetPhoneImei... exports (server) |
No equivalent | |
SendNotification(notification, toType, to) (server) |
SendNotification(target, data) (server) |
The target comes first. toType is replaced by the type of target: number for a server id, string for a phone number. Their text is also read as content. actions and onDismiss are not supported; for a yes or no question use DoPhoneConfirmation(src, title, text, icon) |
SendMessageTo(from, to, message, attachments) (server) |
SendMessage(from, to, text, attachments) (server) |
to is one number. attachments is a table, not a JSON string |
SendMessage(participants, message, senderDeviceNumber, senderPhoneImei, channelId, attachments) (server) |
SendMessage(from, to, text, attachments) (server) |
|
SendMail(mail, receiverType, receiver) (server) |
SendMail(mail) (server) |
The recipient goes inside the table as identifier, number or to. Their title is subject, content is message |
CallContact(targetNumber, targetPlayerId, callerNumber, callerPlayerId, anonymousCall) (server) |
CreateCall(src, number, { hideNumber }) (server) |
|
EndCall(callId) (server) |
EndCall(src) (server) |
FX Phone takes the player, not the call id |
IsInCall(playerId) (server) |
IsInCall(src) (server) |
|
GetCallData(callId) (server) |
GetCall(id) (server) |
|
AddContact(phoneNumber, data) (server) |
AddContact(number, data) (server) |
Field names differ; see Call exports |
DeleteMail, BlockContact, GetBlockedNumbers, AddRecentCall, GetContacts |
No equivalent |
#Sky Phone
Source: https://github.com/sky-systems/sky_phone
No reliable public reference for Sky Phone's app-registration, notification or messaging exports was found. The public repository README says such exports exist but does not name them, so no mapping table is given here.
What the README does state:
- Resource name:
sky_phone. - It names SIM-related client exports (
EjectSimFromSlot,GetInventoryLabels) and item-use exports (UsePhoneItem,UseSimItem). FX Phone's SIM exports are on the client SIM and server SIM pages; they are not one-to-one equivalents. - It shows an app that calls
exports["lb-phone"]:AddCustomApp(...)working through a compatibility alias. An app written that way can be ported with the lb-phone compatibility page.
For anything else, compare the app's own calls with the export index.
#When there is no equivalent
- State that another phone exposes through an export may be available as a state bag or an event. See State bags and Client events.
- Per-character storage for an app is available through
SetAppDataandGetAppDataFor. See App data. - To veto an action (a call, a message), use a check. See Checks.