Client side

🧿 General

ToggleOpen

---@param open boolean If true: open phone, false: close phone
exports.yseries:ToggleOpen(open)

IsOpen

---@return boolean true if phone is open, false if it isn't
exports.yseries:IsOpen()

IsDisabled

---@return boolean true if phone is disabled, false if it isn't
exports.yseries:IsDisabled()

ToggleDisabled

---@param disable boolean
exports.yseries:ToggleDisabled(disable)

🌟 Groups

GetJobStage

---@return string Source player's side job stage
exports.yseries:GetJobStage()

GetGroupId

---@return number Source player's current group id
exports.yseries:GetGroupId()

IsGroupLeader

---@return boolean Whether the source player's is group leader or not
exports.yseries:IsGroupLeader()

🏢 Companies

Dispatch Preview, Dispatch Preview

SendCompanyMessage

-- Example
exports.yseries:SendCompanyMessage('ambulance', 'A citizen is in need of medical assistance', true, false)

-- Example
exports.yseries:SendCompanyMessage('ambulance', 'A citizen is in need of medical assistance', { x = -1337,  y = 1337 }, false)

---@param company string, the company name
---@param message string the message to send
---@param showLocation boolean|table *true, *false or {x = number, y = number}
---@param anonymous boolean *true or *false
exports.yseries:SendCompanyMessage(company, message, showLocation, anonymous)

🔧 Misc

AirplaneModeEnabled

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

StreamerModeEnabled

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

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' } })