Custom Event

Here, we will take a look at Custom Events. Custom events are one of the most powerful features of the bot. It allows you to create automatic action commands based on the events that you have created. Each event can have multiple actions, which makes it very flexible and powerful.

TIP

The first 3 events, with 3 actions per event, is free for everyone! If you want up to 16 events and 11 actions per event, please consider choosing GSH as your server provider or supporting PotBot through Patreon!

Custom Event Components

There are three main components of a custom event:

Conditions

Conditions are the events that provide you with the types of events that will trigger your custom event. There are two conditions:

Condition	Description
if	This condition will trigger the custom event if the event that you have selected is triggered.
Every	This condition will trigger the custom event for every provided period.

These conditions will define the events you can select and the rest of the options you can configure.

Available 'If' Events

TIP

If events use PotBot Webhooks to gather the information needed to execute the command. Ensure you have the correct Webhooks created.

If	If	If	if
PlayerLogin	PlayerLogout	PlayerLeave	ServerStart
PlayerLogout	PlayerKilled	PlayerQuestComplete	ServerRestart
PlayerQuestFailed	PlayerRespawn	AdminSpectate	AdminCommand

Available 'Every' Events

Every	Every	Every	Every
Day	Hour	Minute	Day - Scheduled

Events

This configuration is the event that will trigger the custom event. These are based on the conditions that you have selected. Certain events will have additional options that you can configure, such as the "time".

For example, suppose you select Every condition. In that case, you can choose the Day event and then select the time (box before the event) as 5. This will trigger the custom event every 5 days.

Actions

Actions are the actions that will be performed when the custom event is triggered. There are many actions that you can choose from. Each action will have different options that you can configure.

For example, suppose you select the Announce action. In that case, you can choose the message as Hello World!. When the custom event is triggered, this will announce the message in the game server with the message Hello World!.

Action Options

TIP

The actions you will be able to choose from depends on the events you have chosen

Action	Action	Action
Delay	Whisper	Whisper All
Announce	Heal	Set Marks
Addmarks	Add Marks All	Remove Marks
Modify Attribute	Set Attribute	Teleport
Give Quest	Skipshed	Admin Command
Admin Spectate	Load Creatormode	Save Creatormode
Reset Creatormode	Restart Server	Save Server
Check Role	Add Role	Remove Role
Check Profile Category	Check Dinosaur	Check Growth
Check Verification	Weather	Time
Clear Bodies	Trigger Restart Webhook	Set Water Quality

Now that we know how each component works, we can begin creating our Custom Event.

Creating a Custom Event

1. Go to the custom events page by clicking on the Custom Event button either on the sidebar or the main discord server page on the Dashboard.
2. Click on the + button to create a new custom event.
3. Now, you have many options, as explained above. You can pick and choose the options that you want to configure. Make sure to fill in all the information. Otherwise, the custom event will not be created.
4. Once you have filled in all the information, click the Save button to save the custom event. You can also click on the Discard button to cancel the creation of the custom event.

Editing a Custom Event

1. Go to the custom events page by clicking on the Custom Event button either on the sidebar or the main discord server page on the Dashboard.
2. Edit the information you want to change and click the Save button to save the changes. You can also click the Discard button to cancel the changes.

Delete a Custom Event

1. To delete a custom event, select the Remove?
2. Click the Save button to save the changes.
3. There is also an option to Remove All Rulesets

CAUTION

Using the Remove All Rulesets will delete all created Custom Events.