Index (bus 8.0.0 API)

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

addGenericListener(Class<F>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
addGenericListener(Class<F>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
addGenericListener(Class<F>, EventPriority, boolean, Class<T>, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
addGenericListener(Class<F>, EventPriority, boolean, Class<T>, Consumer<T>) - Method in class net.neoforged.bus.EventBus
addGenericListener(Class<F>, EventPriority, boolean, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
addGenericListener(Class<F>, EventPriority, boolean, Consumer<T>) - Method in class net.neoforged.bus.EventBus
addGenericListener(Class<F>, EventPriority, Consumer<T>) - Method in interface net.neoforged.bus.api.IEventBus: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
addGenericListener(Class<F>, EventPriority, Consumer<T>) - Method in class net.neoforged.bus.EventBus
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.NORMAL and 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 EventPriority and 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 EventPriority and 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 EventPriority and 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 EventPriority and not receiving canceled events.
addListener(EventPriority, Consumer<T>) - Method in class net.neoforged.bus.EventBus
ALLOW - Enum constant in enum class net.neoforged.bus.api.Event.Result
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
build() - Method in class net.neoforged.bus.BusBuilderImpl
builder() - Static method in interface net.neoforged.bus.api.BusBuilder
BusBuilder - Interface in net.neoforged.bus.api: Build a bus
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
checkTypesOnDispatch() - Method in class net.neoforged.bus.BusBuilderImpl
classChecker(IEventClassChecker) - Method in interface net.neoforged.bus.api.BusBuilder
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

D

DEFAULT - Enum constant in enum class net.neoforged.bus.api.Event.Result
DENY - Enum constant in enum class net.neoforged.bus.api.Event.Result

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
Event.HasResult - Annotation Interface in net.neoforged.bus.api: Deprecated, for removal: This API element is subject to removal in a future version.
Use a custom type and custom methods appropriate for your event, instead of the overly general Event.Result enum. Event.getResult() and Event.setResult(Result) will be removed in a future version.
Event.Result - Enum Class in net.neoforged.bus.api
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
EventListenerHelper - Class in net.neoforged.bus
EventListenerHelper() - Constructor for class net.neoforged.bus.EventListenerHelper
EventPriority - Enum Class in net.neoforged.bus.api: Different priorities for Event listeners.

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
GenericEvent<T> - Class in net.neoforged.bus.api: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
GenericEvent() - Constructor for class net.neoforged.bus.api.GenericEvent: Deprecated.
GenericEvent(Class<T>) - Constructor for class net.neoforged.bus.api.GenericEvent: Deprecated.
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
getGenericType() - Method in class net.neoforged.bus.api.GenericEvent: Deprecated.
getGenericType() - Method in interface net.neoforged.bus.api.IGenericEvent: Deprecated.
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
getResult() - Method in class net.neoforged.bus.api.Event: Returns the value set as the result of this event
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
hasResult() - Method in class net.neoforged.bus.api.Event: Determines if this event expects a significant result value.
hasResult(Class<?>) - Static method in class net.neoforged.bus.EventListenerHelper
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
IGenericEvent<T> - Interface in net.neoforged.bus.api: Deprecated, for removal: This API element is subject to removal in a future version.
Use non-generic events instead, or another system.
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
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

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

R

receiveCanceled() - Element in annotation interface net.neoforged.bus.api.SubscribeEvent
register(Object) - Method in interface net.neoforged.bus.api.IEventBus: Register an instance object or a Class, and add listeners for all SubscribeEvent annotated methods found there.
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
setExceptionHandler(IEventExceptionHandler) - Method in class net.neoforged.bus.BusBuilderImpl
setResult(Event.Result) - Method in class net.neoforged.bus.api.Event: Sets the result value for this event, not all events can have a result set, and any attempt to set a result for a event that isn't expecting it will result in a IllegalArgumentException.
shouldRebuild() - Method in class net.neoforged.bus.ListenerList
start() - Method in interface net.neoforged.bus.api.IEventBus
start() - Method in class net.neoforged.bus.EventBus
startShutdown() - Method in interface net.neoforged.bus.api.BusBuilder
startShutdown() - Method in class net.neoforged.bus.BusBuilderImpl
SubscribeEvent - Annotation Interface in net.neoforged.bus.api: Annotation to subscribe a method to an Event This annotation can only be applied to single parameter methods, where the single parameter is a subclass of Event.
SubscribeEventListener - Class in net.neoforged.bus: Wrapper around an event handler generated for a SubscribeEvent method.
SubscribeEventListener(Object, Method, boolean) - 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.Event.Result: Returns the enum constant of this class with the specified name.
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.Event.Result: Returns an array containing the constants of this enum class, in the order they are declared.
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

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form