Events

AntiRaid makes use of events for all communication between scripts. Scripts recieve events from either Discord or AntiRaid itself. This document provides a basic overview of how to handle events in AntiRaid.

Event Registration

To register for events, you can simply provide the list of events in the Events section of the script in the website's settings UI. If you are using push.py for CLI based development, you can simply change the EVENTS variable in the push.py file to include the events you want to register for.

Syntax wise, there are two main syntaxes:

• {event_name}: This will register for the event with the name event_name. This is the most common syntax.
• {event_name}[{scope}]: This will register for the event with the name event_name scoped to a scope called scope. This is useful for key-value related events such as KeyExpiry[scope] and KeyResume[scope]. For these, the related event will only be sent to your script if the key is in the specified scope. For example, a KeyExpiry[my_scope] event will only be sent to your script if the key that expired is in the my_scope scope.

Base Format

All events are dispatched as a readonly/"frozen" Luau table with the following fields:

AntiRaid Events

AntiRaid (as of now) has 4 events that are dispatched to scripts:

KeyExpiry

When a key in the key value store expires, a KeyExpiry event is dispatched to all scripts that have registered for the KeyExpiry event. The event contains the following fields:

KeyResume

If a key has the resume flag set to true (this can be done using the set call's resume parameter), then any restart of AntiRaid's scripting worker process or reloading of the server's Luau VM etc. will cause a KeyResume event to be dispatched to all scripts that have registered for the KeyResume event. The event contains the following fields:

GetSettings

If a user tries to open the dashboard or otherwise attempts to fetch the settings of a server, a GetSettings event is dispatched to all scripts that have registered for the GetSettings event. This can be useful for scripts that want to provide different dashboard options based on the user who is requesting. The event contains the following fields:

The script must then return a list of Settings objects.

ExecuteSetting

When a user tries to execute a setting (trying to view the setting on the dashboard or trying to create/update a setting field etc.), an ExecuteSetting event is dispatched to all scripts that have registered for the ExecuteSetting event. The event contains the following fields:

What exactly you return here depends on the operation being executed:

View Operation

If the operation is View, you should return a list where each object in the list contains the fields and the fields value for every column listed in your setting's schema. This will then be populated/displayed in the dashboard as a list of columns. For example, if your setting defines a string column named name and a number column named age, you should return a list of objects like this:

{
    { name = "John Doe", age = 30 },
    { name = "Jane Smith", age = 25 }
}

Other Operation

In all other cases, you should return a empty table after performing the desired operation. The AntiRaid website will then send a View operation afterwards to get the latest data for the setting.

Discord Events

AntiRaid also directly proxies Discord gateway events to scripts. This means that you can register for any Discord event and it'll be sent to your script. The event name will be the same as the Discord event name in SCREAMING_SNAKE_CASE format. The event data will be the same as the Discord event data (the d field in the Discord event). For example, if you register for the MESSAGE_CREATE event, the event data will be the same as the data in the MESSAGE_CREATE event from Discord.

For more information on the Discord events, see the Discord Gateway documentation.