EventContextKeys (SpongeAPI 7.3.0 API)

java.lang.Object
- org.spongepowered.api.event.cause.EventContextKeys

public final class EventContextKeys
extends Object

Standard keys for use within EventContexts.

Field Summary

Fields
Modifier and Type	Field and Description
`static EventContextKey<LocatableBlock>`	`BLOCK_EVENT_PROCESS` Used when a `World` block event is being processed.
`static EventContextKey<LocatableBlock>`	`BLOCK_EVENT_QUEUE` Used to queue a block event to be processed in a `World`.
`static EventContextKey<BlockSnapshot>`	`BLOCK_HIT` Used when an `Entity` interacts with a block.
`static EventContextKey<ChangeBlockEvent.Break>`	`BREAK_EVENT` Used for `ChangeBlockEvent.Post` to provide the block event without relying on existing in the `Cause` stack.
`static EventContextKey<User>`	`CREATOR` Represents the creator of an `Entity`.
`static EventContextKey<DamageType>`	`DAMAGE_TYPE` Represents the `DamageType` to an entity.
`static EventContextKey<ChangeBlockEvent.Decay>`	`DECAY_EVENT` Used for `ChangeBlockEvent.Post` to provide the block event without relying on existing in the `Cause` stack.
`static EventContextKey<DismountType>`	`DISMOUNT_TYPE` Used when a `Player` dismounts from an `Entity`.
`static EventContextKey<Entity>`	`ENTITY_HIT` Represents the target `Entity`.
`static EventContextKey<Player>`	`FAKE_PLAYER` Represents a fake player responsible for an action.
`static EventContextKey<World>`	`FIRE_SPREAD` Used when fire spreads to other blocks.
`static EventContextKey<ChangeBlockEvent.Grow>`	`GROW_EVENT` Used for `ChangeBlockEvent.Post` to provide the block event without relying on existing in the `Cause` stack.
`static EventContextKey<BlockSnapshot>`	`GROWTH_ORIGIN` Used for `ChangeBlockEvent.Grow` to provide the origin `BlockSnapshot` that is doing the "growing".
`static EventContextKey<Living>`	`IGNITER` Used when an `Entity` ignites causing an `Explosion`.
`static EventContextKey<DamageSource>`	`LAST_DAMAGE_SOURCE` Represents the last `DamageSource` to an `Entity`.
`static EventContextKey<World>`	`LEAVES_DECAY` Used when leaves decay.
`static EventContextKey<World>`	`LIQUID_BREAK` Used when flowing liquid causing another block to break.
`static EventContextKey<World>`	`LIQUID_FLOW` Used when flowing liquid moves to another location.
`static EventContextKey<World>`	`LIQUID_MIX` Used when liquid changes state.
`static EventContextKey<ChangeBlockEvent.Modify>`	`MODIFY_EVENT` Used for `ChangeBlockEvent.Post` to provide the block event without relying on existing in the `Cause` stack.
`static EventContextKey<BlockSnapshot>`	`NEIGHBOR_NOTIFY_SOURCE` Represents the source `BlockSnapshot` of a block notification.
`static EventContextKey<User>`	`NOTIFIER` Represents the `User` that notified a block.
`static EventContextKey<User>`	`OWNER` Represents the `User` that owns a block.
`static EventContextKey<World>`	`PISTON_EXTEND` Used when a `BlockTypes.PISTON_HEAD` extends.
`static EventContextKey<World>`	`PISTON_RETRACT` Used when a `BlockTypes.PISTON_HEAD` retracts.
`static EventContextKey<ChangeBlockEvent.Place>`	`PLACE_EVENT` Used for `ChangeBlockEvent.Post` to provide the block event without relying on existing in the `Cause` stack.
`static EventContextKey<Player>`	`PLAYER` Represents a `Player`.
`static EventContextKey<World>`	`PLAYER_BREAK` Used when a `Player` breaks a block.
`static EventContextKey<World>`	`PLAYER_PLACE` Used when a `Player` places a block.
`static EventContextKey<GameProfile>`	`PLAYER_SIMULATED` Represents a simulated `Player`.
`static EventContextKey<PluginContainer>`	`PLUGIN` Represents a `PluginContainer`.
`static EventContextKey<ProjectileSource>`	`PROJECTILE_SOURCE` Represents a `ProjectileSource`.
`static EventContextKey<ServiceManager>`	`SERVICE_MANAGER` Represents the `ServiceManager`.
`static EventContextKey<SpawnType>`	`SPAWN_TYPE` Represents the `SpawnType` of an entity spawn.
`static EventContextKey<TeleportType>`	`TELEPORT_TYPE` Represents the `TeleportType` when an entity teleports.
`static EventContextKey<ProjectileSource>`	`THROWER` Deprecated. this key is a duplicate of `PROJECTILE_SOURCE` and will be removed in API 8. See this issue on SpongeAPI, Use `PROJECTILE_SOURCE` instead.
`static EventContextKey<HandType>`	`USED_HAND` Represents a `HandType`.
`static EventContextKey<ItemStackSnapshot>`	`USED_ITEM` Represents an `ItemStackSnapshot` of used item.
`static EventContextKey<ItemStackSnapshot>`	`WEAPON` Represents an `ItemStackSnapshot` of a weapon.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BLOCK_EVENT_QUEUE
```
public static final EventContextKey<LocatableBlock> BLOCK_EVENT_QUEUE
```
    Used to queue a block event to be processed in a World. For example, a piston will queue retract/extend movements using this event. Note: This represents vanilla's block event.
  - BLOCK_EVENT_PROCESS
```
public static final EventContextKey<LocatableBlock> BLOCK_EVENT_PROCESS
```
    Used when a World block event is being processed. For example, a piston head retracting and extending. Note: This represents vanilla's block event. Note: This occurs at the end of a world tick after BLOCK_EVENT_QUEUE.
  - BLOCK_HIT
```
public static final EventContextKey<BlockSnapshot> BLOCK_HIT
```
    Used when an Entity interacts with a block.
  - BREAK_EVENT
```
public static final EventContextKey<ChangeBlockEvent.Break> BREAK_EVENT
```
    Used for ChangeBlockEvent.Post to provide the block event without relying on existing in the Cause stack.
  - PLACE_EVENT
```
public static final EventContextKey<ChangeBlockEvent.Place> PLACE_EVENT
```
    Used for ChangeBlockEvent.Post to provide the block event without relying on existing in the Cause stack.
  - MODIFY_EVENT
```
public static final EventContextKey<ChangeBlockEvent.Modify> MODIFY_EVENT
```
    Used for ChangeBlockEvent.Post to provide the block event without relying on existing in the Cause stack.
  - DECAY_EVENT
```
public static final EventContextKey<ChangeBlockEvent.Decay> DECAY_EVENT
```
    Used for ChangeBlockEvent.Post to provide the block event without relying on existing in the Cause stack.
  - GROW_EVENT
```
public static final EventContextKey<ChangeBlockEvent.Grow> GROW_EVENT
```
    Used for ChangeBlockEvent.Post to provide the block event without relying on existing in the Cause stack.
  - GROWTH_ORIGIN
```
public static final EventContextKey<BlockSnapshot> GROWTH_ORIGIN
```
    Used for ChangeBlockEvent.Grow to provide the origin BlockSnapshot that is doing the "growing".
  - CREATOR
```
public static final EventContextKey<User> CREATOR
```
    Represents the creator of an Entity.
  - DAMAGE_TYPE
```
public static final EventContextKey<DamageType> DAMAGE_TYPE
```
    Represents the DamageType to an entity.
  - DISMOUNT_TYPE
```
public static final EventContextKey<DismountType> DISMOUNT_TYPE
```
    Used when a Player dismounts from an Entity.
  - ENTITY_HIT
```
public static final EventContextKey<Entity> ENTITY_HIT
```
    Represents the target Entity. Used when an entity, such as a Player, targets an entity via an interaction.
  - FAKE_PLAYER
```
public static final EventContextKey<Player> FAKE_PLAYER
```
    Represents a fake player responsible for an action. Note: This is normally only used with mods.
  - FIRE_SPREAD
```
public static final EventContextKey<World> FIRE_SPREAD
```
    Used when fire spreads to other blocks.
  - IGNITER
```
public static final EventContextKey<Living> IGNITER
```
    Used when an Entity ignites causing an Explosion.
  - LAST_DAMAGE_SOURCE
```
public static final EventContextKey<DamageSource> LAST_DAMAGE_SOURCE
```
    Represents the last DamageSource to an Entity.
  - LEAVES_DECAY
```
public static final EventContextKey<World> LEAVES_DECAY
```
    Used when leaves decay.
  - LIQUID_BREAK
```
public static final EventContextKey<World> LIQUID_BREAK
```
    Used when flowing liquid causing another block to break.
  - LIQUID_FLOW
```
public static final EventContextKey<World> LIQUID_FLOW
```
    Used when flowing liquid moves to another location.
  - LIQUID_MIX
```
public static final EventContextKey<World> LIQUID_MIX
```
    Used when liquid changes state.
  - NEIGHBOR_NOTIFY_SOURCE
```
public static final EventContextKey<BlockSnapshot> NEIGHBOR_NOTIFY_SOURCE
```
    Represents the source BlockSnapshot of a block notification.
  - NOTIFIER
```
public static final EventContextKey<User> NOTIFIER
```
    Represents the User that notified a block.
  - OWNER
```
public static final EventContextKey<User> OWNER
```
    Represents the User that owns a block.
  - PISTON_EXTEND
```
public static final EventContextKey<World> PISTON_EXTEND
```
    Used when a BlockTypes.PISTON_HEAD extends.
  - PISTON_RETRACT
```
public static final EventContextKey<World> PISTON_RETRACT
```
    Used when a BlockTypes.PISTON_HEAD retracts.
  - PLAYER
```
public static final EventContextKey<Player> PLAYER
```
    Represents a Player.
  - PLAYER_BREAK
```
public static final EventContextKey<World> PLAYER_BREAK
```
    Used when a Player breaks a block.
  - PLAYER_PLACE
```
public static final EventContextKey<World> PLAYER_PLACE
```
    Used when a Player places a block.
  - PLAYER_SIMULATED
```
public static final EventContextKey<GameProfile> PLAYER_SIMULATED
```
    Represents a simulated Player.
  - PLUGIN
```
public static final EventContextKey<PluginContainer> PLUGIN
```
    Represents a PluginContainer.
  - PROJECTILE_SOURCE
```
public static final EventContextKey<ProjectileSource> PROJECTILE_SOURCE
```
    Represents a ProjectileSource.
  - SERVICE_MANAGER
```
public static final EventContextKey<ServiceManager> SERVICE_MANAGER
```
    Represents the ServiceManager.
  - SPAWN_TYPE
```
public static final EventContextKey<SpawnType> SPAWN_TYPE
```
    Represents the SpawnType of an entity spawn.
  - TELEPORT_TYPE
```
public static final EventContextKey<TeleportType> TELEPORT_TYPE
```
    Represents the TeleportType when an entity teleports.
  - THROWER
```
@Deprecated
public static final EventContextKey<ProjectileSource> THROWER
```
    Deprecated. this key is a duplicate of PROJECTILE_SOURCE and will be removed in API 8. See this issue on SpongeAPI, Use PROJECTILE_SOURCE instead.
  - USED_ITEM
```
public static final EventContextKey<ItemStackSnapshot> USED_ITEM
```
    Represents an ItemStackSnapshot of used item.
  - USED_HAND
```
public static final EventContextKey<HandType> USED_HAND
```
    Represents a HandType.
  - WEAPON
```
public static final EventContextKey<ItemStackSnapshot> WEAPON
```
    Represents an ItemStackSnapshot of a weapon.

Class EventContextKeys

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_EVENT_QUEUE

BLOCK_EVENT_PROCESS

BLOCK_HIT

BREAK_EVENT

PLACE_EVENT

MODIFY_EVENT

DECAY_EVENT

GROW_EVENT

GROWTH_ORIGIN

CREATOR

DAMAGE_TYPE

DISMOUNT_TYPE

ENTITY_HIT

FAKE_PLAYER

FIRE_SPREAD

IGNITER

LAST_DAMAGE_SOURCE

LEAVES_DECAY

LIQUID_BREAK

LIQUID_FLOW

LIQUID_MIX

NEIGHBOR_NOTIFY_SOURCE

NOTIFIER

OWNER

PISTON_EXTEND

PISTON_RETRACT

PLAYER

PLAYER_BREAK

PLAYER_PLACE

PLAYER_SIMULATED

PLUGIN

PROJECTILE_SOURCE

SERVICE_MANAGER

SPAWN_TYPE

TELEPORT_TYPE

THROWER

USED_ITEM

USED_HAND

WEAPON