High Scripts

https://docs.high-scripts.com
Admin
High Scripts provides official documentation for its suite of products, including High Phone and...
Tokens:10,926
Snippets:120
Trust Score:6.2
Update:11 months ago
Show doc for...
Tokens:
Raw
### Configure Phone Item for ox_inventory

Source: https://docs.high-scripts.com/phone/installation

Defines a 'phone' item for the ox_inventory system. This allows players to use the item to open the High Phone and is crucial for frameworks like ESX.

```lua
-- Inside ox_inventory/data/items.lua
['phone'] = {
    label = 'Phone',
    weight = 190,
    consume = 0,
    client = {
      export = 'high-phone.usePhoneItem'
    }
}
```

--------------------------------

### Ensure High Phone Resource in Server Config

Source: https://docs.high-scripts.com/phone/installation

This snippet shows how to add the High Phone resource to your server configuration file. It must be added after essential framework and library resources like oxmysql and ox_lib.

```cfg
ensure [high-phone]
```

--------------------------------

### Start Phone Call Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Initiates a phone call to a specified number, with an option for video calls. This function is exported client-side by the 'high-phone' script.

```lua
-- Call a phone number '123456789' with video turned on.
exports['high-phone']:startCall('123456789', true)
```

--------------------------------

### Framework Bridge Example (Lua)

Source: https://docs.high-scripts.com/phone/bridges

An example of a framework bridge in Lua. This function is designed to be overridden by more specific resource bridges, showcasing the prioritization mechanism of the High Scripts bridge system.

```lua
-- This is a framework bridge.
getVehicles = function(player)
    print("This will not print, as it's overriden by the vehicles bridge.")
end

```

--------------------------------

### Initialize Bridge with Global Variables (Lua)

Source: https://docs.high-scripts.com/phone/bridges/shared

The `init` function is automatically called upon resource detection and bridge initialization. It's used for setting up global variables, such as retrieving a shared object. This example demonstrates requiring a library and getting a shared object in Lua.

```lua
init = function(this)
    dbgprint('my_framework Detected and loaded')

    require '@my_framework/lib.lua'
    -- OR
    OBJ = exports.my_framework:getSharedObject()
end
```

--------------------------------

### Ensure Script Dependencies Correctly

Source: https://docs.high-scripts.com/phone/issues

This snippet shows the correct order for ensuring scripts to prevent the phone from failing to detect inventory, garages, or other essential scripts. It emphasizes starting dependencies before the main phone script.

```cfg
...
ensure oxmysql
ensure ox-lib
ensure qbx-core
ensure jg-advancedgarages
ensure ox-inventory

ensure [high-phone]
...
```

--------------------------------

### Grant ox_lib ACE Permissions

Source: https://docs.high-scripts.com/phone/issues

This configuration example demonstrates how to grant ox_lib necessary ACE permissions in the server.cfg file. These permissions are crucial for the proper functioning of commands related to resource management and access control.

```cfg
add_ace resource.ox_lib command.add_ace allow
add_ace resource.ox_lib command.remove_ace allow
add_ace resource.ox_lib command.add_principal allow
add_ace resource.ox_lib command.remove_principal allow
```

--------------------------------

### Hook When Starting a Call

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is triggered when a player initiates a phone call. The callback function receives the player source and call data, and can be used to cancel the call by returning `false`.

```lua
exports['high-phone']:createHook('startCall', function(src, call)
    print(src, call.caller.number, call.participants[1].number)
    -- Cancel the call
    return false
end)
```

--------------------------------

### Get Phone Settings with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Retrieves all current phone settings using the `getSettings` function from the 'hphone' object. The example shows how to access specific settings like `airplaneMode` and `darkMode` from the returned settings object.

```javascript
const { getSettings } = window.hphone;
const settings = getSettings();

console.log(settings.airplaneMode, settings.darkMode)
```

--------------------------------

### Advanced Configuration with Local Variables (Lua)

Source: https://docs.high-scripts.com/phone/configuration

This example illustrates how to include custom Lua code, such as defining local variables, before the return statement in a High Scripts configuration file. This allows for dynamic configuration values. Ensure any added code does not alter the final returned table structure.

```lua
local world = "world"

return {
    hello = world
}
```

--------------------------------

### Get Phone Settings Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Retrieves the settings of the player's current phone. It can fetch all settings or a specific one by name. This is a client-side export of 'high-phone'.

```lua
-- To get just one setting
local airplaneMode = exports['high-phone']:getSettings('airplaneMode')
-- OR to get all settings
local settings = exports['high-phone']:getSettings()
```

--------------------------------

### Vehicles Bridge Example (Lua)

Source: https://docs.high-scripts.com/phone/bridges

An example of a vehicles bridge in Lua that overrides a framework's provided function. This demonstrates how a specific resource bridge can take precedence over a general framework bridge.

```lua
-- This is a vehicles bridge.
getVehicles = function(player)
    print("This will print, it overrides the framework's provided function.")
end

```

--------------------------------

### Get Application Context with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Obtains the current application's context, including its name, data, settings, and options, using the `useApplication` function. This is useful for accessing application-specific information and configurations.

```javascript
const { useApplication } = window.hphone;
const { name, data, settings, options } = useApplication();

console.log(name, data, settings, options);
```

--------------------------------

### Get Signal Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Retrieves the current network provider name and signal strength. If a custom configuration exists, it will be used. This client-side function is exported by 'high-phone'.

```lua
local signalData = exports['high-phone']:getSignal()
local provider = signalData.provider
local strength = signalData.strength
```

--------------------------------

### Get Internationalization Context with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Accesses the phone's internationalization (i18n) context using `useI18n`. This allows for translation of strings and checking for locale existence, utilizing functions like `t`, `te`, and `n`.

```javascript
const { useI18n } = window.hphone;
const { t, te, n } = useI18n();

if(te('phone_models.h1'))
    console.log(t('phone_models.h1'))
else
    console.warn('Locale does not exist!')
```

--------------------------------

### Get Player Phone Number by ID

Source: https://docs.high-scripts.com/phone/exports/server

Retrieves a player's phone number using their player ID. This is a direct way to get the phone number associated with a player, useful for various communication functionalities. It returns the phone number as a string.

```lua
local phoneNumber = exports['high-phone']:getPlayerPhoneNumber(1)
print(phoneNumber)
```

--------------------------------

### Get Player by Phone Number

Source: https://docs.high-scripts.com/phone/exports/server

Retrieves a player object using their phone number. This function is essential for linking phone interactions to specific player entities in the game. It returns a player object conforming to the bridge `getPlayer` structure.

```lua
local player = exports['high-phone']:getPlayerByPhone('12345')
print(player.id, player.identifier)
```

--------------------------------

### Get Player Mail Account

Source: https://docs.high-scripts.com/phone/exports/server

Retrieves the mail account data for a given player ID. This function provides access to a player's email address and potentially other account-related information. It returns the mail account object, which may include an address property.

```lua
local account = exports['high-phone']:getPlayerMailAccount(1)
print(account?.address)
```

--------------------------------

### Get Player Phone Object by ID

Source: https://docs.high-scripts.com/phone/exports/server

Fetches a player's phone object using their unique player ID. This allows access to the phone number and its associated settings for a given player. The function returns an object containing the phone number, ID, and settings.

```lua
local phone = exports['high-phone']:getPlayerPhone(1)
print(phone.number, phone.id, phone.settings)
```

--------------------------------

### Get Offline Player Mail Account

Source: https://docs.high-scripts.com/phone/exports/server

Fetches a player's mail account data even if they are offline, using their unique player identifier. This is useful for asynchronously retrieving mail account details. It returns the mail account object, which may include an address property.

```lua
local account = exports['high-phone']:getOfflinePlayerMailAccount('char1:2gtp1d6c57d7989ba1209e2c6gc9002f4872b856')
print(account?.address)
```

--------------------------------

### Configure Fivemanage Client-Side (Lua)

Source: https://docs.high-scripts.com/phone/configuration/uploading

This snippet demonstrates the client-side configuration for Fivemanage, specifically when pre-signed URLs are disabled. It includes the `presigned` setting and the `apiToken` within the services object. This configuration is crucial if you manually handle uploads from the client.

```lua
uploading = {
    services = {
        ["fivemanage"] = {
            presigned = false,
            apiToken = 'BOXjvkjmiwzdT46y2bxeemZASy1uu7tw'
        },

```

--------------------------------

### Basic Configuration Structure (Lua)

Source: https://docs.high-scripts.com/phone/configuration

This snippet demonstrates the fundamental structure of a High Scripts configuration file using Lua. It shows a minimal configuration that returns a table. The `ox_lib` framework expects configuration files to return a Lua table.

```lua
return {
    hello = "world"
}
```

--------------------------------

### Configure Livekit Server Settings (Lua)

Source: https://docs.high-scripts.com/phone/configuration/live

This snippet shows how to configure Livekit connection details in the `server.lua` file. It requires the Livekit Websocket URL, API key, and API secret obtained from the Livekit website. These values are used to establish a connection to the Livekit service for managing live streams.

```lua
liveKit = {
    url = "Paste the Websocket URL here",
    apiKey = "Paste your API key here",
    apiSecret = "Paste your API secret here"
},
```

--------------------------------

### Add Application using High Scripts Phone

Source: https://docs.high-scripts.com/phone/exports/shared

Adds an application to the High Scripts phone system. It takes the application name, configuration data, and locale information as input. Recommended for server-side use to optimize performance.

```lua
exports['high-phone']:addApplication('bankingv2', {
    icon = {
        imageUrl = "https://aka.ms/confidential",
        background = "#1B1B1B"
    },
    preAdded = false,
    removable = true,
    size = 9.11,
    inAppStore = true,
    developer = "High Scripts",
    preview = {},
    banner = {
        imageUrl = "https://aka.ms/confidential",
        background = "#1C222C",
    },
    defaultSettings = {
        notifications = { allow = true, alerts = 3 }
    }
}, {
    ["en"] = {
        label = "Banking",
        description = "A very great banking application",
    }
})

-- On the client-side:
exports['high-phone']:sendAppNui('bankingv2', {
    action = 'myevent',
    payload = {
        hello = 'world'
    }
})
```

--------------------------------

### Configure Fivemanage API Token (Server-Side Lua)

Source: https://docs.high-scripts.com/phone/configuration/uploading

This snippet shows how to configure the Fivemanage API token in the server-side configuration file for High Phone. It assumes pre-signed URLs are enabled by default. Ensure the API token is only placed on the server for security.

```lua
fivemanage = {
    apiToken = "BOXjvkjmiwzdT46y2bxeemZASy1uu7tw"
},
```

--------------------------------

### Initialize Custom Application with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Initializes a custom application by accessing the global 'hphone' variable. It retrieves event handlers, application data, settings, and options from the 'hphone' object. This is the first step for any custom application to interact with the phone's API.

```javascript
if(window.hphone) {
    const { events, useApplication } = window.hphone;
    const { name, data, settings, options } = useApplication();

    // Your code goes here..
}
```

--------------------------------

### Create General Hook with `createHook`

Source: https://docs.high-scripts.com/phone/exports/server/hooks

Creates a hook for a specified action. The callback function can return `false` to cancel the action. This is the general method for registering server-side hooks.

```lua
exports['high-phone']:createHook('startCall', function(src, call)
    print(src, json.encode(call, { indent = true }))
    -- Cancel the call
    return false
end)
```

--------------------------------

### Configure Cloudflare TURN Server Credentials

Source: https://docs.high-scripts.com/phone/configuration/video

This snippet shows how to uncomment and configure the Cloudflare TURN server settings in the server.lua file. It requires pasting the 'Turn Token ID' and 'API Token' obtained from Cloudflare. The 'ttl' parameter should typically be left unchanged.

```lua
webrtc = {
    turn = {
        -- By default, this will be commented, uncomment it.
        cloudflare = {
            ttl = 86400, -- Keep this as is.
            tokenId = 'Paste your Token ID here',
            apiToken = 'Paste your API Token here',
        }
    }
}
```

--------------------------------

### Hook Before Phone Creation

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is called before a phone is inserted into the database. It allows for injecting custom data into the phone record. The callback receives the player source and phone data.

```lua
exports['high-phone']:createHook('beforeCreatePhone', function(src, data)
    print(src, data.number)
end)
```

--------------------------------

### Import Blip Names Script to Resource (Lua)

Source: https://docs.high-scripts.com/phone/configuration/blips

Adds the 'blips.lua' script to a resource's manifest to enable blip names on the phone's map application. This is necessary because GTA 5 does not natively provide blip names. Ensure the path to the script is correct within your 'fxmanifest.lua' file.

```lua
client_script '@high-phone/imports/blips.lua'
```

--------------------------------

### Open a Modal Dialog with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal dialog box with a title, description, and configurable buttons. Each button has a type, label, and a callback function that executes when the button is pressed. Used for user confirmations or simple input.

```javascript
const { openModal } = window.hphone;

openModal({
    title: 'Title',
    description: 'Description',
    buttons: [
        {
            type: 'confirm',
            label: 'Confirm',
            callback: () => {
                console.log('Confirmed!')
            }
        },
        {
            type: 'cancel',
            label: 'Cancel',
            callback: () => {}
        }
    ]
});
```

--------------------------------

### General API Functions

Source: https://docs.high-scripts.com/phone/exports/shared

Functions for managing applications, locales, and phone numbers within the High Scripts phone system.

```APIDOC
## Shared

### `addApplication`

Adds an application to the phone. It's recommended to use this on the server-side for optimization.

### Method

EXPORTS

### Endpoint

`high-phone:addApplication`

### Parameters

#### Arguments

- **name** (string) - Required - The key, name, or index of the app.
- **data** (AppConfig) - Required - Application configuration, following the `applications.lua` format.
- **locales** (table) - Required - A table of locales for the app, inserted into `ui.apps.`.

### Request Example

```lua
exports['high-phone']:addApplication('bankingv2', {
    icon = { imageUrl = "https://aka.ms/confidential", background = "#1B1B1B" },
    preAdded = false,
    removable = true,
    size = 9.11,
    inAppStore = true,
    developer = "High Scripts",
    preview = {},
    banner = { imageUrl = "https://aka.ms/confidential", background = "#1C222C" },
    defaultSettings = { notifications = { allow = true, alerts = 3 } }
}, {
    ["en"] = {
        label = "Banking",
        description = "A very great banking application"
    }
})
```

### `addLocales`

Merges custom locales into existing ones. Useful for custom application labels and when using the phone's built-in i18n module.

### Method

EXPORTS

### Endpoint

`high-phone:addLocales`

### Parameters

#### Arguments

- **locale** (table) - Required - A table of locales.

### Request Example

```lua
exports['high-phone']:addLocales({
    ["en"] = {
        ui = {
            apps = {
                myapp = {
                    label = "My App",
                    description = "This is a great app"
                }
            }
        }
    }
})
```

### `formatNumber`

Formats a phone number string into the configured format.

### Method

EXPORTS

### Endpoint

`high-phone:formatNumber`

### Parameters

#### Arguments

- **number** (string) - Required - The phone number to format.

### Request Example

```lua
local formattedNumber = exports['high-phone']:formatNumber('1234567890')
```

### `generateNumber`

Generates a phone number based on the configuration and returns it unformatted.

### Method

EXPORTS

### Endpoint

`high-phone:generateNumber`

### Request Example

```lua
local phoneNumber = exports['high-phone']:generateNumber()
```

```

--------------------------------

### Hook for Posting Advertisements

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is triggered when an advertisement is posted in the Adspot. It can be cancelled by returning `false`. The callback receives the player source and ad data, including title and content.

```lua
exports['high-phone']:createHook('postAd', function(src, message)
    print(src, ad.title, ad.content)
    -- Cancel the ad post
    return false
end)
```

--------------------------------

### Open `select_media` Modal Sheet

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal sheet for selecting media (images or videos) with options to limit selection, allow custom URLs, and use the camera. It includes a callback function to process the selected attachments.

```javascript
openModalSheet({
    name: 'select_media',
    options: {
        limit: 1,
        allowCustomUrl: true,
        allowTake: true,
        allowedTypes: [ 'image', 'video' ]
    },
    callback: (attachments) => {
        const image = attachments[0]?.content;
        if(!image) return;

        console.log(image.url);
    }
})
```

--------------------------------

### Hook After Phone Creation

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is executed after a phone has been successfully inserted into the database. It is suitable for tasks that do not require database updates, as changes made here will not be persisted.

```lua
exports['high-phone']:createHook('afterCreatePhone', function(src, data)
    print(src, data.number)
end)
```

--------------------------------

### Open `new_contact` Modal Sheet

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal sheet to create a new contact. It supports pre-filling the phone number for the new contact.

```javascript
openModalSheet({
    name: 'new_contact',
    data: {
        number: '1234'
    }
})
```

--------------------------------

### Toggle Usability Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Controls whether the phone can be used by the player. Setting it to false prevents the phone from being opened. This client-side export is from 'high-phone'.

```lua
local formattedNumber = exports['high-phone']:toggleUsability(true)
```

--------------------------------

### Handle General Setting Updates with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Listens for the 'general.SETTING_UPDATED' event to log changes in phone settings. It defines a callback function that logs the setting name, old value, and new value. The event listener is removed after the first update, demonstrating event unsubscription.

```javascript
const { events } = window.hphone;
const callback = (data) => {
    console.log(`Setting '${data.name}' updated, old value: '${data.oldValue}', new value: '${data.value}'`);
    events.off('general.SETTING_UPDATED', callback);
}

events.on('general.SETTING_UPDATED', callback)
```

--------------------------------

### Open `new_chat` Modal Sheet

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal sheet for creating a new chat. This function allows pre-filling the recipient's number, initial message content, and attachments.

```javascript
openModalSheet({
    name: 'new_contact',
    data: {
        number: '1234',
        content: 'Hello World',
        attachments: [
            { type: 'media', content: { type: 'image', url: 'https://i.imgur.com/6AnLddq.png' } }
        ]
    }
})
```

--------------------------------

### Toggle Valet Service Usage (Lua)

Source: https://docs.high-scripts.com/phone/exports/client

Toggles the usability of Valet services for the player. Setting the state to true prevents the player from using valet services. This function is intended for client-side scripting.

```lua
-- Disables valet services for the player.
exports['high-phone']:toggleValet(false)
```

--------------------------------

### Send Mail

Source: https://docs.high-scripts.com/phone/exports/server

Enables sending emails from either the system or a player. For advanced features like HTML content and action buttons, mail must be sent from a system address configured in the mail app. It supports sender, recipients, subject, content, and attachments.

```lua
exports['high-phone']:sendMail({
    sender = '12345',
    recipients = { 'hello@high.mail', 'world@high.mail' },
    subject = 'Hello World',
    content = 'Hello Mars',
    attachments = {
        {
            type = 'media',
            content = {
                type = 'image', -- or 'video'
                url = 'https://i.imgur.com/6AnLddq.png'
            }
        }
    }
})
```

--------------------------------

### Format Number using High Scripts Phone

Source: https://docs.high-scripts.com/phone/exports/shared

Formats a given phone number string according to the user's configured settings within the High Scripts phone system. It takes a string representing the phone number as input and returns the formatted string.

```lua
local formattedNumber = exports['high-phone']:formatNumber('1234567890')
```

--------------------------------

### Send Notification Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Displays a notification on the phone, which can originate from a specific application. This client-side export is provided by 'high-phone'.

```lua
exports['high-phone']:sendNotification({
    title = 'Hello World',
    content = 'Hello World',
    application = { name = 'twizzler' },
    icon = {
        name = 'fa-solid fa-envelope',
        imageUrl = '',
        color = '#fff',
        sizeMultiplier = 1.0
    },
    duration = 5000
})
```

--------------------------------

### Configure Vehicle Image Path - Lua

Source: https://docs.high-scripts.com/phone/configuration/vehicles

This Lua snippet shows how to configure the base image path for a vehicle in the config. It links a vehicle model name to its corresponding image file located in the ui/img/vehicles directory.

```lua
vehicles = {
    model_name = {
        baseImg = "./img/vehicles/model_name.png"
    }
}
```

--------------------------------

### Can Use Valet Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Checks if the valet service is currently enabled or disabled. This client-side function is exported by the 'high-phone' script.

```lua
local canUseValet = exports['high-phone']:canUseValet()
```

--------------------------------

### Open `select_contact` Modal Sheet

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal sheet for selecting contacts, with an option to limit the number of selections. It allows pre-filling a contact number and provides a callback to retrieve the selected contact information.

```javascript
openModalSheet({
    name: 'select_contact',
    data: [
        {
            number: '1234'
        }
    ],
    options: {
        limit: 1
    },
    callback: (attachments) => {
        const contactNumber = attachments[0]?.content;
        if(!contactNumber) return;

        console.log(contactNumber);
    }
})
```

--------------------------------

### Generate Number using High Scripts Phone

Source: https://docs.high-scripts.com/phone/exports/shared

Generates a phone number based on the configuration set within the High Scripts phone system. The generated number is returned in an unformatted string.

```lua
local phoneNumber = exports['high-phone']:generateNumber()
```

--------------------------------

### Data Types

Source: https://docs.high-scripts.com/phone/exports/shared

Defines the data structures used within the High Scripts phone API.

```APIDOC
## Types

### Attachment

Represents an attachment in the phone system.

- **type** ('media' | 'contact' | 'note') - Required - The type of attachment.
- **content** (Media | Contact | Note) - Required - The content of the attachment.

### Media

Represents media attachments (image or video).

- **type** ('image' | 'video') - Required - The type of media.
- **url** (string) - Required - The URL of the media.

### Contact

Represents contact attachments.

- **number** (string) - Required - The phone number of the contact.
- **name** (string) - Required - The name of the contact.
- **photo** (string) - Optional - The URL of the contact's photo.

### Note

Represents note attachments.

- **title** (string) - Required - The title of the note.
- **content** (string) - Required - The content of the note.

```

--------------------------------

### Toggle Camera Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Controls the phone's camera view, allowing it to be enabled or disabled, and specifying facing ('front'/'rear') and portrait mode. This client-side function is exported by 'high-phone'.

```lua
-- Enables the front camera with portrait mode enabled.
exports['high-phone']:toggleCamera(true, 'front', true)
```

--------------------------------

### Open a Modal Sheet with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a full-screen modal sheet, typically used for selection interfaces like media or contacts. It allows configuration of options such as selection limits, custom URL input, and allowed media types. A callback function handles the selected data.

```javascript
const { openModalSheet } = window.hphone;

openModalSheet({
    name: 'select_media',
    options: {
        limit: 1,
        allowCustomUrl: true,
        allowTake: true,
        allowedTypes: [ 'image', 'video' ]
    },
    callback: (attachments) => {
        const image = attachments[0]?.content;
        if(!image) return;

        console.log(image.url);
    }
});
```

--------------------------------

### Open `gif` Modal Sheet

Source: https://docs.high-scripts.com/phone/applications/javascript

Opens a modal sheet specifically for selecting GIFs. It provides a callback function to handle the selected GIF attachment.

```javascript
openModalSheet({
    name: 'gif',
    callback: (attachments) => {
        const image = attachments[0]?.content;
        if(!image) return;

        console.log(image.url);
    }
})
```

--------------------------------

### Open Phone Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Opens the player's phone, with an option to bypass checks. This function is part of the client-side exports for the 'high-phone' script.

```lua
-- Opens the phone forcefully even if the player is in water, or dead.
exports['high-phone']:openPhone(true)
```

--------------------------------

### Emit NUI Callback with Javascript API

Source: https://docs.high-scripts.com/phone/applications/javascript

Sends a Network Under Interface (NUI) callback to the application's resource asynchronously. It supports passing a payload and optional debounce settings. The function can be used with `await` or `.then/.catch`.

```javascript
const { emitNui } = window.hphone;

// Await usage
const data = await emitNui('test', { hello: 'world' });

// then / catch usageemitNui('test', { hello: 'world' }).then(data => {
    console.log(data);
}).catch(err => {
    console.error(err)
});
```

--------------------------------

### Hook for Money Transfers

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is called when money is transferred between accounts. It can be cancelled by returning `false`. The callback includes details like sender, amount, recipient, and reason.

```lua
exports['high-phone']:createHook('transferMoney', function(src, account, amount, recipient, reason, request, messages)
    print(src, account, amount, recipient)
end)
```

--------------------------------

### Hook When Sending a Message

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is triggered when a message is sent, including server-initiated messages. It can be cancelled by returning `false`. The callback receives the player source (if applicable) and message data.

```lua
exports['high-phone']:createHook('sendMessage', function(src, message)
    print(src, message.sender, message.recipient)
    -- Cancel the message
    return false
end)
```

--------------------------------

### Set Phone Battery Percentage (Lua)

Source: https://docs.high-scripts.com/phone/exports/client

Sets the battery percentage of the player's phone. The percentage should be a number between 0.0 and 1.0. This function is intended for client-side scripting.

```lua
exports['high-phone']:setBattery(0.5)
```

--------------------------------

### Send Notification

Source: https://docs.high-scripts.com/phone/exports/server

Sends a notification to a specified receiver, which can be a player ID or a phone number. This function supports rich notification data, including application details, title, content, and duration, enabling customized alerts.

```lua
exports['high-phone']:sendNotification(-1, {
    application = { name = 'twizzler' },
    title = 'Hello',
    content = 'World!',
    duration = 5000
})
```

--------------------------------

### Send App NUI Message Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Sends an NUI message to a specific custom application within the phone. This client-side export is part of the 'high-phone' script.

```lua
exports['high-phone']:sendAppNui('test_app', {
    action = 'myevent',
    payload = {
        hello = 'world'
    }
})
```

--------------------------------

### Close Phone Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Closes the player's phone. This is a straightforward client-side export function from the 'high-phone' script.

```lua
exports['high-phone']:closePhone()
```

--------------------------------

### Add Locales using High Scripts Phone

Source: https://docs.high-scripts.com/phone/exports/shared

Merges custom locale data into the existing High Scripts phone locale system. This is useful for customizing application labels and utilizing the phone's built-in internationalization (i18n) module. It accepts a table of locale definitions.

```lua
exports['high-phone']:addLocales({
    ["en"] = {
        ui = {
            apps = {
                myapp = {
                    label = "My App",
                    description = "This is a great app"
                }
            }
        }
    }
})
```

--------------------------------

### Set Blip Name Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Assigns a custom name to a blip in the maps application, as blip names cannot be directly accessed via natives. This client-side export is part of 'high-phone'.

```lua
local blip = AddBlipForCoord(0.0, 0.0, 0.0)
SetBlipSprite(blip, 1)

local blipName = 'Test Blip'
BeginTextCommandSetBlipName("STRING")
AddTextComponentString(blipName)
EndTextCommandSetBlipName(blip)

exports['high-phone']:setBlipName(blip, blipName)
```

--------------------------------

### Toggle Phone Charging State (Lua)

Source: https://docs.high-scripts.com/phone/exports/client

Toggles the charging state of the player's phone. It can be called with a boolean argument to explicitly set the state or without an argument to toggle the current state. This function is intended for client-side scripting.

```lua
exports['high-phone']:toggleCharging(true)
-- Or just
exports['high-phone']:toggleCharging()
```

--------------------------------

### Set Camera Facing Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Changes the facing direction of the phone's camera (front or rear) when the camera view is active. This client-side export is part of the 'high-phone' script.

```lua
-- Enables the front camera if camera view is enabled.
exports['high-phone']:setCameraFacing('front')
```

--------------------------------

### Send NUI Message Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Sends a message to the phone's NUI interface, useful for manipulating phone behavior. This function is exported client-side by 'high-phone'.

```lua
exports['high-phone']:sendNui({
    action = 'myevent',
    payload = {
        hello = 'world'
    }
})
```

--------------------------------

### Add Vehicle Display Name - Lua

Source: https://docs.high-scripts.com/phone/configuration/vehicles

This Lua snippet demonstrates how to add a custom display name for a vehicle model. It requires the vehicle's model name, which should match the 'gameName' in the vehicles.meta file, and the desired display name.

```lua
AddTextEntry('adder', 'Adder')
```

--------------------------------

### Hook When Ending a Call

Source: https://docs.high-scripts.com/phone/exports/server/hooks

This hook is called after a phone call has concluded. It receives the player source and call data, allowing for post-call processing.

```lua
exports['high-phone']:createHook('endCall', function(src, call)
    print(src, call.caller.number, call.participants[1].number)
end)
```

--------------------------------

### Is Disabled Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Checks if the phone is currently disabled, including any restrictions imposed by 'toggleUsability'. This client-side function is exported by 'high-phone'.

```lua
local isDisabled = exports['high-phone']:isDisabled()
```

--------------------------------

### End Phone Call Client Function

Source: https://docs.high-scripts.com/phone/exports/client

Ends the current phone call. This is a client-side export function provided by the 'high-phone' script.

```lua
exports['high-phone']:endCall()
```

--------------------------------

### Send Message

Source: https://docs.high-scripts.com/phone/exports/server

Allows sending a text message from one phone number to another. The message can include attachments, such as images or videos, provided in a structured format. The function takes message data including sender, recipient, content, and attachments.

```lua
exports['high-phone']:sendMessage({
    sender = '12345',
    recipient = '123456',
    content = 'Hello World',
    attachments = {
        {
            type = 'media',
            content = {
                type = 'image', -- or 'video'
                url = 'https://i.imgur.com/6AnLddq.png'
            }
        }
    }
})
```

--------------------------------

### Check if Phone is Charging (Lua)

Source: https://docs.high-scripts.com/phone/exports/client

Checks if the player's phone is currently charging. It returns a boolean value indicating the charging status. This function is intended for client-side scripting.

```lua
local isCharging = exports['high-phone']:isCharging()
```

--------------------------------

### Accessing 'services:[name]' Global State in Lua

Source: https://docs.high-scripts.com/phone/statebags/global

This Lua code snippet demonstrates how to access the 'services:[name]' global state to retrieve the number of active workers for a specific service (e.g., 'police'). It checks if there's at least one active worker and prints a message accordingly. This functionality relies on the GlobalState object being available.

```lua
-- Example use of services:[name] global state.
local activePolice = GlobalState.state['services:police']
if(activePolice >= 1) then
    print("There is an active, on duty police officer in the call center!")
end

```

--------------------------------

### End Call

Source: https://docs.high-scripts.com/phone/exports/server

Terminates an active phone call for a specified player ID. This function is used to programmatically end a call in the game environment. It requires the player's ID as an argument.

```lua
exports['high-phone']:endCall(1)
```
Tokens:
Raw