API Reference

For Experienced Developers OnlyThis documentation assumes advanced knowledge of Lua scripting and FiveM development. We do not provide coding tutorials or basic programming support.If an export or event is not working as expected, please open a support ticket on our Discord server.

Overview

This section contains comprehensive API documentation for integrating with our scripts:

RoadPhone - Complete phone system with client and server exports
RoadPad - Tablet interface with specialized functions
RoadCarplay - Vehicle integration system

Documentation Structure

Our API documentation is organized by script and side:

Client Exports

Client-side functions and events for player interactions

Server Exports

Server-side functions for data management and synchronization

Quick Start

Basic Export Usage

All exports follow a consistent pattern across our scripts:

-- Client-side export example
exports['scriptname']:functionName(parameters)

-- Server-side export example
exports['scriptname']:functionName(parameters)

Event Handling

Events can be triggered and handled using standard FiveM patterns:

-- Trigger an event
TriggerEvent('eventName', data)

-- Handle an event
AddEventHandler('eventName', function(data)
    -- Your code here
end)

Framework Compatibility

Our scripts support multiple frameworks:

ESX
QBCore
QBox

All exports are compatible with ESX Legacy and newer versions

Return Types

Most exports return data in standard Lua types:

boolean - State checks and confirmations
string - Text data like phone numbers
table - Complex data structures
number - Numeric values and IDs
nil - When no data is available

Error Handling

Always validate return values before using them. Many functions return nil or false on failure.

-- Example of proper error handling
local phoneNumber = exports['roadphone']:getPhoneNumber()
if phoneNumber then
    print("Phone number: " .. phoneNumber)
else
    print("Failed to get phone number")
end

Support

Discord Support

For technical issues with exports or events, open a ticket on our Discord server

Ensure you have the latest version of the script before reporting issues. Check the changelog for recent updates and fixes.

Client Exports

API documentation

RoadPhone-Pro

RoadPhone

RoadPad

RoadCarPlay

Overview

Documentation Structure

Client Exports

Server Exports

Quick Start

Basic Export Usage

Event Handling

Framework Compatibility

Return Types

Error Handling

Support

Discord Support

​Overview

​Documentation Structure

Client Exports

Server Exports

​Quick Start

​Basic Export Usage

​Event Handling

​Framework Compatibility

​Return Types

​Error Handling

​Support

Discord Support

Overview

Documentation Structure

Quick Start

Basic Export Usage

Event Handling

Framework Compatibility

Return Types

Error Handling

Support