توثيق Pulse Phone
واجهة API للمطورين في Pulse Phone
يوفر Pulse Phone للـ resources الأخرى واجهة API في السيرفر والعميل: اقرأ رقم اللاعب، وأرسل رسائل نصية وبريداً وإشعارات، وأجرِ مكالمات، وتفاعل مع ما يحدث على الهاتف، وأضف تطبيقاتك الخاصة. كل ما في هذه الصفحة مأخوذ من resource الهاتف في Pulse Phone 1.5.0. القائمة الكاملة بكل المعاملات في الـ exports والأحداث.
أين توجد واجهة 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 الخاصة بالتطبيقات.
الـ exports الأكثر استخداماً في السيرفر
| 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؛ لا ينقل أي مال |
السكربتات المكتوبة لهاتف آخر تستدعي هذه بدلاً من exports ذلك الهاتف:
| 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),
})أحداث السيرفر
استمع إليها بـ AddEventHandler في سكربت سيرفر. الهاتف وحده هو من يُطلقها؛ ولا يستطيع العميل تزييفها.
| الحدث | المعاملات |
|---|---|
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 لديك |
الـ exports في العميل
| 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 releaseالـ state bags
يكتب السيرفر هذه القيم في Player(src).state بالأسماء التي تستخدمها resources الهواتف الأخرى، فتقرؤها سكربتات الـ HUD والـ dispatch دون أي تغيير: phoneNumber وphoneOpen وinCall وonCallWith وphoneBattery وphoneDead. ويقرأ العملاء قيمهم عبر LocalPlayer.state.phoneOpen.
أمثلة الإعدادات
إعدادات الهاتف في 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 بنفسه لأسماء أحداث lb-phone وqb-phone وNPWD، فتواصل السكربتات التي ترسل البريد والرسائل والتنبيهات بهذه الطريقة العمل. أما السكربتات التي تستدعي exports هاتف آخر فتحتاج إلى تغيير واحد:
exports.phone. راجع تغيير الهاتف. - مرّر قيمة
sourceالحقيقية من أحداث السيرفر الخاصة بك. لا تأخذ معرّف لاعب من رسالة عميل أبداً. - يرتبط الـ banking والجراجات والسكن والـ dispatch عبر جسور الهاتف التي تُختار عند بدء التشغيل. يمكن إضافة سكربتك كمزوّد: التكاملات المتقدمة.
الأسئلة الشائعة
ما اسم resource الخاص بـ Pulse Phone؟
phone. كل export على الشكل exports.phone:Name(...). أبقِ اسم المجلد كما هو، لأن السكربتات الأخرى وhooks عناصر المخزون تستدعيه بهذا الاسم.
هل تعمل السكربتات المكتوبة لـ lb-phone أو qb-phone مع Pulse Phone؟
السكربتات التي تستخدم أحداث تلك الهواتف (البريد والرسائل والإشعارات ورقم الهاتف) تعمل دون تعديل. أما السكربتات التي تستدعي exports الخاصة بها فتحتاج إلى exports.phone بدلاً منها.
هل يمكنني إضافة تطبيقي الخاص إلى Pulse Phone؟
نعم. سجّله بـ RegisterApp من الـ resource الخاص بك. يظهر في App Hub، ويغطي الدليل الصفحات والصلاحيات والإشعارات.