Özellikler
Company (fx-companyapp)
Paketle gelen şirket yönetimi uygulaması, telefona nasıl kurulduğu, ana ayarları ve tam geliştirici API'si.
#Nedir
fx-companyapp bir şirket yönetimi uygulamasıdır: çalışan listesi, işe alma ve kovma, rütbeler, şirket kasası (para yatırma ve çekme), duyurular, komisyonlu şirket faturaları, istatistikler, bir işletme rehberi ve bir denetim kaydı.
#Gereksinimler
| Resource | Zorunlu |
|---|---|
fx-phone |
Evet (uygulama lb-phone ya da cylex_phone'a da kurulur) |
qb-core ya da qb-core bridge'i ile qbx_core |
Evet |
oxmysql |
Evet |
Bir banka resource'u: tgiann-bank, okokBanking, qb-banking, qb-management veya qb-bossmenu |
Evet, config.lua içinde birini seç |
#Kurulum
cfgensure oxmysql
ensure qb-core
ensure fx-phone
ensure fx-companyapp
- Klasör adını değiştirme. Diğer script'ler bu resource'u
exports['fx-companyapp']olarak çağırır. - Veritabanı tabloları ilk başlangıçta oluşturulur.
setup/sql/install.sqldosyasını yalnızca konsol tabloların oluşturulamadığını bildirirse içe aktar. - Uygulamayı kullanabilecek meslekleri
Config.UseWhitelist,Config.JobWhitelistveConfig.JobBlacklistile seç. İzin verilmeyen bir meslek "şirket yok" ekranını görür. Config.Banking.Providerdeğerini ayarla ve bir test karakteriyle bir deneme yatırma ve bir deneme çekme yap.
#Telefona nasıl kaydolur
Resource'ta client/phone/ içinde her telefon için bir adaptör vardır. Config.Phone.Resource = "auto" olduğunda fx-phone, lb-phone, cylex_phone sırasıyla çalışan ilk telefon seçilir.
- FX Phone adaptörü
exports['fx-phone']:AddCustomAppexport'unuidentifier = Config.AppIdentifier(varsayılanfx_company),name = Config.AppName, açıklama, geliştirici,defaultApp = Config.DefaultApp,price = Config.AppPrice, bir ekran görüntüsü,uiveiconile çağırır. - Bildirimler
exports['fx-phone']:SendNotificationüzerinden gider. Config.Phone.WalletTransactions = trueolduğunda para yatırma ve çekme işlemleriAddTransactionile telefonun banka geçmişine de yazılır.
Uygulamanın hiç başlamamasını istiyorsan Config.BundledApps içinde ['fx-companyapp'] = false yap. Bkz. Uygulamalar.
#Öne çıkan config ayarları
config.lua:
| Ayar | Anlamı |
|---|---|
Config.AppName, Config.AppIdentifier, Config.AppPrice, Config.DefaultApp, Config.Developer |
Uygulamanın telefonda nasıl göründüğü. Identifier'ı asla company yapma |
Config.Phone |
Telefon seçimi, telefon başına ölçek, WalletTransactions |
Config.Locale, Config.Theme, Config.Currency |
Dil, ilk açılıştaki tema (system, corporate, midnight), para birimi simgesi |
Config.Account |
Oyuncunun kişisel hesabı: bank veya cash |
Config.Banking.Provider |
tgiann-bank, okokBanking, qb-banking, qb-management, qbcore-society veya custom (bank_adapter.lua) |
Config.UseWhitelist, Config.JobWhitelist, Config.JobBlacklist |
Hangi mesleklerin uygulamayı açabileceği |
Config.UnemployedJob |
Biri kovulduğunda verilen meslek |
Config.Permissions |
Kimin neyi yapabileceği, aşağıya bak |
Config.JobPermissionOverrides |
Config.Permissions için meslek bazında geçersiz kılmalar |
Config.ProtectHigherRanks |
Kimse kendi rütbesinde ya da üstündeki birini kovamaz veya rütbesini değiştiremez |
Config.HireMode, Config.HireNearbyDistance, Config.DefaultHireGrade |
İşe almanın nasıl çalıştığı |
Config.MinKasaAmount, Config.MaxKasaAmount |
Uygulama içinden tek bir yatırma ya da çekme için sınırlar |
Config.HistoryLimit, Config.LogLimit, Config.PruneAfterDays |
Ne kadar geçmişin gösterilip tutulacağı |
Config.Invoices |
Şirket faturaları: CompanyOnly, BlockSelf, BlockSameCompany, PayAccount, komisyon sınırları, TaxPercent, MaxAmount, MaxDistance, ExpireDays ve fazlası |
Config.InvoicePresets, Config.JobTypes |
İşletme türüne göre hazır fatura listeleri |
Config.Directory (config_directory.lua) |
İşletme rehberi varsayılanları: kategoriler, vurgu renkleri, izin verilen görsel sunucuları, metin sınırları |
Config.Permissions her eylemi "boss" (isboss işaretli rütbeler), "member" (şirketteki herkes) ya da bir rütbe seviyesi numarasına (o rütbe ve üstü) eşler. Eylemler şunlardır: hire, fire, setGrade, withdraw, deposit, announce, viewLogs, viewKasa, invoice, viewInvoices, cancelInvoice, manageInvoices, viewStats, editProfile, viewMessages, takeLine.
config_server.lua yalnızca server tarafındadır. Log ayarları buradadır: Discord webhook'ları (bir varsayılan, grup başına ve şirket başına birer tane), hangi olayların gönderileceği ve konsol çıktısı.
#API kuralları
- Client export'ları altında listelenmedikçe export'lar server tarafındadır.
- Eylemler
ok, valuedöndürür.oktrueise ikinci değer sonuçtur.okfalseise bu bir hata nedenidir; nedenler bu sayfanın sonunda listelenir. - Export'lar oyuncu yetkilerini kontrol etmez. Sistem olarak davranırlar. Bir oyuncu adına işlem yapıyorsan önce
HasPermissionile sor. - Hook'lar yine de çalışır. Bir
beforeFirehook'u, kovma işlemi ister uygulamadan ister bir export'tan gelsin, onu engeller. - Değişiklikler canlı görünür. Etkilenen şirketin açık uygulamaları kendiliğinden yenilenir.
- Export'ların çalışması için bir mesleğin
Config.JobWhitelistiçinde olması gerekmez. Whitelist yalnızca uygulamayı kimin açabileceğini belirler. - Meslek adı, en fazla 60 karakterlik boş olmayan bir string'dir.
Birçok eylem bir opts tablosu kabul eder:
| Alan | Tür | Anlamı |
|---|---|---|
actor |
string | Denetim kaydında ve geçmişte gösterilen ad. Varsayılan: source oyuncusunun adı ya da "System" |
source |
number | İşleme neden olan oyuncunun server id'si; hook'lara ve event'lere aktarılır |
notify |
boolean | false, etkilenen oyuncuya telefon bildirimi göndermez |
title |
string | İşlem başlığı (yalnızca kasa) |
category |
string | İşlem kategorisi (yalnızca kasa) |
log |
boolean | false, geçmiş ya da denetim satırı yazmaz |
#Server export'ları: şirket ve çalışanlar
#GetPlayerCompany
Oyuncunun şirketini uygulamanın gördüğü şekilde döndürür.
lua---@param src number
---@return table|nil company { job, label, isboss, grade = { level, name } }
exports['fx-companyapp']:GetPlayerCompany(src)
lualocal company = exports['fx-companyapp']:GetPlayerCompany(source)
Oyuncunun mesleği uygulamayı kullanamıyorsa nil döndürür.
#IsJobAllowed
Bir mesleğin uygulamayı kullanıp kullanamayacağını söyler.
lua---@param job string
---@return boolean
exports['fx-companyapp']:IsJobAllowed(job)
lualocal allowed = exports['fx-companyapp']:IsJobAllowed('mechanic')
#HasPermission
Bir oyuncunun şirketinde bir eylemi yapıp yapamayacağını söyler.
lua---@param src number
---@param action string A key of Config.Permissions, e.g. 'withdraw'
---@return boolean
exports['fx-companyapp']:HasPermission(src, action)
luaif not exports['fx-companyapp']:HasPermission(source, 'withdraw') then return end
Oyuncunun şirketi yoksa her zaman false olur.
#GetPermissions
Bir oyuncunun bütün yetkilerini tek çağrıda döndürür.
lua---@param src number
---@return table<string, boolean> permissions
exports['fx-companyapp']:GetPermissions(src)
lualocal perms = exports['fx-companyapp']:GetPermissions(source)
#GetCompanyGrades
Bir mesleğin rütbelerini seviyeye göre sıralı döndürür.
lua---@param job string
---@return table[] grades { level, name, isboss, payment }
exports['fx-companyapp']:GetCompanyGrades(job)
lualocal grades = exports['fx-companyapp']:GetCompanyGrades('mechanic')
#GetCompanyMembers
Çevrimiçi ve çevrimdışı bütün çalışanları, en yüksek rütbe önce gelecek şekilde döndürür.
lua---@param job string
---@return table[] members { citizenid, name, grade, gradeName, isboss, online, onduty }
exports['fx-companyapp']:GetCompanyMembers(job)
lualocal members = exports['fx-companyapp']:GetCompanyMembers('mechanic')
Çalışan listesi meslek başına önbelleğe alınır ve her işe alma, kovma, rütbe değişikliği ve meslek güncellemesinde silinir.
#GetEmployee
Bir mesleğin tek bir çalışanını döndürür.
lua---@param job string
---@param who string|number Citizen id or server id
---@return table|nil employee { citizenid, source?, online, level, isboss, name }
exports['fx-companyapp']:GetEmployee(job, who)
lualocal emp = exports['fx-companyapp']:GetEmployee('mechanic', source)
Kişi o meslekte değilse nil döndürür. Çalışan çevrimdışıysa source nil olur.
#GetOnlineEmployees
Bir mesleğin çevrimiçi çalışanlarını döndürür.
lua---@param job string
---@param onDutyOnly? boolean
---@return table[] employees { source, citizenid, onduty }
exports['fx-companyapp']:GetOnlineEmployees(job, onDutyOnly)
lualocal staff = exports['fx-companyapp']:GetOnlineEmployees('police', true)
#GetCompanySummary
Bir şirketin kişi sayılarını, maaş toplamını ve bakiyesini döndürür.
lua---@param job string
---@return table|nil summary { job, label, memberCount, onlineCount, onDutyCount, payroll, balance }
exports['fx-companyapp']:GetCompanySummary(job)
lualocal summary = exports['fx-companyapp']:GetCompanySummary('mechanic')
payroll, bütün çalışanların rütbe maaşlarının toplamıdır.
#Server export'ları: şirket kasası
Kasa, Config.Banking.Provider içinde seçilen banka resource'unda durur. Bu export'lar aynı sağlayıcıdan geçer ve uygulama içi işlem geçmişini yazar.
#GetCompanyBalance
Şirketin kasasını döndürür.
lua---@param job string
---@return number balance
exports['fx-companyapp']:GetCompanyBalance(job)
lualocal balance = exports['fx-companyapp']:GetCompanyBalance('mechanic')
#CompanyAccountExists
Banka resource'unda meslek için bir hesap olup olmadığını söyler.
lua---@param job string
---@return boolean
exports['fx-companyapp']:CompanyAccountExists(job)
lualocal exists = exports['fx-companyapp']:CompanyAccountExists('mechanic')
Bunu anlayamayan sağlayıcılar (qb-banking, qb-management, qb-bossmenu) her zaman true döndürür.
#AddCompanyMoney
Şirket kasasına para ekler ve bir geçmiş satırı yazar.
lua---@param job string
---@param amount number Positive; decimals are floored
---@param opts? table { title?, category?, actor?, source?, log? }
---@return boolean ok
---@return number|string newBalanceOrReason
exports['fx-companyapp']:AddCompanyMoney(job, amount, opts)
lualocal ok, balance = exports['fx-companyapp']:AddCompanyMoney('mechanic', 2500, { title = 'Invoice #1042', category = 'invoice' })
Config.MaxKasaAmountburada uygulanmaz. Yalnızca uygulama içinden tek bir yatırma ya da çekmeyi sınırlar.- Varsayılanlar: başlık "Income", kategori
income, actor "System". - Başarısızlık nedenleri:
invalidJob,invalidAmount,kasaUnavailable,genericya da birbeforeMoneyChangehook'unun döndürdüğü neden.
#RemoveCompanyMoney
Şirket kasasından para çeker ve bir geçmiş satırı yazar.
lua---@param job string
---@param amount number Positive; decimals are floored
---@param opts? table { title?, category?, actor?, source?, log? }
---@return boolean ok
---@return number|string newBalanceOrReason
exports['fx-companyapp']:RemoveCompanyMoney(job, amount, opts)
lualocal ok, balance = exports['fx-companyapp']:RemoveCompanyMoney('burger', 800, { title = 'Stock order', category = 'stock' })
Eksiye düşmek yerine insufficientKasa ile başarısız olur. Varsayılanlar: başlık "Expense", kategori expense.
#LogTransaction
Para taşımadan bir geçmiş satırı yazar.
lua---@param job string
---@param amount number Positive = in, negative = out
---@param title string
---@param category? string
---@param actor? string
exports['fx-companyapp']:LogTransaction(job, amount, title, category, actor)
luaexports['fx-companyapp']:LogTransaction('mechanic', 500, 'Tow fee', 'service', 'John Doe')
Script'in parayı banka resource'u üzerinden zaten kendisi taşıdıysa bunu kullan. Para taşındıktan hemen sonra çağır ki hesap defteri hareketi ikinci kez kaydetmesin.
#GetCompanyTransactions
Bir şirketin en yeni işlemlerini döndürür.
lua---@param job string
---@param limit? number Default Config.HistoryLimit
---@return table[] transactions { amount, title, category, actor, ts }
exports['fx-companyapp']:GetCompanyTransactions(job, limit)
lualocal rows = exports['fx-companyapp']:GetCompanyTransactions('mechanic', 20)
ts bir Unix zaman damgasıdır.
#Server export'ları: çalışan yönetimi
Bunlar uygulamanın yaptığını, yetki ve rütbe koruması kontrolleri olmadan yapar. Hedef oyuncu bir telefon bildirimi alır ve açık uygulaması yeniden yüklenir.
#HireEmployee
Çevrimiçi bir oyuncuyu işe alır.
lua---@param job string
---@param targetSrc number
---@param grade? number Default Config.DefaultHireGrade
---@param opts? table { actor?, source?, notify? }
---@return boolean ok
---@return string gradeNameOrReason
exports['fx-companyapp']:HireEmployee(job, targetSrc, grade, opts)
lualocal ok, res = exports['fx-companyapp']:HireEmployee('mechanic', targetId, 0, { actor = 'Job Center' })
Başarısızlık nedenleri: invalidJob, playerNotOnline, alreadyInCompany, invalidGrade.
#FireEmployee
Çevrimiçi ya da çevrimdışı bir çalışanı kovar.
lua---@param job string
---@param citizenid string
---@param opts? table { actor?, source?, notify? }
---@return boolean ok
---@return string nameOrReason
exports['fx-companyapp']:FireEmployee(job, citizenid, opts)
lualocal ok, name = exports['fx-companyapp']:FireEmployee('mechanic', 'ABC12345')
Çalışan Config.UnemployedJob mesleğine taşınır. Citizen id o mesleğin çalışanı değilse playerNotFound ile başarısız olur.
#SetEmployeeGrade
Çevrimiçi ya da çevrimdışı bir çalışanın rütbesini değiştirir.
lua---@param job string
---@param citizenid string
---@param grade number
---@param opts? table { actor?, source?, notify? }
---@return boolean ok
---@return string nameOrReason
exports['fx-companyapp']:SetEmployeeGrade(job, citizenid, grade, opts)
luaexports['fx-companyapp']:SetEmployeeGrade('police', 'ABC12345', 3, { actor = 'Command' })
Denetim kaydı bunu terfi ya da rütbe düşürme olarak kaydeder.
#Server export'ları: denetim kaydı
#LogAction
Şirketin denetim kaydına bir satır ekler.
lua---@param job string
---@param action string Short key, at most 32 characters
---@param actor? string
---@param target? string
---@param detail? string Line text shown in the app
exports['fx-companyapp']:LogAction(job, action, actor, target, detail)
luaexports['fx-companyapp']:LogAction('mechanic', 'craft', 'John Doe', nil, 'John Doe crafted 5x Repair Kit')
Bilinen eylemlerin kendi simgesi vardır: hired, fired, graded, deposit, withdraw, announce.
#GetCompanyLogs
Bir şirketin en yeni denetim satırlarını döndürür.
lua---@param job string
---@param limit? number 1 to 200, default Config.LogLimit
---@return table[] logs { action, actor, target, detail, ts }
exports['fx-companyapp']:GetCompanyLogs(job, limit)
lualocal logs = exports['fx-companyapp']:GetCompanyLogs('mechanic', 50)
#Server export'ları: bildirimler
#NotifyPlayer
Çevrimiçi bir oyuncuya telefon bildirimi gönderir.
lua---@param src number
---@param title string
---@param message string
---@return boolean sent
exports['fx-companyapp']:NotifyPlayer(src, title, message)
luaexports['fx-companyapp']:NotifyPlayer(source, 'Shift', 'Your shift starts in 5 minutes')
#NotifyEmployee
Citizen id ile telefon bildirimi gönderir.
lua---@param citizenid string
---@param title string
---@param message string
---@return boolean sent
exports['fx-companyapp']:NotifyEmployee(citizenid, title, message)
luaexports['fx-companyapp']:NotifyEmployee('ABC12345', 'Payroll', 'Your bonus was paid')
Oyuncu çevrimdışıysa false döndürür. Hiçbir şey kuyruğa alınmaz.
#SendAnnouncement
Bir mesleğin çevrimiçi tüm çalışanlarına bildirim gönderir.
lua---@param job string
---@param message string
---@param opts? table { title?, onDutyOnly?, exclude?, actor?, log? }
---@return number sent How many employees received it
exports['fx-companyapp']:SendAnnouncement(job, message, opts)
lualocal sent = exports['fx-companyapp']:SendAnnouncement('police', 'Code 3 at Legion Square', { onDutyOnly = true, title = 'Dispatch' })
exclude, atlanacak bir server id'dir.log = falsedenetim satırı yazmaz.- Geçersiz bir meslek ya da boş bir mesaj için
0döndürür.
#Server export'ları: telefon ve uygulama
#GetPhoneResource
Sunucuda kullanılan telefon resource'unu döndürür.
lua---@return string|nil phone 'fx-phone', 'lb-phone', 'cylex_phone' or nil
exports['fx-companyapp']:GetPhoneResource()
lualocal phone = exports['fx-companyapp']:GetPhoneResource()
#RefreshApp
Açık uygulamaları verilerini yeniden yüklemeye zorlar.
lua---@param target number|string Server id or job name
---@param scope? string 'all' (default), 'members', 'kasa', 'logs' or 'invoices'
exports['fx-companyapp']:RefreshApp(target, scope)
luaexports['fx-companyapp']:RefreshApp('mechanic', 'kasa')
Buna yalnızca script'in, uygulamanın okuduğu bir şeyi bu export'ları kullanmadan değiştirdiğinde ihtiyaç duyarsın.
#GetVersionStatus
Güncelleme kontrolünün sonucunu döndürür.
lua---@return table status { state, current, latest, behind }
exports['fx-companyapp']:GetVersionStatus()
lualocal status = exports['fx-companyapp']:GetVersionStatus()
#Server export'ları: faturalar
Faturalar her zaman bir şirket adına kesilir. Biri ödendiğinde komisyon faturayı kesen çalışana gider, isteğe bağlı vergi düşülür ve kalanı şirket kasasına gider.
#CreateInvoice
Bir şirket adına fatura keser.
lua---@param job string
---@param target number|string Server id or citizen id
---@param amount number
---@param label string
---@param opts? table { issuerSrc?, issuerCid?, issuerName?, note?, notify? }
---@return boolean ok
---@return table|string invoiceOrReason
exports['fx-companyapp']:CreateInvoice(job, target, amount, label, opts)
lualocal ok, inv = exports['fx-companyapp']:CreateInvoice('mechanic', customerSrc, 1500, 'Engine repair', { issuerSrc = source })
- Yetki kontrolü yok. Kimin fatura kesebileceğine senin resource'un karar verir.
- Çevrimdışı oyunculara citizen id ile fatura kesilebilir.
issuerSrc, komisyonu alan çevrimiçi çalışandır. Bu yoksa faturayı kesenissuerCid/issuerNameya da şirketin kendisi olur.label,Config.Invoices.LabelMaxLengthuzunluğunda kesilir.- Başarısızlık nedenleri:
invalidJob,invalidAmount,invalidLabel,playerNotFoundya da bir hook'un nedeni.
#PayInvoice
Bir faturayı ödeyenin parasından öder.
lua---@param id number
---@param payerSrc number
---@param opts? table { anyPayer? }
---@return boolean ok
---@return table|string invoiceOrReason
exports['fx-companyapp']:PayInvoice(id, payerSrc, opts)
lualocal ok, inv = exports['fx-companyapp']:PayInvoice(42, source)
Config.Invoices.PayAccount hesabından öder; PayFallbackToCash açıksa nakde geri düşer. opts.anyPayer = true olmadıkça faturayı yalnızca faturanın müşterisi ödeyebilir.
#CancelInvoice
Ödenmemiş bir faturayı iptal eder.
lua---@param id number
---@param opts? table { actor?, source? }
---@return boolean ok
---@return number|string idOrReason
exports['fx-companyapp']:CancelInvoice(id, opts)
luaexports['fx-companyapp']:CancelInvoice(42, { actor = 'Dispatch' })
#GetInvoice
Tek bir fatura döndürür.
lua---@param id number
---@return table|nil invoice
exports['fx-companyapp']:GetInvoice(id)
lualocal inv = exports['fx-companyapp']:GetInvoice(42)
Alanlar: id, job, companyLabel, label, note, amount, status, issuerCid, issuerName, targetCid, targetName, commissionPct, commission, tax, companyShare, closedBy, createdAt, closedAt. status değeri unpaid, paid, cancelled veya expired olur.
#GetCompanyInvoices
Bir şirketin faturalarını en yeniden başlayarak döndürür.
lua---@param job string
---@param filter? table { status?, issuerCid?, targetCid?, limit?, offset? }
---@return table[] invoices
exports['fx-companyapp']:GetCompanyInvoices(job, filter)
lualocal unpaid = exports['fx-companyapp']:GetCompanyInvoices('mechanic', { status = 'unpaid', limit = 20 })
limit en fazla 100 olur.
#GetPlayerInvoices
Herhangi bir şirketten bir oyuncuya kesilmiş faturaları döndürür.
lua---@param who number|string Server id or citizen id
---@param status? string
---@param limit? number
---@return table[] invoices
exports['fx-companyapp']:GetPlayerInvoices(who, status, limit)
lualocal invoices = exports['fx-companyapp']:GetPlayerInvoices(source, 'unpaid')
#GetUnpaidInvoiceCount
Bir oyuncunun kaç ödenmemiş faturası olduğunu döndürür.
lua---@param who number|string Server id or citizen id
---@param job? string Count only this company's invoices
---@return number count
exports['fx-companyapp']:GetUnpaidInvoiceCount(who, job)
lualocal count = exports['fx-companyapp']:GetUnpaidInvoiceCount(source)
#GetUnpaidInvoiceTotal
Bir oyuncunun ödenmemiş toplam borcunu döndürür.
lua---@param who number|string Server id or citizen id
---@param job? string Sum only this company's invoices
---@return number total
exports['fx-companyapp']:GetUnpaidInvoiceTotal(who, job)
lualocal total = exports['fx-companyapp']:GetUnpaidInvoiceTotal(source, 'mechanic')
#HasUnpaidInvoices
Bir oyuncunun en az bir ödenmemiş şirket faturası olup olmadığını söyler.
lua---@param who number|string Server id or citizen id
---@param notify? boolean Send the "unpaid invoices" phone notification when it blocks
---@return boolean blocked
exports['fx-companyapp']:HasUnpaidInvoices(who, notify)
luaif exports['fx-companyapp']:HasUnpaidInvoices(citizenid, true) then return end
Bir veritabanı hatası false döndürür; böylece bir hata asla garajı kilitlemez.
#GetPendingCommission
Bir fatura ödendiğinde çevrimdışı olan çalışanı bekleyen komisyonu döndürür.
lua---@param who number|string Server id or citizen id
---@return number amount
exports['fx-companyapp']:GetPendingCommission(who)
lualocal pending = exports['fx-companyapp']:GetPendingCommission('ABC12345')
#CanIssuePersonalInvoice
Bir oyuncunun kendi adına fatura gönderip gönderemeyeceğini söyler.
lua---@param src number
---@return boolean allowed
---@return string|nil reason 'companyOnly'
exports['fx-companyapp']:CanIssuePersonalInvoice(src)
lualocal allowed = exports['fx-companyapp']:CanIssuePersonalInvoice(source)
Oyuncu bir şirkete bağlıysa ve Config.Invoices.CompanyOnly açıksa false, 'companyOnly' döndürür. Diğer fatura script'leri için düşünülmüştür.
#GetInvoiceIssuer
Bu oyuncudan gelen bir faturanın kimin adına kesilmesi gerektiğini döndürür.
lua---@param src number
---@return table issuer { type = 'company', job, label } or { type = 'personal' }
exports['fx-companyapp']:GetInvoiceIssuer(src)
lualocal issuer = exports['fx-companyapp']:GetInvoiceIssuer(source)
#Server export'ları: fatura ayarları
#GetInvoiceSettings
Bir şirketin fatura ayarlarını döndürür.
lua---@param job string
---@return table|nil settings { commission, commissionMin, commissionMax, presets, presetType, allowCustom, maxAmount }
exports['fx-companyapp']:GetInvoiceSettings(job)
lualocal settings = exports['fx-companyapp']:GetInvoiceSettings('mechanic')
presets, { label, price } öğelerinden oluşan bir listedir.
#SetInvoiceSettings
Bir şirketin fatura ayarlarının bir kısmını kaydeder.
lua---@param job string
---@param patch table
---@return boolean ok
---@return table|string settingsOrReason
exports['fx-companyapp']:SetInvoiceSettings(job, patch)
lualocal ok, settings = exports['fx-companyapp']:SetInvoiceSettings('mechanic', { allowCustom = false })
Değerler config sınırlarına göre kırpılır ve değişiklik loglanır. Geçersiz bir meslek ya da tablo olmayan bir patch için false, 'invalidJob' döndürür.
#GetCommission
Bir şirketin komisyon yüzdesini döndürür.
lua---@param job string
---@return number percent
exports['fx-companyapp']:GetCommission(job)
lualocal pct = exports['fx-companyapp']:GetCommission('mechanic')
#SetCommission
Bir şirketin komisyon yüzdesini ayarlar.
lua---@param job string
---@param percent number
---@return boolean ok
---@return number|string percentOrReason
exports['fx-companyapp']:SetCommission(job, percent)
lualocal ok, pct = exports['fx-companyapp']:SetCommission('mechanic', 15)
Değer komisyon sınırlarına göre kırpılır; ikinci dönüş değeri kaydedilen değerdir.
#GetInvoicePresets
Bir şirketin hazır fatura listesini döndürür.
lua---@param job string
---@return table[] presets { label, price }
exports['fx-companyapp']:GetInvoicePresets(job)
lualocal presets = exports['fx-companyapp']:GetInvoicePresets('mechanic')
#GetInvoiceTemplates
Yerleşik fatura şablonlarını döndürür.
lua---@return table[] templates { key, label, count }
exports['fx-companyapp']:GetInvoiceTemplates()
lualocal templates = exports['fx-companyapp']:GetInvoiceTemplates()
#Server export'ları: istatistikler
days değeri 1, 7, 30 veya 90 olur.
#GetCompanyStats
Bir şirketin gelir, gider ve fatura istatistiklerini döndürür.
lua---@param job string
---@param days number
---@return table|nil stats { days, series, income, expense, net, categories, invoices, top }
exports['fx-companyapp']:GetCompanyStats(job, days)
lualocal stats = exports['fx-companyapp']:GetCompanyStats('mechanic', 30)
series,{ day, income, expense }öğelerinden oluşan bir listedir.categoriesiçinde{ category, amount }öğelerinden oluşanincomeveexpenselisteleri vardır.invoicesiçindecount,gross,paidCount,paid,unpaidCount,unpaid,commission,tax,companyvardır.top,GetEmployeeRankingsonucunun ilk beş satırıdır.
#GetEmployeeRanking
Çalışanları şirkete kazandırdıklarına göre sıralı döndürür.
lua---@param job string
---@param days number
---@return table[] ranking { citizenid, name, issued, gross, paidCount, paid, commission, company }
exports['fx-companyapp']:GetEmployeeRanking(job, days)
lualocal ranking = exports['fx-companyapp']:GetEmployeeRanking('mechanic', 7)
#GetEmployeeStats
Tek bir çalışanın istatistiklerini döndürür.
lua---@param job string
---@param citizenid string
---@param days number
---@return table|nil stats
exports['fx-companyapp']:GetEmployeeStats(job, citizenid, days)
lualocal stats = exports['fx-companyapp']:GetEmployeeStats('mechanic', 'ABC12345', 30)
Sıralama alanlarına ek olarak pendingCommission, deposited, withdrawn, allTime = { issued, paid, commission } ve recent (son 30 fatura).
#Server export'ları: işletme rehberi
Rehber anahtarı meslek adıdır; birden fazla meslek tek bir rehber kartını paylaşıyorsa grup anahtarıdır.
#GetDirectoryKey
Bir mesleğin ait olduğu rehber anahtarını döndürür.
lua---@param job string
---@return string|nil key
exports['fx-companyapp']:GetDirectoryKey(job)
lualocal key = exports['fx-companyapp']:GetDirectoryKey('mechanic')
#GetDirectoryProfile
Bir işletmenin rehber profilini döndürür.
lua---@param key string
---@return table|nil profile
exports['fx-companyapp']:GetDirectoryProfile(key)
lualocal profile = exports['fx-companyapp']:GetDirectoryProfile('mechanic')
Alanlar: name, slogan, description, hours, logo, banner, category, accent, location, listed, callable, messaging, callMode, callGrades. Kaydedilmiş değerler varsayılanların üzerine yazılır.
#SetDirectoryProfile
Bir işletmenin rehber profilini koddan değiştirir.
lua---@param key string
---@param patch table
---@return boolean ok
---@return table|string profileOrReason
exports['fx-companyapp']:SetDirectoryProfile(key, patch)
lualocal ok, profile = exports['fx-companyapp']:SetDirectoryProfile('mechanic', { slogan = 'Open every day' })
Patch, uygulamadaki bir düzenlemeyle aynı doğrulamadan geçer (metin sınırları, izin verilen görsel sunucuları). Kayıtlı konum korunur. Geçersiz bir anahtar için false, 'invalidJob' döndürür.
#Hook'lar
Hook'lar bir eylemi, ister uygulamadan ister bir export'tan gelsin, gerçekleşmeden önce engellemeni sağlar.
#AddHook
Bir eylemden önce çalışan bir fonksiyon kaydeder.
lua---@param name string Hook name, see the table below
---@param fn fun(payload: table): boolean|nil, string|nil
---@return number|nil hookId
exports['fx-companyapp']:AddHook(name, fn)
lualocal id = exports['fx-companyapp']:AddHook('beforeFire', function(p)
if p.job == 'police' and GlobalState.raidActive then return false, 'blocked' end
end)
- İptal etmek için
false, 'reason'döndür. Başka her dönüş değeri eylemin geçmesine izin verir. - Neden, oyuncuya dil dosyasındaki
error.<reason>metniyle gösterilir. Bilinmeyen nedenler genel hatayı gösterir. - Bilinmeyen bir hook adı için
nildöndürür. - Hook'lar, onları ekleyen resource durduğunda kaldırılır.
- Hook'ları hızlı tut. Oyuncunun isteğinin içinde çalışırlar.
#RemoveHook
Bir hook'u kaldırır.
lua---@param hookId number
---@return boolean removed
exports['fx-companyapp']:RemoveHook(hookId)
luaexports['fx-companyapp']:RemoveHook(id)
| Hook | Ne zaman çalışır | Payload |
|---|---|---|
beforeHire |
işe almadan önce | job, grade, source, actor, targetSource, targetCitizenid, targetName, previousJob |
beforeFire |
kovmadan önce | job, grade, source, actor, targetSource, targetCitizenid, targetName |
beforeSetGrade |
rütbe değişikliğinden önce | job, oldGrade, grade, source, actor, targetSource, targetCitizenid, targetName |
beforeDeposit |
uygulama içi para yatırmadan önce | job, source, actor, amount |
beforeWithdraw |
uygulama içi para çekmeden önce | job, source, actor, amount |
beforeAnnounce |
uygulama içi duyurudan önce | job, source, actor, message |
beforeMoneyChange |
AddCompanyMoney / RemoveCompanyMoney öncesi |
job, amount (negatif = çekme), source, actor, title, category, resource |
beforeInvoiceCreate |
uygulamadan fatura / CreateInvoice öncesi |
job, label, amount, note, source, issuerCid, actor, targetSource, targetCid, targetName, resource |
beforeInvoicePay |
uygulamadan ödeme / PayInvoice öncesi |
id, job, amount, label, source, payerCid, issuerCid |
beforeInvoiceCancel |
uygulamadan iptal / CancelInvoice öncesi |
id, job, source, actor |
beforeSettingsChange |
patron fatura ayarlarını kaydetmeden önce | job, source, actor, settings |
source işlemi yapan oyuncudur; sistem ya da export eylemi için nil olur. Hedef çevrimdışıysa targetSource nil olur.
#Server event'leri
Bir eylem başarılı olduktan sonra, eşleşen hook ile aynı payload'a ek olarak sonuç alanlarıyla tetiklenir. Bunlar yerel server event'leridir (TriggerEvent), bu yüzden client'lar bunları tetikleyemez. Bunları net event olarak kaydetme.
| Event | Ek alanlar |
|---|---|
fx-companyapp:server:hired |
gradeName |
fx-companyapp:server:fired |
|
fx-companyapp:server:gradeChanged |
gradeName |
fx-companyapp:server:deposit |
balance (sonrası) |
fx-companyapp:server:withdraw |
balance (sonrası) |
fx-companyapp:server:moneyChanged |
balance (sonrası), AddCompanyMoney / RemoveCompanyMoney kaynaklı |
fx-companyapp:server:announce |
sent |
fx-companyapp:server:invoiceCreated |
id |
fx-companyapp:server:invoicePaid |
commission, tax, companyShare, account, commissionState (paid, pending veya company) |
fx-companyapp:server:invoiceCancelled |
status |
fx-companyapp:server:invoiceExpired |
status |
fx-companyapp:server:settingsChanged |
settings (sonrası) |
Rehber ayrıca fx-companyapp:server:profileChanged, fx-companyapp:server:directoryMessage ve fx-companyapp:server:ticketReply event'lerini tetikler.
luaAddEventHandler('fx-companyapp:server:withdraw', function(p)
print(('%s withdrew %d from %s, %d left'):format(p.actor, p.amount, p.job, p.balance))
end)
#Client export'ları
#GetPhoneResource
Bu client'ta kullanılan telefonu döndürür.
lua---@return string|nil phone 'fx-phone', 'lb-phone', 'cylex_phone' or nil
exports['fx-companyapp']:GetPhoneResource()
lualocal phone = exports['fx-companyapp']:GetPhoneResource()
#IsAppInstalled
Uygulamanın o telefona kayıtlı olup olmadığını söyler.
lua---@return boolean
exports['fx-companyapp']:IsAppInstalled()
lualocal installed = exports['fx-companyapp']:IsAppInstalled()
#RefreshApp
Bu oyuncunun açık uygulamasını yeniden yükler.
lua---@param scope? string 'all' (default), 'members', 'kasa', 'logs' or 'invoices'
---@return boolean sent
exports['fx-companyapp']:RefreshApp(scope)
luaexports['fx-companyapp']:RefreshApp('members')
#ReinstallApp
Uygulamayı telefona yeniden kaydeder.
lua---@return boolean ok
exports['fx-companyapp']:ReinstallApp()
luaexports['fx-companyapp']:ReinstallApp()
#Notify
Bu client'ta uygulamadan bir telefon bildirimi gösterir.
lua---@param title string
---@param message string
---@return boolean sent
exports['fx-companyapp']:Notify(title, message)
luaexports['fx-companyapp']:Notify('Shift', 'Your shift starts in 5 minutes')
#Hata nedenleri
ok false olduğunda ikinci değer olarak döner. Her birinin locales/*.json içinde error. altında bir metni vardır.
| Neden | Ne zaman |
|---|---|
invalidJob |
Meslek adı boş ya da çok uzun; işe alma ve rütbe değişikliklerinde meslek, meslek listende değilse de |
invalidAmount |
Pozitif bir tam sayı değil ya da çok büyük |
invalidLabel |
Fatura etiketi boş ya da string değil |
kasaUnavailable |
Banka resource'unda bu meslek için hesap yok |
insufficientKasa |
Şirket kasasında yeterli para yok |
insufficientPersonal |
(yalnızca uygulama) Oyuncunun yatıracak parası yok |
playerNotFound |
Citizen id o mesleğin çalışanı değil ya da fatura hedefi bulunamıyor |
playerNotOnline |
İşe alınacak kişi çevrimiçi değil |
alreadyInCompany |
İşe alınacak kişi zaten bu meslekte |
invalidGrade |
Bu rütbe meslekte yok |
companyOnly |
Oyuncu şirket adına fatura kesmek zorunda |
cannotTargetSelf |
(yalnızca uygulama) Kendine işlem yapmaya çalışıyor |
protectedRank |
(yalnızca uygulama) Hedef senin rütbende ya da üstünde |
noPermission |
(yalnızca uygulama) Yetki eksik |
noCompany |
(yalnızca uygulama) Oyuncunun kullanılabilir bir şirketi yok |
cooldown |
(yalnızca uygulama) Çok hızlı |
blocked |
Bir hook neden vermeden iptal etti |
generic |
Framework ya da banka reddetti |
#Sorun giderme
| Belirti | Neden |
|---|---|
| Uygulama telefonda görünmüyor | Telefon başlatılmamış ya da bu resource'tan sonra başlatılmış |
| Herkes "şirket yok" ekranını görüyor | Meslek Config.JobWhitelist içinde değil |
Kasa hep 0 gösteriyor |
Config.Banking.Provider yanlış ya da o resource başlatılmamış |
| Para yatırma "kasa hazır değil" hatasıyla başarısız oluyor | Meslek için banka resource'unda hesap yok |
| Rütbe adları boş, işe alma başarısız oluyor | qb-core bu resource'tan sonra başlıyor ya da meslek tanımları eksik |