Instalar o agente

Exports de servidor

O resource fivedock dá cinco exports aos seus scripts de servidor. Chame-os de Lua no lado do servidor: eles passam pela conexão do próprio agente, então seu script não precisa de token. fivedock_upload_allow decide quais resources podem chamar os de upload.

-- 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)

O callback

Cada export de upload chama cb(err, file) uma única vez. Quando dá certo, err é nil e file é uma tabela com id, url, size e mimeType. Quando falha, err é um texto dizendo o motivo, e file é 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

Registra uma denúncia de jogador que a staff de plantão vê no painel. source é o jogador que denuncia, message diz o que aconteceu e subjectSource, se você passar, é o jogador denunciado. Retorna true, ou false e um motivo: empty quando a mensagem tem menos de 3 caracteres, too_soon dentro de 30 segundos da última denúncia desse jogador.

-- 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

Grava um evento na Black Box. source é o jogador de quem se trata, ou 0 para nenhum; event é um nome com pontos como money.transfer; meta é uma tabela opcional de campos, e um amount numérico nela conta para os alertas de economia. O agente já registra sozinho entradas e saídas, mortes, chat, mudanças de dinheiro do ESX e do QBCore, movimentações do ox_inventory e bans, kicks e avisos do txAdmin, então este export é para o que só os seus scripts sabem.

-- 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…',
})