CLIENT EXPORTS

Open Phone

Opens the phone interface for the local player.

exports["17mov_Phone"]:OpenPhone()

Close Phone

Closes the phone interface for the local player.

exports["17mov_Phone"]:ClosePhone()

Set Phone Block State

Blocks or unblocks the local player from using their phone. When blocked, the player cannot open the phone interface.

exports["17mov_Phone"]:SetPlayerPhoneBlockState(state)

Argument	Type	Optional	Explanation
state	boolean	❌	true to block the phone, false to unblock.

Has Phone Item

Checks if the player currently has the required phone item in their inventory.

local hasPhone = exports["17mov_Phone"]:HasPhoneItem()

Returns:

• boolean: true if the player has the phone item, false otherwise.

Is Phone Open

Checks if the phone interface is currently visible (open) for the player.

local isOpen = exports["17mov_Phone"]:IsPhoneOpen()

Returns:

• boolean: true if the phone is open.

Is Phone Minimized

Checks if the phone interface is currently minimzed, and if so - it returns current position and height

local minimized = exports["17mov_Phone"]:IsPhoneMinimized()

Returns:

• {height = number, x = number, y = number, isMinimized = boolean}

Create Notification

Sends a custom notification to the player's phone. Supports locale keys and dynamic replacements.

exports["17mov_Phone"]:CreateNotification({
    app = "MESSAGES",
    title = "New Message",
    message = "You have a new message from John.",
    number = "555-0123"
})

Notification Structure

{
    number = "555-0123", -- (Optional) Player number associated with notification
    app = "APP_NAME", -- App identifier (e.g., "MESSAGES", "BANK")
    title = "Title", -- Title string or ReplaceType object
    message = "Message Content", -- Message string or ReplaceType object
    data = {
        href = "/messages/1", -- (Optional) Internal link to open on click
        alwaysShow = true -- (Optional) Show even if app is open
    }
}

Toggle Flashlight

Toggles the phone's flashlight mode.

exports["17mov_Phone"]:ToggleFlashlight(state)

Argument	Type	Optional	Explanation
state	boolean	❌	true to turn on, false to turn off.

Get Flashlight State

Checks if the flashlight is currently active.

local isOn = exports["17mov_Phone"]:GetFlashlightState()

Returns:

• boolean: true if the flashlight is on.

Set Streamer Mode State

Toggles the Streamer Mode setting. Streamer Mode hides sensitive information (like phone numbers or explicit images) from the UI.

exports["17mov_Phone"]:SetStreamerModeState(state)

Argument	Type	Optional	Explanation
state	boolean	❌	true to enable Streamer Mode.

Get Streamer Mode State

Checks whether Streamer Mode is currently enabled.

local isStreamerModeOn = exports["17mov_Phone"]:GetStreamerModeState()

Returns:

• boolean: true if enabled.

Open App

Opens a specific application on the phone programmatically.

exports["17mov_Phone"]:OpenApp(appName)

Argument	Type	Optional	Explanation
appName	string	❌	The internal name of the app (e.g., "messages", "camera").

Close App

Closes a currently open application on the phone.

exports["17mov_Phone"]:CloseApp(appName)

Argument	Type	Optional	Explanation
appName	string	❌	The internal name of the app to close.

GetSignalTowers

Returns a table with all Signal Towers from config

exports["17mov_Phone"]:GetSignalTowers()

Returns:

• {coords: vector3, radius: number}[]

GetSignalLevelForCoords

Returns a 0-4 value that represent signal strenght for given coordinates

exports["17mov_Phone"]:GetSignalLevelForCoords(coords)

Argument	Type	Optional	Explanation
coords	vector3	❌	Coords to check signal

Returns:

• number (0-4)

GetPlayerSignalLevel

Returns a current player signal strenght

exports["17mov_Phone"]:GetPlayerSignalLevel()

Returns:

• number (0-4)

GetConfig

Retrieves the full phone configuration, allowing other scripts to read global settings, available applications, and their specific parameters.

local phoneConfig = exports["17mov_Phone"]:GetConfig()

Returns:

• table Config: The main configuration table of the script.

Usage Examples:

local config = exports["17mov_Phone"]:GetConfig()

-- Check if phones are unique (metadata-based)
if config.UniquePhones then
    print("The server is using unique phone items")
end

-- Accessing specific app settings
local showNumber = config.Apps['Companies'].ShowCompanyExactNumber
print("Show exact company number: " .. tostring(showNumber))

GetPlayerNumber

Returns the phone number of the simcard currently equipped by the player.

local playerNumber = exports["17mov_Phone"]:GetPlayerNumber()

Returns:

• string playerNumber: The current player's active phone number.

SetPhonePosition

Sets phone position on screen

exports["17mov_Phone"]:SetPhonePosition(0.5, 0.5)

Argument	Type	Optional	Explanation
x	float	❌	x coordinates (0.0-1.0) 0 being right edge of the screen, 1 being left edge of the screen
y	float	❌	y coordinates (0.0-1.0) 0 being bottom edge of the screen, 1 being top edge of the screen

GetPhoneNumberFormat

Returns the current config.lua number formating style

local numberFormat = exports['17mov_Phone']:GetPhoneNumberFormat()

Returns:

• string | nil phoneNumberFormat

GetPhoneMode

Returns current phone mode - Default / Simcards / Unique Phones

local phoneMode = exports['17mov_Phone']:GetPhoneMode()

Returns:

• PhoneModes phoneMode

PhoneModes = {
    DEFAULT = 0,
    UNIQUE_PHONES = 1,
    SIMCARDS = 2,
}

GetUserPhoneNumbers

Returns all user phone numbers

local numbers = exports['17mov_Phone']:GetUserPhoneNumbers()

Returns:

• {number: string, active: number}[] numbers

GetUserBrokenPhones

Returns all user broken phones

local numbers = exports['17mov_Phone']:GetUserBrokenPhones()

Returns:

• InventoryItem[] brokenPhones