Server exportları

Telgraf yönetimi

Bir devlet ya da yönetici resource'u için server export'ları ve konsol komutları: her posta kutusuna resmî telgraf, posta kutusu okuma, adres değiştirme ve posta kutusu kapatma.

Bu export'lar güvenilir bir server resource'u içindir, örneğin bir devlet ya da yönetici script'i. Hiçbir client event'i bunlara ulaşamaz. apps/telegram/server/administration.lua dosyasındadır.

#Ayarlar

apps/telegram/config_server.lua > PocketServerConfig.Apps.telegram.Administration:

Anahtar Varsayılan Ne yapar
Enabled true Yönetim export'larını ve komutlarını açar ya da kapatır
AllowedResources {} Export'ları çağırabilecek resource'lar, örneğin { ['my-government'] = true }. Boş: hiçbiri.
SenderAddress 'SYSTEM' Resmî telgrafların geldiği adres
SenderName 'Resmî Telgraf Dairesi' Resmî telgraflardaki gönderen adı
MaxActiveBroadcasts 3 Aynı anda bekleyebilecek resmî telgraf sayısı
MaxBroadcastRecipients 10000 Posta kutusu sayısı bundan fazlaysa resmî telgraf reddedilir
BroadcastBatchSize 25 Her turda doldurulan posta kutusu (1 ile 100 arası)
ForcedClosure { Enabled = true, RefundPercent = 0, CooldownSeconds = 86400 } Posta kutusu kapatma: açık mı kapalı mı, adres ücretinin geri ödenen yüzdesi ve oyuncunun yeniden açabilmesi için geçmesi gereken süre
BroadcastTemplates {} Gönderilebilecek resmî telgraflar, anahtarlarıyla: ['notice'] = { subject = '...', body = '...' }
  • Her export ok alanı olan bir tablo döndürür. Başarısızlıkta error vardır.
  • AllowedResources listesinde olmayan bir resource'tan gelen ya da Enabled false iken yapılan çağrı ok = false döndürür.
  • Her çağrı, çağıran resource ile birlikte server log'una yazılır.
  • Aynı anda tek bir yönetim işlemi çalışır. Bu sırada gelen ikinci çağrı ok = false döndürür; yeniden dene.
  • nonce alan işlemler (16 ile 64 karakter arası harf, rakam ya da -) aynı nonce için ilk sonucu yeniden döndürür.

#SendGovernmentTelegram

Bir şablondan, adresi olan her kişisel ve şirket posta kutusuna resmî telgrafı sıraya koyar.

lua---@param templateKey string key in BroadcastTemplates
---@param nonce string
---@return table result { ok, id, state, recipients } or { ok, id, state, queued, skipped, duplicate = true }
exports['fx-pocketbook']:SendGovernmentTelegram(templateKey, nonce)
lua-- config_server.lua: BroadcastTemplates = { tax = { subject = 'Land tax', body = 'Land tax is due on Friday.' } }
local result = exports['fx-pocketbook']:SendGovernmentTelegram('tax', 'tax-notice-1899-05-01')
  • Konu ve metin Config.Telegram.MaxSubject ve MaxBody sınırlarına sığmalıdır.
  • Dağıtım, oyuncular çevrimiçiyken arka planda her 10 saniyede bir, her turda BroadcastBatchSize posta kutusu olarak yapılır. Dolu bir posta kutusu atlanır ve sayılır.

#GetGovernmentTelegramStatus

lua---@param id integer
---@return table result { ok, broadcast }
exports['fx-pocketbook']:GetGovernmentTelegramStatus(id)
lualocal status = exports['fx-pocketbook']:GetGovernmentTelegramStatus(4)
print(status.broadcast.state, status.broadcast.queued_count)

broadcast şunları içerir: id, state ('queued', 'completed' ya da 'cancelled'), template_key, queued_count, skipped_count, cursor_id, max_recipient_id, created_at ve completed_at.

#CancelGovernmentTelegram

Hâlâ sırada bekleyen bir resmî telgrafın kalanını durdurur. Teslim edilmiş telgraflar kalır.

lua---@param id integer
---@return table result { ok }
exports['fx-pocketbook']:CancelGovernmentTelegram(id)
luaexports['fx-pocketbook']:CancelGovernmentTelegram(4)

#InspectTelegramMailbox

Bir posta kutusunu ve gönderilen ve alınan telgraflarını döndürür; sayfa başına 25, en yeni önce.

lua---@param address string
---@param page? integer default 1
---@return table result { ok, mailbox, messages, page }
exports['fx-pocketbook']:InspectTelegramMailbox(address, page)
lualocal result = exports['fx-pocketbook']:InspectTelegramMailbox('JMARSTON', 1)
  • address büyük-küçük harf ayırmaz.

#ReassignTelegramAddress

Kişisel bir posta kutusuna yeni bir adres verir.

lua---@param address string current address
---@param newAddress string
---@param mailboxId integer the mailbox id, from InspectTelegramMailbox
---@return table result { ok, id, address }
exports['fx-pocketbook']:ReassignTelegramAddress(address, newAddress, mailboxId)
luaexports['fx-pocketbook']:ReassignTelegramAddress('JMARSTON', 'JOHNM', 118)
  • mailboxId, şu an address adresine sahip posta kutusuyla eşleşmelidir; böylece değişmiş bir posta kutusuna yanlışlıkla dokunulmaz.
  • newAddress boşta olmalı, PB- ile başlamamalı, Config.Telegram.ReservedAddresses ya da SenderAddress olmamalı ve bir şirket posta kutusuna ayrılmış olmamalıdır.
  • Şirket ve sistem posta kutuları değiştirilemez.

#ForceCloseTelegramMailbox

Kişisel bir posta kutusunu kapatır. Telgrafları saklanır. ForcedClosure.Enabled = true gerekir.

lua---@param address string
---@param mailboxId integer
---@param nonce string
---@param reason string 8 to 240 characters
---@return table result { ok, closed, duplicate, refund, reopenAt }
exports['fx-pocketbook']:ForceCloseTelegramMailbox(address, mailboxId, nonce, reason)
luaexports['fx-pocketbook']:ForceCloseTelegramMailbox('JMARSTON', 118, 'close-118-1899-05-01', 'Court order 14/1899')
  • refund dolar cinsindendir (adres ücretinin RefundPercent kadarı). reopenAt, oyuncunun yeniden posta kutusu açabileceği unix zamanıdır.
  • Oyuncu çevrimdışıyken de çalışır.
  • Oyuncunun incelemede bekleyen bir para işlemi ya da bekleyen bir kaydı varsa reddedilir.

#Konsol komutları

Aynı işlemler, server konsolu ya da command.<ad> ACE yetkisi olan oyuncular için kısıtlı komut olarak da vardır:

Komut Argümanlar
pocketbook_broadcast <template> <nonce>
pocketbook_broadcast_status <id>
pocketbook_broadcast_cancel <id>
pocketbook_close_mailbox <address> <mailboxId> <nonce> <reason...>
pocketbook_broadcast tax tax-notice-1899-05-01