Technical Reference
FiveUXE is designed to operate silently in the background without requiring manual API integrations. However, for advanced server owners and framework developers, we provide certain server-side events and exports.
infoEarly Access API
The public API and server-side exports are currently in Beta. Functions and event names are subject to change in upcoming v2.1 releases.
Server-Side Exports
Use these exports to interact with the anticheat from your custom server resources.
exports['anticheat']:IsPlayerBanned(source)Checks if a specific player ID is currently flagged or globally banned by the Hive-Mind.
Returns: boolean
exports['anticheat']:GetPlayerRiskScore(source)Retrieves the current AI-generated risk score for the player (0.0 to 100.0).
Returns: number
exports['anticheat']:ReportSuspiciousActivity(source, reason, data)Allows your custom scripts (e.g., custom anti-money spawning scripts) to report suspicious behavior directly to the FiveUXE AI Copilot.
Returns: void
Server Events
fiveuxe:onPlayerBanned
Triggered server-side immediately after a player is banned. Useful for triggering custom webhooks or discord bot integrations.
AddEventHandler('fiveuxe:onPlayerBanned', function(source, reason, duration) -- Your custom logging logic here print("Player " .. source .. " was banned for: " .. reason) end)