# Seasonal Events

## **Seasonal Events can now be controlled by server owners!**

{% hint style="warning" %}
Please note, activating an event will cause all players in a server to be kicked, while the server sets up the event. \
\
You do not need to restart your server to activate custom events.
{% endhint %}

{% hint style="warning" %}
These values are case sensitive.
{% endhint %}

{% hint style="warning" %}
Changing between event types (Xmas -> Halloween, etc.)  will destroy all items (including deployables) from the previous event, but activating multiple events of the same type (Xmas + Xmas Portals) will not.
{% endhint %}

### Using the GPORTAL Options page

When initially setting up your seasonal events, you must use the GPORTAL Options dropdown, located in the "Events" section.

This will ensure that your chosen event(s) will always be running on your server, regardless of wipes and restarts.

### Using Seasonal Events commands

After you have set up the seasonal events on your server through the GPORTAL page, you are now free to manipulate the events through the GPORTAL console, using the commands listed on this page.

These commands will not affect the server if it wipes or restarts, and will only persist while the server is still running. If the events are not specified by using the dropdown, they will be removed on restart.

### Example: Combining Options and Commands

Let's say you want to create a permanent Halloween server. You would use the option in the GPORTAL page, restart the server, and the event will then be "baked in" to the server's configuration so that it persists across restarts.

Midwipe, you want to change the event to Xmas. You can do this without restarting by entering the following command into the GPORTAL console: `events.start_special Xmas`.

{% hint style="warning" %}
_**NOTE:**_&#x20;

_**This action will kick all players currently in the server while it prepares the event, but will not restart the server. The specified event will not persist through restarts or wipes unless added to the GPORTAL page dropdown.**_
{% endhint %}

You can also pause and unpause the seasonal events without restarting by using the commands listed below in the GPORTAL Console.

***

## List of Events

> ### **📟**
>
> ### _events.list\_special_
>
> Lists all available events.

## Event Check

> ### **📟**
>
> ### _events.current\_special_
>
> Prints the current Seasonal Event to the console log.

***

## Event Pause

> ### **📟**
>
> ### _events.pause\_special_ `1`
>
> Stops the event from occurring, but preserves deployables.
>
> Does not kick players, just stops the events from occurring.
>
> Pausing during an active event will immediately stop that event from occurring.

## Event Unpause

> ### **📟**
>
> ### _events.pause\_special_ `0`
>
> Restarts the event that you just paused.

***

## Event Types

### Easter

> ### **📟🌌**
>
> ### _events.start\_special_ `Easter`
>
> Activates the Easter Collection Event.

***

### Halloween

> ### **📟🌌**
>
> ### _events.start\_special_ `Halloween`
>
> Activates the Halloween Collection Event.

> ### **📟🌌**
>
> ### _events.start\_special_ `HalloweenPortal`
>
> Activates the Halloween Portals.

{% hint style="warning" %}
Executing `pause_special 1` then `pause_special 0` while Portals are active will destroy them immediately and change their position.
{% endhint %}

***

### Xmas

> ### **📟🌌**
>
> ### _events.start\_special_ `Xmas`
>
> Activates the Christmas Collection Event.

> ### **📟🌌**
>
> ### _events.start\_special_ `XmasPortal`
>
> Activates the Christmas Portals.

{% hint style="warning" %}
Executing `pause_special 1` then `pause_special 0` while Portals are active will destroy them immediately and change their position.
{% endhint %}

***

### Example

> ### **📟🌌**
>
> ### _events.start\_special_ `Xmas`
>
> ### _events.start\_special_ `XmasPortal`
>
> When entered separately into the GPORTAL console, these commands will activate both types of Xmas Event (Collection and Portals).

{% hint style="danger" %}
#### _**Xmas-type events and Halloween-type events cannot be simultaneously active on a server!**_
{% endhint %}
