Package net.neoforged.neoforge.event

Class VanillaGameEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.VanillaGameEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class VanillaGameEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

VanillaGameEvent is fired on the server whenever one of Vanilla's GameEvents fire.

This allows for listening to Vanilla's events in a more structured and global way that is not tied to needing a block entity listener.

This event is fired on the NeoForge.EVENT_BUS.

Cancel this event to prevent Vanilla from posting the GameEvent to all nearby GameEventListeners.

Field Summary

Fields

Modifier and Type	Field	Description
private final GameEvent.Context	context
private final Level	level
private final Vec3	position
private final Holder<GameEvent>	vanillaEvent

Constructor Summary

Constructors

Constructor	Description
VanillaGameEvent(Level level, Holder<GameEvent> vanillaEvent, Vec3 position, GameEvent.Context context)

Method Summary

Modifier and Type	Method	Description
@Nullable Entity	getCause()
GameEvent.Context	getContext()
Vec3	getEventPosition()
Level	getLevel()
Holder<GameEvent>	getVanillaEvent()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

level

private final Level level

vanillaEvent

private final Holder<GameEvent> vanillaEvent

position

private final Vec3 position

context

private final GameEvent.Context context

Constructor Details

VanillaGameEvent

public VanillaGameEvent(Level level,
 Holder<GameEvent> vanillaEvent,
 Vec3 position,
 GameEvent.Context context)

Method Details

getLevel

public Level getLevel()

Returns:

The level the Vanilla GameEvent occurred.

getCause

@Nullable
public @Nullable Entity getCause()

Returns:

The entity that was the source or "cause" of the GameEvent.

getVanillaEvent

public Holder<GameEvent> getVanillaEvent()

Returns:

The Vanilla event.

getEventPosition

public Vec3 getEventPosition()

Returns:

The position the event took place at.

getContext

public GameEvent.Context getContext()

Returns:

the context of the vanilla event