Server exportları

Belgeler

Kartlarim'da görünen belgeleri, yani kimlik kartlarını ve ruhsatları veren, kontrol eden, askıya alan ve silen server export'ları.

Kartlarim, defterin belge ve tapu cüzdanıdır. Belgeleri başka script'ler verir: bir ruhsat dairesi, bir doktor, bir ahır. Bu export'lar apps/kartlarim/server/exports.lua dosyasındadır.

#Her Kartlarim export'u için kurallar

  • target bir oyuncunun server id'si (çevrimiçi) ya da bir karakter kimliğidir ('vorp:12', 'rsg:ABC12345'). Karakter kimliği, karakter çevrimdışıyken de çalışır. O zaman adı kendin ver (holder), çünkü server adı okuyamaz.
  • Her export değerini ya da false ve bir neden döndürür.
  • Veritabanını beklerler. Bir thread'den ya da bir event handler'dan çağır.
  • Kimler çağırabilir: apps/kartlarim/config_server.lua > API.AllowedResources. Boş olursa her resource çağırabilir. Bkz. Erişim listeleri.
  • Sahibi çevrimiçiyse açık Kartlarim sayfası yenilenir ve bir bildirim gösterilir. Sinyal gerekmez.
Neden Ne zaman
disabled Config.Kartlarim.Enabled false
forbidden Çağıran resource izin listesinde değil
failed Veritabanı çağrısı başarısız oldu. sql/install.sql dosyasının çalıştığını kontrol et.
invalid_arguments Bir argümanın türü ya da aralığı yanlış
character_unavailable Oyuncu id'sinin yüklü bir karakteri yok ya da karakter kimliği bozuk
invalid_type Belge türü geçerli bir ad değil
not_found O id ile belge yok
database Satır yazılamadı

#IssueDocument

Bir karaktere belge verir.

lua---@param target integer|string player server id or character id
---@param data table document fields, see below
---@return integer|false id
---@return string numberOrReason the document number, or the reason
exports['fx-pocketbook']:IssueDocument(target, data)
lualocal id, number = exports['fx-pocketbook']:IssueDocument(source, { type = 'avci', days = 30 })
if not id then print('licence failed: ' .. number) end
Alan Ne yapar
type Zorunlu. Config.Kartlarim.DocumentTypes içindeki bir anahtar (varsayılan olarak kimlik, avci, balikci, silah, saglik, at) ya da küçük harf, rakam ve _ içeren, en fazla 32 karakterlik başka bir ad. Config'de olmayan bir tür düz görünür.
title Kartın başlığı, en fazla 80 karakter. Varsayılan: türün label değeri.
number Belge numarası, en fazla 32 karakter. Varsayılan: türün prefix değeri ve beş rakam, örneğin AV-10014.
class Adın altındaki satır, en fazla 80 karakter. Varsayılan: türün class değeri.
issuer Belgeyi veren daire, en fazla 120 karakter. Varsayılan: türün office değeri.
signer İmzanın altındaki ad, en fazla 80 karakter. Varsayılan: türün signer değeri.
role İmzalayanın unvanı, en fazla 64 karakter. Varsayılan: türün role değeri.
terms Koşullar yazısı, en fazla 400 karakter. Varsayılan: türün terms değeri.
issued Veriliş zamanı (unix). Varsayılan: şimdi.
expires Süresinin dolduğu zaman (unix).
days Geçerlilik günü; expires verilmezse kullanılır. Varsayılan: türün days değeri. 0 süresizdir.
reason Kâğıdın altında gösterilen tek satır, en fazla 160 karakter.
holder Belgedeki ad, en fazla 120 karakter. Varsayılan: çevrimiçi karakterin adı.
extra Kendi script'in için saklanan bir tablo, JSON olarak en fazla 4000 bayt. Daha büyük tablolar kaydedilmez. GetDocuments bunu geri verir.

#RevokeDocument

Bir belgeyi siler.

lua---@param id integer document id
---@return boolean|false ok
---@return string? reason
exports['fx-pocketbook']:RevokeDocument(id)
luaexports['fx-pocketbook']:RevokeDocument(42)

Config.Kartlarim.AutoIdentity.Enabled = true iken silinen bir kimlik kartı, oyuncu Kartlarim'ı bir sonraki açışında yeniden oluşur. Bir kimlik kartını geri almak için SetDocumentStatus(id, 'hold') kullan ya da kimlik kartlarını bir daire satıyorsa AutoIdentity ayarını kapat.

#SetDocumentStatus

Bir belgeyi geçerli, askıda ya da süresi dolmuş yapar. Değişiklik belgenin geçmişine eklenir (son 20 kayıt).

lua---@param id integer document id
---@param status string 'ok', 'hold' or 'expired'
---@param reason? string one line shown under the paper, up to 160 characters
---@return boolean|false ok
---@return string? reason
exports['fx-pocketbook']:SetDocumentStatus(id, status, reason)
luaexports['fx-pocketbook']:SetDocumentStatus(42, 'hold', 'Suspended by the court until 12 May.')
Durum Bu da kabul edilir Anlamı
ok gecerli Yeniden geçerli
hold askida Askıda
expired suresi doldu Süresi dolmuş

#GetDocuments

Bir karakterin belgelerini (en fazla 60) döndürür; istersen yalnızca bir türü.

lua---@param target integer|string
---@param type? string
---@return table|false list
exports['fx-pocketbook']:GetDocuments(target, type)
luafor _, doc in ipairs(exports['fx-pocketbook']:GetDocuments(source, 'avci') or {}) do
    print(doc.number, doc.state, doc.expiresAt)
end

Her satır:

Alan Nedir
id Belge id'si
type Tür adı
number Belge numarası
holder Üzerindeki ad
issuedAt Veriliş zamanı (unix)
expiresAt Süresinin dolduğu zaman (unix), süresizse 0
state 'ok', 'hold' ya da 'expired'
extra IssueDocument'a verdiğin extra tablosu ya da nil

#HasValidDocument

Karakterin bu türde, askıda olmayan ve süresi dolmamış bir belgesi olup olmadığını döndürür.

lua---@param target integer|string
---@param type string
---@return boolean valid
exports['fx-pocketbook']:HasValidDocument(target, type)
luaif not exports['fx-pocketbook']:HasValidDocument(source, 'silah') then
    return TriggerClientEvent('my-gunstore:noLicence', source)
end
  • Yanlış bir argümanda false, 'invalid_arguments' döndürür.