Skip to content
This repository was archived by the owner on Oct 13, 2020. It is now read-only.

WSEvents

Waterflames edited this page Feb 9, 2017 · 2 revisions

What is WSEvents?

WSEvents is a standalone plugin for Bukkit that enables server administrators to perform websend commands when an event occurs.
In order for WSEvents to work properly, both Websend and WSEvents must be updated to the most recent version.

Installation

  1. Download the latest version here.
  2. Put the jar file into your plugins directory.
  3. Start and stop your server to let the configuration files generate.

Configuration

On its first run WSEvents generates its configuration files in the WSEvents folder in the "plugins" directory.
The name of each file represents the category of events the file contains.
To enable an event, simply open the correct file, search the line with the event you want and replace "false" with true.
For example:
HangingBreakEvent=true
The server requires a restart for the changes to be applied.

Behaviour

When the Bukkit server is started with WSEvents, it will load after Websend. This means that WSEvents will not record any event until Websend and WSEvents are loaded. If you need to observe the loading of certain plugins, you might want to set Websend and WSEvents to load before these plugins. This can be done by editing the plugin.yml inside of WSEvents.
Add a "loadbefore" line as specified here and WSEvents should now start before these plugins.

During the loading of WSEvents, the plugin will check each category for enabled events. If the category contains at least one event that is enabled, WSEvents will register a listener for the whole category but only the requested events will be forwarded. This is due to the way Bukkit event listeners work and for readability and maintainability. This should not affect performance.

When an event is triggered, WSEvents triggers a command that follow the format "/ws event eventname" where eventname is specified here. The source of the event included in the request (normally specifying the player that executed a command) contains the event category (ex.: WEBSEND_EVENTS_PAINTING) except when the event is a player event, in which case it specifies the player that is the source of the event.

Clone this wiki locally