🔧Misc

AirplaneModeEnabled

---@return boolean
exports.yseries:AirplaneModeEnabled()

StreamerModeEnabled

---@return boolean
exports.yseries:StreamerModeEnabled()

UpdateStreamerMode

---@param enabled boolean on/off the phone's steamer mode
---@param updateUI boolean whether to send an update to the UI to update the settings
exports.yseries:UpdateStreamerMode(enabled, updateUI)

ToggleFlashlight

---@param enabled boolean on/off the phone's flashlight
exports.yseries:ToggleFlashlight(enabled)

GetFlashlightState

---@return boolean
exports.yseries:GetFlashlightState()

SendAppMessage

---@param appId string -- Custom app key
---@param data { action: string, data: table } -- Data to send to the app
exports.yseries:SendAppMessage(appId, data)

--- Example
exports.yseries:SendAppMessage('app-id', { action = 'action-name', data = { foo= 'bar' } 

ToggleLandscape

-- Toggle current landscape state
exports['yseries']:ToggleLandscape()

-- Set to landscape mode explicitly  
exports['yseries']:ToggleLandscape(true)

-- Set to portrait mode explicitly
exports['yseries']:ToggleLandscape(false)

IsAppInstalled

Check if an app is installed on the current phone. You can refer to config/config.json for the app keys.

---@param appKey string The app key to check (e.g., 'darkchat', 'banking')
---@return boolean True if the app is installed, false otherwise
exports.yseries:IsAppInstalled(appKey)

-- Example
local isDarkChatInstalled = exports.yseries:IsAppInstalled('darkchat')
if isDarkChatInstalled then
    print('DarkChat is installed on this phone')
end

Modify Nui focus input

Useful when working on custom apps and dealing with input fields. By default, when an input field is focused in a custom app embedded in the phone, game keybinds (like WASD movement) will still trigger. Use this export to block game input while the user is typing.

-- focus - boolean (true = allow game input, false = block game input)
exports.yseries:SetNuiFocusKeepInput(focus)

Example of how to trigger the NUI callback from the UI of your custom app.

// Focus handlers
const handleInputFocus = () => {
    fetchNui('toggle-NuiFocusKeepInput', false).catch(() => {}); // Block game input while typing
};

const handleInputBlur = () => {
    fetchNui('toggle-NuiFocusKeepInput', true).catch(() => {}); // Re-enable game input
};

// In your JSX
<input
    type="text"
    onFocus={handleInputFocus}
    onBlur={handleInputBlur}
/>

Add the NUI callback to the client side of your custom app resource. This is necessary to allow the phone resource to control the focus of the input field.

-- Proxy NUI focus keep input to phone resource (for embedded apps with input fields)
RegisterNuiCallback('toggle-NuiFocusKeepInput', function(focus, cb)
    if GetResourceState('yseries') == "started" then
        exports['yseries']:SetNuiFocusKeepInput(focus)
    end
    cb(true)
end)