net.minecraftforge.fml.common.eventhandler

Class Event

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

Direct Known Subclasses:

AnvilUpdateEvent, BabyEntitySpawnEvent, BiomeEvent, BlockEvent, ChunkGeneratorEvent, ChunkWatchEvent, ClientChatEvent, ClientChatReceivedEvent, ColorHandlerEvent, CommandEvent, ConfigChangedEvent, DecorateBiomeEvent, DifficultyChangeEvent, DrawBlockHighlightEvent, EnchantmentLevelSetEvent, EntityEvent, EntityViewRenderEvent, ExplosionEvent, FluidEvent, FluidRegistry.FluidRegisterEvent, FMLNetworkEvent, FMLNetworkEvent.CustomNetworkEvent, ForgeChunkManager.ForceChunkEvent, ForgeChunkManager.UnforceChunkEvent, FOVUpdateEvent, FurnaceFuelBurnTimeEvent, GameRuleChangeEvent, GenericEvent, GuiContainerEvent, GuiOpenEvent, GuiScreenEvent, InitMapGenEvent, InputEvent, LootTableLoadEvent, MerchantTradeOffersEvent, ModelBakeEvent, ModelRegistryEvent, MouseEvent, OreDictionary.OreRegisterEvent, OreGenEvent, PlayerEvent, PotionBrewEvent, RegistryEvent.NewRegistry, RenderBlockOverlayEvent, RenderGameOverlayEvent, RenderHandEvent, RenderItemInFrameEvent, RenderLivingEvent, RenderSpecificHandEvent, RenderTooltipEvent, RenderWorldLastEvent, ScreenshotEvent, ServerChatEvent, SoundEvent, TextureStitchEvent, TickEvent, VillageSiegeEvent, WorldEvent, WorldTypeEvent

public class Event
extends java.lang.Object

Base Event class that all other events are derived from

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Event.HasResult
static class	Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isCanceled
private static ListenerList	listeners
private EventPriority	phase
private Event.Result	result

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
ListenerList	getListenerList() Returns a ListenerList object that contains all listeners that are registered to this event.
EventPriority	getPhase()
Event.Result	getResult() Returns the value set as the result of this event
boolean	hasResult() Determines if this event expects a significant result value.
boolean	isCancelable() Determine if this function is cancelable at all.
boolean	isCanceled() Determine if this event is canceled and should stop executing.
void	setCanceled(boolean cancel) Sets the cancel state of this event.
void	setPhase(EventPriority value)
void	setResult(Event.Result value) 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.
protected void	setup() Called by the base constructor, this is used by ASM generated event classes to setup various functionality such as the listener list.

Methods inherited from class java.lang.Object

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

Field Detail

isCanceled

private boolean isCanceled

result

private Event.Result result

listeners

private static ListenerList listeners

phase

private EventPriority phase

Constructor Detail

Event

public Event()

Method Detail

isCancelable

public boolean isCancelable()

Determine if this function is cancelable at all.

Returns:

If access to setCanceled should be allowed Note: Events with the Cancelable annotation will have this method automatically added to return true.

isCanceled

public boolean isCanceled()

Determine if this event is canceled and should stop executing.

Returns:

The current canceled state

setCanceled

public void setCanceled(boolean cancel)

Sets the cancel state of this event. Note, not all events are cancelable, and any attempt to invoke this method on an event that is not cancelable (as determined by isCancelable() will result in an UnsupportedOperationException. The functionality of setting the canceled state is defined on a per-event bases.

Parameters:

cancel - The new canceled value

hasResult

public boolean hasResult()

Determines if this event expects a significant result value. Note: Events with the HasResult annotation will have this method automatically added to return true.

getResult

public Event.Result getResult()

Returns the value set as the result of this event

setResult

public void setResult(Event.Result value)

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. The functionality of setting the result is defined on a per-event bases.

Parameters:

value - The new result

setup

protected void setup()

Called by the base constructor, this is used by ASM generated event classes to setup various functionality such as the listener list.

getListenerList

public ListenerList getListenerList()

Returns a ListenerList object that contains all listeners that are registered to this event.

Returns:

Listener List

getPhase

@Nullable
public EventPriority getPhase()

setPhase

public void setPhase(@Nonnull
                     EventPriority value)