Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addListener(boolean, Class<T>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener receiving potentially canceled events.
- addListener(boolean, Class<T>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(boolean, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener receiving potentially canceled events.
- addListener(boolean, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(Class<T>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener not receiving canceled events.
- addListener(Class<T>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener with default
EventPriority.NORMALand not recieving canceled events. - addListener(Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(EventPriority, boolean, Class<T>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener with the specified
EventPriorityand potentially canceled events. - addListener(EventPriority, boolean, Class<T>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(EventPriority, boolean, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener with the specified
EventPriorityand potentially canceled events. - addListener(EventPriority, boolean, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(EventPriority, Class<T>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener with the specified
EventPriorityand not receiving canceled events. - addListener(EventPriority, Class<T>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- addListener(EventPriority, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus
-
Add a consumer listener with the specified
EventPriorityand not receiving canceled events. - addListener(EventPriority, Consumer<T>) - Method in class net.neoforged.bus.EventBus
- allowPerPhasePost() - Method in interface net.neoforged.bus.api.BusBuilder
-
Allow calling
IEventBus.post(EventPriority, Event). - allowPerPhasePost() - Method in class net.neoforged.bus.BusBuilderImpl
B
- build() - Method in interface net.neoforged.bus.api.BusBuilder
-
Returns a built bus configured according to the configuration of this builder.
- build() - Method in class net.neoforged.bus.BusBuilderImpl
- builder() - Static method in interface net.neoforged.bus.api.BusBuilder
-
Returns a new bus builder.
- BusBuilder - Interface in net.neoforged.bus.api
-
Class used to build
event buses. - BusBuilderImpl - Class in net.neoforged.bus
-
BusBuilder Implementation, public for BusBuilder.builder() only, don't use this directly.
- BusBuilderImpl() - Constructor for class net.neoforged.bus.BusBuilderImpl
C
- check(Class<? extends Event>) - Method in interface net.neoforged.bus.api.IEventClassChecker
-
If the event class should be accepted for the bus, does nothing.
- checkTypesOnDispatch() - Method in interface net.neoforged.bus.api.BusBuilder
-
Make the bus check posted events using the
class checker. - checkTypesOnDispatch() - Method in class net.neoforged.bus.BusBuilderImpl
- classChecker(IEventClassChecker) - Method in interface net.neoforged.bus.api.BusBuilder
-
Set a class checker that will allow validating the event types that the bus can handle.
- classChecker(IEventClassChecker) - Method in class net.neoforged.bus.BusBuilderImpl
- clearAll() - Method in class net.neoforged.bus.LockHelper
- computeIfAbsent(K, Function<K, I>, Function<I, V>) - Method in class net.neoforged.bus.LockHelper
- computeIfAbsent(K, Function<K, V>) - Method in class net.neoforged.bus.LockHelper
- consumer - Variable in class net.neoforged.bus.ConsumerEventHandler
- ConsumerEventHandler - Class in net.neoforged.bus
-
Wraps a consumer to be used as an event handler, and overrides
ConsumerEventHandler.toString()for better debugging. - ConsumerEventHandler(Consumer<Event>) - Constructor for class net.neoforged.bus.ConsumerEventHandler
- ConsumerEventHandler.WithPredicate - Class in net.neoforged.bus
- containsKey(K) - Method in class net.neoforged.bus.LockHelper
E
- Event - Class in net.neoforged.bus.api
-
Base Event class that all other events are derived from.
- Event() - Constructor for class net.neoforged.bus.api.Event
- EventBus - Class in net.neoforged.bus
- EventBus(BusBuilderImpl) - Constructor for class net.neoforged.bus.EventBus
- EventBusErrorMessage - Class in net.neoforged.bus
- EventBusErrorMessage(Event, int, EventListener[], Throwable) - Constructor for class net.neoforged.bus.EventBusErrorMessage
- EventListener - Class in net.neoforged.bus.api
-
Event listeners are wrapped with implementations of this class.
- EventListener() - Constructor for class net.neoforged.bus.api.EventListener
- EventPriority - Enum Class in net.neoforged.bus.api
-
Different priorities for
Eventlisteners.
F
- forceRebuild() - Method in class net.neoforged.bus.ListenerList
- formatTo(StringBuilder) - Method in class net.neoforged.bus.EventBusErrorMessage
G
- GeneratedEventListener - Class in net.neoforged.bus
-
Base class for event listeners generated by
EventListenerFactory. - GeneratedEventListener() - Constructor for class net.neoforged.bus.GeneratedEventListener
- get(K) - Method in class net.neoforged.bus.LockHelper
- getFormat() - Method in class net.neoforged.bus.EventBusErrorMessage
- getFormattedMessage() - Method in class net.neoforged.bus.EventBusErrorMessage
- getListeners() - Method in class net.neoforged.bus.ListenerList
-
Returns a full list of all listeners for all priority levels.
- getParameters() - Method in class net.neoforged.bus.EventBusErrorMessage
- getPhaseListeners(EventPriority) - Method in class net.neoforged.bus.ListenerList
- getPriority() - Method in class net.neoforged.bus.SubscribeEventListener
- getThrowable() - Method in class net.neoforged.bus.EventBusErrorMessage
- getWithoutCheck() - Method in class net.neoforged.bus.ConsumerEventHandler.WithPredicate
- getWithoutCheck() - Method in interface net.neoforged.bus.IWrapperListener
- getWithoutCheck() - Method in class net.neoforged.bus.SubscribeEventListener
H
- handleException(IEventBus, Event, EventListener[], int, Throwable) - Method in interface net.neoforged.bus.api.IEventExceptionHandler
-
Fired when a EventListener throws an exception for the specified event on the event bus.
- handleException(IEventBus, Event, EventListener[], int, Throwable) - Method in class net.neoforged.bus.EventBus
- HIGH - Enum constant in enum class net.neoforged.bus.api.EventPriority
- HIGHEST - Enum constant in enum class net.neoforged.bus.api.EventPriority
-
Priority of event listeners, listeners will be sorted with respect to this priority level.
I
- ICancellableEvent - Interface in net.neoforged.bus.api
-
Interface for events that can be canceled.
- IEventBus - Interface in net.neoforged.bus.api
-
EventBus API.
- IEventClassChecker - Interface in net.neoforged.bus.api
- IEventExceptionHandler - Interface in net.neoforged.bus.api
-
Handler for exceptions occurred in event listeners.
- invoke(Event) - Method in class net.neoforged.bus.api.EventListener
- invoke(Event) - Method in class net.neoforged.bus.ConsumerEventHandler
- invoke(Event) - Method in class net.neoforged.bus.ConsumerEventHandler.WithPredicate
- invoke(Event) - Method in class net.neoforged.bus.SubscribeEventListener
- isCanceled() - Method in interface net.neoforged.bus.api.ICancellableEvent
-
Returns the canceled state of this event.
- IWrapperListener - Interface in net.neoforged.bus
-
Listener that wraps a listener to add a check.
L
- ListenerList - Class in net.neoforged.bus
- LockHelper<K,
V> - Class in net.neoforged.bus -
Helper class that should be faster then ConcurrentHashMap, yet still manages to properly deal with many threads.
- LOW - Enum constant in enum class net.neoforged.bus.api.EventPriority
- LOWEST - Enum constant in enum class net.neoforged.bus.api.EventPriority
M
- markerType(Class<?>) - Method in interface net.neoforged.bus.api.BusBuilder
-
Helper for
BusBuilder.classChecker(IEventClassChecker)that will check if the event type is of the givenmarkerInterface.
N
- net.neoforged.bus - module net.neoforged.bus
- net.neoforged.bus - package net.neoforged.bus
- net.neoforged.bus.api - package net.neoforged.bus.api
- NORMAL - Enum constant in enum class net.neoforged.bus.api.EventPriority
P
- post(EventPriority, T) - Method in interface net.neoforged.bus.api.IEventBus
-
Submit the event for dispatch to listeners registered with a specific
EventPriority. - post(EventPriority, T) - Method in class net.neoforged.bus.EventBus
- post(T) - Method in interface net.neoforged.bus.api.IEventBus
-
Submit the event for dispatch to appropriate listeners
- post(T) - Method in class net.neoforged.bus.EventBus
- priority() - Element in annotation interface net.neoforged.bus.api.SubscribeEvent
-
Returns the priority to subscribe this listener with.
R
- receiveCanceled() - Element in annotation interface net.neoforged.bus.api.SubscribeEvent
-
Returns whether this listener should receive cancelled events.
- register(Object) - Method in interface net.neoforged.bus.api.IEventBus
-
Register an instance object or a Class, and add listeners for all
SubscribeEventannotated methods found there, or directly a Method annotated withSubscribeEvent. - register(Object) - Method in class net.neoforged.bus.EventBus
- register(EventPriority, EventListener) - Method in class net.neoforged.bus.ListenerList
S
- setCanceled(boolean) - Method in interface net.neoforged.bus.api.ICancellableEvent
-
Sets the cancel state of this event.
- setExceptionHandler(IEventExceptionHandler) - Method in interface net.neoforged.bus.api.BusBuilder
-
Override the default exception handler.
- setExceptionHandler(IEventExceptionHandler) - Method in class net.neoforged.bus.BusBuilderImpl
- shouldRebuild() - Method in class net.neoforged.bus.ListenerList
- start() - Method in interface net.neoforged.bus.api.IEventBus
-
Start this bus (if it was created shut down), making it able to post events to listeners.
- start() - Method in class net.neoforged.bus.EventBus
- startShutdown() - Method in interface net.neoforged.bus.api.BusBuilder
-
Create the bus in a shut down state.
- startShutdown() - Method in class net.neoforged.bus.BusBuilderImpl
- SubscribeEvent - Annotation Interface in net.neoforged.bus.api
-
Annotation to subscribe a method to an
Event - SubscribeEventListener - Class in net.neoforged.bus
-
Wrapper around an event handler generated for a
SubscribeEventmethod. - SubscribeEventListener(Object, Method) - Constructor for class net.neoforged.bus.SubscribeEventListener
T
- toString() - Method in class net.neoforged.bus.ConsumerEventHandler
- toString() - Method in class net.neoforged.bus.SubscribeEventListener
U
- unregister(Object) - Method in interface net.neoforged.bus.api.IEventBus
-
Unregister the supplied listener from this EventBus.
- unregister(Object) - Method in class net.neoforged.bus.EventBus
- unregister(EventListener) - Method in class net.neoforged.bus.ListenerList
V
- valueOf(String) - Static method in enum class net.neoforged.bus.api.EventPriority
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class net.neoforged.bus.api.EventPriority
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withHashMap() - Static method in class net.neoforged.bus.LockHelper
- withIdentityHashMap() - Static method in class net.neoforged.bus.LockHelper
- WithPredicate(Consumer<Event>, Predicate<Event>) - Constructor for class net.neoforged.bus.ConsumerEventHandler.WithPredicate
All Classes and Interfaces|All Packages|Serialized Form