Özel uygulamalar
Özel uygulamalara genel bakış
Başka bir resource'un deftere kendi uygulamasını nasıl eklediği: üç parça, ayarlar, sınırlar ve bir uygulamanın uyması gereken kurallar.
29 yerleşik uygulamanın hepsi fx-pocketbook içinde gelir. Başka bir resource, çekirdeği değiştirmeden defterin uygulama listesine kendi uygulamasını ekleyebilir. Uygulama o resource'ta yaşar: sayfası, server kodu ve verisi.
Bu, Pocketbook eklenti API'sinin 1. sürümüdür. Başka bir telefonun API'sinin birebir kopyası değildir.
#Üç parça
| Parça | Nerede | Ne yapar |
|---|---|---|
| Liste girişi | client, [AddCustomApp](/phone/docs/pocketbook/exports/client/custom-apps) |
Uygulamanın adını ve simgesini listeye koyar, hangi sayfanın yükleneceğini söyler |
| Sayfa | tarayıcı, [pocketbook.js](/phone/docs/pocketbook/custom-apps/browser-bridge) |
Defterin içinde gösterilen HTML'in. Temayı ve sinyali okur, istek gönderir. |
| Server aksiyonları | server, [RegisterApplication](/phone/docs/pocketbook/exports/server/custom-apps) |
Sayfanın isteklerini cevaplayan fonksiyonlar |
Bir istek şöyle ilerler:
- Sayfa
Pocketbook.request('balance', { ... })çağırır. - Defter bunu server'a, uygulamanın
balanceaksiyonu olarak gönderir. - Server oyuncuyu kontrol eder (karakter, defter item'ı, uygulama kurulu mu) ve senin fonksiyonunu
source,characterve payload ile çağırır. - Fonksiyonun
{ ok = true, ... }ya da{ ok = false, error = '...' }döndürür. Sayfa bu tabloyu alır.
Çalışan tam bir resource Başlangıç sayfasında.
#Ayarlar
config.lua:
luaConfig.CustomApps = { Enabled = true, Maximum = 24, RequireInstall = true }
| Anahtar | Varsayılan | Ne yapar |
|---|---|---|
Enabled |
true |
Özel uygulamaları açar ya da kapatır. Kapalıyken AddCustomApp ve RegisterApplication her uygulamayı reddeder. |
Maximum |
24 |
Aynı anda kayıtlı olabilecek özel uygulama sayısı. |
RequireInstall |
true |
Server aksiyonlarının çalışması için oyuncu uygulamayı önce App Store'dan kurmalıdır. Orada özel uygulama olarak listelenir. false: kurmadan çalışır. |
Uygulamana ayrı bir log webhook'u vermek için çekirdeğin config_server.lua dosyasına, yerleşik bir uygulamanın config_server.lua dosyasıyla aynı biçimde PocketServerConfig.Apps['<senin id>'].Logs ekle. Webhook'u asla client ya da shared bir dosyaya koyma.
#Senin resource'un
luafx_version 'cerulean'
game 'rdr3'
rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships.'
dependency 'fx-pocketbook'
client_script 'client.lua'
server_script 'server.lua'
files { 'ui/index.html', 'ui/app.js', 'ui/style.css', 'ui/pocketbook.js', 'ui/icon.png' }
- Sayfanın yüklediği her dosyayı
filesaltında listele. - Uygulama için
ui_pagetanımlama. Çerçeveyi defter oluşturur ve odak ondadır. - fx-pocketbook içindeki
sdk/pocketbook.jsdosyasını sayfa klasörüne kopyala ve kendi script'inden önce yükle. İnternetten hiçbir şeye ihtiyaç duymaz. - Resource'unu
fx-pocketbook'tan sonra başlat.
#Yeniden başlatmalar
- Resource'un durduğunda liste girişi, sayfası ve server aksiyonları kaldırılır.
- fx-pocketbook yeniden başladığında bütün özel uygulamaları unutur. Yeniden kaydet:
- client: kendi resource'un başlarken ve [
fx-pocketbook:ready](/phone/docs/pocketbook/events/client-events) event'inde, - server: kendi resource'un ve
fx-pocketbookiçinonResourceStartevent'inde. - Zaten kayıtlı bir id'yi kaydetmek
falsedöndürür ve ilk kaydı korur. Kaydın başarısız olduğunda başka bir resource'un uygulamasını asla kaldırma.
#Sınırlar
| Ne | Sınır |
|---|---|
| Uygulama id'si | Küçük harf, rakam ve _; harfle başlar, en fazla 32 karakter, yerleşik bir id olamaz |
| Uygulama adı | En fazla 64 bayt |
| Uygulama başına server aksiyonu | 1 ile 32 arası; adlar harf ve rakamdan oluşur, harfle başlar, en fazla 32 karakter |
| Payload, sonuç ve mesajlar | JSON olarak 32 KiB, 8 seviye derinlik, tablo başına 128 anahtar, en fazla 16384 baytlık string'ler |
| Bir sayfada bekleyen istek | 4 |
| Sayfada istek zaman aşımı | 15 saniye |
| Oyuncu başına istek | Bütün defter için aynı anda bir tane, en az 250 ms arayla |
#Uygulamanın uyması gereken kurallar
- Her kararı server'da ver.
sourcevecharacterçekirdekten gelir; oyuncu id'sini, karakter kimliğini, fiyatı, mesleği ya da yetkiyi asla payload'dan alma. - Her aksiyonda kendi kurallarını (sahiplik, meslek, rütbe) kontrol et. Uygulama kaydetmek ona para ya da envanter yetkisi vermez.
- Beklenen bir sorgudan sonra ve bir değişiklikten hemen önce [
ValidateApplicationPlayer](/phone/docs/pocketbook/exports/server/custom-apps) ile kendi kontrollerini yeniden çalıştır. - Yazma işlemlerini tekrarlanabilir yap: sayfadan sabit bir nonce ve beklenen bir sürüm gönder. Zaman aşımı değişikliğin başarısız olduğu anlamına gelmez. Yeniden deneme sunmadan önce, özellikle para ve item'larda, aynı nonce'ı kullan ve kaydedilmiş sonucu oku.
- Bir aksiyon telgraf hattı gerektiriyorsa [
CanUseOnline](/phone/docs/pocketbook/exports/server/notifications-and-signal) çağır. Çekirdek bunu senin yerine kontrol etmez. - Sayfaya yazıyı ham HTML olarak değil,
textContentya da kaçışlı şablonlarla koy. - İstek göndermeden önce ilk
onContextçağrısını bekle. Sayfa açıkken tema ve sinyal değişebilir; bir formu sıfırlamadan renkleri güncelle. - Oyuncu uygulamadan çıkınca sayfa yok edilir. Dinleyicilerini ve zamanlayıcılarını kaldır, veriyi server'da tut, sayfanın içinde dünya sesi çalma.
customAppOpenedvecustomAppClosedevent'lerini kendi id'ne göre süz.- Test et: yetkisi olmayan oyuncular, kopyalanmış id'ler, aynı anda iki kayıt, karakter değiştirme ya da bağlantı kopması, defter item'ının alınması, bir aksiyon sırasında resource'un yeniden başlaması, kaybolan bir cevap, sinyalsizlik ve küçük bir ekran.