net.minecraftforge.eventbus

クラス EventBus

java.lang.Object

net.minecraftforge.eventbus.EventBus

すべての実装されたインタフェース:

IEventBus, IEventExceptionHandler

public class EventBus
extends java.lang.Object
implements IEventExceptionHandler, IEventBus

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
EventBus(BusBuilder busBuilder)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<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.
void	handleException(IEventBus bus, Event event, IEventListener[] listeners, int index, java.lang.Throwable throwable) Fired when a EventListener throws an exception for the specified event on the event bus.
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.

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

EventBus

public EventBus(BusBuilder busBuilder)

メソッドの詳細

register

public void register(java.lang.Object target)

インタフェースからコピーされた説明: IEventBus

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.

定義:

register インタフェース内 IEventBus

パラメータ:

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

addListener

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

インタフェースからコピーされた説明: IEventBus

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

定義:

addListener インタフェース内 IEventBus

型パラメータ:

T - The Event subclass to listen for

パラメータ:

consumer - Callback to invoke when a matching event is received

addListener

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

インタフェースからコピーされた説明: IEventBus

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

定義:

addListener インタフェース内 IEventBus

型パラメータ:

T - The Event subclass to listen for

パラメータ:

priority - EventPriority for this listener

consumer - Callback to invoke when a matching event is received

addListener

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

インタフェースからコピーされた説明: IEventBus

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

定義:

addListener インタフェース内 IEventBus

型パラメータ:

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

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

インタフェースからコピーされた説明: IEventBus

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.

定義:

addListener インタフェース内 IEventBus

型パラメータ:

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

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

インタフェースからコピーされた説明: IEventBus

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

定義:

addGenericListener インタフェース内 IEventBus

型パラメータ:

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

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

インタフェースからコピーされた説明: IEventBus

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.

定義:

addGenericListener インタフェース内 IEventBus

型パラメータ:

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

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

インタフェースからコピーされた説明: IEventBus

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.

定義:

addGenericListener インタフェース内 IEventBus

型パラメータ:

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

public <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)

インタフェースからコピーされた説明: IEventBus

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.

定義:

addGenericListener インタフェース内 IEventBus

型パラメータ:

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

public void unregister(java.lang.Object object)

インタフェースからコピーされた説明: IEventBus

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.

定義:

unregister インタフェース内 IEventBus

パラメータ:

object - The object, Class or Consumer to unsubscribe.

post

public boolean post(Event event)

インタフェースからコピーされた説明: IEventBus

Submit the event for dispatch to appropriate listeners

定義:

post インタフェース内 IEventBus

パラメータ:

event - The event to dispatch to listeners

戻り値:

true if the event was Cancelable cancelled

handleException

public void handleException(IEventBus bus,
                            Event event,
                            IEventListener[] listeners,
                            int index,
                            java.lang.Throwable throwable)

インタフェースからコピーされた説明: IEventExceptionHandler

Fired when a EventListener throws an exception for the specified event on the event bus. After this function returns, the original Throwable will be propagated upwards.

定義:

handleException インタフェース内 IEventExceptionHandler

パラメータ:

bus - The bus the event is being fired on

event - The event that is being fired

listeners - All listeners that are listening for this event, in order

index - Index for the current listener being fired.

throwable - The throwable being thrown

shutdown

public void shutdown()

インタフェースからコピーされた説明: IEventBus

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

定義:

shutdown インタフェース内 IEventBus

start

public void start()

定義:

start インタフェース内 IEventBus