org.spongepowered.api.event

Interface EventManager

public interface EventManager

Manages the registration of event listeners and the dispatching of events.

Method Summary

Modifier and Type	Method and Description
boolean	post(Event event) Calls a Event to all listeners that listen to it.
<T extends Event> void	registerListener(Object plugin, Class<T> eventClass, EventListener<? super T> listener) Registers an event listener for a specific event class.
<T extends Event> void	registerListener(Object plugin, Class<T> eventClass, Order order, boolean beforeModifications, EventListener<? super T> listener) Registers an event listener with the specified order for a specific event class.
<T extends Event> void	registerListener(Object plugin, Class<T> eventClass, Order order, EventListener<? super T> listener) Registers an event listener with the specified order for a specific event class.
<T extends Event> void	registerListener(Object plugin, TypeToken<T> eventType, EventListener<? super T> listener) Registers an event listener for a specific event TypeToken.
<T extends Event> void	registerListener(Object plugin, TypeToken<T> eventType, Order order, boolean beforeModifications, EventListener<? super T> listener) Registers an event listener with the specified order for a specific event class.
<T extends Event> void	registerListener(Object plugin, TypeToken<T> eventType, Order order, EventListener<? super T> listener) Registers an event listener with the specified order for a specific event TypeToken.
void	registerListeners(Object plugin, Object obj) Registers Event methods annotated with @Listener in the specified object.
void	unregisterListeners(Object obj) Un-registers an object from receiving Events.
void	unregisterPluginListeners(Object plugin) Un-registers all event listeners of a plugin.

Method Detail

registerListeners

void registerListeners(Object plugin,
                       Object obj)

Registers Event methods annotated with @Listener in the specified object.

Only methods that are public will be registered and the class must be public as well.

Parameters:

plugin - The plugin instance

obj - The object

Throws:

IllegalArgumentException - Thrown if plugin is not a plugin instance

registerListener

<T extends Event> void registerListener(Object plugin,
                                        Class<T> eventClass,
                                        EventListener<? super T> listener)

Registers an event listener for a specific event class.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventClass - The event to listen to

listener - The listener to receive the events

registerListener

<T extends Event> void registerListener(Object plugin,
                                        TypeToken<T> eventType,
                                        EventListener<? super T> listener)

Registers an event listener for a specific event TypeToken.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventType - The event to listen to

listener - The listener to receive the events

registerListener

<T extends Event> void registerListener(Object plugin,
                                        Class<T> eventClass,
                                        Order order,
                                        EventListener<? super T> listener)

Registers an event listener with the specified order for a specific event class.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventClass - The event to listen to

order - The order the listener will get called at

listener - The listener to receive the events

registerListener

<T extends Event> void registerListener(Object plugin,
                                        TypeToken<T> eventType,
                                        Order order,
                                        EventListener<? super T> listener)

Registers an event listener with the specified order for a specific event TypeToken.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventType - The event to listen to

order - The order the listener will get called at

listener - The listener to receive the events

registerListener

<T extends Event> void registerListener(Object plugin,
                                        Class<T> eventClass,
                                        Order order,
                                        boolean beforeModifications,
                                        EventListener<? super T> listener)

Registers an event listener with the specified order for a specific event class.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventClass - The event to listen to

order - The order the listener will get called at

beforeModifications - Whether to call the listener before other server modifications

listener - The listener to receive the events

registerListener

<T extends Event> void registerListener(Object plugin,
                                        TypeToken<T> eventType,
                                        Order order,
                                        boolean beforeModifications,
                                        EventListener<? super T> listener)

Registers an event listener with the specified order for a specific event class.

Normally, the annotation-based way in registerListeners(Object, Object) should be preferred over this way. This method exists primarily to support dynamic event registration like needed in scripting plugins.

Type Parameters:

T - The type of the event

Parameters:

plugin - The plugin instance

eventType - The event to listen to

order - The order the listener will get called at

beforeModifications - Whether to call the listener before other server modifications

listener - The listener to receive the events

unregisterListeners

void unregisterListeners(Object obj)

Un-registers an object from receiving Events.

Parameters:

obj - The object

unregisterPluginListeners

void unregisterPluginListeners(Object plugin)

Un-registers all event listeners of a plugin.

Parameters:

plugin - The plugin instance

post

boolean post(Event event)

Calls a Event to all listeners that listen to it.

Parameters:

event - The event

Returns:

True if cancelled, false if not