Agent installieren

Server-Exports

Die Resource fivedock gibt deinen Server-Skripten fünf Exports. Ruf sie aus serverseitigem Lua auf: Sie laufen über die Verbindung des Agents, dein Skript braucht also kein Token. fivedock_upload_allow legt fest, welche Resources die Upload-Exports aufrufen dürfen.

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

Der Callback

Jeder Upload-Export ruft cb(err, file) genau einmal auf. Bei Erfolg ist err nil und file eine Tabelle mit id, url, size und mimeType. Bei einem Fehler ist err ein String mit dem Grund und 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

Reicht eine Spielermeldung ein, die das diensthabende Team im Panel sieht. source ist der meldende Spieler, message sagt, was passiert ist, und subjectSource ist, falls angegeben, der gemeldete Spieler. Gibt true zurück oder false und einen Grund: empty, wenn die Nachricht kürzer als 3 Zeichen ist, too_soon innerhalb von 30 Sekunden nach der letzten Meldung dieses Spielers.

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

Schreibt ein Event in die Black Box. source ist der Spieler, um den es geht, oder 0 für keinen; event ist ein Name mit Punkten wie money.transfer; meta ist eine optionale Tabelle mit Feldern, und ein numerisches amount darin zählt für die Wirtschaftsalarme. Joins und Drops, Tode, Chat, Geldänderungen in ESX und QBCore, Bewegungen in ox_inventory sowie Bans, Kicks und Verwarnungen aus txAdmin zeichnet der Agent schon von selbst auf. Dieser Export ist für das, was nur deine Skripte wissen.

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