Client exportları

Bildirimler ve sinyal

Defterde bildirim gösteren ve oyuncunun sinyal çubuklarını okuyan client export'ları.

Bu export'lar oyuncunun kendi client'ında çalışır. Bir oyuncuya server'dan bildirim göndermek için server [Notify](/phone/docs/pocketbook/exports/server/notifications-and-signal) export'unu kullan.

#Notify

Defterde bir bildirim gösterir: açık defterde bir kart, ya da kapalı defterin üst kısmı görünür hale yükselir. Gönderen uygulamanın bildirim sesi çalar (Config.Notifications.SoundByApp) ve ana sayfa simgesine rozet gelir.

lua---@param data table { title, message, app?, offline?, kind?, icon?, duration?, progress? }
---@return boolean accepted
exports['fx-pocketbook']:Notify(data)
luaexports['fx-pocketbook']:Notify({
    title = 'Valentine Bank',
    message = 'Your savings account was opened.',
    app = 'bank',
    kind = 'money',
    offline = true,
})

Yalnızca title ve message zorunludur. Yalnızca bu alanları gönderen eski çağrılar aynen çalışır. Geçersiz bir alan atlanır, asla hata vermez.

Alan Tür Ne yapar
title string Zorunlu. 64 karaktere kısaltılır.
message string Zorunlu. 220 karaktere kısaltılır.
app string Gönderen uygulamanın id'si ('telegram', 'bank', 'billing' ya da özel uygulamanın id'si): kart onun adını ve çizimini gösterir, sesini çalar ve simgesine rozet koyar. Karta tıklamak uygulamayı açar. Küçük harf, rakam ve _, en fazla 32 karakter. Yerleşik uygulamaların hepsi bunu gönderir.
offline boolean true olursa sinyal olmadan da gösterilir. Telgrafla gelmeyen şeyler için kullan, örneğin cepteki bir kâğıt.
kind string 'info', 'success', 'warn', 'error', 'money', 'mail' ya da 'telegram': kartta sakin, renkli bir şerit.
icon string Kartın gönderenin çizimi yerine göstereceği çizimin uygulama id'si.
duration number Ekranda kalma süresi, ms, 1500 ile 15000 arası. Varsayılan Config.Notifications.Duration.
progress number ya da false 0 ile 1 arası: kartta sabit bir çizgi, bir teslimat ya da zamanlayıcı için. false: çizgi yok. Yazılmazsa çizgi süreyle birlikte azalır.

Tekrarlayan bildirimler üst üste binmez, tek kartta birleşir:

  • Aynı app ve kind yeniden gelirse (art arda üç telgraf): en yeni metinle tek kart ve "+2 yeni" sayısı.
  • kind olmadan aynı app ve title (bir ses adımı, bir sayaç): ekrandaki ya da sıradaki kart yeniden yazılır.
  • Şu durumlarda false döndürür: arayüz yüklenmemişse, Config.Notifications.Enabled false ise, title ya da message string değilse veya bekleme listesi doluysa.
  • Sinyal açıkken (Config.Signal.Enabled), offline true değilse ve oyuncunun çubuğu Config.Signal.ReceiveBars değerinden azsa bildirim bekler. Oyuncu başına en fazla 50 bildirim bekleyebilir. Sinyal gelince sırayla gösterilir. Export yine de true döndürür.
  • Oyuncu karakter değiştirince bekleme listesi temizlenir.

#GetSignal

Oyuncunun sinyal çubuklarını döndürür.

lua---@return integer bars 0 to 5
exports['fx-pocketbook']:GetSignal()
lualocal bars = exports['fx-pocketbook']:GetSignal()
  • Config.Signal.Enabled = false ise her zaman 5 döner.
  • Değer server'dan defter açıkken her Config.Signal.UpdateInterval, kapalıyken her Config.Signal.IdleInterval milisaniyede bir gelir. Üç aralık boyunca cevap gelmezse 0 olur (varsayılanlarla açıkken 6, kapalıyken 30 saniye).
  • [fx-pocketbook:signalChanged](/phone/docs/pocketbook/events/client-events) event'i çubuklar ya da kasaba değiştiğinde ve defter açıldıktan sonra bir kez tetiklenir.

#CanUseOnline

Sinyalin göndermeye ya da almaya yetecek kadar güçlü olup olmadığını döndürür.

lua---@param operation 'send'|'receive'
---@return boolean ok
exports['fx-pocketbook']:CanUseOnline(operation)
luaif not exports['fx-pocketbook']:CanUseOnline('send') then
    return exports['fx-pocketbook']:Notify({ title = 'Telegraph', message = 'No line here.', offline = true })
end
  • 'receive' çubukları Config.Signal.ReceiveBars ile karşılaştırır. Başka her değer Config.Signal.SendBars ile karşılaştırır.
  • Bu, oyuncunun kendi tarafındaki değerdir. Önemli kararlarda (para, item) server [CanUseOnline](/phone/docs/pocketbook/exports/server/notifications-and-signal) export'unu kullan.