Server exportları

Özel uygulama aksiyonları

Özel uygulamana server aksiyonlarını veren, bunları kaldıran ve bir değişiklikten önce oyuncuyu yeniden kontrol eden server export'ları.

Uygulamanın sayfası Pocketbook.request('action', payload) çağırır. Defter bunu server'a gönderir ve resource'unun bu export'larla kaydettiği aksiyonu çalıştırır. Akışın tamamı için Özel uygulamalara genel bakış sayfasına bak.

Yalnızca Config.CustomApps.Enabled true iken çalışırlar.

#RegisterApplication

Uygulamanın server aksiyonlarını kaydeder. Çağıran resource sahibi olur.

lua---@param id string the same id you gave AddCustomApp
---@param actions table { [name] = function(source, character, payload) ... end }
---@return boolean ok
---@return string? reason
exports['fx-pocketbook']:RegisterApplication(id, actions)
lualocal function register()
    exports['fx-pocketbook']:RegisterApplication('ranch_ledger', {
        balance = function(source, character, payload)
            -- check ownership, job and permissions here, on the server
            return { ok = true, balance = 0 }
        end,
    })
end
AddEventHandler('onResourceStart', function(resource)
    if resource == GetCurrentResourceName() or resource == 'fx-pocketbook' then register() end
end)
Kural Değer
id AddCustomApp ile aynı kurallar: küçük harf, rakam ve _; harfle başlar, en fazla 32 karakter, yerleşik bir id olamaz, daha önce kaydedilmemiş olmalı.
Aksiyon adları Harfle başlar, yalnızca harf ve rakam, en fazla 32 karakter.
Aksiyon sayısı 1 ile 32 arası.

Bir aksiyon şunları alır:

Argüman Nedir
source İsteği yapan oyuncu.
character { id, framework, name, job, grade, onDuty? }. id 'vorp:...' ya da 'rsg:...' olur. Sayfadan değil, framework'ten gelir.
payload Sayfanın gönderdiği tablo. İçindeki her değeri güvenilmez say.

Bir aksiyon, boolean ok alanı olan bir tablo döndürmelidir. Başka her şey sayfaya ok = false ve bir hata yazısı olarak ulaşır.

  • Tablo sayfaya geri gönderilir. Bir mesajla aynı boyut sınırlarına uymalıdır: JSON olarak 32 KiB, 8 seviye, tablo başına 128 anahtar, en fazla 16384 baytlık string'ler.
  • İsteğe bağlı bir audit tablosu server log'una yazılır ve sonuç sayfaya ulaşmadan silinir. İçine gizli bilgi ve uzun yazı koyma.
  • Log'lar, eklersen çekirdeğin config_server.lua dosyasındaki PocketServerConfig.Apps['<senin id>'].Logs ayarına, yerleşik bir uygulamayla aynı biçimde gider. Yoksa çekirdeğin log ayarları geçerlidir.
  • Bir aksiyon çalışırken resource'un yeniden başlarsa sayfa eski sonucun yerine ok = false (uygulama yeniden başladı) alır. Handler'ının zaten yaptığı bir değişiklik geri alınmaz.
  • Çekirdek, özel uygulamalar için sinyali kontrol etmez. Aksiyon hat gerektiriyorsa [CanUseOnline](/phone/docs/pocketbook/exports/server/notifications-and-signal) çağır.
  • Config.CustomApps.RequireInstall = true iken oyuncu uygulamayı önce App Store'dan kurmalıdır. O zamana kadar her aksiyon uygulamanın kurulu olmadığını söyler.
  • Kayıt, para ya da envanter yetkisi vermez.

#UnregisterApplication

Uygulamanın server aksiyonlarını kaldırır.

lua---@param id string
---@return boolean removed false when the app is not yours
exports['fx-pocketbook']:UnregisterApplication(id)
luaexports['fx-pocketbook']:UnregisterApplication('ranch_ledger')

Sahibi olan resource durduğunda da aksiyonlar kaldırılır.

#ValidateApplicationPlayer

Aksiyonun bir şeyi değiştirmeden hemen önce yeniden kontrol eder: oyuncu hâlâ aynı karakterde mi, defteri hâlâ kullanabiliyor mu (item ve erişim kuralları) ve uygulaman hâlâ aynı kayıt mı.

lua---@param id string your app id
---@param src integer
---@param characterId string the character.id your action received
---@return boolean allowed
---@return string? reason
exports['fx-pocketbook']:ValidateApplicationPlayer(id, src, characterId)
luabalance = function(source, character, payload)
    local row = MySQL.single.await('SELECT balance FROM ranch_ledgers WHERE owner = ?', { character.id })
    local allowed, reason = exports['fx-pocketbook']:ValidateApplicationPlayer('ranch_ledger', source, character.id)
    if not allowed then return { ok = false, error = reason } end
    return { ok = true, balance = row and row.balance or 0 }
end,
  • Yalnızca id'yi kaydeden resource çağırabilir.
  • Tek bir andaki kontroldür; bir kilit ya da para veya envanter işlemi değildir. Kendi kontrollerin (sahiplik, meslek, yazma işlemleri için nonce) yine gereklidir.