Instalacja agenta

Eksporty serwerowe

Zasób fivedock daje Twoim skryptom serwerowym pięć eksportów. Wywołuj je z Lua po stronie serwera: idą przez połączenie samego agenta, więc skrypt nie potrzebuje żadnego tokenu. fivedock_upload_allow decyduje, które zasoby mogą wywoływać te do wysyłania.

-- server.lua: /evidence <player id> screenshots that player, for staff only
RegisterCommand('evidence', function(source, args)
  local target = tonumber(args[1])
  if not target then return end

  exports.fivedock:screenshot(target, {
    folder   = '/evidence',
    encoding = 'webp', -- 'jpg' (default), 'png' or 'webp'
    quality  = 0.85,   -- 0 to 1
  }, function(err, file)
    if err then
      print(('screenshot failed: %s'):format(err))
      return
    end
    print(('%s, %d bytes, %s'):format(file.url, file.size, file.mimeType))
  end)
end, true)

-- a file your resource wrote to resources/my-script/cache/shot.jpg
exports.fivedock:upload({
  resource = 'my-script',      -- defaults to the resource calling the export
  path     = 'cache/shot.jpg', -- relative to that resource's folder
  name     = 'shot.jpg',
  folder   = '/screenshots',
}, function(err, file)
  if not err then print(file.url) end
end)

exports.fivedock:uploadFile('my-script', 'cache/shot.jpg', {
  name   = 'shot.jpg',
  folder = '/screenshots',
}, function(err, file)
  if not err then print(file.id, file.url) end
end)

Callback

Każdy eksport do wysyłania wywołuje cb(err, file) dokładnie raz. Gdy się uda, err to nil, a file to tabela z polami id, url, size i mimeType. Gdy się nie uda, err to tekst z powodem, a file to nil.

function(err, file)
  -- on success: err = nil
  --   file = { id = '8Kq2nR4t', url = 'https://cdn.fivedock.dev/f/8Kq2nR4t.jpg',
  --            size = 48213, mimeType = 'image/jpeg' }
  -- on failure: err = 'screenshot-basic is not started' (or another reason), file = nil
end

report

Zgłasza gracza, a zgłoszenie widzi w panelu administracja na dyżurze. source to gracz, który zgłasza, message opisuje, co się stało, a subjectSource, jeśli go podasz, to zgłaszany gracz. Zwraca true albo false i powód: empty, gdy wiadomość ma mniej niż 3 znaki, albo too_soon, gdy od poprzedniego zgłoszenia tego gracza minęło mniej niż 30 sekund.

-- source reports subjectSource; subjectSource is optional
local ok, reason = exports.fivedock:report(source, 'He rammed my car at Legion Square', 12)
if not ok then
  print(('report refused: %s'):format(reason)) -- 'empty' or 'too_soon'
end

log

Zapisuje event w Black Boksie. source to gracz, którego dotyczy, albo 0, gdy nikogo; event to nazwa z kropkami, np. money.transfer; meta to opcjonalna tabela pól, a liczbowe amount w niej liczy się do alertów ekonomii. Wejścia i wyjścia, śmierci, chat, zmiany pieniędzy w ESX i QBCore, ruchy w ox_inventory oraz bany, kicki i ostrzeżenia z txAdmina agent zapisuje już sam, więc ten eksport jest na to, co wiedzą tylko Twoje skrypty.

-- source is the player it is about, or 0; meta is optional
exports.fivedock:log(source, 'money.transfer', 'Paid 500 to Bo for the car', {
  amount = 500, to = 'license:9a4f…',
})