Server exportları

Faturalar

Hesap Defteri'nde çevrimiçi bir oyuncu adına fatura kesen, ödeyen, iptal eden ve okuyan, gecikmiş faturaları kontrol eden server export'ları.

Bu export'lar Billing uygulamasını (Hesap Defteri) başka bir resource'tan çalıştırır. Her biri src olarak verdiğin oyuncu olarak işlem yapar: o oyuncu uygulamayı kullandığında geçerli olan yetki, sinyal ve mesafe kuralları aynen geçerlidir. apps/billing/server/exports.lua dosyasındadır.

#Çağırmadan önce

  • Resource'una apps/billing/config_server.lua içinde izin ver. Boş liste hiçbir resource'a izin vermez.
luaAPI = { AllowedResources = { ['my-saloon'] = true }, AllowDistanceOverride = false,
    MaxRequests = 30, WindowSeconds = 10, MaxPayloadBytes = 16384 },
Anahtar Varsayılan Ne yapar
AllowedResources {} Çağırabilecek resource'lar. Boş: hiçbiri.
AllowDistanceOverride false true olursa CreateInvoice iki oyuncu arasındaki mesafe kontrolünü atlar.
MaxRequests 30 Bir pencere içinde oyuncu ve çağıran resource başına çağrı sayısı (1 ile 120 arası).
WindowSeconds 10 O pencerenin uzunluğu (1 ile 60 arası).
MaxPayloadBytes 16384 JSON olarak en büyük data tablosu (1024 ile 65536 arası).
  • src, yüklü bir karakteri olan çevrimiçi bir oyuncu olmalıdır.
  • Her export ok alanı olan bir tablo döndürür. Başarısızlıkta error (oyuncuya gösterilecek yazı) ve, reddeden export'un kendisiyse, code vardır.
  • data içindeki ve dönen faturalardaki tutarlar dolardır. GetInvoiceStats sent döndürür.
  • Oyuncu ve çağıran resource başına aynı anda tek bir çağrı çalışır.
  • Yazan export'lar (CreateInvoice, PayInvoice, CancelInvoice, CancelInvoices) oyuncunun gönderme sinyaline, okuyan export'lar alma sinyaline ihtiyaç duyar. CheckUnpaidInvoices sinyal istemez.
code Ne zaman
forbidden Çağıran resource AllowedResources içinde değil
invalid_arguments src bir oyuncu id'si değil ya da data tablo değil
character_unavailable Oyuncunun yüklü bir karakteri yok
busy Senin resource'undan bu oyuncu için bir çağrı hâlâ çalışıyor
rate_limited Çok fazla çağrı; retryAfterMs ne kadar beklemen gerektiğini söyler
invalid_payload data fazla büyük ya da fazla derin
disabled Config.Billing.Enabled false
signal_unavailable Sinyal yokken CreateInvoice
unavailable Fatura aksiyonu yüklenmemiş
context_changed Çağrı sırasında oyuncunun karakteri, entegrasyon ya da şirket erişimi değişti. Yazan export'larda maybeCommitted = true: yeniden denemeden önce kontrol et.
storage_unavailable Veritabanı hata verdi. Yazan export'larda maybeCommitted = true.

Yazan export'lar bir nonce alır: 16 ile 64 karakter arası harf, rakam ya da - içeren, her işlem için benzersiz bir string. Aynı nonce'ı yeniden göndermek işlemi iki kez yapmaz, ilk sonucu duplicate = true ile döndürür. Zaman aşımından sonra yeniden denerken nonce'ı koru.

#CreateInvoice

src adına başka bir çevrimiçi oyuncuya fatura keser. SendInvoice adıyla da kullanılabilir.

lua---@param src integer the player who writes the bill
---@param data table
---@return table result { ok, id?, duplicate?, error?, code? }
exports['fx-pocketbook']:CreateInvoice(src, data)
lualocal result = exports['fx-pocketbook']:CreateInvoice(source, {
    target = customerId,
    account = 'company',
    amount = 12.50,
    description = 'Room and bath, two nights',
    nonce = ('saloon-%d-%d'):format(source, os.time()),
})
if result.ok then print('bill #' .. result.id) end
Alan Varsayılan Ne yapar
target Zorunlu. Faturayı alacak oyuncunun server id'si. Çevrimiçi ve aynı framework'te olmalı.
account 'personal' Kim kesiyor: 'personal' ya da 'company' (oyuncunun meslek şirketi). Kişisel fatura için Config.Billing.AllowPersonalSend gerekir; şirket faturası için mesleğin gönderme yetkisi gerekir.
recipientType 'personal' Kim alıyor: 'personal' ya da 'company'.
amount Zorunlu. Dolar; 0'dan büyük, en fazla Config.Billing.MaxAmount, en fazla iki ondalık.
description Zorunlu. Config.Billing.MinDescription ile MaxDescription arası karakter, en az bir harf.
details '' En fazla Config.Billing.MaxDetails karakter.
installments 1 1 ile Config.Billing.MaxInstallments arası.
periodDays 7 Son ödemeye kalan gün, 1 ile Config.Billing.MaxPeriodDays arası.
recurringDays 0 Fatura ödendikten bu kadar gün sonra yinelenir. 0 yinelenmez.
attachments https:// görsel bağlantıları listesi; en fazla Config.Billing.MaxAttachments, Config.Billing.ImageHosts doluysa oradaki bir sunucuda.
nonce Zorunlu. Yukarıya bak.
  • Config.Billing.EnforceNearby açıkken, AllowDistanceOverride true değilse oyuncular Config.Billing.NearbyDistance metre içinde durmalıdır.
  • Config.Billing.AllowCreateUI bu export'a uygulanmaz.
  • Aynı fatura (gönderen, alan, tutar, açıklama) Config.Billing.DuplicateWindowSeconds içinde yeniden kesilirse reddedilir.
  • İki taraf da bildirim alır. Hooks.Sent kancası çalışır. Bkz. Server kancaları.

#PayInvoice

src oyuncusunun aldığı bir faturayı öder.

lua---@param src integer the player who pays
---@param data table { id, nonce, account?, amount?, full? }
---@return table result { ok, duplicate?, error?, code? }
exports['fx-pocketbook']:PayInvoice(src, data)
luaexports['fx-pocketbook']:PayInvoice(source, { id = 31, full = true, nonce = myNonce })
Alan Varsayılan Ne yapar
id Zorunlu. Fatura id'si.
nonce Zorunlu.
account 'personal' 'personal' oyuncunun parasından öder (Config.MoneyAccount); 'company' meslek şirketinin kasasından öder ve o yetkiyi ister.
amount Ödenecek dolar, en fazla kalan kadar.
full true kalanın hepsini öder.
  • Ne amount ne full verilirse bir taksit ödenir.
  • Fatura açık olmalı ve bir yöneticinin incelemesini beklememelidir.
  • Hooks.Paid kancası çalışır.

#CancelInvoice

src oyuncusunun kestiği bir faturanın kalanını iptal eder.

lua---@param src integer
---@param data table { id, account?, revision? }
---@return table result { ok, duplicate?, error?, code? }
exports['fx-pocketbook']:CancelInvoice(src, data)
luaexports['fx-pocketbook']:CancelInvoice(source, { id = 31, account = 'company' })
  • Yalnızca açık ya da zamanlanmış faturalar iptal edilebilir. Ödenmiş fatura edilemez.
  • revision: verilirse fatura hâlâ o sürümde olmalıdır (GetInvoice'tan).
  • Zaten iptal edilmiş bir faturayı iptal etmek ok = true, duplicate = true döndürür.
  • Hooks.Cancelled kancası çalışır.

#CancelInvoices

src oyuncusunun kestiği birkaç faturayı iptal eder.

lua---@param src integer
---@param data table { ids, revisions, account? }
---@return table result { ok, results, cancelled, failed }
exports['fx-pocketbook']:CancelInvoices(src, data)
luaexports['fx-pocketbook']:CancelInvoices(source, {
    ids = { 31, 32 },
    revisions = { ['31'] = 1, ['32'] = 2 },
    account = 'company',
})
  • ids birbirinden farklı fatura id'lerinin listesidir, en fazla Config.Billing.MaxBulkCancel.
  • revisions her id'nin güncel sürümünü, id'yi string anahtar yaparak tutar.
  • results şöyledir: { { id, ok, duplicate, error }, ... }.

#GetInvoices

src oyuncusunun aldığı ya da kestiği faturalardan bir sayfa döndürür.

lua---@param src integer
---@param data? table filters
---@return table result { ok, invoices, hasMore, canCancel }
exports['fx-pocketbook']:GetInvoices(src, data)
lualocal result = exports['fx-pocketbook']:GetInvoices(source, { folder = 'received', state = 'open' })
Alan Varsayılan Ne yapar
account 'personal' 'personal' ya da 'company'
folder 'received' 'received' ya da 'sent'
state 'all' 'all', 'open', 'paid', 'cancelled' ya da 'scheduled'
page 1 Sayfa numarası; bir sayfada Config.Billing.PageSize fatura vardır
search '' Açıklamada ya da gönderen veya alan adında geçen yazı, en fazla 80 karakter
dateFrom, dateTo 'YYYY-MM-DD'
amountMin, amountMax Dolar

invoices içindeki her fatura: id, description, details, sender, recipient, issuer, amount, paid, penalty, remaining (dolar), state, revision, installments, periodDays, recurringDays, dueAt, createdAt.

#GetInvoice

src oyuncusunun tek bir faturasını ödemeleri ve geçmişiyle döndürür.

lua---@param src integer
---@param data table { id, account? }
---@return table result { ok, invoice }
exports['fx-pocketbook']:GetInvoice(src, data)
lualocal result = exports['fx-pocketbook']:GetInvoice(source, { id = 31 })

invoice, GetInvoices satırının alanlarına ek olarak attachments, payments (en fazla 100), events (en fazla 100), canPay, canCancel, review (incelemede bekleyen bir ödeme var), senderAvatar ve recipientAvatar içerir. Oyuncunun kestiği bir faturada commissionBps ve issuedByMe de vardır.

#GetInvoiceStats

src oyuncusunun fatura toplamlarını döndürür.

lua---@param src integer
---@param data? table { account? }
---@return table result { ok, totals, months }
exports['fx-pocketbook']:GetInvoiceStats(src, data)
lualocal stats = exports['fx-pocketbook']:GetInvoiceStats(source, { account = 'company' })
  • totals: debt, receivable, paid, received, penalties (sent) ve pending, late, sentPending, sentLate (adet).
  • months: son 6 ayda aylık tahsil edilen para, { { month = 'YYYY-MM', total }, ... }, total sent cinsinden.

#CheckUnpaidInvoices

src oyuncusunun Config.Billing.Enforcement.GraceMinutes süresinden sonra hâlâ açık kişisel faturası olup olmadığını döndürür. Oyuncu ödeyene kadar bir hizmeti (ahır, araba) kapatmak için kullan.

lua---@param src integer
---@return table result { ok, blocked, count, amount, characterId, enforcementEnabled }
exports['fx-pocketbook']:CheckUnpaidInvoices(src)
lualocal check = exports['fx-pocketbook']:CheckUnpaidInvoices(source)
if check.ok and check.blocked then
    return Notify(source, ('You owe $%.2f in %d bills.'):format(check.amount, check.count))
end
Alan Nedir
blocked Config.Billing.Enforcement.Enabled açıksa ve count 0'dan büyükse true
count Bu faturaların sayısı
amount Üzerlerinde kalan tutar, dolar
characterId Oyuncunun karakter kimliği
enforcementEnabled Config.Billing.Enforcement.Enabled değeri
  • Sinyalsiz çalışır; böylece hattı kaybetmek kontrolü atlatmanın yolu olamaz.