YATS/Forge Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
Classes | Public Member Functions | Protected Member Functions | List of all members
net.minecraftforge.event.Event Class Reference
Inheritance diagram for net.minecraftforge.event.Event:
net.minecraftforge.client.event.ClientChatReceivedEvent net.minecraftforge.client.event.DrawBlockHighlightEvent net.minecraftforge.client.event.RenderGameOverlayEvent net.minecraftforge.client.event.RenderLivingEvent net.minecraftforge.client.event.RenderWorldLastEvent net.minecraftforge.client.event.sound.SoundEvent net.minecraftforge.client.event.TextureLoadEvent net.minecraftforge.client.event.TextureStitchEvent net.minecraftforge.event.brewing.PotionBrewedEvent net.minecraftforge.event.CommandEvent net.minecraftforge.event.entity.EntityEvent net.minecraftforge.event.ServerChatEvent net.minecraftforge.event.terraingen.BiomeEvent net.minecraftforge.event.terraingen.ChunkProviderEvent net.minecraftforge.event.terraingen.DecorateBiomeEvent net.minecraftforge.event.terraingen.InitMapGenEvent net.minecraftforge.event.terraingen.OreGenEvent net.minecraftforge.event.terraingen.WorldTypeEvent net.minecraftforge.event.world.ChunkWatchEvent net.minecraftforge.event.world.WorldEvent net.minecraftforge.liquids.LiquidEvent

Classes

interface  HasResult
 
enum  Result
 

Public Member Functions

 Event ()
 
boolean isCancelable ()
 
boolean isCanceled ()
 
void setCanceled (boolean cancel)
 
boolean hasResult ()
 
Result getResult ()
 
void setResult (Result value)
 
ListenerList getListenerList ()
 

Protected Member Functions

void setup ()
 

Detailed Description

Base Event class that all other events are derived from

Constructor & Destructor Documentation

net.minecraftforge.event.Event.Event ( )

Member Function Documentation

ListenerList net.minecraftforge.event.Event.getListenerList ( )

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

Returns
Listener List
Result net.minecraftforge.event.Event.getResult ( )

Returns the value set as the result of this event

boolean net.minecraftforge.event.Event.hasResult ( )

Determines if this event expects a significant result value.

boolean net.minecraftforge.event.Event.isCancelable ( )

Determine if this function is cancelable at all.

Returns
If access to setCanceled should be allowed
boolean net.minecraftforge.event.Event.isCanceled ( )

Determine if this event is canceled and should stop executing.

Returns
The current canceled state
void net.minecraftforge.event.Event.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
cancelThe new canceled value
void net.minecraftforge.event.Event.setResult ( 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
valueThe new result
void net.minecraftforge.event.Event.setup ( )
protected

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

The documentation for this class was generated from the following file: