net.minecraftforge.eventbus.api

インタフェース IEventBus

既知の実装クラスのリスト:

EventBus

public interface IEventBus

EventBus API. Register for events and post events. Contains factory methods to construct an instance #create() and #create(IEventExceptionHandler)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<T extends GenericEvent<? extends F>,F> void	addGenericListener(java.lang.Class<F> genericClassFilter, java.util.function.Consumer<T> consumer) Add a consumer listener for a GenericEvent subclass, filtered to only be called for the specified filter Class.
<T extends GenericEvent<? extends F>,F> void	addGenericListener(java.lang.Class<F> genericClassFilter, EventPriority priority, boolean receiveCancelled, java.lang.Class<T> eventType, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and potentially cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class.
<T extends GenericEvent<? extends F>,F> void	addGenericListener(java.lang.Class<F> genericClassFilter, EventPriority priority, boolean receiveCancelled, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and potentially cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class.
<T extends GenericEvent<? extends F>,F> void	addGenericListener(java.lang.Class<F> genericClassFilter, EventPriority priority, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and not receiving cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class.
<T extends Event> void	addListener(java.util.function.Consumer<T> consumer) Add a consumer listener with default EventPriority.NORMAL and not recieving cancelled events.
<T extends Event> void	addListener(EventPriority priority, boolean receiveCancelled, java.lang.Class<T> eventType, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and potentially cancelled events.
<T extends Event> void	addListener(EventPriority priority, boolean receiveCancelled, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and potentially cancelled events.
<T extends Event> void	addListener(EventPriority priority, java.util.function.Consumer<T> consumer) Add a consumer listener with the specified EventPriority and not receiving cancelled events.
boolean	post(Event event) Submit the event for dispatch to appropriate listeners
void	register(java.lang.Object target) Register an instance object or a Class, and add listeners for all SubscribeEvent annotated methods found there.
void	shutdown() Shuts down this event bus.
void	start()
void	unregister(java.lang.Object object) Unregister the supplied listener from this EventBus.

メソッドの詳細

register

void register(java.lang.Object target)

Register an instance object or a Class, and add listeners for all SubscribeEvent annotated methods found there. Depending on what is passed as an argument, different listener creation behaviour is performed.

Object Instance

Scanned for non-static methods annotated with SubscribeEvent and creates listeners for each method found.

Class Instance

Scanned for static methods annotated with SubscribeEvent and creates listeners for each method found.

パラメータ:

target - Either a Class instance or an arbitrary object, for scanning and event listener creation

addListener

<T extends Event> void addListener(java.util.function.Consumer<T> consumer)

Add a consumer listener with default EventPriority.NORMAL and not recieving cancelled events.

型パラメータ:

T - The Event subclass to listen for

パラメータ:

consumer - Callback to invoke when a matching event is received

addListener

<T extends Event> void addListener(EventPriority priority,
                                   java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and not receiving cancelled events.

型パラメータ:

T - The Event subclass to listen for

パラメータ:

priority - EventPriority for this listener

consumer - Callback to invoke when a matching event is received

addListener

<T extends Event> void addListener(EventPriority priority,
                                   boolean receiveCancelled,
                                   java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and potentially cancelled events.

型パラメータ:

T - The Event subclass to listen for

パラメータ:

priority - EventPriority for this listener

receiveCancelled - Indicate if this listener should receive events that have been Cancelable cancelled

consumer - Callback to invoke when a matching event is received

addListener

<T extends Event> void addListener(EventPriority priority,
                                   boolean receiveCancelled,
                                   java.lang.Class<T> eventType,
                                   java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and potentially cancelled events. Use this method when one of the other methods fails to determine the concrete Event subclass that is intended to be subscribed to.

型パラメータ:

T - The Event subclass to listen for

パラメータ:

priority - EventPriority for this listener

receiveCancelled - Indicate if this listener should receive events that have been Cancelable cancelled

eventType - The concrete Event subclass to subscribe to

consumer - Callback to invoke when a matching event is received

addGenericListener

<T extends GenericEvent<? extends F>,F> void addGenericListener(java.lang.Class<F> genericClassFilter,
                                                                java.util.function.Consumer<T> consumer)

Add a consumer listener for a GenericEvent subclass, filtered to only be called for the specified filter Class.

型パラメータ:

T - The GenericEvent subclass to listen for

F - The Class to filter the GenericEvent for

パラメータ:

genericClassFilter - A Class which the GenericEvent should be filtered for

consumer - Callback to invoke when a matching event is received

addGenericListener

<T extends GenericEvent<? extends F>,F> void addGenericListener(java.lang.Class<F> genericClassFilter,
                                                                EventPriority priority,
                                                                java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and not receiving cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class.

型パラメータ:

T - The GenericEvent subclass to listen for

F - The Class to filter the GenericEvent for

パラメータ:

genericClassFilter - A Class which the GenericEvent should be filtered for

priority - EventPriority for this listener

consumer - Callback to invoke when a matching event is received

addGenericListener

<T extends GenericEvent<? extends F>,F> void addGenericListener(java.lang.Class<F> genericClassFilter,
                                                                EventPriority priority,
                                                                boolean receiveCancelled,
                                                                java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and potentially cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class.

型パラメータ:

T - The GenericEvent subclass to listen for

F - The Class to filter the GenericEvent for

パラメータ:

genericClassFilter - A Class which the GenericEvent should be filtered for

priority - EventPriority for this listener

receiveCancelled - Indicate if this listener should receive events that have been Cancelable cancelled

consumer - Callback to invoke when a matching event is received

addGenericListener

<T extends GenericEvent<? extends F>,F> void addGenericListener(java.lang.Class<F> genericClassFilter,
                                                                EventPriority priority,
                                                                boolean receiveCancelled,
                                                                java.lang.Class<T> eventType,
                                                                java.util.function.Consumer<T> consumer)

Add a consumer listener with the specified EventPriority and potentially cancelled events, for a GenericEvent subclass, filtered to only be called for the specified filter Class. Use this method when one of the other methods fails to determine the concrete GenericEvent subclass that is intended to be subscribed to.

型パラメータ:

T - The GenericEvent subclass to listen for

F - The Class to filter the GenericEvent for

パラメータ:

genericClassFilter - A Class which the GenericEvent should be filtered for

priority - EventPriority for this listener

receiveCancelled - Indicate if this listener should receive events that have been Cancelable cancelled

eventType - The concrete GenericEvent subclass to subscribe to

consumer - Callback to invoke when a matching event is received

unregister

void unregister(java.lang.Object object)

Unregister the supplied listener from this EventBus. Removes all listeners from events. NOTE: Consumers can be stored in a variable if unregistration is required for the Consumer.

パラメータ:

object - The object, Class or Consumer to unsubscribe.

post

boolean post(Event event)

Submit the event for dispatch to appropriate listeners

パラメータ:

event - The event to dispatch to listeners

戻り値:

true if the event was Cancelable cancelled

shutdown

void shutdown()

Shuts down this event bus. No future events will be fired on this event bus, so any call to post(Event) will be a no op after this method has been invoked

start

void start()