org.spongepowered.api.event

Interface Event

All Known Subinterfaces:

AdvancementEvent, AdvancementEvent.Grant, AdvancementEvent.Revoke, AdvancementTreeEvent, AdvancementTreeEvent.GenerateLayout, AffectEntityEvent, AffectItemStackEvent, AffectSlotEvent, AITaskEvent, AITaskEvent.Add, AITaskEvent.Remove, AnimateHandEvent, AttackEntityEvent, BanIpEvent, BanUserEvent, BanUserEvent.TargetPlayer, BreedEntityEvent, BreedEntityEvent.Breed, BreedEntityEvent.FindMate, BreedEntityEvent.ReadyToMate, BrewingEvent, BrewingEvent.Finish, BrewingEvent.Interrupt, BrewingEvent.Start, BrewingEvent.Tick, ChangeBlockEvent, ChangeBlockEvent.Break, ChangeBlockEvent.Decay, ChangeBlockEvent.Grow, ChangeBlockEvent.Modify, ChangeBlockEvent.Place, ChangeBlockEvent.Post, ChangeBlockEvent.Pre, ChangeDataHolderEvent, ChangeDataHolderEvent.ValueChange, ChangeEntityEquipmentEvent, ChangeEntityEquipmentEvent.Break, ChangeEntityEquipmentEvent.TargetHumanoid, ChangeEntityEquipmentEvent.TargetLiving, ChangeEntityEquipmentEvent.TargetPlayer, ChangeEntityExperienceEvent, ChangeEntityPotionEffectEvent, ChangeEntityPotionEffectEvent.Expire, ChangeEntityPotionEffectEvent.Gain, ChangeEntityPotionEffectEvent.Remove, ChangeGameModeEvent, ChangeGameModeEvent.TargetPlayer, ChangeInventoryEvent, ChangeInventoryEvent.Equipment, ChangeInventoryEvent.Held, ChangeInventoryEvent.Pickup, ChangeInventoryEvent.Pickup.Pre, ChangeInventoryEvent.SwapHand, ChangeInventoryEvent.Transfer, ChangeInventoryEvent.Transfer.Post, ChangeInventoryEvent.Transfer.Pre, ChangeLevelEvent, ChangeLevelEvent.TargetPlayer, ChangeServiceProviderEvent, ChangeSignEvent, ChangeStatisticEvent, ChangeStatisticEvent.TargetPlayer, ChangeWorldBorderEvent, ChangeWorldBorderEvent.TargetPlayer, ChangeWorldBorderEvent.TargetWorld, ChangeWorldGameRuleEvent, ChangeWorldWeatherEvent, ChannelRegistrationEvent, ChannelRegistrationEvent.Register, ChannelRegistrationEvent.Unregister, ChunkPreGenerationEvent, ChunkPreGenerationEvent.Cancelled, ChunkPreGenerationEvent.Complete, ChunkPreGenerationEvent.Post, ChunkPreGenerationEvent.Pre, ClickInventoryEvent, ClickInventoryEvent.Creative, ClickInventoryEvent.Double, ClickInventoryEvent.Drag, ClickInventoryEvent.Drag.Middle, ClickInventoryEvent.Drag.Primary, ClickInventoryEvent.Drag.Secondary, ClickInventoryEvent.Drop, ClickInventoryEvent.Drop.Full, ClickInventoryEvent.Drop.Outside, ClickInventoryEvent.Drop.Outside.Creative, ClickInventoryEvent.Drop.Outside.Primary, ClickInventoryEvent.Drop.Outside.Secondary, ClickInventoryEvent.Drop.Single, ClickInventoryEvent.Middle, ClickInventoryEvent.NumberPress, ClickInventoryEvent.Primary, ClickInventoryEvent.Recipe, ClickInventoryEvent.Recipe.All, ClickInventoryEvent.Recipe.Single, ClickInventoryEvent.Secondary, ClickInventoryEvent.Shift, ClickInventoryEvent.Shift.Primary, ClickInventoryEvent.Shift.Secondary, ClientConnectionEvent, ClientConnectionEvent.Auth, ClientConnectionEvent.Disconnect, ClientConnectionEvent.Join, ClientConnectionEvent.Login, ClientPingServerEvent, CollideBlockEvent, CollideBlockEvent.Impact, CollideEntityEvent, CollideEntityEvent.Impact, CollideEvent, CollideEvent.Impact, ConstructEntityEvent, ConstructEntityEvent.Post, ConstructEntityEvent.Pre, ConstructPortalEvent, ConstructWorldPropertiesEvent, CooldownEvent, CooldownEvent.End, CooldownEvent.Set, CraftItemEvent, CraftItemEvent.Craft, CraftItemEvent.Preview, CriterionEvent, CriterionEvent.Grant, CriterionEvent.Revoke, CriterionEvent.Score, CriterionEvent.Score.Change, CriterionEvent.Score.Grant, CriterionEvent.Score.Revoke, CriterionEvent.Trigger<C>, DamageEntityEvent, DefuseExplosiveEvent, DefuseExplosiveEvent.Post, DefuseExplosiveEvent.Pre, DestructEntityEvent, DestructEntityEvent.Death, DetonateExplosiveEvent, DropItemEvent, DropItemEvent.Close, DropItemEvent.Custom, DropItemEvent.Destruct, DropItemEvent.Dispense, DropItemEvent.Pre, EconomyTransactionEvent, EnchantItemEvent, EnchantItemEvent.CalculateEnchantment, EnchantItemEvent.CalculateLevelRequirement, EnchantItemEvent.Post, ExpireEntityEvent, ExpireEntityEvent.TargetItem, ExplosionEvent, ExplosionEvent.Detonate, ExplosionEvent.Post, ExplosionEvent.Pre, FishingEvent, FishingEvent.HookEntity, FishingEvent.Start, FishingEvent.Stop, ForcedChunkEvent, GameAboutToStartServerEvent, GameConstructionEvent, GameInitializationEvent, GameLoadCompleteEvent, GamePostInitializationEvent, GamePreInitializationEvent, GameRegistryEvent, GameRegistryEvent.Register<T>, GameReloadEvent, GameStartedServerEvent, GameStartingServerEvent, GameStateEvent, GameStoppedEvent, GameStoppedServerEvent, GameStoppingEvent, GameStoppingServerEvent, GenerateChunkEvent, GenerateChunkEvent.Post, GenerateChunkEvent.Pre, GenericEvent<T>, HandInteractEvent, HarvestEntityEvent, HarvestEntityEvent.TargetHumanoid, HarvestEntityEvent.TargetLiving, HarvestEntityEvent.TargetPlayer, HealEntityEvent, IgniteEntityEvent, InteractBlockEvent, InteractBlockEvent.Primary, InteractBlockEvent.Primary.MainHand, InteractBlockEvent.Primary.OffHand, InteractBlockEvent.Secondary, InteractBlockEvent.Secondary.MainHand, InteractBlockEvent.Secondary.OffHand, InteractEntityEvent, InteractEntityEvent.Primary, InteractEntityEvent.Primary.MainHand, InteractEntityEvent.Primary.OffHand, InteractEntityEvent.Secondary, InteractEntityEvent.Secondary.MainHand, InteractEntityEvent.Secondary.OffHand, InteractEvent, InteractInventoryEvent, InteractInventoryEvent.Close, InteractInventoryEvent.Open, InteractItemEvent, InteractItemEvent.Primary, InteractItemEvent.Primary.MainHand, InteractItemEvent.Primary.OffHand, InteractItemEvent.Secondary, InteractItemEvent.Secondary.MainHand, InteractItemEvent.Secondary.OffHand, ItemMergeItemEvent, KickPlayerEvent, LaunchProjectileEvent, LeashEntityEvent, LightningEvent, LightningEvent.Post, LightningEvent.Pre, LightningEvent.Strike, LoadChunkEvent, LoadWorldEvent, MessageChannelEvent, MessageChannelEvent.Chat, MessageEvent, MoveEntityEvent, MoveEntityEvent.Position, MoveEntityEvent.Teleport, MoveEntityEvent.Teleport.Portal, NotifyNeighborBlockEvent, PardonIpEvent, PardonUserEvent, PardonUserEvent.TargetPlayer, PlayerChangeClientSettingsEvent, PlaySoundEvent, PlaySoundEvent.AtEntity, PlaySoundEvent.Broadcast, PlaySoundEvent.NoteBlock, PlaySoundEvent.Record, PlaySoundEvent.Record.Start, PlaySoundEvent.Record.Stop, PopulateChunkEvent, PopulateChunkEvent.Populate, PopulateChunkEvent.Post, PopulateChunkEvent.Pre, PrimeExplosiveEvent, PrimeExplosiveEvent.Post, PrimeExplosiveEvent.Pre, QueryServerEvent, QueryServerEvent.Basic, QueryServerEvent.Full, RconConnectionEvent, RconConnectionEvent.Connect, RconConnectionEvent.Disconnect, RconConnectionEvent.Login, ResourcePackStatusEvent, RespawnPlayerEvent, RideEntityEvent, RideEntityEvent.Dismount, RideEntityEvent.Mount, RotateEntityEvent, SaveChunkEvent, SaveChunkEvent.Post, SaveChunkEvent.Pre, SaveWorldEvent, SaveWorldEvent.Post, SaveWorldEvent.Pre, SendCommandEvent, SetAITargetEvent, SleepingEvent, SleepingEvent.Finish, SleepingEvent.Post, SleepingEvent.Pre, SleepingEvent.Tick, SmeltEvent, SmeltEvent.ConsumeFuel, SmeltEvent.Finish, SmeltEvent.Interrupt, SmeltEvent.Start, SmeltEvent.Tick, SpawnEntityEvent, SpawnEntityEvent.ChunkLoad, SpawnEntityEvent.Custom, SpawnEntityEvent.Spawner, TabCompleteEvent, TabCompleteEvent.Chat, TabCompleteEvent.Command, TameEntityEvent, TargetAgentEvent, TargetBlockEvent, TargetChunkEvent, TargetContainerEvent, TargetEntityEvent, TargetExplosiveEvent, TargetFusedExplosiveEvent, TargetHumanoidEvent, TargetInventoryEvent, TargetItemEvent, TargetLivingEvent, TargetPlayerEvent, TargetProjectileEvent, TargetTileEntityEvent, TargetUserEvent, TargetWorldEvent, TickBlockEvent, TickBlockEvent.Random, TickBlockEvent.Scheduled, UnforcedChunkEvent, UnleashEntityEvent, UnloadChunkEvent, UnloadWorldEvent, UpdateAnvilEvent, UseItemStackEvent, UseItemStackEvent.Finish, UseItemStackEvent.Replace, UseItemStackEvent.Reset, UseItemStackEvent.Start, UseItemStackEvent.Stop, UseItemStackEvent.Tick

All Known Implementing Classes:

AbstractAffectEntityEvent, AbstractAITaskEvent, AbstractAttackEntityEvent, AbstractChangeEntityEquipmentEvent, AbstractDamageEntityEvent, AbstractEvent, AbstractGameRegistryRegisterEvent, AbstractHealEntityEvent, AbstractMessageEvent, AbstractModifierEvent, AbstractSpawnEntityEvent, AbstractValueChangeEvent

public interface Event

An event called within Sponge.

This is a marker interface, which must be implemented by any event used with the Sponge event bus.

Method Summary

Modifier and Type	Method and Description
Cause	getCause() Gets the cause for the event.
default EventContext	getContext() Gets the context of the event.
default Object	getSource() Gets the source of the event (the first object in the cause).

Method Detail

getCause

Cause getCause()

Gets the cause for the event. The Cause of the event is an object which implements the Iterable interface. So, when investigating the Cause of the event a common idiom is to use operations (functions) on the result of getCause as follows: Use-case: Getting the Player (if any) responsible: Optional<Player> optPlayer = event.getCause().first(Player.class);

Returns:

The cause

getSource

default Object getSource()

Gets the source of the event (the first object in the cause).

Returns:

The event source

getContext

default EventContext getContext()

Gets the context of the event.

Returns:

The event context