Package org.spongepowered.api.event

Class EventContextKeys

java.lang.Object

org.spongepowered.api.event.EventContextKeys

public final class EventContextKeys
extends Object

Standard keys for use within EventContexts.

Field Summary

Fields

Modifier and Type	Field	Description
static final EventContextKey<Audience>	AUDIENCE	Used during command execution, indicates the Audience to send any messages to.
static final EventContextKey<LocatableBlock>	BLOCK_EVENT_PROCESS	Used when a World block event is being processed.
static final EventContextKey<LocatableBlock>	BLOCK_EVENT_QUEUE	Used to queue a block event to be processed in a World.
static final EventContextKey<BlockSnapshot>	BLOCK_HIT	Used when an Entity interacts with a block.
static final EventContextKey<BlockSnapshot>	BLOCK_TARGET	Used during command execution, indicates the BlockSnapshot that is the target of the invocation.
static final EventContextKey<String>	COMMAND	Represents the command string that was provided to the command processor.
static final EventContextKey<UUID>	CREATOR	Represents the creator of an Entity or a BlockState at a Location
static final EventContextKey<DamageType>	DAMAGE_TYPE	Represents the DamageType to an entity.
static final EventContextKey<DismountType>	DISMOUNT_TYPE	Used when a Player dismounts from an Entity.
static final EventContextKey<Entity>	ENTITY_HIT	Represents the target Entity.
static final EventContextKey<Player>	FAKE_PLAYER	Represents a fake player responsible for an action.
static final EventContextKey<ServerWorld>	FIRE_SPREAD	Used when fire spreads to other blocks.
static final EventContextKey<BlockSnapshot>	GROWTH_ORIGIN	Used for ChangeBlockEvent to provide the origin BlockSnapshot that is doing the "growing".
static final EventContextKey<Living>	IGNITER	Used when an Living ignites causing an Explosion.
static final EventContextKey<DamageSource>	LAST_DAMAGE_SOURCE	Represents the last DamageSource to an Entity.
static final EventContextKey<ServerLocation>	LOCATION	Used during command execution, indicates the ServerLocation that the command is centered around.
static final EventContextKey<MovementType>	MOVEMENT_TYPE	Represents the MovementType when an entity moves.
static final EventContextKey<BlockSnapshot>	NEIGHBOR_NOTIFY_SOURCE	Represents the source BlockSnapshot of a block notification.
static final EventContextKey<UUID>	NOTIFIER	Represents the UUID of a User that notified a block.
static final EventContextKey<ServerWorld>	PISTON_EXTEND	Used when a BlockTypes.PISTON_HEAD extends.
static final EventContextKey<ServerWorld>	PISTON_RETRACT	Used when a BlockTypes.PISTON_HEAD retracts.
static final EventContextKey<Player>	PLAYER	Represents a Player.
static final EventContextKey<ServerWorld>	PLAYER_BREAK	Used when a Player breaks a block.
static final EventContextKey<ServerWorld>	PLAYER_PLACE	Used when a Player places a block.
static final EventContextKey<org.spongepowered.plugin.PluginContainer>	PLUGIN	Represents a PluginContainer.
static final EventContextKey<Portal>	PORTAL	Represents a Portal.
static final EventContextKey<ProjectileSource>	PROJECTILE_SOURCE	Represents a ProjectileSource.
static final EventContextKey<Vector3d>	ROTATION	Represents a rotation as a Vector3d, for use with commands.
static final EventContextKey<GameProfile>	SIMULATED_PLAYER	Represents a simulated Player.
static final EventContextKey<SpawnType>	SPAWN_TYPE	Represents the SpawnType of an entity spawn.
static final EventContextKey<Subject>	SUBJECT	Used during command invocation, indicates the Subject that permission checks should be performed against.
static final EventContextKey<HandType>	USED_HAND	Represents a HandType.
static final EventContextKey<ItemStackSnapshot>	USED_ITEM	Represents an ItemStackSnapshot of used item.
static final 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 Details

AUDIENCE

public static final EventContextKey<Audience> AUDIENCE

Used during command execution, indicates the Audience to send any messages to.

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_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_HIT

public static final EventContextKey<BlockSnapshot> BLOCK_HIT

Used when an Entity interacts with a block.

BLOCK_TARGET

public static final EventContextKey<BlockSnapshot> BLOCK_TARGET

Used during command execution, indicates the BlockSnapshot that is the target of the invocation.

COMMAND

public static final EventContextKey<String> COMMAND

Represents the command string that was provided to the command processor.

CREATOR

public static final EventContextKey<UUID> CREATOR

Represents the creator of an Entity or a BlockState at a Location

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<ServerWorld> FIRE_SPREAD

Used when fire spreads to other blocks.

GROWTH_ORIGIN

public static final EventContextKey<BlockSnapshot> GROWTH_ORIGIN

Used for ChangeBlockEvent to provide the origin BlockSnapshot that is doing the "growing". This is likely useful to determine what is the origin with BlockTransaction.operation() when the operation is of Operations.GROWTH.

IGNITER

public static final EventContextKey<Living> IGNITER

Used when an Living ignites causing an Explosion.

LAST_DAMAGE_SOURCE

public static final EventContextKey<DamageSource> LAST_DAMAGE_SOURCE

Represents the last DamageSource to an Entity.

LOCATION

public static final EventContextKey<ServerLocation> LOCATION

Used during command execution, indicates the ServerLocation that the command is centered around.

MOVEMENT_TYPE

public static final EventContextKey<MovementType> MOVEMENT_TYPE

Represents the MovementType when an entity moves.

NEIGHBOR_NOTIFY_SOURCE

public static final EventContextKey<BlockSnapshot> NEIGHBOR_NOTIFY_SOURCE

Represents the source BlockSnapshot of a block notification.

NOTIFIER

public static final EventContextKey<UUID> NOTIFIER

Represents the UUID of a User that notified a block.

PISTON_EXTEND

public static final EventContextKey<ServerWorld> PISTON_EXTEND

Used when a BlockTypes.PISTON_HEAD extends.

PISTON_RETRACT

public static final EventContextKey<ServerWorld> 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<ServerWorld> PLAYER_BREAK

Used when a Player breaks a block.

PLAYER_PLACE

public static final EventContextKey<ServerWorld> PLAYER_PLACE

Used when a Player places a block.

PLUGIN

public static final EventContextKey<org.spongepowered.plugin.PluginContainer> PLUGIN

Represents a PluginContainer.

PORTAL

public static final EventContextKey<Portal> PORTAL

Represents a Portal.

PROJECTILE_SOURCE

public static final EventContextKey<ProjectileSource> PROJECTILE_SOURCE

Represents a ProjectileSource.

ROTATION

public static final EventContextKey<Vector3d> ROTATION

Represents a rotation as a Vector3d, for use with commands.

SIMULATED_PLAYER

public static final EventContextKey<GameProfile> SIMULATED_PLAYER

Represents a simulated Player.

SPAWN_TYPE

public static final EventContextKey<SpawnType> SPAWN_TYPE

Represents the SpawnType of an entity spawn.

SUBJECT

public static final EventContextKey<Subject> SUBJECT

Used during command invocation, indicates the Subject that permission checks should be performed against.

USED_HAND

public static final EventContextKey<HandType> USED_HAND

Represents a HandType.

USED_ITEM

public static final EventContextKey<ItemStackSnapshot> USED_ITEM

Represents an ItemStackSnapshot of used item.

WEAPON

public static final EventContextKey<ItemStackSnapshot> WEAPON

Represents an ItemStackSnapshot of a weapon.