คู่มือ Pulse Phone
API สำหรับนักพัฒนาของ Pulse Phone
Pulse Phone มี API ฝั่งเซิร์ฟเวอร์และไคลเอนต์ให้ resource อื่นใช้: อ่านเบอร์ของผู้เล่น ส่งข้อความ เมล และการแจ้งเตือน โทรออก ตอบสนองต่อสิ่งที่เกิดขึ้นบนมือถือ และเพิ่มแอปของคุณเอง ทุกอย่างในหน้านี้มาจาก resource phone ของ Pulse Phone 1.5.0 รายการครบทุกอาร์กิวเมนต์อยู่ที่ Exports และ events
API อยู่ที่ไหน
resource ชื่อ phone ดังนั้นทุกการเรียกคือ exports.phone:... รอให้มือถือพร้อมก่อนใช้งาน: IsReady() จะเป็น true เมื่อฐานข้อมูลตอบกลับและมือถือรับคำขอได้แล้ว
CreateThread(function()
while GetResourceState('phone') ~= 'started' or not exports.phone:IsReady() do Wait(500) end
print('Pulse Phone is ready')
end)phone_api ในคอนโซลเซิร์ฟเวอร์จะแสดงสรุปสั้น ๆ ของ API แอป
export ฝั่งเซิร์ฟเวอร์ที่ใช้บ่อยที่สุด
| Export | ทำอะไร |
|---|---|
GetPhoneNumber(src) |
เบอร์ของมือถือที่ผู้เล่นถืออยู่ หรือ nil จนกว่าจะโหลดเสร็จ |
SourceOfNumber(number) |
ผู้เล่นออนไลน์ที่ใช้เบอร์นั้น หรือ nil |
Notify(src, { title, body, app?, actions? }) |
การแจ้งเตือนบนมือถือของผู้เล่นคนนั้น พร้อมปุ่มได้สูงสุด 3 ปุ่ม |
SendMessage(src, number, text) |
ข้อความจากผู้เล่นคนนั้นไปยังเบอร์หนึ่ง |
SendMail(address, sender, subject, body) |
เมลไปยังที่อยู่หนึ่ง |
Call(src, number, video?) |
โทรออกให้ผู้เล่นคนนั้น |
SetPhoneDisabled(src, bool) |
ปิดหรือเปิดมือถือของผู้เล่น (เช่น ติดคุก หรือฉากคัตซีน) |
RecordTransaction(number, 'sent' or 'received', amount, party, note?) |
รายการในใบแจ้งยอดของ Wallet โดยไม่ได้ย้ายเงินจริง |
สคริปต์ที่เขียนสำหรับมือถือรุ่นอื่นให้เรียกตัวเหล่านี้แทน export ของมือถือรุ่นนั้น:
| Export | ทำอะไร |
|---|---|
ResolvePhone(target[, cb]) |
หามือถือด้วย { source }, { number }, { email }, { identifier } หรือ { imei } |
DeliverMailTo(target, mail[, cb]) |
เมลไปยังมือถือเครื่องนั้น: { sender, subject, body } |
SendText(from, to, body[, opts][, cb]) |
ข้อความจากมือถือเครื่องหนึ่ง หรือจากบริการที่ระบุชื่อ |
DispatchAlert(jobs, { title, body, coords? }) |
แจ้งเตือนสมาชิกทุกคนของอาชีพเหล่านั้นที่เข้างานอยู่ และคืนค่าจำนวนที่ส่งถึง |
ตัวอย่าง: สคริปต์ปล้นแจ้งตำรวจพร้อมหมุดบนแผนที่
local reached = exports.phone:DispatchAlert({ 'police', 'sheriff' }, {
title = 'Store robbery',
body = 'Alarm at the 24/7 on Innocence Blvd.',
coords = vector3(25.7, -1345.6, 29.5),
})event ฝั่งเซิร์ฟเวอร์
รับฟังด้วย AddEventHandler ในสคริปต์ฝั่งเซิร์ฟเวอร์ มีเพียงมือถือที่เรียก event เหล่านี้ได้ ไคลเอนต์ปลอมไม่ได้
| Event | อาร์กิวเมนต์ |
|---|---|
phone:numberChanged |
src, number, oldNumber |
phone:callStarted |
callId, fromNumber, toNumber, fromSrc, toSrc, video |
phone:callEnded |
fromNumber, toNumber, reason, durationMs, fromSrc, toSrc, callId |
phone:messageSent |
fromNumber, toNumber, body |
phone:emergencyCall |
src, service, reason, coords |
phone:wallet:transfer |
fromNumber, toNumber, amount, note |
phone:notification:action |
src, app, notificationId, actionId: มีการกดปุ่มที่ Notify ของคุณแสดงไว้ |
export ฝั่งไคลเอนต์
| Export | ทำอะไร |
|---|---|
Open(), Close(), IsOpen() |
เปิดหรือปิดมือถือ; Open เคารพทุกการบล็อกด้านล่าง |
AddOpenCheck(fn) |
fn() ที่คืนค่า false จะหยุดไม่ให้มือถือเปิด และถูกถอดออกเมื่อ resource ของคุณหยุด |
SetRestriction(key, mode) |
สถานะผู้เล่นของคุณเอง: 'block', 'emergency-only' หรือ nil เพื่อล้างค่า |
SetCarAudio(state) |
แสดงเครื่องเสียงรถของคุณบน Pulse Drive ซึ่งเป็นหน้าจอในรถ |
GetPhoneNumber(), IsInCall(), GetBattery() |
มือถือของผู้เล่นคนนี้เอง |
ตัวอย่าง: ไม่มีมือถือใช้ขณะผู้เล่นอยู่ในคุกของคุณ
exports.phone:SetRestriction('myjail', 'block') -- on entering the cell
exports.phone:SetRestriction('myjail', nil) -- on releasestate bag
เซิร์ฟเวอร์เขียนค่าเหล่านี้ลงใน Player(src).state ด้วยชื่อที่ resource มือถืออื่นใช้ ทำให้สคริปต์ HUD และ dispatch อ่านได้โดยไม่ต้องแก้: phoneNumber, phoneOpen, inCall, onCallWith, phoneBattery, phoneDead ฝั่งไคลเอนต์อ่านค่าของตัวเองได้ที่ LocalPlayer.state.phoneOpen
ตัวอย่าง config
การตั้งค่าของมือถืออยู่ใน phone/config/ สามรายการที่สคริปต์อื่นพึ่งพา:
Config.Item = {
required = false, -- true: the player needs the phone item
name = 'phone',
}
Config.Public = {
numberState = true, -- publish Player(src).state.phoneNumber
}
Config.Open = {
blockWhenNuiFocused = true, -- no phone while another menu holds the cursor
}แอปของคุณเอง
exports.phone:RegisterApp({ id, name, colour, icon, page = { kind = 'frame', url = 'ui/index.html' } }) เพิ่มแอปลงในหน้าจอหลักและ App Hub หน้าเพจทำงานใน frame ของตัวเองและคุยกับเซิร์ฟเวอร์ของคุณผ่านมือถือ สิทธิ์ การแจ้งเตือน ภาษา และรายการใน App Hub เป็นช่องที่ไม่บังคับ คู่มือฉบับเต็มอยู่ที่ แอปที่สร้างเอง
บันทึกการเชื่อมต่อ
- Pulse Phone ตอบรับชื่อ event ของ lb-phone, qb-phone และ NPWD เอง ดังนั้นสคริปต์ที่ส่งเมล ข้อความ และการแจ้งเตือนด้วยวิธีนั้นยังทำงานต่อได้ สคริปต์ที่เรียก export ของมือถือรุ่นอื่นต้องแก้จุดเดียว:
exports.phoneดู การเปลี่ยนมือถือ - ส่ง
sourceตัวจริงจาก event ฝั่งเซิร์ฟเวอร์ของคุณเอง ห้ามใช้ ID ผู้เล่นจากข้อความของไคลเอนต์ - ธนาคาร โรงรถ ที่อยู่อาศัย และ dispatch เชื่อมต่อผ่าน bridge ของมือถือที่เลือกตอนเริ่มระบบ คุณเพิ่มสคริปต์ของตัวเองเป็นผู้ให้บริการได้: การเชื่อมต่อขั้นสูง
คำถามที่พบบ่อย
resource ของ Pulse Phone ชื่ออะไร
phone ทุก export อยู่ในรูป exports.phone:Name(...) คงชื่อโฟลเดอร์ไว้ เพราะสคริปต์อื่นและ hook ของไอเทมในคลังเรียกด้วยชื่อนี้
สคริปต์ที่เขียนสำหรับ lb-phone หรือ qb-phone ใช้กับ Pulse Phone ได้หรือไม่
สคริปต์ที่ใช้ event ของมือถือเหล่านั้น (เมล ข้อความ การแจ้งเตือน เบอร์โทร) ทำงานได้โดยไม่ต้องแก้ ส่วนสคริปต์ที่เรียก export ของมือถือเหล่านั้นต้องเปลี่ยนเป็น exports.phone
เพิ่มแอปของตัวเองลงใน Pulse Phone ได้หรือไม่
ได้ ลงทะเบียนด้วย RegisterApp จาก resource ของคุณ แอปจะแสดงใน App Hub และคู่มือครอบคลุมเรื่องหน้าเพจ สิทธิ์ และการแจ้งเตือน