Class GameEvent

java.lang.Object

org.bukkit.GameEvent

All Implemented Interfaces:

Keyed, Keyed

public abstract class GameEvent
extends Object
implements Keyed

Represents a generic Mojang game event.

Since:

1.17

Field Summary

Fields

Modifier and Type	Field	Description
static final GameEvent	BLOCK_ACTIVATE
static final GameEvent	BLOCK_ATTACH
static final GameEvent	BLOCK_CHANGE
static final GameEvent	BLOCK_CLOSE
static final GameEvent	BLOCK_DEACTIVATE
static final GameEvent	BLOCK_DESTROY
static final GameEvent	BLOCK_DETACH
static final GameEvent	BLOCK_OPEN
static final GameEvent	BLOCK_PLACE
static final GameEvent	BLOCK_PRESS	Deprecated. in favor of BLOCK_ACTIVATE
static final GameEvent	BLOCK_SWITCH	Deprecated. in favor of BLOCK_ACTIVATE
static final GameEvent	BLOCK_UNPRESS	Deprecated. in favor of BLOCK_DEACTIVATE
static final GameEvent	BLOCK_UNSWITCH	Deprecated. in favor of BLOCK_DEACTIVATE
static final GameEvent	CONTAINER_CLOSE
static final GameEvent	CONTAINER_OPEN
static final GameEvent	DISPENSE_FAIL	Deprecated. in favor of BLOCK_ACTIVATE
static final GameEvent	DRINK
static final GameEvent	DRINKING_FINISH	Deprecated. in favor of DRINK
static final GameEvent	EAT
static final GameEvent	ELYTRA_FREE_FALL	Deprecated. in favor of ELYTRA_GLIDE
static final GameEvent	ELYTRA_GLIDE
static final GameEvent	ENTITY_ACTION
static final GameEvent	ENTITY_DAMAGE
static final GameEvent	ENTITY_DAMAGED	Deprecated. in favor of ENTITY_DAMAGE
static final GameEvent	ENTITY_DIE
static final GameEvent	ENTITY_DISMOUNT
static final GameEvent	ENTITY_DYING	Deprecated. in favor of ENTITY_DIE
static final GameEvent	ENTITY_INTERACT
static final GameEvent	ENTITY_KILLED	Deprecated. in favor of ENTITY_DIE
static final GameEvent	ENTITY_MOUNT
static final GameEvent	ENTITY_PLACE
static final GameEvent	ENTITY_ROAR	Deprecated. in favor of ENTITY_ACTION
static final GameEvent	ENTITY_SHAKE	Deprecated. in favor of ENTITY_ACTION
static final GameEvent	EQUIP
static final GameEvent	EXPLODE
static final GameEvent	FLAP
static final GameEvent	FLUID_PICKUP
static final GameEvent	FLUID_PLACE
static final GameEvent	HIT_GROUND
static final GameEvent	INSTRUMENT_PLAY
static final GameEvent	ITEM_INTERACT_FINISH
static final GameEvent	ITEM_INTERACT_START
static final GameEvent	JUKEBOX_PLAY
static final GameEvent	JUKEBOX_STOP_PLAY
static final GameEvent	LIGHTNING_STRIKE
static final GameEvent	MOB_INTERACT	Deprecated. in favor of ENTITY_INTERACT
static final GameEvent	NOTE_BLOCK_PLAY
static final GameEvent	PISTON_CONTRACT	Deprecated. in favor of BLOCK_DEACTIVATE
static final GameEvent	PISTON_EXTEND	Deprecated. in favor of BLOCK_ACTIVATE
static final GameEvent	PRIME_FUSE
static final GameEvent	PROJECTILE_LAND
static final GameEvent	PROJECTILE_SHOOT
static final GameEvent	RAVAGER_ROAR	Deprecated. in favor of ENTITY_ACTION
static final GameEvent	RESONATE_1
static final GameEvent	RESONATE_10
static final GameEvent	RESONATE_11
static final GameEvent	RESONATE_12
static final GameEvent	RESONATE_13
static final GameEvent	RESONATE_14
static final GameEvent	RESONATE_15
static final GameEvent	RESONATE_2
static final GameEvent	RESONATE_3
static final GameEvent	RESONATE_4
static final GameEvent	RESONATE_5
static final GameEvent	RESONATE_6
static final GameEvent	RESONATE_7
static final GameEvent	RESONATE_8
static final GameEvent	RESONATE_9
static final GameEvent	RING_BELL	Deprecated. in favor of BLOCK_CHANGE
static final GameEvent	SCULK_SENSOR_TENDRILS_CLICKING
static final GameEvent	SHEAR
static final GameEvent	SHRIEK
static final GameEvent	SHULKER_CLOSE	Deprecated. in favor of CONTAINER_CLOSE
static final GameEvent	SHULKER_OPEN	Deprecated. in favor of CONTAINER_OPEN
static final GameEvent	SPLASH
static final GameEvent	STEP
static final GameEvent	SWIM
static final GameEvent	TELEPORT
static final GameEvent	UNEQUIP
static final GameEvent	WOLF_SHAKING	Deprecated. in favor of ENTITY_ACTION

Constructor Summary

Constructors

Constructor	Description
GameEvent()

Method Summary

Modifier and Type	Method	Description
static @Nullable GameEvent	getByKey(@NotNull NamespacedKey namespacedKey)	Deprecated. Use Registry.get(NamespacedKey) instead.
abstract int	getRange()	Gets the range of the event which is used to notify listeners of the event.
abstract int	getVibrationLevel()	Gets the vibration level of the game event for vibration listeners.
static @NotNull Collection<GameEvent>	values()	Deprecated. use Registry.stream().

Methods inherited from class Object

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

Methods inherited from interface Keyed

getKey, key

Field Details

BLOCK_ACTIVATE

public static final GameEvent BLOCK_ACTIVATE

Since:

1.19

BLOCK_ATTACH

public static final GameEvent BLOCK_ATTACH

Since:

1.17

BLOCK_CHANGE

public static final GameEvent BLOCK_CHANGE

Since:

1.17

BLOCK_CLOSE

public static final GameEvent BLOCK_CLOSE

Since:

1.17

BLOCK_DEACTIVATE

public static final GameEvent BLOCK_DEACTIVATE

Since:

1.19

BLOCK_DESTROY

public static final GameEvent BLOCK_DESTROY

Since:

1.17

BLOCK_DETACH

public static final GameEvent BLOCK_DETACH

Since:

1.17

BLOCK_OPEN

public static final GameEvent BLOCK_OPEN

Since:

1.17

BLOCK_PLACE

public static final GameEvent BLOCK_PLACE

Since:

1.17

CONTAINER_CLOSE

public static final GameEvent CONTAINER_CLOSE

Since:

1.17

CONTAINER_OPEN

public static final GameEvent CONTAINER_OPEN

Since:

1.17

DRINK

public static final GameEvent DRINK

Since:

1.19

EAT

public static final GameEvent EAT

Since:

1.17

ELYTRA_GLIDE

public static final GameEvent ELYTRA_GLIDE

Since:

1.19

ENTITY_ACTION

public static final GameEvent ENTITY_ACTION

Since:

1.20.2

ENTITY_DAMAGE

public static final GameEvent ENTITY_DAMAGE

Since:

1.19

ENTITY_DIE

public static final GameEvent ENTITY_DIE

Since:

1.19

ENTITY_DISMOUNT

public static final GameEvent ENTITY_DISMOUNT

Since:

1.19.4

ENTITY_INTERACT

public static final GameEvent ENTITY_INTERACT

Since:

1.19

ENTITY_MOUNT

public static final GameEvent ENTITY_MOUNT

Since:

1.19.4

ENTITY_PLACE

public static final GameEvent ENTITY_PLACE

Since:

1.17

EQUIP

public static final GameEvent EQUIP

Since:

1.17

EXPLODE

public static final GameEvent EXPLODE

Since:

1.17

FLAP

public static final GameEvent FLAP

Since:

1.17

FLUID_PICKUP

public static final GameEvent FLUID_PICKUP

Since:

1.17

FLUID_PLACE

public static final GameEvent FLUID_PLACE

Since:

1.17

HIT_GROUND

public static final GameEvent HIT_GROUND

Since:

1.17

INSTRUMENT_PLAY

public static final GameEvent INSTRUMENT_PLAY

Since:

1.19

ITEM_INTERACT_FINISH

public static final GameEvent ITEM_INTERACT_FINISH

Since:

1.19

ITEM_INTERACT_START

public static final GameEvent ITEM_INTERACT_START

Since:

1.19

JUKEBOX_PLAY

public static final GameEvent JUKEBOX_PLAY

Since:

1.19.1

JUKEBOX_STOP_PLAY

public static final GameEvent JUKEBOX_STOP_PLAY

Since:

1.19.1

LIGHTNING_STRIKE

public static final GameEvent LIGHTNING_STRIKE

Since:

1.17

NOTE_BLOCK_PLAY

public static final GameEvent NOTE_BLOCK_PLAY

Since:

1.19

PRIME_FUSE

public static final GameEvent PRIME_FUSE

Since:

1.17

PROJECTILE_LAND

public static final GameEvent PROJECTILE_LAND

Since:

1.17

PROJECTILE_SHOOT

public static final GameEvent PROJECTILE_SHOOT

Since:

1.17

RESONATE_1

public static final GameEvent RESONATE_1

Since:

1.20

RESONATE_2

public static final GameEvent RESONATE_2

Since:

1.20

RESONATE_3

public static final GameEvent RESONATE_3

Since:

1.20

RESONATE_4

public static final GameEvent RESONATE_4

Since:

1.20

RESONATE_5

public static final GameEvent RESONATE_5

Since:

1.20

RESONATE_6

public static final GameEvent RESONATE_6

Since:

1.20

RESONATE_7

public static final GameEvent RESONATE_7

Since:

1.20

RESONATE_8

public static final GameEvent RESONATE_8

Since:

1.20

RESONATE_9

public static final GameEvent RESONATE_9

Since:

1.20

RESONATE_10

public static final GameEvent RESONATE_10

Since:

1.20

RESONATE_11

public static final GameEvent RESONATE_11

Since:

1.20

RESONATE_12

public static final GameEvent RESONATE_12

Since:

1.20

RESONATE_13

public static final GameEvent RESONATE_13

Since:

1.20

RESONATE_14

public static final GameEvent RESONATE_14

Since:

1.20

RESONATE_15

public static final GameEvent RESONATE_15

Since:

1.20

SCULK_SENSOR_TENDRILS_CLICKING

public static final GameEvent SCULK_SENSOR_TENDRILS_CLICKING

Since:

1.19

SHEAR

public static final GameEvent SHEAR

Since:

1.17

SHRIEK

public static final GameEvent SHRIEK

Since:

1.19

SPLASH

public static final GameEvent SPLASH

Since:

1.17

STEP

public static final GameEvent STEP

Since:

1.17

SWIM

public static final GameEvent SWIM

Since:

1.17

TELEPORT

public static final GameEvent TELEPORT

Since:

1.19

UNEQUIP

public static final GameEvent UNEQUIP

Since:

1.20.2

BLOCK_PRESS

@Deprecated(since="1.19")
public static final GameEvent BLOCK_PRESS

Deprecated.

in favor of BLOCK_ACTIVATE

Since:

1.17

BLOCK_SWITCH

@Deprecated(since="1.19")
public static final GameEvent BLOCK_SWITCH

Deprecated.

in favor of BLOCK_ACTIVATE

Since:

1.17

BLOCK_UNPRESS

@Deprecated(since="1.19")
public static final GameEvent BLOCK_UNPRESS

Deprecated.

in favor of BLOCK_DEACTIVATE

Since:

1.17

BLOCK_UNSWITCH

@Deprecated(since="1.19")
public static final GameEvent BLOCK_UNSWITCH

Deprecated.

in favor of BLOCK_DEACTIVATE

Since:

1.17

DISPENSE_FAIL

@Deprecated(since="1.20")
public static final GameEvent DISPENSE_FAIL

Deprecated.

in favor of BLOCK_ACTIVATE

Since:

1.17

DRINKING_FINISH

@Deprecated(since="1.19")
public static final GameEvent DRINKING_FINISH

Deprecated.

in favor of DRINK

Since:

1.17

ELYTRA_FREE_FALL

@Deprecated(since="1.19")
public static final GameEvent ELYTRA_FREE_FALL

Deprecated.

in favor of ELYTRA_GLIDE

Since:

1.17

ENTITY_DAMAGED

@Deprecated(since="1.19")
public static final GameEvent ENTITY_DAMAGED

Deprecated.

in favor of ENTITY_DAMAGE

Since:

1.17

ENTITY_DYING

@Deprecated(since="1.19")
public static final GameEvent ENTITY_DYING

Deprecated.

in favor of ENTITY_DIE

Since:

1.19

ENTITY_KILLED

@Deprecated(since="1.19")
public static final GameEvent ENTITY_KILLED

Deprecated.

in favor of ENTITY_DIE

Since:

1.17

ENTITY_ROAR

@Deprecated(since="1.20.2")
public static final GameEvent ENTITY_ROAR

Deprecated.

in favor of ENTITY_ACTION

Since:

1.19

ENTITY_SHAKE

@Deprecated(since="1.20.2")
public static final GameEvent ENTITY_SHAKE

Deprecated.

in favor of ENTITY_ACTION

Since:

1.19

MOB_INTERACT

@Deprecated(since="1.19")
public static final GameEvent MOB_INTERACT

Deprecated.

in favor of ENTITY_INTERACT

Since:

1.17

PISTON_CONTRACT

@Deprecated(since="1.20")
public static final GameEvent PISTON_CONTRACT

Deprecated.

in favor of BLOCK_DEACTIVATE

Since:

1.17

PISTON_EXTEND

@Deprecated(since="1.20")
public static final GameEvent PISTON_EXTEND

Deprecated.

in favor of BLOCK_ACTIVATE

Since:

1.17

RAVAGER_ROAR

@Deprecated(since="1.19")
public static final GameEvent RAVAGER_ROAR

Deprecated.

in favor of ENTITY_ACTION

Since:

1.17

RING_BELL

@Deprecated(since="1.19")
public static final GameEvent RING_BELL

Deprecated.

in favor of BLOCK_CHANGE

Since:

1.17

SHULKER_CLOSE

@Deprecated(since="1.19")
public static final GameEvent SHULKER_CLOSE

Deprecated.

in favor of CONTAINER_CLOSE

Since:

1.17

SHULKER_OPEN

@Deprecated(since="1.19")
public static final GameEvent SHULKER_OPEN

Deprecated.

in favor of CONTAINER_OPEN

Since:

1.17

WOLF_SHAKING

@Deprecated(since="1.19")
public static final GameEvent WOLF_SHAKING

Deprecated.

in favor of ENTITY_ACTION

Since:

1.17

Constructor Details

GameEvent

public GameEvent()

Method Details

getByKey

@Nullable
@Deprecated(since="1.20.1")
public static @Nullable GameEvent getByKey(@NotNull
 @NotNull NamespacedKey namespacedKey)

Deprecated.

Use Registry.get(NamespacedKey) instead.

Returns a GameEvent by a NamespacedKey.

Parameters:

namespacedKey - the key

Returns:

the event or null

Since:

1.17

values

@NotNull
@Deprecated(since="1.20.1")
public static @NotNull Collection<GameEvent> values()

Deprecated.

use Registry.stream().

Returns the set of all GameEvents.

Returns:

the memoryKeys

Since:

1.17

getRange

public abstract int getRange()

Gets the range of the event which is used to notify listeners of the event.

Returns:

the range

Since:

1.21

getVibrationLevel

public abstract int getVibrationLevel()

Gets the vibration level of the game event for vibration listeners. Not all events have vibration levels, and a level of 0 means it won't cause any vibrations.

Returns:

the vibration level

Since:

1.21