net.minecraftforge.event
Class Event

java.lang.Object
  net.minecraftforge.event.Event

Direct Known Subclasses:

ClientChatReceivedEvent, CommandEvent, DrawBlockHighlightEvent, EntityEvent, OreDictionary.OreRegisterEvent, RenderWorldLastEvent, SoundEvent, TextureLoadEvent, WorldEvent

public class Event
extends Object

Base Event class that all other events are derived from

Nested Class Summary

static class

Event.Result

Constructor Summary

Event()

Method Summary

ListenerList	getListenerList() Returns a ListenerList object that contains all listeners that are registered to this event.
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 state of this event, not all events are cancelable, and any attempt to cancel a event that can't be will result in a IllegalArgumentException.

Methods inherited from class java.lang.Object

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

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

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 state of this event, not all events are cancelable, and any attempt to cancel a event that can't be will result in a IllegalArgumentException. The functionality of setting the canceled state is defined on a per-event bases.

Parameters:

cancel - The new canceled value

getListenerList

public ListenerList getListenerList()

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

Returns:

Listener List